diff --git a/.openpublishing.redirection.exchange.json b/.openpublishing.redirection.exchange.json index 7eb756dfc2..68da428a79 100644 --- a/.openpublishing.redirection.exchange.json +++ b/.openpublishing.redirection.exchange.json @@ -2,73 +2,73 @@ "redirections": [ { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpEdmSschema.md", - "redirect_url": "/powershell/module/exchange/new-dlpedmschema", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpedmschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-TeamsRetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/get-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-TeamsRetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/get-retentioncompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-TeamsRetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/new-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-TeamsRetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/new-retentioncompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-TeamsRetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/remove-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-TeamsRetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/remove-retentioncompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-TeamsRetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/set-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-TeamsRetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/set-retentioncompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpComplianceRuleV2.md", - "redirect_url": "/powershell/module/exchange/get-dlpcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpComplianceRuleV2.md", - "redirect_url": "/powershell/module/exchange/new-dlpcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRuleV2.md", - "redirect_url": "/powershell/module/exchange/remove-dlpcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpComplianceRuleV2.md", - "redirect_url": "/powershell/module/exchange/set-dlpcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/exchange-ps-v2-module/connect-exchangeonline.md", - "redirect_url": "/powershell/module/exchange/connect-exchangeonline", - "redirect_document_id": true + "redirect_url": "/powershell/module/exchangepowershell/connect-exchangeonline", + "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Test-ExchangeUMCallFlow.md", @@ -162,2987 +162,2987 @@ }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Add-ADPermission.md", - "redirect_url": "/powershell/module/exchange/add-adpermission", + "redirect_url": "/powershell/module/exchangepowershell/add-adpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Dump-ProvisioningCache.md", - "redirect_url": "/powershell/module/exchange/dump-provisioningcache", + "redirect_url": "/powershell/module/exchangepowershell/dump-provisioningcache", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADPermission.md", - "redirect_url": "/powershell/module/exchange/get-adpermission", + "redirect_url": "/powershell/module/exchangepowershell/get-adpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADServerSettings.md", - "redirect_url": "/powershell/module/exchange/get-adserversettings", + "redirect_url": "/powershell/module/exchangepowershell/get-adserversettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADSite.md", - "redirect_url": "/powershell/module/exchange/get-adsite", + "redirect_url": "/powershell/module/exchangepowershell/get-adsite", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-AdSiteLink.md", - "redirect_url": "/powershell/module/exchange/get-adsitelink", + "redirect_url": "/powershell/module/exchangepowershell/get-adsitelink", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-DomainController.md", - "redirect_url": "/powershell/module/exchange/get-domaincontroller", + "redirect_url": "/powershell/module/exchangepowershell/get-domaincontroller", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-OrganizationalUnit.md", - "redirect_url": "/powershell/module/exchange/get-organizationalunit", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationalunit", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-Trust.md", - "redirect_url": "/powershell/module/exchange/get-trust", + "redirect_url": "/powershell/module/exchangepowershell/get-trust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-UserPrincipalNamesSuffix.md", - "redirect_url": "/powershell/module/exchange/get-userprincipalnamessuffix", + "redirect_url": "/powershell/module/exchangepowershell/get-userprincipalnamessuffix", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Remove-ADPermission.md", - "redirect_url": "/powershell/module/exchange/remove-adpermission", + "redirect_url": "/powershell/module/exchangepowershell/remove-adpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Reset-ProvisioningCache.md", - "redirect_url": "/powershell/module/exchange/reset-provisioningcache", + "redirect_url": "/powershell/module/exchangepowershell/reset-provisioningcache", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Set-ADServerSettings.md", - "redirect_url": "/powershell/module/exchange/set-adserversettings", + "redirect_url": "/powershell/module/exchangepowershell/set-adserversettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Set-ADSite.md", - "redirect_url": "/powershell/module/exchange/set-adsite", + "redirect_url": "/powershell/module/exchangepowershell/set-adsite", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Set-AdSiteLink.md", - "redirect_url": "/powershell/module/exchange/set-adsitelink", + "redirect_url": "/powershell/module/exchangepowershell/set-adsitelink", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/disable-antiphishrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/disable-safeattachmentrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/disable-safelinksrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/enable-antiphishrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/enable-safeattachmentrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/enable-safelinksrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentDetail.md", - "redirect_url": "/powershell/module/exchange/get-advancedthreatprotectiondocumentdetail", + "redirect_url": "/powershell/module/exchangepowershell/get-advancedthreatprotectiondocumentdetail", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentReport.md", - "redirect_url": "/powershell/module/exchange/get-advancedthreatprotectiondocumentreport", + "redirect_url": "/powershell/module/exchangepowershell/get-advancedthreatprotectiondocumentreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionTrafficReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AntiPhishPolicy.md", - "redirect_url": "/powershell/module/exchange/get-antiphishpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-antiphishpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/get-antiphishrule", + "redirect_url": "/powershell/module/exchangepowershell/get-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AtpPolicyForO365.md", - "redirect_url": "/powershell/module/exchange/get-atppolicyforo365", + "redirect_url": "/powershell/module/exchangepowershell/get-atppolicyforo365", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-MailDetailATPReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-MailTrafficATPReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficatpreport", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-tenantallowblocklistspoofitems", + "redirect_url": "/powershell/module/exchangepowershell/get-tenantallowblocklistspoofitems", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeAttachmentPolicy.md", - "redirect_url": "/powershell/module/exchange/get-safeattachmentpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-safeattachmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/get-safeattachmentrule", + "redirect_url": "/powershell/module/exchangepowershell/get-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeLinksPolicy.md", - "redirect_url": "/powershell/module/exchange/get-safelinkspolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinkspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/get-safelinksrule", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SpoofMailReport.md", - "redirect_url": "/powershell/module/exchange/get-spoofmailreport", + "redirect_url": "/powershell/module/exchangepowershell/get-spoofmailreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-UrlTrace.md", - "redirect_url": "/powershell/module/exchange/get-safelinksaggregatereport", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksaggregatereport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-AntiPhishPolicy.md", - "redirect_url": "/powershell/module/exchange/new-antiphishpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-antiphishpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/new-antiphishrule", + "redirect_url": "/powershell/module/exchangepowershell/new-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeAttachmentPolicy.md", - "redirect_url": "/powershell/module/exchange/new-safeattachmentpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-safeattachmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/new-safeattachmentrule", + "redirect_url": "/powershell/module/exchangepowershell/new-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeLinksPolicy.md", - "redirect_url": "/powershell/module/exchange/new-safelinkspolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-safelinkspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/new-safelinksrule", + "redirect_url": "/powershell/module/exchangepowershell/new-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-AntiPhishPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-antiphishpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-antiphishpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/remove-antiphishrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeAttachmentPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-safeattachmentpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-safeattachmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/remove-safeattachmentrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeLinksPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-safelinkspolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-safelinkspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/remove-safelinksrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AntiPhishPolicy.md", - "redirect_url": "/powershell/module/exchange/set-antiphishpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-antiphishpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AntiPhishRule.md", - "redirect_url": "/powershell/module/exchange/set-antiphishrule", + "redirect_url": "/powershell/module/exchangepowershell/set-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AtpPolicyForO365.md", - "redirect_url": "/powershell/module/exchange/set-atppolicyforo365", + "redirect_url": "/powershell/module/exchangepowershell/set-atppolicyforo365", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-tenantallowblocklistspoofitems", + "redirect_url": "/powershell/module/exchangepowershell/set-tenantallowblocklistspoofitems", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeAttachmentPolicy.md", - "redirect_url": "/powershell/module/exchange/set-safeattachmentpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-safeattachmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeAttachmentRule.md", - "redirect_url": "/powershell/module/exchange/set-safeattachmentrule", + "redirect_url": "/powershell/module/exchangepowershell/set-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeLinksPolicy.md", - "redirect_url": "/powershell/module/exchange/set-safelinkspolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-safelinkspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeLinksRule.md", - "redirect_url": "/powershell/module/exchange/set-safelinksrule", + "redirect_url": "/powershell/module/exchangepowershell/set-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-AttachmentFilterEntry.md", - "redirect_url": "/powershell/module/exchange/add-attachmentfilterentry", + "redirect_url": "/powershell/module/exchangepowershell/add-attachmentfilterentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-ContentFilterPhrase.md", - "redirect_url": "/powershell/module/exchange/add-contentfilterphrase", + "redirect_url": "/powershell/module/exchangepowershell/add-contentfilterphrase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPAllowListEntry.md", - "redirect_url": "/powershell/module/exchange/add-ipallowlistentry", + "redirect_url": "/powershell/module/exchangepowershell/add-ipallowlistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPAllowListProvider.md", - "redirect_url": "/powershell/module/exchange/add-ipallowlistprovider", + "redirect_url": "/powershell/module/exchangepowershell/add-ipallowlistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPBlockListEntry.md", - "redirect_url": "/powershell/module/exchange/add-ipblocklistentry", + "redirect_url": "/powershell/module/exchangepowershell/add-ipblocklistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPBlockListProvider.md", - "redirect_url": "/powershell/module/exchange/add-ipblocklistprovider", + "redirect_url": "/powershell/module/exchangepowershell/add-ipblocklistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Delete-QuarantineMessage.md", - "redirect_url": "/powershell/module/exchange/delete-quarantinemessage", + "redirect_url": "/powershell/module/exchangepowershell/delete-quarantinemessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/disable-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/disable-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/disable-malwarefilterrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-AntispamUpdates.md", - "redirect_url": "/powershell/module/exchange/enable-antispamupdates", + "redirect_url": "/powershell/module/exchangepowershell/enable-antispamupdates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/enable-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/enable-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/enable-malwarefilterrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Export-QuarantineMessage.md", - "redirect_url": "/powershell/module/exchange/export-quarantinemessage", + "redirect_url": "/powershell/module/exchangepowershell/export-quarantinemessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AgentLog.md", - "redirect_url": "/powershell/module/exchange/get-agentlog", + "redirect_url": "/powershell/module/exchangepowershell/get-agentlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AttachmentFilterEntry.md", - "redirect_url": "/powershell/module/exchange/get-attachmentfilterentry", + "redirect_url": "/powershell/module/exchangepowershell/get-attachmentfilterentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AttachmentFilterListConfig.md", - "redirect_url": "/powershell/module/exchange/get-attachmentfilterlistconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-attachmentfilterlistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-BlockedSenderAddress.md", - "redirect_url": "/powershell/module/exchange/get-blockedsenderaddress", + "redirect_url": "/powershell/module/exchangepowershell/get-blockedsenderaddress", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-ContentFilterConfig.md", - "redirect_url": "/powershell/module/exchange/get-contentfilterconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-contentfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-ContentFilterPhrase.md", - "redirect_url": "/powershell/module/exchange/get-contentfilterphrase", + "redirect_url": "/powershell/module/exchangepowershell/get-contentfilterphrase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-DkimSigningConfig.md", - "redirect_url": "/powershell/module/exchange/get-dkimsigningconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-dkimsigningconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedConnectionFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-hostedconnectionfilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedconnectionfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedContentFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-hostedcontentfilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedcontentfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/get-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-hostedoutboundspamfilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedoutboundspamfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/get-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListConfig.md", - "redirect_url": "/powershell/module/exchange/get-ipallowlistconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListEntry.md", - "redirect_url": "/powershell/module/exchange/get-ipallowlistentry", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListProvider.md", - "redirect_url": "/powershell/module/exchange/get-ipallowlistprovider", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListProvidersConfig.md", - "redirect_url": "/powershell/module/exchange/get-ipallowlistprovidersconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistprovidersconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListConfig.md", - "redirect_url": "/powershell/module/exchange/get-ipblocklistconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListEntry.md", - "redirect_url": "/powershell/module/exchange/get-ipblocklistentry", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListProvider.md", - "redirect_url": "/powershell/module/exchange/get-ipblocklistprovider", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListProvidersConfig.md", - "redirect_url": "/powershell/module/exchange/get-ipblocklistprovidersconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistprovidersconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MailboxJunkEmailConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxjunkemailconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxjunkemailconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilteringServer.md", - "redirect_url": "/powershell/module/exchange/get-malwarefilteringserver", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilteringserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-malwarefilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/get-malwarefilterrule", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-QuarantineMessage.md", - "redirect_url": "/powershell/module/exchange/get-quarantinemessage", + "redirect_url": "/powershell/module/exchangepowershell/get-quarantinemessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-QuarantineMessageHeader.md", - "redirect_url": "/powershell/module/exchange/get-quarantinemessageheader", + "redirect_url": "/powershell/module/exchangepowershell/get-quarantinemessageheader", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-RecipientFilterConfig.md", - "redirect_url": "/powershell/module/exchange/get-recipientfilterconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderFilterConfig.md", - "redirect_url": "/powershell/module/exchange/get-senderfilterconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-senderfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderIdConfig.md", - "redirect_url": "/powershell/module/exchange/get-senderidconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-senderidconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderReputationConfig.md", - "redirect_url": "/powershell/module/exchange/get-senderreputationconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-senderreputationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-DkimSigningConfig.md", - "redirect_url": "/powershell/module/exchange/new-dkimsigningconfig", + "redirect_url": "/powershell/module/exchangepowershell/new-dkimsigningconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedContentFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/new-hostedcontentfilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedcontentfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/new-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/new-hostedoutboundspamfilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedoutboundspamfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/new-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-MalwareFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/new-malwarefilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-malwarefilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/new-malwarefilterrule", + "redirect_url": "/powershell/module/exchangepowershell/new-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Preview-QuarantineMessage.md", - "redirect_url": "/powershell/module/exchange/preview-quarantinemessage", + "redirect_url": "/powershell/module/exchangepowershell/preview-quarantinemessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Release-QuarantineMessage.md", - "redirect_url": "/powershell/module/exchange/release-quarantinemessage", + "redirect_url": "/powershell/module/exchangepowershell/release-quarantinemessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-AttachmentFilterEntry.md", - "redirect_url": "/powershell/module/exchange/remove-attachmentfilterentry", + "redirect_url": "/powershell/module/exchangepowershell/remove-attachmentfilterentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-BlockedSenderAddress.md", - "redirect_url": "/powershell/module/exchange/remove-blockedsenderaddress", + "redirect_url": "/powershell/module/exchangepowershell/remove-blockedsenderaddress", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-ContentFilterPhrase.md", - "redirect_url": "/powershell/module/exchange/remove-contentfilterphrase", + "redirect_url": "/powershell/module/exchangepowershell/remove-contentfilterphrase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedContentFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-hostedcontentfilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedcontentfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/remove-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-hostedoutboundspamfilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/remove-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPAllowListEntry.md", - "redirect_url": "/powershell/module/exchange/remove-ipallowlistentry", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipallowlistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPAllowListProvider.md", - "redirect_url": "/powershell/module/exchange/remove-ipallowlistprovider", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipallowlistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPBlockListEntry.md", - "redirect_url": "/powershell/module/exchange/remove-ipblocklistentry", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipblocklistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPBlockListProvider.md", - "redirect_url": "/powershell/module/exchange/remove-ipblocklistprovider", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipblocklistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-MalwareFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-malwarefilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-malwarefilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/remove-malwarefilterrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Rotate-DkimSigningConfig.md", - "redirect_url": "/powershell/module/exchange/rotate-dkimsigningconfig", + "redirect_url": "/powershell/module/exchangepowershell/rotate-dkimsigningconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-AttachmentFilterListConfig.md", - "redirect_url": "/powershell/module/exchange/set-attachmentfilterlistconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-attachmentfilterlistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-ContentFilterConfig.md", - "redirect_url": "/powershell/module/exchange/set-contentfilterconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-contentfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-DkimSigningConfig.md", - "redirect_url": "/powershell/module/exchange/set-dkimsigningconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-dkimsigningconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedConnectionFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-hostedconnectionfilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedconnectionfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedContentFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-hostedcontentfilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedcontentfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedContentFilterRule.md", - "redirect_url": "/powershell/module/exchange/set-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-hostedoutboundspamfilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedoutboundspamfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterRule.md", - "redirect_url": "/powershell/module/exchange/set-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListConfig.md", - "redirect_url": "/powershell/module/exchange/set-ipallowlistconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListProvider.md", - "redirect_url": "/powershell/module/exchange/set-ipallowlistprovider", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListProvidersConfig.md", - "redirect_url": "/powershell/module/exchange/set-ipallowlistprovidersconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistprovidersconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListConfig.md", - "redirect_url": "/powershell/module/exchange/set-ipblocklistconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListProvider.md", - "redirect_url": "/powershell/module/exchange/set-ipblocklistprovider", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListProvidersConfig.md", - "redirect_url": "/powershell/module/exchange/set-ipblocklistprovidersconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistprovidersconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MailboxJunkEmailConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxjunkemailconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxjunkemailconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilteringServer.md", - "redirect_url": "/powershell/module/exchange/set-malwarefilteringserver", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilteringserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-malwarefilterpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilterRule.md", - "redirect_url": "/powershell/module/exchange/set-malwarefilterrule", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-RecipientFilterConfig.md", - "redirect_url": "/powershell/module/exchange/set-recipientfilterconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-recipientfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderFilterConfig.md", - "redirect_url": "/powershell/module/exchange/set-senderfilterconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-senderfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderIdConfig.md", - "redirect_url": "/powershell/module/exchange/set-senderidconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-senderidconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderReputationConfig.md", - "redirect_url": "/powershell/module/exchange/set-senderreputationconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-senderreputationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-IPAllowListProvider.md", - "redirect_url": "/powershell/module/exchange/test-ipallowlistprovider", + "redirect_url": "/powershell/module/exchangepowershell/test-ipallowlistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-IPBlockListProvider.md", - "redirect_url": "/powershell/module/exchange/test-ipblocklistprovider", + "redirect_url": "/powershell/module/exchangepowershell/test-ipblocklistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-SenderId.md", - "redirect_url": "/powershell/module/exchange/test-senderid", + "redirect_url": "/powershell/module/exchangepowershell/test-senderid", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Update-SafeList.md", - "redirect_url": "/powershell/module/exchange/update-safelist", + "redirect_url": "/powershell/module/exchangepowershell/update-safelist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Clear-TextMessagingAccount.md", - "redirect_url": "/powershell/module/exchange/clear-textmessagingaccount", + "redirect_url": "/powershell/module/exchangepowershell/clear-textmessagingaccount", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Compare-TextMessagingVerificationCode.md", - "redirect_url": "/powershell/module/exchange/compare-textmessagingverificationcode", + "redirect_url": "/powershell/module/exchangepowershell/compare-textmessagingverificationcode", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Disable-PushNotificationProxy.md", - "redirect_url": "/powershell/module/exchange/disable-pushnotificationproxy", + "redirect_url": "/powershell/module/exchangepowershell/disable-pushnotificationproxy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Enable-PushNotificationProxy.md", - "redirect_url": "/powershell/module/exchange/enable-pushnotificationproxy", + "redirect_url": "/powershell/module/exchangepowershell/enable-pushnotificationproxy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Export-AutoDiscoverConfig.md", - "redirect_url": "/powershell/module/exchange/export-autodiscoverconfig", + "redirect_url": "/powershell/module/exchangepowershell/export-autodiscoverconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-CASMailbox.md", - "redirect_url": "/powershell/module/exchange/get-casmailbox", + "redirect_url": "/powershell/module/exchangepowershell/get-casmailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-CASMailboxPlan.md", - "redirect_url": "/powershell/module/exchange/get-casmailboxplan", + "redirect_url": "/powershell/module/exchangepowershell/get-casmailboxplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-ClientAccessRule.md", - "redirect_url": "/powershell/module/exchange/get-clientaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-ImapSettings.md", - "redirect_url": "/powershell/module/exchange/get-imapsettings", + "redirect_url": "/powershell/module/exchangepowershell/get-imapsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxCalendarConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxcalendarconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxcalendarconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxMessageConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxmessageconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxmessageconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxRegionalConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxregionalconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxregionalconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxSpellingConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxspellingconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxspellingconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-OutlookProvider.md", - "redirect_url": "/powershell/module/exchange/get-outlookprovider", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-OwaMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/get-owamailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-owamailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-PopSettings.md", - "redirect_url": "/powershell/module/exchange/get-popsettings", + "redirect_url": "/powershell/module/exchangepowershell/get-popsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-TextMessagingAccount.md", - "redirect_url": "/powershell/module/exchange/get-textmessagingaccount", + "redirect_url": "/powershell/module/exchangepowershell/get-textmessagingaccount", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/New-ClientAccessRule.md", - "redirect_url": "/powershell/module/exchange/new-clientaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/new-clientaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/New-OutlookProvider.md", - "redirect_url": "/powershell/module/exchange/new-outlookprovider", + "redirect_url": "/powershell/module/exchangepowershell/new-outlookprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/New-OwaMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/new-owamailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-owamailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Remove-ClientAccessRule.md", - "redirect_url": "/powershell/module/exchange/remove-clientaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-clientaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Remove-OutlookProvider.md", - "redirect_url": "/powershell/module/exchange/remove-outlookprovider", + "redirect_url": "/powershell/module/exchangepowershell/remove-outlookprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Remove-OwaMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-owamailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-owamailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Send-TextMessagingVerificationCode.md", - "redirect_url": "/powershell/module/exchange/send-textmessagingverificationcode", + "redirect_url": "/powershell/module/exchangepowershell/send-textmessagingverificationcode", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-CASMailbox.md", - "redirect_url": "/powershell/module/exchange/set-casmailbox", + "redirect_url": "/powershell/module/exchangepowershell/set-casmailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/set-CASMailboxPlan.md", - "redirect_url": "/powershell/module/exchange/set-casmailboxplan", + "redirect_url": "/powershell/module/exchangepowershell/set-casmailboxplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-ClientAccessRule.md", - "redirect_url": "/powershell/module/exchange/set-clientaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-ImapSettings.md", - "redirect_url": "/powershell/module/exchange/set-imapsettings", + "redirect_url": "/powershell/module/exchangepowershell/set-imapsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxCalendarConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxcalendarconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxcalendarconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxMessageConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxmessageconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxmessageconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxRegionalConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxregionalconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxregionalconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxSpellingConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxspellingconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxspellingconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-OutlookProvider.md", - "redirect_url": "/powershell/module/exchange/set-outlookprovider", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-OwaMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/set-owamailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-owamailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-PopSettings.md", - "redirect_url": "/powershell/module/exchange/set-popsettings", + "redirect_url": "/powershell/module/exchangepowershell/set-popsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-TextMessagingAccount.md", - "redirect_url": "/powershell/module/exchange/set-textmessagingaccount", + "redirect_url": "/powershell/module/exchangepowershell/set-textmessagingaccount", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-CalendarConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-calendarconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-calendarconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-ClientAccessRule.md", - "redirect_url": "/powershell/module/exchange/test-clientaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/test-clientaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-EcpConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-ecpconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-ecpconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-ImapConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-imapconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-imapconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-OutlookConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-outlookconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-outlookconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-OutlookWebServices.md", - "redirect_url": "/powershell/module/exchange/test-outlookwebservices", + "redirect_url": "/powershell/module/exchangepowershell/test-outlookwebservices", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-OwaConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-owaconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-owaconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-PopConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-popconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-popconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-PowerShellConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-powershellconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-powershellconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-WebServicesConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-webservicesconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-webservicesconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Disable-OutlookAnywhere.md", - "redirect_url": "/powershell/module/exchange/disable-outlookanywhere", + "redirect_url": "/powershell/module/exchangepowershell/disable-outlookanywhere", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Enable-OutlookAnywhere.md", - "redirect_url": "/powershell/module/exchange/enable-outlookanywhere", + "redirect_url": "/powershell/module/exchangepowershell/enable-outlookanywhere", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ActiveSyncVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-activesyncvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-AuthRedirect.md", - "redirect_url": "/powershell/module/exchange/get-authredirect", + "redirect_url": "/powershell/module/exchangepowershell/get-authredirect", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-AutodiscoverVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-autodiscovervirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/get-autodiscovervirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessArray.md", - "redirect_url": "/powershell/module/exchange/get-clientaccessarray", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessarray", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessServer.md", - "redirect_url": "/powershell/module/exchange/get-clientaccessserver", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessService.md", - "redirect_url": "/powershell/module/exchange/get-clientaccessservice", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-EcpVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-ecpvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/get-ecpvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-MapiVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-mapivirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/get-mapivirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-OutlookAnywhere.md", - "redirect_url": "/powershell/module/exchange/get-outlookanywhere", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookanywhere", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-OwaVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-owavirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/get-owavirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-PowerShellVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-powershellvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/get-powershellvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-RpcClientAccess.md", - "redirect_url": "/powershell/module/exchange/get-rpcclientaccess", + "redirect_url": "/powershell/module/exchangepowershell/get-rpcclientaccess", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-WebServicesVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-webservicesvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/get-webservicesvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-ActiveSyncVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-activesyncvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-AuthRedirect.md", - "redirect_url": "/powershell/module/exchange/new-authredirect", + "redirect_url": "/powershell/module/exchangepowershell/new-authredirect", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-AutodiscoverVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-autodiscovervirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/new-autodiscovervirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-ClientAccessArray.md", - "redirect_url": "/powershell/module/exchange/new-clientaccessarray", + "redirect_url": "/powershell/module/exchangepowershell/new-clientaccessarray", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-EcpVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-ecpvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/new-ecpvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-MapiVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-mapivirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/new-mapivirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-OwaVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-owavirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/new-owavirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-PowerShellVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-powershellvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/new-powershellvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-RpcClientAccess.md", - "redirect_url": "/powershell/module/exchange/new-rpcclientaccess", + "redirect_url": "/powershell/module/exchangepowershell/new-rpcclientaccess", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-WebServicesVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-webservicesvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/new-webservicesvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-ActiveSyncVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-activesyncvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-AuthRedirect.md", - "redirect_url": "/powershell/module/exchange/remove-authredirect", + "redirect_url": "/powershell/module/exchangepowershell/remove-authredirect", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-AutodiscoverVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-autodiscovervirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/remove-autodiscovervirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-ClientAccessArray.md", - "redirect_url": "/powershell/module/exchange/remove-clientaccessarray", + "redirect_url": "/powershell/module/exchangepowershell/remove-clientaccessarray", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-EcpVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-ecpvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/remove-ecpvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-MapiVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-mapivirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/remove-mapivirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-OwaVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-owavirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/remove-owavirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-PowerShellVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-powershellvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/remove-powershellvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-RpcClientAccess.md", - "redirect_url": "/powershell/module/exchange/remove-rpcclientaccess", + "redirect_url": "/powershell/module/exchangepowershell/remove-rpcclientaccess", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-WebServicesVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-webservicesvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/remove-webservicesvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ActiveSyncVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-activesyncvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-AuthRedirect.md", - "redirect_url": "/powershell/module/exchange/set-authredirect", + "redirect_url": "/powershell/module/exchangepowershell/set-authredirect", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-AutodiscoverVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-autodiscovervirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/set-autodiscovervirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessArray.md", - "redirect_url": "/powershell/module/exchange/set-clientaccessarray", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessarray", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessServer.md", - "redirect_url": "/powershell/module/exchange/set-clientaccessserver", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessService.md", - "redirect_url": "/powershell/module/exchange/set-clientaccessservice", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-EcpVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-ecpvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/set-ecpvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-MapiVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-mapivirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/set-mapivirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-OutlookAnywhere.md", - "redirect_url": "/powershell/module/exchange/set-outlookanywhere", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookanywhere", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-OwaVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-owavirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/set-owavirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-PowerShellVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-powershellvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/set-powershellvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-RpcClientAccess.md", - "redirect_url": "/powershell/module/exchange/set-rpcclientaccess", + "redirect_url": "/powershell/module/exchangepowershell/set-rpcclientaccess", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-WebServicesVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-webservicesvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/set-webservicesvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Add-DatabaseAvailabilityGroupServer.md", - "redirect_url": "/powershell/module/exchange/add-databaseavailabilitygroupserver", + "redirect_url": "/powershell/module/exchangepowershell/add-databaseavailabilitygroupserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Add-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/add-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/get-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchangepowershell/get-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "/powershell/module/exchange/get-databaseavailabilitygroupnetwork", + "redirect_url": "/powershell/module/exchangepowershell/get-databaseavailabilitygroupnetwork", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-MailboxDatabaseCopyStatus.md", - "redirect_url": "/powershell/module/exchange/get-mailboxdatabasecopystatus", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxdatabasecopystatus", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Move-ActiveMailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/move-activemailboxdatabase", + "redirect_url": "/powershell/module/exchangepowershell/move-activemailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/New-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/new-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchangepowershell/new-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/New-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "/powershell/module/exchange/new-databaseavailabilitygroupnetwork", + "redirect_url": "/powershell/module/exchangepowershell/new-databaseavailabilitygroupnetwork", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/remove-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "/powershell/module/exchange/remove-databaseavailabilitygroupnetwork", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroupnetwork", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupServer.md", - "redirect_url": "/powershell/module/exchange/remove-databaseavailabilitygroupserver", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroupserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Restore-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/restore-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchangepowershell/restore-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Resume-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/resume-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/set-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchangepowershell/set-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "/powershell/module/exchange/set-databaseavailabilitygroupnetwork", + "redirect_url": "/powershell/module/exchangepowershell/set-databaseavailabilitygroupnetwork", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/set-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Start-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/start-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchangepowershell/start-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Stop-DatabaseAvailabilityGroup.md", - "redirect_url": "/powershell/module/exchange/stop-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchangepowershell/stop-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Suspend-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/suspend-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Test-ReplicationHealth.md", - "redirect_url": "/powershell/module/exchange/test-replicationhealth", + "redirect_url": "/powershell/module/exchangepowershell/test-replicationhealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Update-MailboxDatabaseCopy.md", - "redirect_url": "/powershell/module/exchange/update-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchangepowershell/update-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Clear-ActiveSyncDevice.md", - "redirect_url": "/powershell/module/exchange/clear-activesyncdevice", + "redirect_url": "/powershell/module/exchangepowershell/clear-activesyncdevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Clear-MobileDevice.md", - "redirect_url": "/powershell/module/exchange/clear-mobiledevice", + "redirect_url": "/powershell/module/exchangepowershell/clear-mobiledevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Export-ActiveSyncLog.md", - "redirect_url": "/powershell/module/exchange/export-activesynclog", + "redirect_url": "/powershell/module/exchangepowershell/export-activesynclog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDevice.md", - "redirect_url": "/powershell/module/exchange/get-activesyncdevice", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceAccessRule.md", - "redirect_url": "/powershell/module/exchange/get-activesyncdeviceaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceAutoblockThreshold.md", - "redirect_url": "/powershell/module/exchange/get-activesyncdeviceautoblockthreshold", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceautoblockthreshold", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceClass.md", - "redirect_url": "/powershell/module/exchange/get-activesyncdeviceclass", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceclass", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceStatistics.md", - "redirect_url": "/powershell/module/exchange/get-activesyncdevicestatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdevicestatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/get-activesyncmailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncmailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncOrganizationSettings.md", - "redirect_url": "/powershell/module/exchange/get-activesyncorganizationsettings", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncorganizationsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConditionalAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/get-deviceconditionalaccesspolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconditionalaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConditionalAccessRule.md", - "redirect_url": "/powershell/module/exchange/get-deviceconditionalaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconditionalaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/get-deviceconfigurationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/get-deviceconfigurationrule", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DevicePolicy.md", - "redirect_url": "/powershell/module/exchange/get-devicepolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-devicepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceTenantPolicy.md", - "redirect_url": "/powershell/module/exchange/get-devicetenantpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-devicetenantpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceTenantRule.md", - "redirect_url": "/powershell/module/exchange/get-devicetenantrule", + "redirect_url": "/powershell/module/exchangepowershell/get-devicetenantrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDevice.md", - "redirect_url": "/powershell/module/exchange/get-mobiledevice", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDeviceMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/get-mobiledevicemailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevicemailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDeviceStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mobiledevicestatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevicestatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-ActiveSyncDeviceAccessRule.md", - "redirect_url": "/powershell/module/exchange/new-activesyncdeviceaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncdeviceaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-ActiveSyncMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/new-activesyncmailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncmailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConditionalAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/new-deviceconditionalaccesspolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconditionalaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConditionalAccessRule.md", - "redirect_url": "/powershell/module/exchange/new-deviceconditionalaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconditionalaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/new-deviceconfigurationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/new-deviceconfigurationrule", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceTenantPolicy.md", - "redirect_url": "/powershell/module/exchange/new-devicetenantpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-devicetenantpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceTenantRule.md", - "redirect_url": "/powershell/module/exchange/new-devicetenantrule", + "redirect_url": "/powershell/module/exchangepowershell/new-devicetenantrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-MobileDeviceMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/new-mobiledevicemailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-mobiledevicemailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDevice.md", - "redirect_url": "/powershell/module/exchange/remove-activesyncdevice", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDeviceAccessRule.md", - "redirect_url": "/powershell/module/exchange/remove-activesyncdeviceaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdeviceaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDeviceClass.md", - "redirect_url": "/powershell/module/exchange/remove-activesyncdeviceclass", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdeviceclass", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-activesyncmailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncmailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConditionalAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-deviceconditionalaccesspolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconditionalaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConditionalAccessRule.md", - "redirect_url": "/powershell/module/exchange/remove-deviceconditionalaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconditionalaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-deviceconfigurationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/remove-deviceconfigurationrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceTenantPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-devicetenantpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-devicetenantpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceTenantRule.md", - "redirect_url": "/powershell/module/exchange/remove-devicetenantrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-devicetenantrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-MobileDevice.md", - "redirect_url": "/powershell/module/exchange/remove-mobiledevice", + "redirect_url": "/powershell/module/exchangepowershell/remove-mobiledevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-MobileDeviceMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-mobiledevicemailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-mobiledevicemailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncDeviceAccessRule.md", - "redirect_url": "/powershell/module/exchange/set-activesyncdeviceaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncdeviceaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncDeviceAutoblockThreshold.md", - "redirect_url": "/powershell/module/exchange/set-activesyncdeviceautoblockthreshold", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncdeviceautoblockthreshold", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/set-activesyncmailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncmailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncOrganizationSettings.md", - "redirect_url": "/powershell/module/exchange/set-activesyncorganizationsettings", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncorganizationsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConditionalAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/set-deviceconditionalaccesspolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconditionalaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConditionalAccessRule.md", - "redirect_url": "/powershell/module/exchange/set-deviceconditionalaccessrule", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconditionalaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/set-deviceconfigurationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/set-deviceconfigurationrule", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceTenantPolicy.md", - "redirect_url": "/powershell/module/exchange/set-devicetenantpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-devicetenantpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceTenantRule.md", - "redirect_url": "/powershell/module/exchange/set-devicetenantrule", + "redirect_url": "/powershell/module/exchangepowershell/set-devicetenantrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-MobileDeviceMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/set-mobiledevicemailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-mobiledevicemailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Test-ActiveSyncConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-activesyncconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-activesyncconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Disable-AddressListPaging.md", - "redirect_url": "/powershell/module/exchange/disable-addresslistpaging", + "redirect_url": "/powershell/module/exchangepowershell/disable-addresslistpaging", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Enable-AddressListPaging.md", - "redirect_url": "/powershell/module/exchange/enable-addresslistpaging", + "redirect_url": "/powershell/module/exchangepowershell/enable-addresslistpaging", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-AddressBookPolicy.md", - "redirect_url": "/powershell/module/exchange/get-addressbookpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-addressbookpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-AddressList.md", - "redirect_url": "/powershell/module/exchange/get-addresslist", + "redirect_url": "/powershell/module/exchangepowershell/get-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-DetailsTemplate.md", - "redirect_url": "/powershell/module/exchange/get-detailstemplate", + "redirect_url": "/powershell/module/exchangepowershell/get-detailstemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-EmailAddressPolicy.md", - "redirect_url": "/powershell/module/exchange/get-emailaddresspolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-emailaddresspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-GlobalAddressList.md", - "redirect_url": "/powershell/module/exchange/get-globaladdresslist", + "redirect_url": "/powershell/module/exchangepowershell/get-globaladdresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-OabVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/get-oabvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/get-oabvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/get-offlineaddressbook", + "redirect_url": "/powershell/module/exchangepowershell/get-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Move-AddressList.md", - "redirect_url": "/powershell/module/exchange/move-addresslist", + "redirect_url": "/powershell/module/exchangepowershell/move-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Move-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/move-offlineaddressbook", + "redirect_url": "/powershell/module/exchangepowershell/move-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-AddressBookPolicy.md", - "redirect_url": "/powershell/module/exchange/new-addressbookpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-addressbookpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-AddressList.md", - "redirect_url": "/powershell/module/exchange/new-addresslist", + "redirect_url": "/powershell/module/exchangepowershell/new-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-EmailAddressPolicy.md", - "redirect_url": "/powershell/module/exchange/new-emailaddresspolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-emailaddresspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-GlobalAddressList.md", - "redirect_url": "/powershell/module/exchange/new-globaladdresslist", + "redirect_url": "/powershell/module/exchangepowershell/new-globaladdresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-OabVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/new-oabvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/new-oabvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/new-offlineaddressbook", + "redirect_url": "/powershell/module/exchangepowershell/new-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-AddressBookPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-addressbookpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-addressbookpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-AddressList.md", - "redirect_url": "/powershell/module/exchange/remove-addresslist", + "redirect_url": "/powershell/module/exchangepowershell/remove-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-EmailAddressPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-emailaddresspolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-emailaddresspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-GlobalAddressList.md", - "redirect_url": "/powershell/module/exchange/remove-globaladdresslist", + "redirect_url": "/powershell/module/exchangepowershell/remove-globaladdresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-OabVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/remove-oabvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/remove-oabvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/remove-offlineaddressbook", + "redirect_url": "/powershell/module/exchangepowershell/remove-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Restore-DetailsTemplate.md", - "redirect_url": "/powershell/module/exchange/restore-detailstemplate", + "redirect_url": "/powershell/module/exchangepowershell/restore-detailstemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-AddressBookPolicy.md", - "redirect_url": "/powershell/module/exchange/set-addressbookpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-addressbookpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-AddressList.md", - "redirect_url": "/powershell/module/exchange/set-addresslist", + "redirect_url": "/powershell/module/exchangepowershell/set-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-DetailsTemplate.md", - "redirect_url": "/powershell/module/exchange/set-detailstemplate", + "redirect_url": "/powershell/module/exchangepowershell/set-detailstemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-EmailAddressPolicy.md", - "redirect_url": "/powershell/module/exchange/set-emailaddresspolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-emailaddresspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-GlobalAddressList.md", - "redirect_url": "/powershell/module/exchange/set-globaladdresslist", + "redirect_url": "/powershell/module/exchangepowershell/set-globaladdresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-OabVirtualDirectory.md", - "redirect_url": "/powershell/module/exchange/set-oabvirtualdirectory", + "redirect_url": "/powershell/module/exchangepowershell/set-oabvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/set-offlineaddressbook", + "redirect_url": "/powershell/module/exchangepowershell/set-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-AddressList.md", - "redirect_url": "/powershell/module/exchange/update-addresslist", + "redirect_url": "/powershell/module/exchangepowershell/update-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-EmailAddressPolicy.md", - "redirect_url": "/powershell/module/exchange/update-emailaddresspolicy", + "redirect_url": "/powershell/module/exchangepowershell/update-emailaddresspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-GlobalAddressList.md", - "redirect_url": "/powershell/module/exchange/update-globaladdresslist", + "redirect_url": "/powershell/module/exchangepowershell/update-globaladdresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-OfflineAddressBook.md", - "redirect_url": "/powershell/module/exchange/update-offlineaddressbook", + "redirect_url": "/powershell/module/exchangepowershell/update-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Enable-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/enable-exchangecertificate", + "redirect_url": "/powershell/module/exchangepowershell/enable-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Export-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/export-exchangecertificate", + "redirect_url": "/powershell/module/exchangepowershell/export-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-DataEncryptionPolicy.md", - "redirect_url": "/powershell/module/exchange/get-dataencryptionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-dataencryptionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/get-exchangecertificate", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-IRMConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-irmconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-irmconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-OMEConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-omeconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-omeconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-OMEMessageStatus.md", - "redirect_url": "/powershell/module/exchange/get-omemessagestatus", + "redirect_url": "/powershell/module/exchangepowershell/get-omemessagestatus", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-RMSTemplate.md", - "redirect_url": "/powershell/module/exchange/get-rmstemplate", + "redirect_url": "/powershell/module/exchangepowershell/get-rmstemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-SmimeConfig.md", - "redirect_url": "/powershell/module/exchange/get-smimeconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-smimeconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Import-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/import-exchangecertificate", + "redirect_url": "/powershell/module/exchangepowershell/import-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Import-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-DataEncryptionPolicy.md", - "redirect_url": "/powershell/module/exchange/new-dataencryptionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-dataencryptionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/new-exchangecertificate", + "redirect_url": "/powershell/module/exchangepowershell/new-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-OMEConfiguration.md", - "redirect_url": "/powershell/module/exchange/new-omeconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/new-omeconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-ExchangeCertificate.md", - "redirect_url": "/powershell/module/exchange/remove-exchangecertificate", + "redirect_url": "/powershell/module/exchangepowershell/remove-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-OMEConfiguration.md", - "redirect_url": "/powershell/module/exchange/remove-omeconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/remove-omeconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-DataEncryptionPolicy.md", - "redirect_url": "/powershell/module/exchange/set-dataencryptionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-dataencryptionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-IRMConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-irmconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/set-irmconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-OMEConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-omeconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/set-omeconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-OMEMessageRevocation.md", - "redirect_url": "/powershell/module/exchange/set-omemessagerevocation", + "redirect_url": "/powershell/module/exchangepowershell/set-omemessagerevocation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-RMSTemplate.md", - "redirect_url": "/powershell/module/exchange/set-rmstemplate", + "redirect_url": "/powershell/module/exchangepowershell/set-rmstemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-SmimeConfig.md", - "redirect_url": "/powershell/module/exchange/set-smimeconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-smimeconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Test-IRMConfiguration.md", - "redirect_url": "/powershell/module/exchange/test-irmconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/test-irmconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Add-FederatedDomain.md", - "redirect_url": "/powershell/module/exchange/add-federateddomain", + "redirect_url": "/powershell/module/exchangepowershell/add-federateddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Disable-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/disable-remotemailbox", + "redirect_url": "/powershell/module/exchangepowershell/disable-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Enable-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/enable-remotemailbox", + "redirect_url": "/powershell/module/exchangepowershell/enable-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederatedDomainProof.md", - "redirect_url": "/powershell/module/exchange/get-federateddomainproof", + "redirect_url": "/powershell/module/exchangepowershell/get-federateddomainproof", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederatedOrganizationIdentifier.md", - "redirect_url": "/powershell/module/exchange/get-federatedorganizationidentifier", + "redirect_url": "/powershell/module/exchangepowershell/get-federatedorganizationidentifier", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederationInformation.md", - "redirect_url": "/powershell/module/exchange/get-federationinformation", + "redirect_url": "/powershell/module/exchangepowershell/get-federationinformation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederationTrust.md", - "redirect_url": "/powershell/module/exchange/get-federationtrust", + "redirect_url": "/powershell/module/exchangepowershell/get-federationtrust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-hybridconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-hybridconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridMailflow.md", - "redirect_url": "/powershell/module/exchange/get-hybridmailflow", + "redirect_url": "/powershell/module/exchangepowershell/get-hybridmailflow", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridMailflowDatacenterIPs.md", - "redirect_url": "/powershell/module/exchange/get-hybridmailflowdatacenterips", + "redirect_url": "/powershell/module/exchangepowershell/get-hybridmailflowdatacenterips", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-IntraOrganizationConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-intraorganizationconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-intraorganizationconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-IntraOrganizationConnector.md", - "redirect_url": "/powershell/module/exchange/get-intraorganizationconnector", + "redirect_url": "/powershell/module/exchangepowershell/get-intraorganizationconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-OnPremisesOrganization.md", - "redirect_url": "/powershell/module/exchange/get-onpremisesorganization", + "redirect_url": "/powershell/module/exchangepowershell/get-onpremisesorganization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-PendingFederatedDomain.md", - "redirect_url": "/powershell/module/exchange/get-pendingfederateddomain", + "redirect_url": "/powershell/module/exchangepowershell/get-pendingfederateddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/get-remotemailbox", + "redirect_url": "/powershell/module/exchangepowershell/get-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-FederationTrust.md", - "redirect_url": "/powershell/module/exchange/new-federationtrust", + "redirect_url": "/powershell/module/exchangepowershell/new-federationtrust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-HybridConfiguration.md", - "redirect_url": "/powershell/module/exchange/new-hybridconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/new-hybridconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-IntraOrganizationConnector.md", - "redirect_url": "/powershell/module/exchange/new-intraorganizationconnector", + "redirect_url": "/powershell/module/exchangepowershell/new-intraorganizationconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-OnPremisesOrganization.md", - "redirect_url": "/powershell/module/exchange/new-onpremisesorganization", + "redirect_url": "/powershell/module/exchangepowershell/new-onpremisesorganization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/new-remotemailbox", + "redirect_url": "/powershell/module/exchangepowershell/new-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-FederatedDomain.md", - "redirect_url": "/powershell/module/exchange/remove-federateddomain", + "redirect_url": "/powershell/module/exchangepowershell/remove-federateddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-FederationTrust.md", - "redirect_url": "/powershell/module/exchange/remove-federationtrust", + "redirect_url": "/powershell/module/exchangepowershell/remove-federationtrust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-HybridConfiguration.md", - "redirect_url": "/powershell/module/exchange/remove-hybridconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/remove-hybridconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-IntraOrganizationConnector.md", - "redirect_url": "/powershell/module/exchange/remove-intraorganizationconnector", + "redirect_url": "/powershell/module/exchangepowershell/remove-intraorganizationconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-OnPremisesOrganization.md", - "redirect_url": "/powershell/module/exchange/remove-onpremisesorganization", + "redirect_url": "/powershell/module/exchangepowershell/remove-onpremisesorganization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/remove-remotemailbox", + "redirect_url": "/powershell/module/exchangepowershell/remove-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-FederatedOrganizationIdentifier.md", - "redirect_url": "/powershell/module/exchange/set-federatedorganizationidentifier", + "redirect_url": "/powershell/module/exchangepowershell/set-federatedorganizationidentifier", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-FederationTrust.md", - "redirect_url": "/powershell/module/exchange/set-federationtrust", + "redirect_url": "/powershell/module/exchangepowershell/set-federationtrust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-HybridConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-hybridconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/set-hybridconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-HybridMailflow.md", - "redirect_url": "/powershell/module/exchange/set-hybridmailflow", + "redirect_url": "/powershell/module/exchangepowershell/set-hybridmailflow", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-IntraOrganizationConnector.md", - "redirect_url": "/powershell/module/exchange/set-intraorganizationconnector", + "redirect_url": "/powershell/module/exchangepowershell/set-intraorganizationconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-OnPremisesOrganization.md", - "redirect_url": "/powershell/module/exchange/set-onpremisesorganization", + "redirect_url": "/powershell/module/exchangepowershell/set-onpremisesorganization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-PendingFederatedDomain.md", - "redirect_url": "/powershell/module/exchange/set-pendingfederateddomain", + "redirect_url": "/powershell/module/exchangepowershell/set-pendingfederateddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-RemoteMailbox.md", - "redirect_url": "/powershell/module/exchange/set-remotemailbox", + "redirect_url": "/powershell/module/exchangepowershell/set-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Test-FederationTrust.md", - "redirect_url": "/powershell/module/exchange/test-federationtrust", + "redirect_url": "/powershell/module/exchangepowershell/test-federationtrust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Test-FederationTrustCertificate.md", - "redirect_url": "/powershell/module/exchange/test-federationtrustcertificate", + "redirect_url": "/powershell/module/exchangepowershell/test-federationtrustcertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Update-HybridConfiguration.md", - "redirect_url": "/powershell/module/exchange/update-hybridconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/update-hybridconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Update-Recipient.md", - "redirect_url": "/powershell/module/exchange/update-recipient", + "redirect_url": "/powershell/module/exchangepowershell/update-recipient", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Add-ResubmitRequest.md", - "redirect_url": "/powershell/module/exchange/add-resubmitrequest", + "redirect_url": "/powershell/module/exchangepowershell/add-resubmitrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Disable-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/disable-transportagent", + "redirect_url": "/powershell/module/exchangepowershell/disable-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Enable-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/enable-transportagent", + "redirect_url": "/powershell/module/exchangepowershell/enable-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Export-Message.md", - "redirect_url": "/powershell/module/exchange/export-message", + "redirect_url": "/powershell/module/exchangepowershell/export-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-AcceptedDomain.md", - "redirect_url": "/powershell/module/exchange/get-accepteddomain", + "redirect_url": "/powershell/module/exchangepowershell/get-accepteddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-AddressRewriteEntry.md", - "redirect_url": "/powershell/module/exchange/get-addressrewriteentry", + "redirect_url": "/powershell/module/exchangepowershell/get-addressrewriteentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-DeliveryAgentConnector.md", - "redirect_url": "/powershell/module/exchange/get-deliveryagentconnector", + "redirect_url": "/powershell/module/exchangepowershell/get-deliveryagentconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-EdgeSubscription.md", - "redirect_url": "/powershell/module/exchange/get-edgesubscription", + "redirect_url": "/powershell/module/exchangepowershell/get-edgesubscription", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-EdgeSyncServiceConfig.md", - "redirect_url": "/powershell/module/exchange/get-edgesyncserviceconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-edgesyncserviceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ForeignConnector.md", - "redirect_url": "/powershell/module/exchange/get-foreignconnector", + "redirect_url": "/powershell/module/exchangepowershell/get-foreignconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-FrontendTransportService.md", - "redirect_url": "/powershell/module/exchange/get-frontendtransportservice", + "redirect_url": "/powershell/module/exchangepowershell/get-frontendtransportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-InboundConnector.md", - "redirect_url": "/powershell/module/exchange/get-inboundconnector", + "redirect_url": "/powershell/module/exchangepowershell/get-inboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MailboxTransportService.md", - "redirect_url": "/powershell/module/exchange/get-mailboxtransportservice", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxtransportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-Message.md", - "redirect_url": "/powershell/module/exchange/get-message", + "redirect_url": "/powershell/module/exchangepowershell/get-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrace.md", - "redirect_url": "/powershell/module/exchange/get-messagetrace", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrace", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTraceDetail.md", - "redirect_url": "/powershell/module/exchange/get-messagetracedetail", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetracedetail", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrackingLog.md", - "redirect_url": "/powershell/module/exchange/get-messagetrackinglog", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrackinglog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrackingReport.md", - "redirect_url": "/powershell/module/exchange/get-messagetrackingreport", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrackingreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-NetworkConnectionInfo.md", - "redirect_url": "/powershell/module/exchange/get-networkconnectioninfo", + "redirect_url": "/powershell/module/exchangepowershell/get-networkconnectioninfo", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-OutboundConnector.md", - "redirect_url": "/powershell/module/exchange/get-outboundconnector", + "redirect_url": "/powershell/module/exchangepowershell/get-outboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-Queue.md", - "redirect_url": "/powershell/module/exchange/get-queue", + "redirect_url": "/powershell/module/exchangepowershell/get-queue", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-QueueDigest.md", - "redirect_url": "/powershell/module/exchange/get-queuedigest", + "redirect_url": "/powershell/module/exchangepowershell/get-queuedigest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ReceiveConnector.md", - "redirect_url": "/powershell/module/exchange/get-receiveconnector", + "redirect_url": "/powershell/module/exchangepowershell/get-receiveconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-RemoteDomain.md", - "redirect_url": "/powershell/module/exchange/get-remotedomain", + "redirect_url": "/powershell/module/exchangepowershell/get-remotedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ResubmitRequest.md", - "redirect_url": "/powershell/module/exchange/get-resubmitrequest", + "redirect_url": "/powershell/module/exchangepowershell/get-resubmitrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-RoutingGroupConnector.md", - "redirect_url": "/powershell/module/exchange/get-routinggroupconnector", + "redirect_url": "/powershell/module/exchangepowershell/get-routinggroupconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-SendConnector.md", - "redirect_url": "/powershell/module/exchange/get-sendconnector", + "redirect_url": "/powershell/module/exchangepowershell/get-sendconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-SystemMessage.md", - "redirect_url": "/powershell/module/exchange/get-systemmessage", + "redirect_url": "/powershell/module/exchangepowershell/get-systemmessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/get-transportagent", + "redirect_url": "/powershell/module/exchangepowershell/get-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportConfig.md", - "redirect_url": "/powershell/module/exchange/get-transportconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-transportconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportPipeline.md", - "redirect_url": "/powershell/module/exchange/get-transportpipeline", + "redirect_url": "/powershell/module/exchangepowershell/get-transportpipeline", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportServer.md", - "redirect_url": "/powershell/module/exchange/get-transportserver", + "redirect_url": "/powershell/module/exchangepowershell/get-transportserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportService.md", - "redirect_url": "/powershell/module/exchange/get-transportservice", + "redirect_url": "/powershell/module/exchangepowershell/get-transportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-X400AuthoritativeDomain.md", - "redirect_url": "/powershell/module/exchange/get-x400authoritativedomain", + "redirect_url": "/powershell/module/exchangepowershell/get-x400authoritativedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Install-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/install-transportagent", + "redirect_url": "/powershell/module/exchangepowershell/install-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-AcceptedDomain.md", - "redirect_url": "/powershell/module/exchange/new-accepteddomain", + "redirect_url": "/powershell/module/exchangepowershell/new-accepteddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-AddressRewriteEntry.md", - "redirect_url": "/powershell/module/exchange/new-addressrewriteentry", + "redirect_url": "/powershell/module/exchangepowershell/new-addressrewriteentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-DeliveryAgentConnector.md", - "redirect_url": "/powershell/module/exchange/new-deliveryagentconnector", + "redirect_url": "/powershell/module/exchangepowershell/new-deliveryagentconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-EdgeSubscription.md", - "redirect_url": "/powershell/module/exchange/new-edgesubscription", + "redirect_url": "/powershell/module/exchangepowershell/new-edgesubscription", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-EdgeSyncServiceConfig.md", - "redirect_url": "/powershell/module/exchange/new-edgesyncserviceconfig", + "redirect_url": "/powershell/module/exchangepowershell/new-edgesyncserviceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-ForeignConnector.md", - "redirect_url": "/powershell/module/exchange/new-foreignconnector", + "redirect_url": "/powershell/module/exchangepowershell/new-foreignconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-InboundConnector.md", - "redirect_url": "/powershell/module/exchange/new-inboundconnector", + "redirect_url": "/powershell/module/exchangepowershell/new-inboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-OutboundConnector.md", - "redirect_url": "/powershell/module/exchange/new-outboundconnector", + "redirect_url": "/powershell/module/exchangepowershell/new-outboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-ReceiveConnector.md", - "redirect_url": "/powershell/module/exchange/new-receiveconnector", + "redirect_url": "/powershell/module/exchangepowershell/new-receiveconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-RemoteDomain.md", - "redirect_url": "/powershell/module/exchange/new-remotedomain", + "redirect_url": "/powershell/module/exchangepowershell/new-remotedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-RoutingGroupConnector.md", - "redirect_url": "/powershell/module/exchange/new-routinggroupconnector", + "redirect_url": "/powershell/module/exchangepowershell/new-routinggroupconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-SendConnector.md", - "redirect_url": "/powershell/module/exchange/new-sendconnector", + "redirect_url": "/powershell/module/exchangepowershell/new-sendconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-SystemMessage.md", - "redirect_url": "/powershell/module/exchange/new-systemmessage", + "redirect_url": "/powershell/module/exchangepowershell/new-systemmessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-X400AuthoritativeDomain.md", - "redirect_url": "/powershell/module/exchange/new-x400authoritativedomain", + "redirect_url": "/powershell/module/exchangepowershell/new-x400authoritativedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Redirect-Message.md", - "redirect_url": "/powershell/module/exchange/redirect-message", + "redirect_url": "/powershell/module/exchangepowershell/redirect-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-AcceptedDomain.md", - "redirect_url": "/powershell/module/exchange/remove-accepteddomain", + "redirect_url": "/powershell/module/exchangepowershell/remove-accepteddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-AddressRewriteEntry.md", - "redirect_url": "/powershell/module/exchange/remove-addressrewriteentry", + "redirect_url": "/powershell/module/exchangepowershell/remove-addressrewriteentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-DeliveryAgentConnector.md", - "redirect_url": "/powershell/module/exchange/remove-deliveryagentconnector", + "redirect_url": "/powershell/module/exchangepowershell/remove-deliveryagentconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-EdgeSubscription.md", - "redirect_url": "/powershell/module/exchange/remove-edgesubscription", + "redirect_url": "/powershell/module/exchangepowershell/remove-edgesubscription", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ForeignConnector.md", - "redirect_url": "/powershell/module/exchange/remove-foreignconnector", + "redirect_url": "/powershell/module/exchangepowershell/remove-foreignconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-InboundConnector.md", - "redirect_url": "/powershell/module/exchange/remove-inboundconnector", + "redirect_url": "/powershell/module/exchangepowershell/remove-inboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-Message.md", - "redirect_url": "/powershell/module/exchange/remove-message", + "redirect_url": "/powershell/module/exchangepowershell/remove-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-OutboundConnector.md", - "redirect_url": "/powershell/module/exchange/remove-outboundconnector", + "redirect_url": "/powershell/module/exchangepowershell/remove-outboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ReceiveConnector.md", - "redirect_url": "/powershell/module/exchange/remove-receiveconnector", + "redirect_url": "/powershell/module/exchangepowershell/remove-receiveconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-RemoteDomain.md", - "redirect_url": "/powershell/module/exchange/remove-remotedomain", + "redirect_url": "/powershell/module/exchangepowershell/remove-remotedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ResubmitRequest.md", - "redirect_url": "/powershell/module/exchange/remove-resubmitrequest", + "redirect_url": "/powershell/module/exchangepowershell/remove-resubmitrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-RoutingGroupConnector.md", - "redirect_url": "/powershell/module/exchange/remove-routinggroupconnector", + "redirect_url": "/powershell/module/exchangepowershell/remove-routinggroupconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-SendConnector.md", - "redirect_url": "/powershell/module/exchange/remove-sendconnector", + "redirect_url": "/powershell/module/exchangepowershell/remove-sendconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-SystemMessage.md", - "redirect_url": "/powershell/module/exchange/remove-systemmessage", + "redirect_url": "/powershell/module/exchangepowershell/remove-systemmessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-X400AuthoritativeDomain.md", - "redirect_url": "/powershell/module/exchange/remove-x400authoritativedomain", + "redirect_url": "/powershell/module/exchangepowershell/remove-x400authoritativedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Resume-Message.md", - "redirect_url": "/powershell/module/exchange/resume-message", + "redirect_url": "/powershell/module/exchangepowershell/resume-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Resume-Queue.md", - "redirect_url": "/powershell/module/exchange/resume-queue", + "redirect_url": "/powershell/module/exchangepowershell/resume-queue", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Retry-Queue.md", - "redirect_url": "/powershell/module/exchange/retry-queue", + "redirect_url": "/powershell/module/exchangepowershell/retry-queue", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Search-MessageTrackingReport.md", - "redirect_url": "/powershell/module/exchange/search-messagetrackingreport", + "redirect_url": "/powershell/module/exchangepowershell/search-messagetrackingreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-AcceptedDomain.md", - "redirect_url": "/powershell/module/exchange/set-accepteddomain", + "redirect_url": "/powershell/module/exchangepowershell/set-accepteddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-AddressRewriteEntry.md", - "redirect_url": "/powershell/module/exchange/set-addressrewriteentry", + "redirect_url": "/powershell/module/exchangepowershell/set-addressrewriteentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-DeliveryAgentConnector.md", - "redirect_url": "/powershell/module/exchange/set-deliveryagentconnector", + "redirect_url": "/powershell/module/exchangepowershell/set-deliveryagentconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-EdgeSyncServiceConfig.md", - "redirect_url": "/powershell/module/exchange/set-edgesyncserviceconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-edgesyncserviceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ForeignConnector.md", - "redirect_url": "/powershell/module/exchange/set-foreignconnector", + "redirect_url": "/powershell/module/exchangepowershell/set-foreignconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-FrontendTransportService.md", - "redirect_url": "/powershell/module/exchange/set-frontendtransportservice", + "redirect_url": "/powershell/module/exchangepowershell/set-frontendtransportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-InboundConnector.md", - "redirect_url": "/powershell/module/exchange/set-inboundconnector", + "redirect_url": "/powershell/module/exchangepowershell/set-inboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-MailboxTransportService.md", - "redirect_url": "/powershell/module/exchange/set-mailboxtransportservice", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxtransportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-OutboundConnector.md", - "redirect_url": "/powershell/module/exchange/set-outboundconnector", + "redirect_url": "/powershell/module/exchangepowershell/set-outboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ReceiveConnector.md", - "redirect_url": "/powershell/module/exchange/set-receiveconnector", + "redirect_url": "/powershell/module/exchangepowershell/set-receiveconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-RemoteDomain.md", - "redirect_url": "/powershell/module/exchange/set-remotedomain", + "redirect_url": "/powershell/module/exchangepowershell/set-remotedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ResubmitRequest.md", - "redirect_url": "/powershell/module/exchange/set-resubmitrequest", + "redirect_url": "/powershell/module/exchangepowershell/set-resubmitrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-RoutingGroupConnector.md", - "redirect_url": "/powershell/module/exchange/set-routinggroupconnector", + "redirect_url": "/powershell/module/exchangepowershell/set-routinggroupconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-SendConnector.md", - "redirect_url": "/powershell/module/exchange/set-sendconnector", + "redirect_url": "/powershell/module/exchangepowershell/set-sendconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-SystemMessage.md", - "redirect_url": "/powershell/module/exchange/set-systemmessage", + "redirect_url": "/powershell/module/exchangepowershell/set-systemmessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/set-transportagent", + "redirect_url": "/powershell/module/exchangepowershell/set-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportConfig.md", - "redirect_url": "/powershell/module/exchange/set-transportconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-transportconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportServer.md", - "redirect_url": "/powershell/module/exchange/set-transportserver", + "redirect_url": "/powershell/module/exchangepowershell/set-transportserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportService.md", - "redirect_url": "/powershell/module/exchange/set-transportservice", + "redirect_url": "/powershell/module/exchangepowershell/set-transportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-X400AuthoritativeDomain.md", - "redirect_url": "/powershell/module/exchange/set-x400authoritativedomain", + "redirect_url": "/powershell/module/exchangepowershell/set-x400authoritativedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Start-EdgeSynchronization.md", - "redirect_url": "/powershell/module/exchange/start-edgesynchronization", + "redirect_url": "/powershell/module/exchangepowershell/start-edgesynchronization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Start-HistoricalSearch.md", - "redirect_url": "/powershell/module/exchange/start-historicalsearch", + "redirect_url": "/powershell/module/exchangepowershell/start-historicalsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Stop-HistoricalSearch.md", - "redirect_url": "/powershell/module/exchange/stop-historicalsearch", + "redirect_url": "/powershell/module/exchangepowershell/stop-historicalsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Suspend-Message.md", - "redirect_url": "/powershell/module/exchange/suspend-message", + "redirect_url": "/powershell/module/exchangepowershell/suspend-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Suspend-Queue.md", - "redirect_url": "/powershell/module/exchange/suspend-queue", + "redirect_url": "/powershell/module/exchangepowershell/suspend-queue", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-EdgeSynchronization.md", - "redirect_url": "/powershell/module/exchange/test-edgesynchronization", + "redirect_url": "/powershell/module/exchangepowershell/test-edgesynchronization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-Mailflow.md", - "redirect_url": "/powershell/module/exchange/test-mailflow", + "redirect_url": "/powershell/module/exchangepowershell/test-mailflow", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-SmtpConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-smtpconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-smtpconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Uninstall-TransportAgent.md", - "redirect_url": "/powershell/module/exchange/uninstall-transportagent", + "redirect_url": "/powershell/module/exchangepowershell/uninstall-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Validate-OutboundConnector.md", - "redirect_url": "/powershell/module/exchange/validate-outboundconnector", + "redirect_url": "/powershell/module/exchangepowershell/validate-outboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Clean-MailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/clean-mailboxdatabase", + "redirect_url": "/powershell/module/exchangepowershell/clean-mailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Disable-MailboxQuarantine.md", - "redirect_url": "/powershell/module/exchange/disable-mailboxquarantine", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailboxquarantine", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Disable-MetaCacheDatabase.md", - "redirect_url": "/powershell/module/exchange/disable-metacachedatabase", + "redirect_url": "/powershell/module/exchangepowershell/disable-metacachedatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Dismount-Database.md", - "redirect_url": "/powershell/module/exchange/dismount-database", + "redirect_url": "/powershell/module/exchangepowershell/dismount-database", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Enable-MailboxQuarantine.md", - "redirect_url": "/powershell/module/exchange/enable-mailboxquarantine", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailboxquarantine", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Enable-MetaCacheDatabase.md", - "redirect_url": "/powershell/module/exchange/enable-metacachedatabase", + "redirect_url": "/powershell/module/exchangepowershell/enable-metacachedatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-FailedContentIndexDocuments.md", - "redirect_url": "/powershell/module/exchange/get-failedcontentindexdocuments", + "redirect_url": "/powershell/module/exchangepowershell/get-failedcontentindexdocuments", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/get-mailboxdatabase", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxRepairRequest.md", - "redirect_url": "/powershell/module/exchange/get-mailboxrepairrequest", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrepairrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxServer.md", - "redirect_url": "/powershell/module/exchange/get-mailboxserver", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-SearchDocumentFormat.md", - "redirect_url": "/powershell/module/exchange/get-searchdocumentformat", + "redirect_url": "/powershell/module/exchangepowershell/get-searchdocumentformat", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-StoreUsageStatistics.md", - "redirect_url": "/powershell/module/exchange/get-storeusagestatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-storeusagestatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Mount-Database.md", - "redirect_url": "/powershell/module/exchange/mount-database", + "redirect_url": "/powershell/module/exchangepowershell/mount-database", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Move-DatabasePath.md", - "redirect_url": "/powershell/module/exchange/move-databasepath", + "redirect_url": "/powershell/module/exchangepowershell/move-databasepath", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-MailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/new-mailboxdatabase", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-MailboxRepairRequest.md", - "redirect_url": "/powershell/module/exchange/new-mailboxrepairrequest", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxrepairrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-SearchDocumentFormat.md", - "redirect_url": "/powershell/module/exchange/new-searchdocumentformat", + "redirect_url": "/powershell/module/exchangepowershell/new-searchdocumentformat", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-MailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxdatabase", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-MailboxRepairRequest.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxrepairrequest", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxrepairrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-SearchDocumentFormat.md", - "redirect_url": "/powershell/module/exchange/remove-searchdocumentformat", + "redirect_url": "/powershell/module/exchangepowershell/remove-searchdocumentformat", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-StoreMailbox.md", - "redirect_url": "/powershell/module/exchange/remove-storemailbox", + "redirect_url": "/powershell/module/exchangepowershell/remove-storemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-MailboxDatabase.md", - "redirect_url": "/powershell/module/exchange/set-mailboxdatabase", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-MailboxServer.md", - "redirect_url": "/powershell/module/exchange/set-mailboxserver", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-SearchDocumentFormat.md", - "redirect_url": "/powershell/module/exchange/set-searchdocumentformat", + "redirect_url": "/powershell/module/exchangepowershell/set-searchdocumentformat", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-AssistantHealth.md", - "redirect_url": "/powershell/module/exchange/test-assistanthealth", + "redirect_url": "/powershell/module/exchangepowershell/test-assistanthealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-ExchangeSearch.md", - "redirect_url": "/powershell/module/exchange/test-exchangesearch", + "redirect_url": "/powershell/module/exchangepowershell/test-exchangesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-MRSHealth.md", - "redirect_url": "/powershell/module/exchange/test-mrshealth", + "redirect_url": "/powershell/module/exchangepowershell/test-mrshealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-DatabaseSchema.md", - "redirect_url": "/powershell/module/exchange/update-databaseschema", + "redirect_url": "/powershell/module/exchangepowershell/update-databaseschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-FileDistributionService.md", - "redirect_url": "/powershell/module/exchange/update-filedistributionservice", + "redirect_url": "/powershell/module/exchangepowershell/update-filedistributionservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-StoreMailboxState.md", - "redirect_url": "/powershell/module/exchange/update-storemailboxstate", + "redirect_url": "/powershell/module/exchangepowershell/update-storemailboxstate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-MailboxFolderPermission.md", - "redirect_url": "/powershell/module/exchange/add-mailboxfolderpermission", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxfolderpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-MailboxPermission.md", - "redirect_url": "/powershell/module/exchange/add-mailboxpermission", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-RecipientPermission.md", - "redirect_url": "/powershell/module/exchange/add-recipientpermission", + "redirect_url": "/powershell/module/exchangepowershell/add-recipientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Connect-Mailbox.md", - "redirect_url": "/powershell/module/exchange/connect-mailbox", + "redirect_url": "/powershell/module/exchangepowershell/connect-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-App.md", - "redirect_url": "/powershell/module/exchange/disable-app", + "redirect_url": "/powershell/module/exchangepowershell/disable-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-InboxRule.md", - "redirect_url": "/powershell/module/exchange/disable-inboxrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-Mailbox.md", - "redirect_url": "/powershell/module/exchange/disable-mailbox", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-ServiceEmailChannel.md", - "redirect_url": "/powershell/module/exchange/disable-serviceemailchannel", + "redirect_url": "/powershell/module/exchangepowershell/disable-serviceemailchannel", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-SweepRule.md", - "redirect_url": "/powershell/module/exchange/disable-sweeprule", + "redirect_url": "/powershell/module/exchangepowershell/disable-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-App.md", - "redirect_url": "/powershell/module/exchange/enable-app", + "redirect_url": "/powershell/module/exchangepowershell/enable-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-InboxRule.md", - "redirect_url": "/powershell/module/exchange/enable-inboxrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-Mailbox.md", - "redirect_url": "/powershell/module/exchange/enable-mailbox", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-ServiceEmailChannel.md", - "redirect_url": "/powershell/module/exchange/enable-serviceemailchannel", + "redirect_url": "/powershell/module/exchangepowershell/enable-serviceemailchannel", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-SweepRule.md", - "redirect_url": "/powershell/module/exchange/enable-sweeprule", + "redirect_url": "/powershell/module/exchangepowershell/enable-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Export-MailboxDiagnosticLogs.md", - "redirect_url": "/powershell/module/exchange/export-mailboxdiagnosticlogs", + "redirect_url": "/powershell/module/exchangepowershell/export-mailboxdiagnosticlogs", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Export-RecipientDataProperty.md", - "redirect_url": "/powershell/module/exchange/export-recipientdataproperty", + "redirect_url": "/powershell/module/exchangepowershell/export-recipientdataproperty", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-App.md", - "redirect_url": "/powershell/module/exchange/get-app", + "redirect_url": "/powershell/module/exchangepowershell/get-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticAnalysis.md", - "redirect_url": "/powershell/module/exchange/get-calendardiagnosticanalysis", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticanalysis", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticLog.md", - "redirect_url": "/powershell/module/exchange/get-calendardiagnosticlog", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticObjects.md", - "redirect_url": "/powershell/module/exchange/get-calendardiagnosticobjects", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticobjects", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarNotification.md", - "redirect_url": "/powershell/module/exchange/get-calendarnotification", + "redirect_url": "/powershell/module/exchangepowershell/get-calendarnotification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarProcessing.md", - "redirect_url": "/powershell/module/exchange/get-calendarprocessing", + "redirect_url": "/powershell/module/exchangepowershell/get-calendarprocessing", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Clutter.md", - "redirect_url": "/powershell/module/exchange/get-clutter", + "redirect_url": "/powershell/module/exchangepowershell/get-clutter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-FocusedInbox.md", - "redirect_url": "/powershell/module/exchange/get-focusedinbox", + "redirect_url": "/powershell/module/exchangepowershell/get-focusedinbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-InboxRule.md", - "redirect_url": "/powershell/module/exchange/get-inboxrule", + "redirect_url": "/powershell/module/exchangepowershell/get-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Mailbox.md", - "redirect_url": "/powershell/module/exchange/get-mailbox", + "redirect_url": "/powershell/module/exchangepowershell/get-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxAutoReplyConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxautoreplyconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxautoreplyconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxCalendarFolder.md", - "redirect_url": "/powershell/module/exchange/get-mailboxcalendarfolder", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxcalendarfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/get-mailboxexportrequest", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxExportRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mailboxexportrequeststatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxexportrequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolder.md", - "redirect_url": "/powershell/module/exchange/get-mailboxfolder", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolderPermission.md", - "redirect_url": "/powershell/module/exchange/get-mailboxfolderpermission", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolderpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolderStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mailboxfolderstatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolderstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/get-mailboximportrequest", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxImportRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mailboximportrequeststatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboximportrequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxLocation.md", - "redirect_url": "/powershell/module/exchange/get-mailboxlocation", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxlocation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxPermission.md", - "redirect_url": "/powershell/module/exchange/get-mailboxpermission", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxPlan.md", - "redirect_url": "/powershell/module/exchange/get-mailboxplan", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/get-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxRestoreRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mailboxrestorerequeststatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrestorerequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxSentItemsConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxsentitemsconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxsentitemsconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxStatistics.md", - "redirect_url": "/powershell/module/exchange/get-mailboxstatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxUserConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-mailboxuserconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxuserconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MessageCategory.md", - "redirect_url": "/powershell/module/exchange/get-messagecategory", + "redirect_url": "/powershell/module/exchangepowershell/get-messagecategory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Place.md", - "redirect_url": "/powershell/module/exchange/get-place", + "redirect_url": "/powershell/module/exchangepowershell/get-place", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-RecipientPermission.md", - "redirect_url": "/powershell/module/exchange/get-recipientpermission", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-RecoverableItems.md", - "redirect_url": "/powershell/module/exchange/get-recoverableitems", + "redirect_url": "/powershell/module/exchangepowershell/get-recoverableitems", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-ResourceConfig.md", - "redirect_url": "/powershell/module/exchange/get-resourceconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-resourceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-SweepRule.md", - "redirect_url": "/powershell/module/exchange/get-sweeprule", + "redirect_url": "/powershell/module/exchangepowershell/get-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-UserPhoto.md", - "redirect_url": "/powershell/module/exchange/get-userphoto", + "redirect_url": "/powershell/module/exchangepowershell/get-userphoto", "redirect_document_id": false }, { @@ -3152,1987 +3152,1987 @@ }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Import-RecipientDataProperty.md", - "redirect_url": "/powershell/module/exchange/import-recipientdataproperty", + "redirect_url": "/powershell/module/exchangepowershell/import-recipientdataproperty", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-App.md", - "redirect_url": "/powershell/module/exchange/new-app", + "redirect_url": "/powershell/module/exchangepowershell/new-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-InboxRule.md", - "redirect_url": "/powershell/module/exchange/new-inboxrule", + "redirect_url": "/powershell/module/exchangepowershell/new-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-Mailbox.md", - "redirect_url": "/powershell/module/exchange/new-mailbox", + "redirect_url": "/powershell/module/exchangepowershell/new-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/new-mailboxexportrequest", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxFolder.md", - "redirect_url": "/powershell/module/exchange/new-mailboxfolder", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/new-mailboximportrequest", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/new-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailMessage.md", - "redirect_url": "/powershell/module/exchange/new-mailmessage", + "redirect_url": "/powershell/module/exchangepowershell/new-mailmessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-SiteMailbox.md", - "redirect_url": "/powershell/module/exchange/new-sitemailbox", + "redirect_url": "/powershell/module/exchangepowershell/new-sitemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-SweepRule.md", - "redirect_url": "/powershell/module/exchange/new-sweeprule", + "redirect_url": "/powershell/module/exchangepowershell/new-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-App.md", - "redirect_url": "/powershell/module/exchange/remove-app", + "redirect_url": "/powershell/module/exchangepowershell/remove-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-CalendarEvents.md", - "redirect_url": "/powershell/module/exchange/remove-calendarevents", + "redirect_url": "/powershell/module/exchangepowershell/remove-calendarevents", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-InboxRule.md", - "redirect_url": "/powershell/module/exchange/remove-inboxrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-Mailbox.md", - "redirect_url": "/powershell/module/exchange/remove-mailbox", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxexportrequest", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxFolderPermission.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxfolderpermission", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxfolderpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/remove-mailboximportrequest", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxPermission.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxpermission", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxUserConfiguration.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxuserconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxuserconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-RecipientPermission.md", - "redirect_url": "/powershell/module/exchange/remove-recipientpermission", + "redirect_url": "/powershell/module/exchangepowershell/remove-recipientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-SweepRule.md", - "redirect_url": "/powershell/module/exchange/remove-sweeprule", + "redirect_url": "/powershell/module/exchangepowershell/remove-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-UserPhoto.md", - "redirect_url": "/powershell/module/exchange/remove-userphoto", + "redirect_url": "/powershell/module/exchangepowershell/remove-userphoto", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Restore-Mailbox.md", - "redirect_url": "/powershell/module/exchange/restore-mailbox", + "redirect_url": "/powershell/module/exchangepowershell/restore-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Restore-RecoverableItems.md", - "redirect_url": "/powershell/module/exchange/restore-recoverableitems", + "redirect_url": "/powershell/module/exchangepowershell/restore-recoverableitems", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/resume-mailboxexportrequest", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/resume-mailboximportrequest", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/resume-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Search-Mailbox.md", - "redirect_url": "/powershell/module/exchange/search-mailbox", + "redirect_url": "/powershell/module/exchangepowershell/search-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-App.md", - "redirect_url": "/powershell/module/exchange/set-app", + "redirect_url": "/powershell/module/exchangepowershell/set-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-CalendarNotification.md", - "redirect_url": "/powershell/module/exchange/set-calendarnotification", + "redirect_url": "/powershell/module/exchangepowershell/set-calendarnotification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-CalendarProcessing.md", - "redirect_url": "/powershell/module/exchange/set-calendarprocessing", + "redirect_url": "/powershell/module/exchangepowershell/set-calendarprocessing", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Clutter.md", - "redirect_url": "/powershell/module/exchange/set-clutter", + "redirect_url": "/powershell/module/exchangepowershell/set-clutter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-FocusedInbox.md", - "redirect_url": "/powershell/module/exchange/set-focusedinbox", + "redirect_url": "/powershell/module/exchangepowershell/set-focusedinbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-InboxRule.md", - "redirect_url": "/powershell/module/exchange/set-inboxrule", + "redirect_url": "/powershell/module/exchangepowershell/set-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Mailbox.md", - "redirect_url": "/powershell/module/exchange/set-mailbox", + "redirect_url": "/powershell/module/exchangepowershell/set-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxAutoReplyConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxautoreplyconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxautoreplyconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxCalendarFolder.md", - "redirect_url": "/powershell/module/exchange/set-mailboxcalendarfolder", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxcalendarfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/set-mailboxexportrequest", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxFolderPermission.md", - "redirect_url": "/powershell/module/exchange/set-mailboxfolderpermission", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxfolderpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/set-mailboximportrequest", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxPlan.md", - "redirect_url": "/powershell/module/exchange/set-mailboxplan", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/set-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxSentItemsConfiguration.md", - "redirect_url": "/powershell/module/exchange/set-mailboxsentitemsconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxsentitemsconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Place.md", - "redirect_url": "/powershell/module/exchange/set-place", + "redirect_url": "/powershell/module/exchangepowershell/set-place", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-ResourceConfig.md", - "redirect_url": "/powershell/module/exchange/set-resourceconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-resourceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-SweepRule.md", - "redirect_url": "/powershell/module/exchange/set-sweeprule", + "redirect_url": "/powershell/module/exchangepowershell/set-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-UserPhoto.md", - "redirect_url": "/powershell/module/exchange/set-userphoto", + "redirect_url": "/powershell/module/exchangepowershell/set-userphoto", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxExportRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-mailboxexportrequest", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxImportRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-mailboximportrequest", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxRestoreRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Test-MAPIConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-mapiconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-mapiconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Undo-SoftDeletedMailbox.md", - "redirect_url": "/powershell/module/exchange/undo-softdeletedmailbox", + "redirect_url": "/powershell/module/exchangepowershell/undo-softdeletedmailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Complete-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/complete-migrationbatch", + "redirect_url": "/powershell/module/exchangepowershell/complete-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Export-MigrationReport.md", - "redirect_url": "/powershell/module/exchange/export-migrationreport", + "redirect_url": "/powershell/module/exchangepowershell/export-migrationreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/get-migrationbatch", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationConfig.md", - "redirect_url": "/powershell/module/exchange/get-migrationconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationEndpoint.md", - "redirect_url": "/powershell/module/exchange/get-migrationendpoint", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationendpoint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationStatistics.md", - "redirect_url": "/powershell/module/exchange/get-migrationstatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationUser.md", - "redirect_url": "/powershell/module/exchange/get-migrationuser", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationUserStatistics.md", - "redirect_url": "/powershell/module/exchange/get-migrationuserstatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationuserstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/get-moverequest", + "redirect_url": "/powershell/module/exchangepowershell/get-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MoveRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-moverequeststatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-moverequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermailboxmigrationrequest", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermailboxmigrationrequeststatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMigrationRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermigrationrequeststatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermigrationrequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMoveRequestStatistics.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermoverequeststatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermoverequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/new-migrationbatch", + "redirect_url": "/powershell/module/exchangepowershell/new-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MigrationEndpoint.md", - "redirect_url": "/powershell/module/exchange/new-migrationendpoint", + "redirect_url": "/powershell/module/exchangepowershell/new-migrationendpoint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/new-moverequest", + "redirect_url": "/powershell/module/exchangepowershell/new-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/new-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/new-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/remove-migrationbatch", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationEndpoint.md", - "redirect_url": "/powershell/module/exchange/remove-migrationendpoint", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationendpoint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationUser.md", - "redirect_url": "/powershell/module/exchange/remove-migrationuser", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/remove-moverequest", + "redirect_url": "/powershell/module/exchangepowershell/remove-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMailboxMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/remove-publicfoldermailboxmigrationrequest", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermailboxmigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/remove-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/remove-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/resume-moverequest", + "redirect_url": "/powershell/module/exchangepowershell/resume-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/resume-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/resume-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/set-migrationbatch", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationConfig.md", - "redirect_url": "/powershell/module/exchange/set-migrationconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationEndpoint.md", - "redirect_url": "/powershell/module/exchange/set-migrationendpoint", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationendpoint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationUser.md", - "redirect_url": "/powershell/module/exchange/set-migrationuser", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/set-moverequest", + "redirect_url": "/powershell/module/exchangepowershell/set-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/set-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/set-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Start-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/start-migrationbatch", + "redirect_url": "/powershell/module/exchangepowershell/start-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Start-MigrationUser.md", - "redirect_url": "/powershell/module/exchange/start-migrationuser", + "redirect_url": "/powershell/module/exchangepowershell/start-migrationuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Stop-MigrationBatch.md", - "redirect_url": "/powershell/module/exchange/stop-migrationbatch", + "redirect_url": "/powershell/module/exchangepowershell/stop-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Stop-MigrationUser.md", - "redirect_url": "/powershell/module/exchange/stop-migrationuser", + "redirect_url": "/powershell/module/exchangepowershell/stop-migrationuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-MoveRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-moverequest", + "redirect_url": "/powershell/module/exchangepowershell/suspend-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMailboxMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-publicfoldermailboxmigrationrequest", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermailboxmigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMigrationRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMoveRequest.md", - "redirect_url": "/powershell/module/exchange/suspend-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Test-MigrationServerAvailability.md", - "redirect_url": "/powershell/module/exchange/test-migrationserveravailability", + "redirect_url": "/powershell/module/exchangepowershell/test-migrationserveravailability", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Disable-CmdletExtensionAgent.md", - "redirect_url": "/powershell/module/exchange/disable-cmdletextensionagent", + "redirect_url": "/powershell/module/exchangepowershell/disable-cmdletextensionagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Enable-CmdletExtensionAgent.md", - "redirect_url": "/powershell/module/exchange/enable-cmdletextensionagent", + "redirect_url": "/powershell/module/exchangepowershell/enable-cmdletextensionagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Enable-OrganizationCustomization.md", - "redirect_url": "/powershell/module/exchange/enable-organizationcustomization", + "redirect_url": "/powershell/module/exchangepowershell/enable-organizationcustomization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-AccessToCustomerDataRequest.md", - "redirect_url": "/powershell/module/exchange/get-accesstocustomerdatarequest", + "redirect_url": "/powershell/module/exchangepowershell/get-accesstocustomerdatarequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/get-applicationaccesspolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-applicationaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthConfig.md", - "redirect_url": "/powershell/module/exchange/get-authconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-authconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthenticationPolicy.md", - "redirect_url": "/powershell/module/exchange/get-authenticationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-authenticationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthServer.md", - "redirect_url": "/powershell/module/exchange/get-authserver", + "redirect_url": "/powershell/module/exchangepowershell/get-authserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-CmdletExtensionAgent.md", - "redirect_url": "/powershell/module/exchange/get-cmdletextensionagent", + "redirect_url": "/powershell/module/exchangepowershell/get-cmdletextensionagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeAssistanceConfig.md", - "redirect_url": "/powershell/module/exchange/get-exchangeassistanceconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeassistanceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeDiagnosticInfo.md", - "redirect_url": "/powershell/module/exchange/get-exchangediagnosticinfo", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangediagnosticinfo", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServer.md", - "redirect_url": "/powershell/module/exchange/get-exchangeserver", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServerAccessLicense.md", - "redirect_url": "/powershell/module/exchange/get-exchangeserveraccesslicense", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserveraccesslicense", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServerAccessLicenseUser.md", - "redirect_url": "/powershell/module/exchange/get-exchangeserveraccesslicenseuser", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserveraccesslicenseuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeSettings.md", - "redirect_url": "/powershell/module/exchange/get-exchangesettings", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangesettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-Notification.md", - "redirect_url": "/powershell/module/exchange/get-notification", + "redirect_url": "/powershell/module/exchangepowershell/get-notification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-OrganizationConfig.md", - "redirect_url": "/powershell/module/exchange/get-organizationconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-PartnerApplication.md", - "redirect_url": "/powershell/module/exchange/get-partnerapplication", + "redirect_url": "/powershell/module/exchangepowershell/get-partnerapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-PerimeterConfig.md", - "redirect_url": "/powershell/module/exchange/get-perimeterconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-perimeterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-SettingOverride.md", - "redirect_url": "/powershell/module/exchange/get-settingoverride", + "redirect_url": "/powershell/module/exchangepowershell/get-settingoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-ApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/new-applicationaccesspolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-applicationaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-AuthenticationPolicy.md", - "redirect_url": "/powershell/module/exchange/new-authenticationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-authenticationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-AuthServer.md", - "redirect_url": "/powershell/module/exchange/new-authserver", + "redirect_url": "/powershell/module/exchangepowershell/new-authserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-ExchangeSettings.md", - "redirect_url": "/powershell/module/exchange/new-exchangesettings", + "redirect_url": "/powershell/module/exchangepowershell/new-exchangesettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-PartnerApplication.md", - "redirect_url": "/powershell/module/exchange/new-partnerapplication", + "redirect_url": "/powershell/module/exchangepowershell/new-partnerapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-SettingOverride.md", - "redirect_url": "/powershell/module/exchange/new-settingoverride", + "redirect_url": "/powershell/module/exchangepowershell/new-settingoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Remove-ApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-applicationaccesspolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-applicationaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Remove-AuthenticationPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-authenticationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-authenticationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Remove-AuthServer.md", - "redirect_url": "/powershell/module/exchange/remove-authserver", + "redirect_url": "/powershell/module/exchangepowershell/remove-authserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Remove-PartnerApplication.md", - "redirect_url": "/powershell/module/exchange/remove-partnerapplication", + "redirect_url": "/powershell/module/exchangepowershell/remove-partnerapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Remove-SettingOverride.md", - "redirect_url": "/powershell/module/exchange/remove-settingoverride", + "redirect_url": "/powershell/module/exchangepowershell/remove-settingoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-AccessToCustomerDataRequest.md", - "redirect_url": "/powershell/module/exchange/set-accesstocustomerdatarequest", + "redirect_url": "/powershell/module/exchangepowershell/set-accesstocustomerdatarequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-ApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/set-applicationaccesspolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-applicationaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthConfig.md", - "redirect_url": "/powershell/module/exchange/set-authconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-authconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthenticationPolicy.md", - "redirect_url": "/powershell/module/exchange/set-authenticationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-authenticationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthServer.md", - "redirect_url": "/powershell/module/exchange/set-authserver", + "redirect_url": "/powershell/module/exchangepowershell/set-authserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-CmdletExtensionAgent.md", - "redirect_url": "/powershell/module/exchange/set-cmdletextensionagent", + "redirect_url": "/powershell/module/exchangepowershell/set-cmdletextensionagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeAssistanceConfig.md", - "redirect_url": "/powershell/module/exchange/set-exchangeassistanceconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangeassistanceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeServer.md", - "redirect_url": "/powershell/module/exchange/set-exchangeserver", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangeserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeSettings.md", - "redirect_url": "/powershell/module/exchange/set-exchangesettings", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangesettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-Notification.md", - "redirect_url": "/powershell/module/exchange/set-notification", + "redirect_url": "/powershell/module/exchangepowershell/set-notification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-OrganizationConfig.md", - "redirect_url": "/powershell/module/exchange/set-organizationconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-PartnerApplication.md", - "redirect_url": "/powershell/module/exchange/set-partnerapplication", + "redirect_url": "/powershell/module/exchangepowershell/set-partnerapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-PerimeterConfig.md", - "redirect_url": "/powershell/module/exchange/set-perimeterconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-perimeterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-SettingOverride.md", - "redirect_url": "/powershell/module/exchange/set-settingoverride", + "redirect_url": "/powershell/module/exchangepowershell/set-settingoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Test-ApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/exchange/test-applicationaccesspolicy", + "redirect_url": "/powershell/module/exchangepowershell/test-applicationaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Test-OAuthConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-oauthconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-oauthconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Test-SystemHealth.md", - "redirect_url": "/powershell/module/exchange/test-systemhealth", + "redirect_url": "/powershell/module/exchangepowershell/test-systemhealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Update-ExchangeHelp.md", - "redirect_url": "/powershell/module/exchange/update-exchangehelp", + "redirect_url": "/powershell/module/exchangepowershell/update-exchangehelp", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-JournalArchiving.md", - "redirect_url": "/powershell/module/exchange/disable-journalarchiving", + "redirect_url": "/powershell/module/exchangepowershell/disable-journalarchiving", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-JournalRule.md", - "redirect_url": "/powershell/module/exchange/disable-journalrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/disable-outlookprotectionrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-TransportRule.md", - "redirect_url": "/powershell/module/exchange/disable-transportrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-JournalRule.md", - "redirect_url": "/powershell/module/exchange/enable-journalrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/enable-outlookprotectionrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-TransportRule.md", - "redirect_url": "/powershell/module/exchange/enable-transportrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Export-JournalRuleCollection.md", - "redirect_url": "/powershell/module/exchange/export-journalrulecollection", + "redirect_url": "/powershell/module/exchangepowershell/export-journalrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Export-TransportRuleCollection.md", - "redirect_url": "/powershell/module/exchange/export-transportrulecollection", + "redirect_url": "/powershell/module/exchangepowershell/export-transportrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/get-activityalert", + "redirect_url": "/powershell/module/exchangepowershell/get-activityalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-AdministrativeUnit.md", - "redirect_url": "/powershell/module/exchange/get-administrativeunit", + "redirect_url": "/powershell/module/exchangepowershell/get-administrativeunit", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierPoliciesApplicationStatus.md", - "redirect_url": "/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierpoliciesapplicationstatus", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierPolicy.md", - "redirect_url": "/powershell/module/exchange/get-informationbarrierpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierRecipientStatus.md", - "redirect_url": "/powershell/module/exchange/get-informationbarrierrecipientstatus", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierrecipientstatus", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-JournalRule.md", - "redirect_url": "/powershell/module/exchange/get-journalrule", + "redirect_url": "/powershell/module/exchangepowershell/get-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-Label.md", - "redirect_url": "/powershell/module/exchange/get-label", + "redirect_url": "/powershell/module/exchangepowershell/get-label", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-LabelPolicy.md", - "redirect_url": "/powershell/module/exchange/get-labelpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-labelpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-MessageClassification.md", - "redirect_url": "/powershell/module/exchange/get-messageclassification", + "redirect_url": "/powershell/module/exchangepowershell/get-messageclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-OrganizationSegment.md", - "redirect_url": "/powershell/module/exchange/get-organizationsegment", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationsegment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/get-outlookprotectionrule", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-ProtectionAlert.md", - "redirect_url": "/powershell/module/exchange/get-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/get-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-SupervisoryReviewPolicyV2.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewpolicyv2", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewpolicyv2", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-SupervisoryReviewRule.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewrule", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRule.md", - "redirect_url": "/powershell/module/exchange/get-transportrule", + "redirect_url": "/powershell/module/exchangepowershell/get-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRuleAction.md", - "redirect_url": "/powershell/module/exchange/get-transportruleaction", + "redirect_url": "/powershell/module/exchangepowershell/get-transportruleaction", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRulePredicate.md", - "redirect_url": "/powershell/module/exchange/get-transportrulepredicate", + "redirect_url": "/powershell/module/exchangepowershell/get-transportrulepredicate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Import-JournalRuleCollection.md", - "redirect_url": "/powershell/module/exchange/import-journalrulecollection", + "redirect_url": "/powershell/module/exchangepowershell/import-journalrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Import-TransportRuleCollection.md", - "redirect_url": "/powershell/module/exchange/import-transportrulecollection", + "redirect_url": "/powershell/module/exchangepowershell/import-transportrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Install-UnifiedCompliancePrerequisite.md", - "redirect_url": "/powershell/module/exchange/install-unifiedcomplianceprerequisite", + "redirect_url": "/powershell/module/exchangepowershell/install-unifiedcomplianceprerequisite", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/new-activityalert", + "redirect_url": "/powershell/module/exchangepowershell/new-activityalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-InformationBarrierPolicy.md", - "redirect_url": "/powershell/module/exchange/new-informationbarrierpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-informationbarrierpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-JournalRule.md", - "redirect_url": "/powershell/module/exchange/new-journalrule", + "redirect_url": "/powershell/module/exchangepowershell/new-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-Label.md", - "redirect_url": "/powershell/module/exchange/new-label", + "redirect_url": "/powershell/module/exchangepowershell/new-label", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-LabelPolicy.md", - "redirect_url": "/powershell/module/exchange/new-labelpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-labelpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-MessageClassification.md", - "redirect_url": "/powershell/module/exchange/new-messageclassification", + "redirect_url": "/powershell/module/exchangepowershell/new-messageclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-OrganizationSegment.md", - "redirect_url": "/powershell/module/exchange/new-organizationsegment", + "redirect_url": "/powershell/module/exchangepowershell/new-organizationsegment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/new-outlookprotectionrule", + "redirect_url": "/powershell/module/exchangepowershell/new-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-ProtectionAlert.md", - "redirect_url": "/powershell/module/exchange/new-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/new-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-SupervisoryReviewPolicyV2.md", - "redirect_url": "/powershell/module/exchange/new-supervisoryreviewpolicyv2", + "redirect_url": "/powershell/module/exchangepowershell/new-supervisoryreviewpolicyv2", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-SupervisoryReviewRule.md", - "redirect_url": "/powershell/module/exchange/new-supervisoryreviewrule", + "redirect_url": "/powershell/module/exchangepowershell/new-supervisoryreviewrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-TransportRule.md", - "redirect_url": "/powershell/module/exchange/new-transportrule", + "redirect_url": "/powershell/module/exchangepowershell/new-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/remove-activityalert", + "redirect_url": "/powershell/module/exchangepowershell/remove-activityalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-InformationBarrierPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-informationbarrierpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-informationbarrierpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-JournalRule.md", - "redirect_url": "/powershell/module/exchange/remove-journalrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-Label.md", - "redirect_url": "/powershell/module/exchange/remove-label", + "redirect_url": "/powershell/module/exchangepowershell/remove-label", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-LabelPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-labelpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-labelpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-MessageClassification.md", - "redirect_url": "/powershell/module/exchange/remove-messageclassification", + "redirect_url": "/powershell/module/exchangepowershell/remove-messageclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-OrganizationSegment.md", - "redirect_url": "/powershell/module/exchange/remove-organizationsegment", + "redirect_url": "/powershell/module/exchangepowershell/remove-organizationsegment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/remove-outlookprotectionrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-ProtectionAlert.md", - "redirect_url": "/powershell/module/exchange/remove-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/remove-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-SupervisoryReviewPolicyV2.md", - "redirect_url": "/powershell/module/exchange/remove-supervisoryreviewpolicyv2", + "redirect_url": "/powershell/module/exchangepowershell/remove-supervisoryreviewpolicyv2", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-TransportRule.md", - "redirect_url": "/powershell/module/exchange/remove-transportrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/set-activityalert", + "redirect_url": "/powershell/module/exchangepowershell/set-activityalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-InformationBarrierPolicy.md", - "redirect_url": "/powershell/module/exchange/set-informationbarrierpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-informationbarrierpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-JournalRule.md", - "redirect_url": "/powershell/module/exchange/set-journalrule", + "redirect_url": "/powershell/module/exchangepowershell/set-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-Label.md", - "redirect_url": "/powershell/module/exchange/set-label", + "redirect_url": "/powershell/module/exchangepowershell/set-label", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-LabelPolicy.md", - "redirect_url": "/powershell/module/exchange/set-labelpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-labelpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-MessageClassification.md", - "redirect_url": "/powershell/module/exchange/set-messageclassification", + "redirect_url": "/powershell/module/exchangepowershell/set-messageclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-OrganizationSegment.md", - "redirect_url": "/powershell/module/exchange/set-organizationsegment", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationsegment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-OutlookProtectionRule.md", - "redirect_url": "/powershell/module/exchange/set-outlookprotectionrule", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-ProtectionAlert.md", - "redirect_url": "/powershell/module/exchange/set-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/set-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-SupervisoryReviewPolicyV2.md", - "redirect_url": "/powershell/module/exchange/set-supervisoryreviewpolicyv2", + "redirect_url": "/powershell/module/exchangepowershell/set-supervisoryreviewpolicyv2", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-SupervisoryReviewRule.md", - "redirect_url": "/powershell/module/exchange/set-supervisoryreviewrule", + "redirect_url": "/powershell/module/exchangepowershell/set-supervisoryreviewrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-TransportRule.md", - "redirect_url": "/powershell/module/exchange/set-transportrule", + "redirect_url": "/powershell/module/exchangepowershell/set-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Start-InformationBarrierPoliciesApplication.md", - "redirect_url": "/powershell/module/exchange/start-informationbarrierpoliciesapplication", + "redirect_url": "/powershell/module/exchangepowershell/start-informationbarrierpoliciesapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Stop-InformationBarrierPoliciesApplication.md", - "redirect_url": "/powershell/module/exchange/stop-informationbarrierpoliciesapplication", + "redirect_url": "/powershell/module/exchangepowershell/stop-informationbarrierpoliciesapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Test-ArchiveConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-archiveconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-archiveconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AdminAuditLogConfig.md", - "redirect_url": "/powershell/module/exchange/get-adminauditlogconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-adminauditlogconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfig.md", - "redirect_url": "/powershell/module/exchange/get-auditconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-auditconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/get-auditconfigurationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-auditconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/get-auditconfigurationrule", + "redirect_url": "/powershell/module/exchangepowershell/get-auditconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditLogSearch.md", - "redirect_url": "/powershell/module/exchange/get-auditlogsearch", + "redirect_url": "/powershell/module/exchangepowershell/get-auditlogsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-MailboxAuditBypassAssociation.md", - "redirect_url": "/powershell/module/exchange/get-mailboxauditbypassassociation", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxauditbypassassociation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/get-unifiedauditlogretentionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedauditlogretentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AdminAuditLogSearch.md", - "redirect_url": "/powershell/module/exchange/new-adminauditlogsearch", + "redirect_url": "/powershell/module/exchangepowershell/new-adminauditlogsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AuditConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/new-auditconfigurationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-auditconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/new-auditconfigurationrule", + "redirect_url": "/powershell/module/exchangepowershell/new-auditconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-MailboxAuditLogSearch.md", - "redirect_url": "/powershell/module/exchange/new-mailboxauditlogsearch", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxauditlogsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/new-unifiedauditlogretentionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-unifiedauditlogretentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-AuditConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-auditconfigurationpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-auditconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/remove-auditconfigurationrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-auditconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-unifiedauditlogretentionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedauditlogretentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-AdminAuditLog.md", - "redirect_url": "/powershell/module/exchange/search-adminauditlog", + "redirect_url": "/powershell/module/exchangepowershell/search-adminauditlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-MailboxAuditLog.md", - "redirect_url": "/powershell/module/exchange/search-mailboxauditlog", + "redirect_url": "/powershell/module/exchangepowershell/search-mailboxauditlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-UnifiedAuditLog.md", - "redirect_url": "/powershell/module/exchange/search-unifiedauditlog", + "redirect_url": "/powershell/module/exchangepowershell/search-unifiedauditlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AdminAuditLogConfig.md", - "redirect_url": "/powershell/module/exchange/set-adminauditlogconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-adminauditlogconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AuditConfig.md", - "redirect_url": "/powershell/module/exchange/set-auditconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-auditconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/set-auditconfigurationrule", + "redirect_url": "/powershell/module/exchangepowershell/set-auditconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-MailboxAuditBypassAssociation.md", - "redirect_url": "/powershell/module/exchange/set-mailboxauditbypassassociation", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxauditbypassassociation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/set-unifiedauditlogretentionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-unifiedauditlogretentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Write-AdminAuditLog.md", - "redirect_url": "/powershell/module/exchange/write-adminauditlog", + "redirect_url": "/powershell/module/exchangepowershell/write-adminauditlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/get-compliancesearch", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSearchAction.md", - "redirect_url": "/powershell/module/exchange/get-compliancesearchaction", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesearchaction", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSecurityFilter.md", - "redirect_url": "/powershell/module/exchange/get-compliancesecurityfilter", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesecurityfilter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/get-mailboxsearch", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Invoke-ComplianceSearchActionStep.md", - "redirect_url": "/powershell/module/exchange/invoke-compliancesearchactionstep", + "redirect_url": "/powershell/module/exchangepowershell/invoke-compliancesearchactionstep", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/new-compliancesearch", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSearchAction.md", - "redirect_url": "/powershell/module/exchange/new-compliancesearchaction", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesearchaction", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSecurityFilter.md", - "redirect_url": "/powershell/module/exchange/new-compliancesecurityfilter", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesecurityfilter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/new-mailboxsearch", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/remove-compliancesearch", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSearchAction.md", - "redirect_url": "/powershell/module/exchange/remove-compliancesearchaction", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesearchaction", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSecurityFilter.md", - "redirect_url": "/powershell/module/exchange/remove-compliancesecurityfilter", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesecurityfilter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/remove-mailboxsearch", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/set-compliancesearch", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSearchAction.md", - "redirect_url": "/powershell/module/exchange/set-compliancesearchaction", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesearchaction", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSecurityFilter.md", - "redirect_url": "/powershell/module/exchange/set-compliancesecurityfilter", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesecurityfilter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/set-mailboxsearch", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Start-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/start-compliancesearch", + "redirect_url": "/powershell/module/exchangepowershell/start-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Start-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/start-mailboxsearch", + "redirect_url": "/powershell/module/exchangepowershell/start-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Stop-ComplianceSearch.md", - "redirect_url": "/powershell/module/exchange/stop-compliancesearch", + "redirect_url": "/powershell/module/exchangepowershell/stop-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Stop-MailboxSearch.md", - "redirect_url": "/powershell/module/exchange/stop-mailboxsearch", + "redirect_url": "/powershell/module/exchangepowershell/stop-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Export-DlpPolicyCollection.md", - "redirect_url": "/powershell/module/exchange/export-dlppolicycollection", + "redirect_url": "/powershell/module/exchangepowershell/export-dlppolicycollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-ClassificationRuleCollection.md", - "redirect_url": "/powershell/module/exchange/get-classificationrulecollection", + "redirect_url": "/powershell/module/exchangepowershell/get-classificationrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DataClassification.md", - "redirect_url": "/powershell/module/exchange/get-dataclassification", + "redirect_url": "/powershell/module/exchangepowershell/get-dataclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DataClassificationConfig.md", - "redirect_url": "/powershell/module/exchange/get-dataclassificationconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-dataclassificationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/get-dlpcompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpComplianceRule.md", - "redirect_url": "/powershell/module/exchange/get-dlpcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpDetailReport.md", - "redirect_url": "/powershell/module/exchange/get-dlpdetailreport", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpdetailreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpDetectionsReport.md", - "redirect_url": "/powershell/module/exchange/get-dlpdetectionsreport", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpdetectionsreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpEdmSchema.md", - "redirect_url": "/powershell/module/exchange/get-dlpedmschema", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpedmschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpKeywordDictionary.md", - "redirect_url": "/powershell/module/exchange/get-dlpkeyworddictionary", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpkeyworddictionary", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpPolicy.md", - "redirect_url": "/powershell/module/exchange/get-dlppolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-dlppolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpPolicyTemplate.md", - "redirect_url": "/powershell/module/exchange/get-dlppolicytemplate", + "redirect_url": "/powershell/module/exchangepowershell/get-dlppolicytemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationType.md", - "redirect_url": "/powershell/module/exchange/get-dlpsensitiveinformationtype", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsensitiveinformationtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "/powershell/module/exchange/get-dlpsensitiveinformationtyperulepackage", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsensitiveinformationtyperulepackage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSiDetectionsReport.md", - "redirect_url": "/powershell/module/exchange/get-dlpsidetectionsreport", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsidetectionsreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-PolicyTipConfig.md", - "redirect_url": "/powershell/module/exchange/get-policytipconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-policytipconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Import-DlpPolicyCollection.md", - "redirect_url": "/powershell/module/exchange/import-dlppolicycollection", + "redirect_url": "/powershell/module/exchangepowershell/import-dlppolicycollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Import-DlpPolicyTemplate.md", - "redirect_url": "/powershell/module/exchange/import-dlppolicytemplate", + "redirect_url": "/powershell/module/exchangepowershell/import-dlppolicytemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-ClassificationRuleCollection.md", - "redirect_url": "/powershell/module/exchange/new-classificationrulecollection", + "redirect_url": "/powershell/module/exchangepowershell/new-classificationrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DataClassification.md", - "redirect_url": "/powershell/module/exchange/new-dataclassification", + "redirect_url": "/powershell/module/exchangepowershell/new-dataclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/new-dlpcompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpComplianceRule.md", - "redirect_url": "/powershell/module/exchange/new-dlpcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpEdmSchema.md", - "redirect_url": "/powershell/module/exchange/new-dlpedmschema", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpedmschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpFingerprint.md", - "redirect_url": "/powershell/module/exchange/new-dlpfingerprint", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpfingerprint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpKeywordDictionary.md", - "redirect_url": "/powershell/module/exchange/new-dlpkeyworddictionary", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpkeyworddictionary", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpPolicy.md", - "redirect_url": "/powershell/module/exchange/new-dlppolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-dlppolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationType.md", - "redirect_url": "/powershell/module/exchange/new-dlpsensitiveinformationtype", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpsensitiveinformationtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpsensitiveinformationtyperulepackage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-Fingerprint.md", - "redirect_url": "/powershell/module/exchange/new-fingerprint", + "redirect_url": "/powershell/module/exchangepowershell/new-fingerprint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-PolicyTipConfig.md", - "redirect_url": "/powershell/module/exchange/new-policytipconfig", + "redirect_url": "/powershell/module/exchangepowershell/new-policytipconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-ClassificationRuleCollection.md", - "redirect_url": "/powershell/module/exchange/remove-classificationrulecollection", + "redirect_url": "/powershell/module/exchangepowershell/remove-classificationrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DataClassification.md", - "redirect_url": "/powershell/module/exchange/remove-dataclassification", + "redirect_url": "/powershell/module/exchangepowershell/remove-dataclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/remove-dlpcompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRule.md", - "redirect_url": "/powershell/module/exchange/remove-dlpcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpEdmSchema.md", - "redirect_url": "/powershell/module/exchange/remove-dlpedmschema", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpedmschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpKeywordDictionary.md", - "redirect_url": "/powershell/module/exchange/remove-dlpkeyworddictionary", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpkeyworddictionary", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-dlppolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlppolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpPolicyTemplate.md", - "redirect_url": "/powershell/module/exchange/remove-dlppolicytemplate", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlppolicytemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationType.md", - "redirect_url": "/powershell/module/exchange/remove-dlpsensitiveinformationtype", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtyperulepackage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-PolicyTipConfig.md", - "redirect_url": "/powershell/module/exchange/remove-policytipconfig", + "redirect_url": "/powershell/module/exchangepowershell/remove-policytipconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-ClassificationRuleCollection.md", - "redirect_url": "/powershell/module/exchange/set-classificationrulecollection", + "redirect_url": "/powershell/module/exchangepowershell/set-classificationrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DataClassification.md", - "redirect_url": "/powershell/module/exchange/set-dataclassification", + "redirect_url": "/powershell/module/exchangepowershell/set-dataclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/set-dlpcompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpComplianceRule.md", - "redirect_url": "/powershell/module/exchange/set-dlpcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpEdmSchema.md", - "redirect_url": "/powershell/module/exchange/set-dlpedmschema", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpedmschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpKeywordDictionary.md", - "redirect_url": "/powershell/module/exchange/set-dlpkeyworddictionary", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpkeyworddictionary", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpPolicy.md", - "redirect_url": "/powershell/module/exchange/set-dlppolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-dlppolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationType.md", - "redirect_url": "/powershell/module/exchange/set-dlpsensitiveinformationtype", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpsensitiveinformationtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "/powershell/module/exchange/set-dlpsensitiveinformationtyperulepackage", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpsensitiveinformationtyperulepackage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-PolicyTipConfig.md", - "redirect_url": "/powershell/module/exchange/set-policytipconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-policytipconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Add-ComplianceCaseMember.md", - "redirect_url": "/powershell/module/exchange/add-compliancecasemember", + "redirect_url": "/powershell/module/exchangepowershell/add-compliancecasemember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Add-eDiscoveryCaseAdmin.md", - "redirect_url": "/powershell/module/exchange/add-ediscoverycaseadmin", + "redirect_url": "/powershell/module/exchangepowershell/add-ediscoverycaseadmin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-CaseHoldPolicy.md", - "redirect_url": "/powershell/module/exchange/get-caseholdpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-caseholdpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-CaseHoldRule.md", - "redirect_url": "/powershell/module/exchange/get-caseholdrule", + "redirect_url": "/powershell/module/exchangepowershell/get-caseholdrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-ComplianceCase.md", - "redirect_url": "/powershell/module/exchange/get-compliancecase", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancecase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-ComplianceCaseMember.md", - "redirect_url": "/powershell/module/exchange/get-compliancecasemember", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancecasemember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-eDiscoveryCaseAdmin.md", - "redirect_url": "/powershell/module/exchange/get-ediscoverycaseadmin", + "redirect_url": "/powershell/module/exchangepowershell/get-ediscoverycaseadmin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-CaseHoldPolicy.md", - "redirect_url": "/powershell/module/exchange/new-caseholdpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-caseholdpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-CaseHoldRule.md", - "redirect_url": "/powershell/module/exchange/new-caseholdrule", + "redirect_url": "/powershell/module/exchangepowershell/new-caseholdrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-ComplianceCase.md", - "redirect_url": "/powershell/module/exchange/new-compliancecase", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancecase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-caseholdpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-caseholdpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldRule.md", - "redirect_url": "/powershell/module/exchange/remove-caseholdrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-caseholdrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCase.md", - "redirect_url": "/powershell/module/exchange/remove-compliancecase", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancecase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCaseMember.md", - "redirect_url": "/powershell/module/exchange/remove-compliancecasemember", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancecasemember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-eDiscoveryCaseAdmin.md", - "redirect_url": "/powershell/module/exchange/remove-ediscoverycaseadmin", + "redirect_url": "/powershell/module/exchangepowershell/remove-ediscoverycaseadmin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-CaseHoldPolicy.md", - "redirect_url": "/powershell/module/exchange/set-caseholdpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-caseholdpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-CaseHoldRule.md", - "redirect_url": "/powershell/module/exchange/set-caseholdrule", + "redirect_url": "/powershell/module/exchangepowershell/set-caseholdrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-ComplianceCase.md", - "redirect_url": "/powershell/module/exchange/set-compliancecase", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancecase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Update-ComplianceCaseMember.md", - "redirect_url": "/powershell/module/exchange/update-compliancecasemember", + "redirect_url": "/powershell/module/exchangepowershell/update-compliancecasemember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Update-eDiscoveryCaseAdmin.md", - "redirect_url": "/powershell/module/exchange/update-ediscoverycaseadmin", + "redirect_url": "/powershell/module/exchangepowershell/update-ediscoverycaseadmin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Enable-ComplianceTagStorage.md", - "redirect_url": "/powershell/module/exchange/enable-compliancetagstorage", + "redirect_url": "/powershell/module/exchangepowershell/enable-compliancetagstorage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEvent.md", - "redirect_url": "/powershell/module/exchange/get-complianceretentionevent", + "redirect_url": "/powershell/module/exchangepowershell/get-complianceretentionevent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEventType.md", - "redirect_url": "/powershell/module/exchange/get-complianceretentioneventtype", + "redirect_url": "/powershell/module/exchangepowershell/get-complianceretentioneventtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceTag.md", - "redirect_url": "/powershell/module/exchange/get-compliancetag", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancetag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceTagStorage.md", - "redirect_url": "/powershell/module/exchange/get-compliancetagstorage", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancetagstorage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-DataRetentionReport.md", - "redirect_url": "/powershell/module/exchange/get-dataretentionreport", + "redirect_url": "/powershell/module/exchangepowershell/get-dataretentionreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-HoldCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/get-holdcompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-holdcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-HoldComplianceRule.md", - "redirect_url": "/powershell/module/exchange/get-holdcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/get-holdcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedContentSettings.md", - "redirect_url": "/powershell/module/exchange/get-managedcontentsettings", + "redirect_url": "/powershell/module/exchangepowershell/get-managedcontentsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedFolder.md", - "redirect_url": "/powershell/module/exchange/get-managedfolder", + "redirect_url": "/powershell/module/exchangepowershell/get-managedfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedFolderMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/get-managedfoldermailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-managedfoldermailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/get-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/get-retentioncompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionEvent.md", - "redirect_url": "/powershell/module/exchange/get-retentionevent", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionevent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/get-retentionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionPolicyTag.md", - "redirect_url": "/powershell/module/exchange/get-retentionpolicytag", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionpolicytag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceRetentionEvent.md", - "redirect_url": "/powershell/module/exchange/new-complianceretentionevent", + "redirect_url": "/powershell/module/exchangepowershell/new-complianceretentionevent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceRetentionEventType.md", - "redirect_url": "/powershell/module/exchange/new-complianceretentioneventtype", + "redirect_url": "/powershell/module/exchangepowershell/new-complianceretentioneventtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceTag.md", - "redirect_url": "/powershell/module/exchange/new-compliancetag", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancetag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-HoldCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/new-holdcompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-holdcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-HoldComplianceRule.md", - "redirect_url": "/powershell/module/exchange/new-holdcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/new-holdcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedContentSettings.md", - "redirect_url": "/powershell/module/exchange/new-managedcontentsettings", + "redirect_url": "/powershell/module/exchangepowershell/new-managedcontentsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedFolder.md", - "redirect_url": "/powershell/module/exchange/new-managedfolder", + "redirect_url": "/powershell/module/exchangepowershell/new-managedfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedFolderMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/new-managedfoldermailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-managedfoldermailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/new-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/new-retentioncompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/new-retentionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-retentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionPolicyTag.md", - "redirect_url": "/powershell/module/exchange/new-retentionpolicytag", + "redirect_url": "/powershell/module/exchangepowershell/new-retentionpolicytag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ComplianceRetentionEventType.md", - "redirect_url": "/powershell/module/exchange/remove-complianceretentioneventtype", + "redirect_url": "/powershell/module/exchangepowershell/remove-complianceretentioneventtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ComplianceTag.md", - "redirect_url": "/powershell/module/exchange/remove-compliancetag", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancetag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-HoldCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/remove-holdcompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-holdcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-HoldComplianceRule.md", - "redirect_url": "/powershell/module/exchange/remove-holdcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/remove-holdcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedContentSettings.md", - "redirect_url": "/powershell/module/exchange/remove-managedcontentsettings", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedcontentsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedFolder.md", - "redirect_url": "/powershell/module/exchange/remove-managedfolder", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedFolderMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-managedfoldermailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedfoldermailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/remove-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/remove-retentioncompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-retentionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionPolicyTag.md", - "redirect_url": "/powershell/module/exchange/remove-retentionpolicytag", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentionpolicytag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ComplianceRetentionEventType.md", - "redirect_url": "/powershell/module/exchange/set-complianceretentioneventtype", + "redirect_url": "/powershell/module/exchangepowershell/set-complianceretentioneventtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ComplianceTag.md", - "redirect_url": "/powershell/module/exchange/set-compliancetag", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancetag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-HoldCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/set-holdcompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-holdcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-HoldComplianceRule.md", - "redirect_url": "/powershell/module/exchange/set-holdcompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/set-holdcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedContentSettings.md", - "redirect_url": "/powershell/module/exchange/set-managedcontentsettings", + "redirect_url": "/powershell/module/exchangepowershell/set-managedcontentsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedFolder.md", - "redirect_url": "/powershell/module/exchange/set-managedfolder", + "redirect_url": "/powershell/module/exchangepowershell/set-managedfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedFolderMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/set-managedfoldermailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-managedfoldermailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionCompliancePolicy.md", - "redirect_url": "/powershell/module/exchange/set-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionComplianceRule.md", - "redirect_url": "/powershell/module/exchange/set-retentioncompliancerule", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionPolicy.md", - "redirect_url": "/powershell/module/exchange/set-retentionpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-retentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionPolicyTag.md", - "redirect_url": "/powershell/module/exchange/set-retentionpolicytag", + "redirect_url": "/powershell/module/exchangepowershell/set-retentionpolicytag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Start-ManagedFolderAssistant.md", - "redirect_url": "/powershell/module/exchange/start-managedfolderassistant", + "redirect_url": "/powershell/module/exchangepowershell/start-managedfolderassistant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Start-RetentionAutoTagLearning.md", - "redirect_url": "/powershell/module/exchange/start-retentionautotaglearning", + "redirect_url": "/powershell/module/exchangepowershell/start-retentionautotaglearning", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Stop-ManagedFolderAssistant.md", - "redirect_url": "/powershell/module/exchange/stop-managedfolderassistant", + "redirect_url": "/powershell/module/exchangepowershell/stop-managedfolderassistant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Validate-RetentionRuleQuery.md", - "redirect_url": "/powershell/module/exchange/validate-retentionrulequery", + "redirect_url": "/powershell/module/exchangepowershell/validate-retentionrulequery", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Connect-ExchangeOnline.md", - "redirect_url": "/powershell/module/exchange/connect-exchangeonline", + "redirect_url": "/powershell/module/exchangepowershell/connect-exchangeonline", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOCasMailbox.md", - "redirect_url": "/powershell/module/exchange/get-exocasmailbox", + "redirect_url": "/powershell/module/exchangepowershell/get-exocasmailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailbox.md", - "redirect_url": "/powershell/module/exchange/get-exomailbox", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxFolderPermission.md", - "redirect_url": "/powershell/module/exchange/get-exomailboxfolderpermission", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxfolderpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxFolderStatistics.md", - "redirect_url": "/powershell/module/exchange/get-exomailboxfolderstatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxfolderstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxPermission.md", - "redirect_url": "/powershell/module/exchange/get-exomailboxpermission", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxStatistics.md", - "redirect_url": "/powershell/module/exchange/get-exomailboxstatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMobileDeviceStatistics.md", - "redirect_url": "/powershell/module/exchange/get-exomobiledevicestatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-exomobiledevicestatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXORecipient.md", - "redirect_url": "/powershell/module/exchange/get-exorecipient", + "redirect_url": "/powershell/module/exchangepowershell/get-exorecipient", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXORecipientPermission.md", - "redirect_url": "/powershell/module/exchange/get-exorecipientpermission", + "redirect_url": "/powershell/module/exchangepowershell/get-exorecipientpermission", "redirect_document_id": false }, { @@ -5207,7 +5207,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-HistoricalSearch.md", - "redirect_url": "/powershell/module/exchange/get-historicalsearch", + "redirect_url": "/powershell/module/exchangepowershell/get-historicalsearch", "redirect_document_id": false }, { @@ -5217,7 +5217,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-LogonStatistics.md", - "redirect_url": "/powershell/module/exchange/get-logonstatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-logonstatistics", "redirect_document_id": false }, { @@ -5237,52 +5237,52 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailDlpPolicyReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetaildlppolicyreport", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetaildlppolicyreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailMalwareReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailSpamReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailTransportRuleReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailtransportrulereport", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailtransportrulereport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailFilterListReport.md", - "redirect_url": "/powershell/module/exchange/get-mailfilterlistreport", + "redirect_url": "/powershell/module/exchangepowershell/get-mailfilterlistreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficPolicyReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficpolicyreport", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficpolicyreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficreport", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficSummaryReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficsummaryreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficTopReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficsummaryreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MxRecordReport.md", - "redirect_url": "/powershell/module/exchange/get-mxrecordreport", + "redirect_url": "/powershell/module/exchangepowershell/get-mxrecordreport", "redirect_document_id": false }, { @@ -5307,27 +5307,27 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-OutboundConnectorReport.md", - "redirect_url": "/powershell/module/exchange/get-outboundconnectorreport", + "redirect_url": "/powershell/module/exchangepowershell/get-outboundconnectorreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-RecipientStatisticsReport.md", - "redirect_url": "/powershell/module/exchange/get-recipientstatisticsreport", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientstatisticsreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-ReportExecutionInstance.md", - "redirect_url": "/powershell/module/exchange/get-reportexecutioninstance", + "redirect_url": "/powershell/module/exchangepowershell/get-reportexecutioninstance", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SCInsights.md", - "redirect_url": "/powershell/module/exchange/get-scinsights", + "redirect_url": "/powershell/module/exchangepowershell/get-scinsights", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-ServiceDeliveryReport.md", - "redirect_url": "/powershell/module/exchange/get-servicedeliveryreport", + "redirect_url": "/powershell/module/exchangepowershell/get-servicedeliveryreport", "redirect_document_id": false }, { @@ -5372,1138 +5372,1138 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewActivity.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewactivity", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewactivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewOverallProgressReport.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewoverallprogressreport", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewoverallprogressreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewPolicyReport.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewpolicyreport", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewpolicyreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewReport.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewreport", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewTopCasesReport.md", - "redirect_url": "/powershell/module/exchange/get-supervisoryreviewtopcasesreport", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewtopcasesreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-TenantAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-UserAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Set-TenantAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchangepowershell/myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Set-UserAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchangepowershell/myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Add-ManagementRoleEntry.md", - "redirect_url": "/powershell/module/exchange/add-managementroleentry", + "redirect_url": "/powershell/module/exchangepowershell/add-managementroleentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Add-RoleGroupMember.md", - "redirect_url": "/powershell/module/exchange/add-rolegroupmember", + "redirect_url": "/powershell/module/exchangepowershell/add-rolegroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRole.md", - "redirect_url": "/powershell/module/exchange/get-managementrole", + "redirect_url": "/powershell/module/exchangepowershell/get-managementrole", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRoleAssignment.md", - "redirect_url": "/powershell/module/exchange/get-managementroleassignment", + "redirect_url": "/powershell/module/exchangepowershell/get-managementroleassignment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRoleEntry.md", - "redirect_url": "/powershell/module/exchange/get-managementroleentry", + "redirect_url": "/powershell/module/exchangepowershell/get-managementroleentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementScope.md", - "redirect_url": "/powershell/module/exchange/get-managementscope", + "redirect_url": "/powershell/module/exchangepowershell/get-managementscope", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleAssignmentPolicy.md", - "redirect_url": "/powershell/module/exchange/get-roleassignmentpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-roleassignmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleGroup.md", - "redirect_url": "/powershell/module/exchange/get-rolegroup", + "redirect_url": "/powershell/module/exchangepowershell/get-rolegroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleGroupMember.md", - "redirect_url": "/powershell/module/exchange/get-rolegroupmember", + "redirect_url": "/powershell/module/exchangepowershell/get-rolegroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementRole.md", - "redirect_url": "/powershell/module/exchange/new-managementrole", + "redirect_url": "/powershell/module/exchangepowershell/new-managementrole", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementRoleAssignment.md", - "redirect_url": "/powershell/module/exchange/new-managementroleassignment", + "redirect_url": "/powershell/module/exchangepowershell/new-managementroleassignment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementScope.md", - "redirect_url": "/powershell/module/exchange/new-managementscope", + "redirect_url": "/powershell/module/exchangepowershell/new-managementscope", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-RoleAssignmentPolicy.md", - "redirect_url": "/powershell/module/exchange/new-roleassignmentpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-roleassignmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-RoleGroup.md", - "redirect_url": "/powershell/module/exchange/new-rolegroup", + "redirect_url": "/powershell/module/exchangepowershell/new-rolegroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRole.md", - "redirect_url": "/powershell/module/exchange/remove-managementrole", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementrole", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRoleAssignment.md", - "redirect_url": "/powershell/module/exchange/remove-managementroleassignment", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementroleassignment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRoleEntry.md", - "redirect_url": "/powershell/module/exchange/remove-managementroleentry", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementroleentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementScope.md", - "redirect_url": "/powershell/module/exchange/remove-managementscope", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementscope", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleAssignmentPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-roleassignmentpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-roleassignmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleGroup.md", - "redirect_url": "/powershell/module/exchange/remove-rolegroup", + "redirect_url": "/powershell/module/exchangepowershell/remove-rolegroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleGroupMember.md", - "redirect_url": "/powershell/module/exchange/remove-rolegroupmember", + "redirect_url": "/powershell/module/exchangepowershell/remove-rolegroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementRoleAssignment.md", - "redirect_url": "/powershell/module/exchange/set-managementroleassignment", + "redirect_url": "/powershell/module/exchangepowershell/set-managementroleassignment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementRoleEntry.md", - "redirect_url": "/powershell/module/exchange/set-managementroleentry", + "redirect_url": "/powershell/module/exchangepowershell/set-managementroleentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementScope.md", - "redirect_url": "/powershell/module/exchange/set-managementscope", + "redirect_url": "/powershell/module/exchangepowershell/set-managementscope", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-RoleAssignmentPolicy.md", - "redirect_url": "/powershell/module/exchange/set-roleassignmentpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-roleassignmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-RoleGroup.md", - "redirect_url": "/powershell/module/exchange/set-rolegroup", + "redirect_url": "/powershell/module/exchangepowershell/set-rolegroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Update-RoleGroupMember.md", - "redirect_url": "/powershell/module/exchange/update-rolegroupmember", + "redirect_url": "/powershell/module/exchangepowershell/update-rolegroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Add-GlobalMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/add-globalmonitoringoverride", + "redirect_url": "/powershell/module/exchangepowershell/add-globalmonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Add-ServerMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/add-servermonitoringoverride", + "redirect_url": "/powershell/module/exchangepowershell/add-servermonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-AvailabilityReportOutage.md", - "redirect_url": "/powershell/module/exchange/get-availabilityreportoutage", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityreportoutage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-EventLogLevel.md", - "redirect_url": "/powershell/module/exchange/get-eventloglevel", + "redirect_url": "/powershell/module/exchangepowershell/get-eventloglevel", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-GlobalMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/get-globalmonitoringoverride", + "redirect_url": "/powershell/module/exchangepowershell/get-globalmonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-HealthReport.md", - "redirect_url": "/powershell/module/exchange/get-healthreport", + "redirect_url": "/powershell/module/exchangepowershell/get-healthreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-MonitoringItemHelp.md", - "redirect_url": "/powershell/module/exchange/get-monitoringitemhelp", + "redirect_url": "/powershell/module/exchangepowershell/get-monitoringitemhelp", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-MonitoringItemIdentity.md", - "redirect_url": "/powershell/module/exchange/get-monitoringitemidentity", + "redirect_url": "/powershell/module/exchangepowershell/get-monitoringitemidentity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerComponentState.md", - "redirect_url": "/powershell/module/exchange/get-servercomponentstate", + "redirect_url": "/powershell/module/exchangepowershell/get-servercomponentstate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerHealth.md", - "redirect_url": "/powershell/module/exchange/get-serverhealth", + "redirect_url": "/powershell/module/exchangepowershell/get-serverhealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/get-servermonitoringoverride", + "redirect_url": "/powershell/module/exchangepowershell/get-servermonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ThrottlingPolicy.md", - "redirect_url": "/powershell/module/exchange/get-throttlingpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-throttlingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ThrottlingPolicyAssociation.md", - "redirect_url": "/powershell/module/exchange/get-throttlingpolicyassociation", + "redirect_url": "/powershell/module/exchangepowershell/get-throttlingpolicyassociation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Invoke-MonitoringProbe.md", - "redirect_url": "/powershell/module/exchange/invoke-monitoringprobe", + "redirect_url": "/powershell/module/exchangepowershell/invoke-monitoringprobe", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/New-AvailabilityReportOutage.md", - "redirect_url": "/powershell/module/exchange/new-availabilityreportoutage", + "redirect_url": "/powershell/module/exchangepowershell/new-availabilityreportoutage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/New-ThrottlingPolicy.md", - "redirect_url": "/powershell/module/exchange/new-throttlingpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-throttlingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-AvailabilityReportOutage.md", - "redirect_url": "/powershell/module/exchange/remove-availabilityreportoutage", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityreportoutage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-GlobalMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/remove-globalmonitoringoverride", + "redirect_url": "/powershell/module/exchangepowershell/remove-globalmonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-ServerMonitoringOverride.md", - "redirect_url": "/powershell/module/exchange/remove-servermonitoringoverride", + "redirect_url": "/powershell/module/exchangepowershell/remove-servermonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-ThrottlingPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-throttlingpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-throttlingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-AvailabilityReportOutage.md", - "redirect_url": "/powershell/module/exchange/set-availabilityreportoutage", + "redirect_url": "/powershell/module/exchangepowershell/set-availabilityreportoutage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-EventLogLevel.md", - "redirect_url": "/powershell/module/exchange/set-eventloglevel", + "redirect_url": "/powershell/module/exchangepowershell/set-eventloglevel", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ServerComponentState.md", - "redirect_url": "/powershell/module/exchange/set-servercomponentstate", + "redirect_url": "/powershell/module/exchangepowershell/set-servercomponentstate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ServerMonitor.md", - "redirect_url": "/powershell/module/exchange/set-servermonitor", + "redirect_url": "/powershell/module/exchangepowershell/set-servermonitor", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ThrottlingPolicy.md", - "redirect_url": "/powershell/module/exchange/set-throttlingpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-throttlingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ThrottlingPolicyAssociation.md", - "redirect_url": "/powershell/module/exchange/set-throttlingpolicyassociation", + "redirect_url": "/powershell/module/exchangepowershell/set-throttlingpolicyassociation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Test-ServiceHealth.md", - "redirect_url": "/powershell/module/exchange/test-servicehealth", + "redirect_url": "/powershell/module/exchangepowershell/test-servicehealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-AvailabilityAddressSpace.md", - "redirect_url": "/powershell/module/exchange/add-availabilityaddressspace", + "redirect_url": "/powershell/module/exchangepowershell/add-availabilityaddressspace", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-PublicFolderAdministrativePermission.md", - "redirect_url": "/powershell/module/exchange/add-publicfolderadministrativepermission", + "redirect_url": "/powershell/module/exchangepowershell/add-publicfolderadministrativepermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-PublicFolderClientPermission.md", - "redirect_url": "/powershell/module/exchange/add-publicfolderclientpermission", + "redirect_url": "/powershell/module/exchangepowershell/add-publicfolderclientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Disable-MailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/disable-mailpublicfolder", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Enable-MailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/enable-mailpublicfolder", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-AvailabilityAddressSpace.md", - "redirect_url": "/powershell/module/exchange/get-availabilityaddressspace", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityaddressspace", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-AvailabilityConfig.md", - "redirect_url": "/powershell/module/exchange/get-availabilityconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-MailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/get-mailpublicfolder", + "redirect_url": "/powershell/module/exchangepowershell/get-mailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-OrganizationRelationship.md", - "redirect_url": "/powershell/module/exchange/get-organizationrelationship", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationrelationship", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolder.md", - "redirect_url": "/powershell/module/exchange/get-publicfolder", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderAdministrativePermission.md", - "redirect_url": "/powershell/module/exchange/get-publicfolderadministrativepermission", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderadministrativepermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderClientPermission.md", - "redirect_url": "/powershell/module/exchange/get-publicfolderclientpermission", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderclientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderDatabase.md", - "redirect_url": "/powershell/module/exchange/get-publicfolderdatabase", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderItemStatistics.md", - "redirect_url": "/powershell/module/exchange/get-publicfolderitemstatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderitemstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderMailboxDiagnostics.md", - "redirect_url": "/powershell/module/exchange/get-publicfoldermailboxdiagnostics", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxdiagnostics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderStatistics.md", - "redirect_url": "/powershell/module/exchange/get-publicfolderstatistics", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SharingPolicy.md", - "redirect_url": "/powershell/module/exchange/get-sharingpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-sharingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailbox.md", - "redirect_url": "/powershell/module/exchange/get-sitemailbox", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailboxDiagnostics.md", - "redirect_url": "/powershell/module/exchange/get-sitemailboxdiagnostics", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailboxdiagnostics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailboxProvisioningPolicy.md", - "redirect_url": "/powershell/module/exchange/get-sitemailboxprovisioningpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailboxprovisioningpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-AvailabilityConfig.md", - "redirect_url": "/powershell/module/exchange/new-availabilityconfig", + "redirect_url": "/powershell/module/exchangepowershell/new-availabilityconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-OrganizationRelationship.md", - "redirect_url": "/powershell/module/exchange/new-organizationrelationship", + "redirect_url": "/powershell/module/exchangepowershell/new-organizationrelationship", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolder.md", - "redirect_url": "/powershell/module/exchange/new-publicfolder", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolderDatabase.md", - "redirect_url": "/powershell/module/exchange/new-publicfolderdatabase", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolderdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolderDatabaseRepairRequest.md", - "redirect_url": "/powershell/module/exchange/new-publicfolderdatabaserepairrequest", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolderdatabaserepairrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SharingPolicy.md", - "redirect_url": "/powershell/module/exchange/new-sharingpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-sharingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SiteMailboxProvisioningPolicy.md", - "redirect_url": "/powershell/module/exchange/new-sitemailboxprovisioningpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-sitemailboxprovisioningpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SyncMailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/new-syncmailpublicfolder", + "redirect_url": "/powershell/module/exchangepowershell/new-syncmailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-AvailabilityAddressSpace.md", - "redirect_url": "/powershell/module/exchange/remove-availabilityaddressspace", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityaddressspace", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-AvailabilityConfig.md", - "redirect_url": "/powershell/module/exchange/remove-availabilityconfig", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-OrganizationRelationship.md", - "redirect_url": "/powershell/module/exchange/remove-organizationrelationship", + "redirect_url": "/powershell/module/exchangepowershell/remove-organizationrelationship", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolder.md", - "redirect_url": "/powershell/module/exchange/remove-publicfolder", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderAdministrativePermission.md", - "redirect_url": "/powershell/module/exchange/remove-publicfolderadministrativepermission", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderadministrativepermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderClientPermission.md", - "redirect_url": "/powershell/module/exchange/remove-publicfolderclientpermission", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderclientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderDatabase.md", - "redirect_url": "/powershell/module/exchange/remove-publicfolderdatabase", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SharingPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-sharingpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-sharingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SiteMailboxProvisioningPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-sitemailboxprovisioningpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-sitemailboxprovisioningpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SyncMailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/remove-syncmailpublicfolder", + "redirect_url": "/powershell/module/exchangepowershell/remove-syncmailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Resume-PublicFolderReplication.md", - "redirect_url": "/powershell/module/exchange/resume-publicfolderreplication", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfolderreplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-AvailabilityConfig.md", - "redirect_url": "/powershell/module/exchange/set-availabilityconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-availabilityconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-MailPublicFolder.md", - "redirect_url": "/powershell/module/exchange/set-mailpublicfolder", + "redirect_url": "/powershell/module/exchangepowershell/set-mailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-OrganizationRelationship.md", - "redirect_url": "/powershell/module/exchange/set-organizationrelationship", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationrelationship", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-PublicFolder.md", - "redirect_url": "/powershell/module/exchange/set-publicfolder", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-PublicFolderDatabase.md", - "redirect_url": "/powershell/module/exchange/set-publicfolderdatabase", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfolderdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SharingPolicy.md", - "redirect_url": "/powershell/module/exchange/set-sharingpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-sharingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SiteMailbox.md", - "redirect_url": "/powershell/module/exchange/set-sitemailbox", + "redirect_url": "/powershell/module/exchangepowershell/set-sitemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SiteMailboxProvisioningPolicy.md", - "redirect_url": "/powershell/module/exchange/set-sitemailboxprovisioningpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-sitemailboxprovisioningpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Suspend-PublicFolderReplication.md", - "redirect_url": "/powershell/module/exchange/suspend-publicfolderreplication", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfolderreplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Test-OrganizationRelationship.md", - "redirect_url": "/powershell/module/exchange/test-organizationrelationship", + "redirect_url": "/powershell/module/exchangepowershell/test-organizationrelationship", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Test-SiteMailbox.md", - "redirect_url": "/powershell/module/exchange/test-sitemailbox", + "redirect_url": "/powershell/module/exchangepowershell/test-sitemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolder.md", - "redirect_url": "/powershell/module/exchange/update-publicfolder", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolderHierarchy.md", - "redirect_url": "/powershell/module/exchange/update-publicfolderhierarchy", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfolderhierarchy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolderMailbox.md", - "redirect_url": "/powershell/module/exchange/update-publicfoldermailbox", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfoldermailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-SiteMailbox.md", - "redirect_url": "/powershell/module/exchange/update-sitemailbox", + "redirect_url": "/powershell/module/exchangepowershell/update-sitemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/disable-umautoattendant", + "redirect_url": "/powershell/module/exchangepowershell/disable-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/disable-umcallansweringrule", + "redirect_url": "/powershell/module/exchangepowershell/disable-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/disable-umipgateway", + "redirect_url": "/powershell/module/exchangepowershell/disable-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMMailbox.md", - "redirect_url": "/powershell/module/exchange/disable-ummailbox", + "redirect_url": "/powershell/module/exchangepowershell/disable-ummailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMServer.md", - "redirect_url": "/powershell/module/exchange/disable-umserver", + "redirect_url": "/powershell/module/exchangepowershell/disable-umserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMService.md", - "redirect_url": "/powershell/module/exchange/disable-umservice", + "redirect_url": "/powershell/module/exchangepowershell/disable-umservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/enable-umautoattendant", + "redirect_url": "/powershell/module/exchangepowershell/enable-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/enable-umcallansweringrule", + "redirect_url": "/powershell/module/exchangepowershell/enable-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/enable-umipgateway", + "redirect_url": "/powershell/module/exchangepowershell/enable-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMMailbox.md", - "redirect_url": "/powershell/module/exchange/enable-ummailbox", + "redirect_url": "/powershell/module/exchangepowershell/enable-ummailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMServer.md", - "redirect_url": "/powershell/module/exchange/enable-umserver", + "redirect_url": "/powershell/module/exchangepowershell/enable-umserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMService.md", - "redirect_url": "/powershell/module/exchange/enable-umservice", + "redirect_url": "/powershell/module/exchangepowershell/enable-umservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Export-UMCallDataRecord.md", - "redirect_url": "/powershell/module/exchange/export-umcalldatarecord", + "redirect_url": "/powershell/module/exchangepowershell/export-umcalldatarecord", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Export-UMPrompt.md", - "redirect_url": "/powershell/module/exchange/export-umprompt", + "redirect_url": "/powershell/module/exchangepowershell/export-umprompt", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-OnlineMeetingConfiguration.md", - "redirect_url": "/powershell/module/exchange/get-onlinemeetingconfiguration", + "redirect_url": "/powershell/module/exchangepowershell/get-onlinemeetingconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMActiveCalls.md", - "redirect_url": "/powershell/module/exchange/get-umactivecalls", + "redirect_url": "/powershell/module/exchangepowershell/get-umactivecalls", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/get-umautoattendant", + "redirect_url": "/powershell/module/exchangepowershell/get-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/get-umcallansweringrule", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallDataRecord.md", - "redirect_url": "/powershell/module/exchange/get-umcalldatarecord", + "redirect_url": "/powershell/module/exchangepowershell/get-umcalldatarecord", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallRouterSettings.md", - "redirect_url": "/powershell/module/exchange/get-umcallroutersettings", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallroutersettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallSummaryReport.md", - "redirect_url": "/powershell/module/exchange/get-umcallsummaryreport", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallsummaryreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMDialPlan.md", - "redirect_url": "/powershell/module/exchange/get-umdialplan", + "redirect_url": "/powershell/module/exchangepowershell/get-umdialplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMHuntGroup.md", - "redirect_url": "/powershell/module/exchange/get-umhuntgroup", + "redirect_url": "/powershell/module/exchangepowershell/get-umhuntgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/get-umipgateway", + "redirect_url": "/powershell/module/exchangepowershell/get-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailbox.md", - "redirect_url": "/powershell/module/exchange/get-ummailbox", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailboxPIN.md", - "redirect_url": "/powershell/module/exchange/get-ummailboxpin", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailboxpin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/get-ummailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UmServer.md", - "redirect_url": "/powershell/module/exchange/get-umserver", + "redirect_url": "/powershell/module/exchangepowershell/get-umserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMService.md", - "redirect_url": "/powershell/module/exchange/get-umservice", + "redirect_url": "/powershell/module/exchangepowershell/get-umservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Import-UMPrompt.md", - "redirect_url": "/powershell/module/exchange/import-umprompt", + "redirect_url": "/powershell/module/exchangepowershell/import-umprompt", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/new-umautoattendant", + "redirect_url": "/powershell/module/exchangepowershell/new-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/new-umcallansweringrule", + "redirect_url": "/powershell/module/exchangepowershell/new-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMDialPlan.md", - "redirect_url": "/powershell/module/exchange/new-umdialplan", + "redirect_url": "/powershell/module/exchangepowershell/new-umdialplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMHuntGroup.md", - "redirect_url": "/powershell/module/exchange/new-umhuntgroup", + "redirect_url": "/powershell/module/exchangepowershell/new-umhuntgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/new-umipgateway", + "redirect_url": "/powershell/module/exchangepowershell/new-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/new-ummailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/new-ummailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/remove-umautoattendant", + "redirect_url": "/powershell/module/exchangepowershell/remove-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/remove-umcallansweringrule", + "redirect_url": "/powershell/module/exchangepowershell/remove-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMDialPlan.md", - "redirect_url": "/powershell/module/exchange/remove-umdialplan", + "redirect_url": "/powershell/module/exchangepowershell/remove-umdialplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMHuntGroup.md", - "redirect_url": "/powershell/module/exchange/remove-umhuntgroup", + "redirect_url": "/powershell/module/exchangepowershell/remove-umhuntgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/remove-umipgateway", + "redirect_url": "/powershell/module/exchangepowershell/remove-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-ummailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/remove-ummailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMAutoAttendant.md", - "redirect_url": "/powershell/module/exchange/set-umautoattendant", + "redirect_url": "/powershell/module/exchangepowershell/set-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMCallAnsweringRule.md", - "redirect_url": "/powershell/module/exchange/set-umcallansweringrule", + "redirect_url": "/powershell/module/exchangepowershell/set-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMCallRouterSettings.md", - "redirect_url": "/powershell/module/exchange/set-umcallroutersettings", + "redirect_url": "/powershell/module/exchangepowershell/set-umcallroutersettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMDialPlan.md", - "redirect_url": "/powershell/module/exchange/set-umdialplan", + "redirect_url": "/powershell/module/exchangepowershell/set-umdialplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMIPGateway.md", - "redirect_url": "/powershell/module/exchange/set-umipgateway", + "redirect_url": "/powershell/module/exchangepowershell/set-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailbox.md", - "redirect_url": "/powershell/module/exchange/set-ummailbox", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailboxPIN.md", - "redirect_url": "/powershell/module/exchange/set-ummailboxpin", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailboxpin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailboxPolicy.md", - "redirect_url": "/powershell/module/exchange/set-ummailboxpolicy", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UmServer.md", - "redirect_url": "/powershell/module/exchange/set-umserver", + "redirect_url": "/powershell/module/exchangepowershell/set-umserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMService.md", - "redirect_url": "/powershell/module/exchange/set-umservice", + "redirect_url": "/powershell/module/exchangepowershell/set-umservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Test-UMConnectivity.md", - "redirect_url": "/powershell/module/exchange/test-umconnectivity", + "redirect_url": "/powershell/module/exchangepowershell/test-umconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Add-DistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/add-distributiongroupmember", + "redirect_url": "/powershell/module/exchangepowershell/add-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Add-UnifiedGroupLinks.md", - "redirect_url": "/powershell/module/exchange/add-unifiedgrouplinks", + "redirect_url": "/powershell/module/exchangepowershell/add-unifiedgrouplinks", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/disable-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/disable-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-MailContact.md", - "redirect_url": "/powershell/module/exchange/disable-mailcontact", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-MailUser.md", - "redirect_url": "/powershell/module/exchange/disable-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/enable-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/enable-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-MailContact.md", - "redirect_url": "/powershell/module/exchange/enable-mailcontact", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-MailUser.md", - "redirect_url": "/powershell/module/exchange/enable-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Contact.md", - "redirect_url": "/powershell/module/exchange/get-contact", + "redirect_url": "/powershell/module/exchangepowershell/get-contact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/get-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/get-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/get-distributiongroupmember", + "redirect_url": "/powershell/module/exchangepowershell/get-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DynamicDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/get-dynamicdistributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/get-dynamicdistributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-EligibleDistributionGroupForMigration.md", - "redirect_url": "/powershell/module/exchange/get-eligibledistributiongroupformigration", + "redirect_url": "/powershell/module/exchangepowershell/get-eligibledistributiongroupformigration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Group.md", - "redirect_url": "/powershell/module/exchange/get-group", + "redirect_url": "/powershell/module/exchangepowershell/get-group", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-LinkedUser.md", - "redirect_url": "/powershell/module/exchange/get-linkeduser", + "redirect_url": "/powershell/module/exchangepowershell/get-linkeduser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-MailContact.md", - "redirect_url": "/powershell/module/exchange/get-mailcontact", + "redirect_url": "/powershell/module/exchangepowershell/get-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-MailUser.md", - "redirect_url": "/powershell/module/exchange/get-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/get-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Recipient.md", - "redirect_url": "/powershell/module/exchange/get-recipient", + "redirect_url": "/powershell/module/exchangepowershell/get-recipient", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-SecurityPrincipal.md", - "redirect_url": "/powershell/module/exchange/get-securityprincipal", + "redirect_url": "/powershell/module/exchangepowershell/get-securityprincipal", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-UnifiedGroup.md", - "redirect_url": "/powershell/module/exchange/get-unifiedgroup", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-UnifiedGroupLinks.md", - "redirect_url": "/powershell/module/exchange/get-unifiedgrouplinks", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedgrouplinks", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-User.md", - "redirect_url": "/powershell/module/exchange/get-user", + "redirect_url": "/powershell/module/exchangepowershell/get-user", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/new-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/new-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-DynamicDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/new-dynamicdistributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/new-dynamicdistributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/new-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/new-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/new-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/new-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-MailContact.md", - "redirect_url": "/powershell/module/exchange/new-mailcontact", + "redirect_url": "/powershell/module/exchangepowershell/new-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-MailUser.md", - "redirect_url": "/powershell/module/exchange/new-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/new-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-UnifiedGroup.md", - "redirect_url": "/powershell/module/exchange/new-unifiedgroup", + "redirect_url": "/powershell/module/exchangepowershell/new-unifiedgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/remove-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/remove-distributiongroupmember", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DynamicDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/remove-dynamicdistributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/remove-dynamicdistributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/remove-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/remove-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-MailContact.md", - "redirect_url": "/powershell/module/exchange/remove-mailcontact", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-MailUser.md", - "redirect_url": "/powershell/module/exchange/remove-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-UnifiedGroup.md", - "redirect_url": "/powershell/module/exchange/remove-unifiedgroup", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-UnifiedGroupLinks.md", - "redirect_url": "/powershell/module/exchange/remove-unifiedgrouplinks", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedgrouplinks", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-Contact.md", - "redirect_url": "/powershell/module/exchange/set-contact", + "redirect_url": "/powershell/module/exchangepowershell/set-contact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/set-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/set-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-DynamicDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/set-dynamicdistributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/set-dynamicdistributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/set-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/set-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPGroup.md", - "redirect_url": "/powershell/module/exchange/set-group", + "redirect_url": "/powershell/module/exchangepowershell/set-group", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/set-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/set-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPUser.md", - "redirect_url": "/powershell/module/exchange/set-user", + "redirect_url": "/powershell/module/exchangepowershell/set-user", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-Group.md", - "redirect_url": "/powershell/module/exchange/set-group", + "redirect_url": "/powershell/module/exchangepowershell/set-group", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-LinkedUser.md", - "redirect_url": "/powershell/module/exchange/set-linkeduser", + "redirect_url": "/powershell/module/exchangepowershell/set-linkeduser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-MailContact.md", - "redirect_url": "/powershell/module/exchange/set-mailcontact", + "redirect_url": "/powershell/module/exchangepowershell/set-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-MailUser.md", - "redirect_url": "/powershell/module/exchange/set-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/set-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-UnifiedGroup.md", - "redirect_url": "/powershell/module/exchange/set-unifiedgroup", + "redirect_url": "/powershell/module/exchangepowershell/set-unifiedgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-User.md", - "redirect_url": "/powershell/module/exchange/set-user", + "redirect_url": "/powershell/module/exchangepowershell/set-user", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Undo-SoftDeletedUnifiedGroup.md", - "redirect_url": "/powershell/module/exchange/undo-softdeletedunifiedgroup", + "redirect_url": "/powershell/module/exchangepowershell/undo-softdeletedunifiedgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Update-DistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", + "redirect_url": "/powershell/module/exchangepowershell/update-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Update-EOPDistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", + "redirect_url": "/powershell/module/exchangepowershell/update-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Upgrade-DistributionGroup.md", - "redirect_url": "/powershell/module/exchange/upgrade-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/upgrade-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/office-365-scc/office-365-scc-powershell.md", "redirect_url": "/powershell/exchange/scc-powershell", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell.md", "redirect_url": "/powershell/exchange/connect-to-scc-powershell", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/mfa-connect-to-scc-powershell.md", @@ -6513,32 +6513,32 @@ { "source_path": "exchange/docs-conceptual/exchange-server/connect-to-exchange-servers-using-remote-powershell.md", "redirect_url": "/powershell/exchange/connect-to-exchange-servers-using-remote-powershell", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-server/control-remote-powershell-access-to-exchange-servers.md", "redirect_url": "/powershell/exchange/control-remote-powershell-access-to-exchange-servers", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-server/exchange-cmdlet-syntax.md", "redirect_url": "/powershell/exchange/exchange-cmdlet-syntax", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-server/exchange-management-shell.md", "redirect_url": "/powershell/exchange/exchange-management-shell", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-server/find-exchange-cmdlet-permissions.md", "redirect_url": "/powershell/exchange/find-exchange-cmdlet-permissions", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-server/open-the-exchange-management-shell.md", "redirect_url": "/powershell/exchange/open-the-exchange-management-shell", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-server/use-update-exchangehelp.md", @@ -6548,32 +6548,32 @@ { "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/filter-properties.md", "redirect_url": "/powershell/exchange/filter-properties", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/recipient-filters.md", "redirect_url": "/powershell/exchange/recipient-filters", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/recipientfilter-properties.md", "redirect_url": "/powershell/exchange/recipientfilter-properties", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-online/disable-access-to-exchange-online-powershell.md", "redirect_url": "/powershell/exchange/disable-access-to-exchange-online-powershell", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell.md", "redirect_url": "/powershell/exchange/exchange-online-powershell", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md", "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/mfa-connect-to-exchange-online-powershell.md", @@ -6583,22 +6583,22 @@ { "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/app-only-auth-powershell-v2.md", "redirect_url": "/powershell/exchange/app-only-auth-powershell-v2", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets.md", "redirect_url": "/powershell/exchange/cmdlet-property-sets", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2.md", "redirect_url": "/powershell/exchange/exchange-online-powershell-v2", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/filters-v2.md", "redirect_url": "/powershell/exchange/filters-v2", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-eop/connect-to-exchange-online-protection-powershell.md", @@ -6608,7 +6608,7 @@ { "source_path": "exchange/docs-conceptual/exchange-eop/exchange-online-protection-powershell.md", "redirect_url": "/powershell/exchange/exchange-online-protection-powershell", - "redirect_document_id": true + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/mfa-connect-to-exchange-online-powershell.md", @@ -6622,47 +6622,47 @@ }, { "source_path": "exchange/virtual-folder/exchange/Get-TenantAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-TenantAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/set-myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-UserAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-UserAnalyticsConfig.md", - "redirect_url": "/powershell/module/exchange/set-myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchangepowershell/set-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-MailDetailMalwareReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-MailDetailSpamReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionTrafficReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-UrlTrace.md", - "redirect_url": "/powershell/module/exchange/get-safelinksaggregatereport", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksaggregatereport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficReport.md", - "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", "redirect_document_id": false }, { @@ -6757,87 +6757,87 @@ }, { "source_path": "exchange/virtual-folder/exchange/Get-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Import-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchangepowershell/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-CustomNudge.md", - "redirect_url": "/powershell/module/exchange/", + "redirect_url": "/powershell/module/exchangepowershell/", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-CustomNudgeAssignment.md", - "redirect_url": "/powershell/module/exchange/", + "redirect_url": "/powershell/module/exchangepowershell/", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-CustomNudgeSettings.md", - "redirect_url": "/powershell/module/exchange/", + "redirect_url": "/powershell/module/exchangepowershell/", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/New-CustomNudge.md", - "redirect_url": "/powershell/module/exchange/", + "redirect_url": "/powershell/module/exchangepowershell/", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/New-CustomNudgeAssignment.md", - "redirect_url": "/powershell/module/exchange/", + "redirect_url": "/powershell/module/exchangepowershell/", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-CustomNudge.md", - "redirect_url": "/powershell/module/exchange/", + "redirect_url": "/powershell/module/exchangepowershell/", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-CustomNudgeAssignment.md", - "redirect_url": "/powershell/module/exchange/", + "redirect_url": "/powershell/module/exchangepowershell/", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-CustomNudge.md", - "redirect_url": "/powershell/module/exchange/", + "redirect_url": "/powershell/module/exchangepowershell/", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-CustomNudgeAssignment.md", - "redirect_url": "/powershell/module/exchange/", + "redirect_url": "/powershell/module/exchangepowershell/", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-CustomNudgeSettings.md", - "redirect_url": "/powershell/module/exchange/", + "redirect_url": "/powershell/module/exchangepowershell/", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficTopReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficsummaryreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-tenantallowblocklistspoofitems", + "redirect_url": "/powershell/module/exchangepowershell/get-tenantallowblocklistspoofitems", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-tenantallowblocklistspoofitems", + "redirect_url": "/powershell/module/exchangepowershell/set-tenantallowblocklistspoofitems", "redirect_document_id": false }, { @@ -6862,102 +6862,97 @@ }, { "source_path": "exchange/virtual-folder/exchange/New-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/new-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/new-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/New-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/new-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/new-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/remove-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/remove-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-EOPDistributionGroup.md", - "redirect_url": "/powershell/module/exchange/set-distributiongroup", + "redirect_url": "/powershell/module/exchangepowershell/set-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-EOPGroup.md", - "redirect_url": "/powershell/module/exchange/set-group", + "redirect_url": "/powershell/module/exchangepowershell/set-group", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-EOPMailUser.md", - "redirect_url": "/powershell/module/exchange/set-mailuser", + "redirect_url": "/powershell/module/exchangepowershell/set-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-EOPUser.md", - "redirect_url": "/powershell/module/exchange/set-user", + "redirect_url": "/powershell/module/exchangepowershell/set-user", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Update-EOPDistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", - "redirect_document_id": false - }, - { - "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.yml", - "redirect_url": "https://review.learn.microsoft.com/en-us/powershell/module/teams/", + "redirect_url": "/powershell/module/exchangepowershell/update-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/use-update-exchangehelp.md", "redirect_url": "/powershell/exchange/exchange-management-shell", - "redirect_document_id": false + "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md", "redirect_url": "/powershell/exchange/connect-to-scc-powershell", - "redirect_document_id": false + "redirect_document_id": true }, { "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionDocumentDetail.md", - "redirect_url": "/powershell/module/exchange/get-contentmalwaremdodetailreport", + "redirect_url": "/powershell/module/exchangepowershell/get-contentmalwaremdodetailreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionDocumentReport.md", - "redirect_url": "/powershell/module/exchange/get-contentmalwaremdoaggregatereport", + "redirect_url": "/powershell/module/exchangepowershell/get-contentmalwaremdoaggregatereport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/New-SecOpsOverrideRule.md", - "redirect_url": "/powershell/module/exchange/new-exosecopsoverriderule", + "redirect_url": "/powershell/module/exchangepowershell/new-exosecopsoverriderule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-SecOpsOverrideRule.md", - "redirect_url": "/powershell/module/exchange/remove-exosecopsoverriderule", + "redirect_url": "/powershell/module/exchangepowershell/remove-exosecopsoverriderule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-SecOpsOverrideRule.md", - "redirect_url": "/powershell/module/exchange/set-exosecopsoverriderule", + "redirect_url": "/powershell/module/exchangepowershell/set-exosecopsoverriderule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/New-PhishSimOverrideRule.md", - "redirect_url": "/powershell/module/exchange/new-exophishsimoverriderule", + "redirect_url": "/powershell/module/exchangepowershell/new-exophishsimoverriderule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-PhishSimOverrideRule.md", - "redirect_url": "/powershell/module/exchange/remove-exophishsimoverriderule", + "redirect_url": "/powershell/module/exchangepowershell/remove-exophishsimoverriderule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-PhishSimOverrideRule.md", - "redirect_url": "/powershell/module/exchange/set-exophishsimoverriderule", + "redirect_url": "/powershell/module/exchangepowershell/set-exophishsimoverriderule", "redirect_document_id": false }, { @@ -7122,12 +7117,12 @@ }, { "source_path": "exchange/virtual-folder/exchange/Get-PhishSimOverrideRule.md", - "redirect_url": "/powershell/module/exchange/get-exophishsimoverriderule", + "redirect_url": "/powershell/module/exchangepowershell/get-exophishsimoverriderule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-SecOpsOverrideRule.md", - "redirect_url": "/powershell/module/exchange/get-exosecopsoverriderule", + "redirect_url": "/powershell/module/exchangepowershell/get-exosecopsoverriderule", "redirect_document_id": false }, { @@ -7137,68 +7132,7108 @@ }, { "source_path": "exchange/virtual-folder/exchange/Get-AuditConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/get-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/get-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/New-AuditConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/new-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/new-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-AuditConfigurationPolicy.md", - "redirect_url": "/powershell/module/exchange/remove-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/remove-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/get-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/get-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/New-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/new-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/new-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/remove-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/remove-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-AuditConfigurationRule.md", - "redirect_url": "/powershell/module/exchange/set-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/set-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/get-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/get-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/New-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/new-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/new-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/remove-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/remove-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-ActivityAlert.md", - "redirect_url": "/powershell/module/exchange/set-protectionalert", + "redirect_url": "/powershell/module/exchangepowershell/set-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-RecordLabel.md", - "redirect_url": "/powershell/module/exchange/remove-label", + "redirect_url": "/powershell/module/exchangepowershell/remove-label", "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md", "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ADPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-adpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-AttachmentFilterEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-attachmentfilterentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-AvailabilityAddressSpace.md", + "redirect_url": "/powershell/module/exchangepowershell/add-availabilityaddressspace", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/add-compliancecasemember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ContentFilterPhrase.md", + "redirect_url": "/powershell/module/exchangepowershell/add-contentfilterphrase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-DatabaseAvailabilityGroupServer.md", + "redirect_url": "/powershell/module/exchangepowershell/add-databaseavailabilitygroupserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/add-distributiongroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-FederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/add-federateddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-GlobalMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/add-globalmonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-IPAllowListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipallowlistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipallowlistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-IPBlockListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipblocklistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ipblocklistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxfolderpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-MailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-mailboxpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/add-managementroleentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-PublicFolderAdministrativePermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-publicfolderadministrativepermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-PublicFolderClientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-publicfolderclientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-RecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/add-recipientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/add-resubmitrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/add-rolegroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-ServerMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/add-servermonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-UnifiedGroupLinks.md", + "redirect_url": "/powershell/module/exchangepowershell/add-unifiedgrouplinks", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-VivaModuleFeaturePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/add-vivamodulefeaturepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-VivaOrgInsightsDelegatedRole.md", + "redirect_url": "/powershell/module/exchangepowershell/add-vivaorginsightsdelegatedrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Add-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/add-ediscoverycaseadmin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Check-PurviewConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/check-purviewconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Clean-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/clean-mailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Clear-ActiveSyncDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/clear-activesyncdevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Clear-MobileDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/clear-mobiledevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Clear-TextMessagingAccount.md", + "redirect_url": "/powershell/module/exchangepowershell/clear-textmessagingaccount", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Compare-TextMessagingVerificationCode.md", + "redirect_url": "/powershell/module/exchangepowershell/compare-textmessagingverificationcode", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Complete-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/complete-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Connect-ExchangeOnline.md", + "redirect_url": "/powershell/module/exchangepowershell/connect-exchangeonline", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Connect-IPPSSession.md", + "redirect_url": "/powershell/module/exchangepowershell/connect-ippssession", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Connect-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/connect-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Delete-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/delete-quarantinemessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-AddressListPaging.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-addresslistpaging", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-App.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-cmdletextensionagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-DnssecForVerifiedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-dnssecforverifieddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-IPv6ForAcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-ipv6foraccepteddomain", "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-JournalArchiving.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-journalarchiving", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MailboxQuarantine.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-mailboxquarantine", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-MetaCacheDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-metacachedatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-outlookanywhere", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-PushNotificationProxy.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-pushnotificationproxy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-ServiceEmailChannel.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-serviceemailchannel", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-SmtpDaneInbound.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-smtpdaneinbound", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-ummailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMServer.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disable-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/disable-umservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Disconnect-ExchangeOnline.md", + "redirect_url": "/powershell/module/exchangepowershell/disconnect-exchangeonline", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Dismount-Database.md", + "redirect_url": "/powershell/module/exchangepowershell/dismount-database", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Dump-ProvisioningCache.md", + "redirect_url": "/powershell/module/exchangepowershell/dump-provisioningcache", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-AddressListPaging.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-addresslistpaging", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-AntispamUpdates.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-antispamupdates", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-App.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-cmdletextensionagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-ComplianceTagStorage.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-compliancetagstorage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-DnssecForVerifiedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-dnssecforverifieddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-IPv6ForAcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-ipv6foraccepteddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MailboxQuarantine.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-mailboxquarantine", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-MetaCacheDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-metacachedatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-OrganizationCustomization.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-organizationcustomization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-outlookanywhere", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-PushNotificationProxy.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-pushnotificationproxy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-ServiceEmailChannel.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-serviceemailchannel", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-SmtpDaneInbound.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-smtpdaneinbound", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-ummailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMServer.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Enable-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/enable-umservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/exchange.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/index.md", + "redirect_url": "/powershell/module/exchangepowershell/", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Execute-AzureADLabelSync.md", + "redirect_url": "/powershell/module/exchangepowershell/execute-azureadlabelsync", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Expedite-Delicensing.md", + "redirect_url": "/powershell/module/exchangepowershell/expedite-delicensing", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-ActiveSyncLog.md", + "redirect_url": "/powershell/module/exchangepowershell/export-activesynclog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-ActivityExplorerData.md", + "redirect_url": "/powershell/module/exchangepowershell/export-activityexplorerdata", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-AutoDiscoverConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/export-autodiscoverconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-ContentExplorerData.md", + "redirect_url": "/powershell/module/exchangepowershell/export-contentexplorerdata", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-DlpPolicyCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/export-dlppolicycollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/export-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-FilePlanProperty.md", + "redirect_url": "/powershell/module/exchangepowershell/export-fileplanproperty", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-JournalRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/export-journalrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-MailboxDiagnosticLogs.md", + "redirect_url": "/powershell/module/exchangepowershell/export-mailboxdiagnosticlogs", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/export-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-MigrationReport.md", + "redirect_url": "/powershell/module/exchangepowershell/export-migrationreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/export-quarantinemessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-RecipientDataProperty.md", + "redirect_url": "/powershell/module/exchangepowershell/export-recipientdataproperty", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-TransportRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/export-transportrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-UMCallDataRecord.md", + "redirect_url": "/powershell/module/exchangepowershell/export-umcalldatarecord", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Export-UMPrompt.md", + "redirect_url": "/powershell/module/exchangepowershell/export-umprompt", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ADPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ADServerSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adserversettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ADSite.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adsite", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ATPBuiltInProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-atpbuiltinprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ATPTotalTrafficReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-atptotaltrafficreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-accepteddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AccessToCustomerDataRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-accesstocustomerdatarequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceautoblockthreshold", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncDeviceClass.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdeviceclass", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncDeviceStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncdevicestatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncmailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncOrganizationSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncorganizationsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-activesyncvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdSiteLink.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adsitelink", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdaptiveScope.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adaptivescope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-addressbookpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/get-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-addressrewriteentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdminAuditLogConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-adminauditlogconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdministrativeUnit.md", + "redirect_url": "/powershell/module/exchangepowershell/get-administrativeunit", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AgentLog.md", + "redirect_url": "/powershell/module/exchangepowershell/get-agentlog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AggregateZapReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-aggregatezapreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-antiphishpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-App.md", + "redirect_url": "/powershell/module/exchangepowershell/get-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AppRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-appretentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AppRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-appretentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-applicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ArcConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-arcconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AtpPolicyForO365.md", + "redirect_url": "/powershell/module/exchangepowershell/get-atppolicyforo365", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AttachmentFilterEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-attachmentfilterentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AttachmentFilterListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-attachmentfilterlistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuditConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-auditconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuditLogSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-auditlogsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuthConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authredirect", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-authenticationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AutoSensitivityLabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-autosensitivitylabelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AutoSensitivityLabelRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-autosensitivitylabelrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-autodiscovervirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AvailabilityAddressSpace.md", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityaddressspace", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-availabilityreportoutage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-BlockedConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-blockedconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-BlockedSenderAddress.md", + "redirect_url": "/powershell/module/exchangepowershell/get-blockedsenderaddress", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CASMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-casmailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CASMailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/get-casmailboxplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CalendarDiagnosticAnalysis.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticanalysis", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CalendarDiagnosticLog.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticlog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CalendarDiagnosticObjects.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendardiagnosticobjects", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CalendarNotification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendarnotification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CalendarProcessing.md", + "redirect_url": "/powershell/module/exchangepowershell/get-calendarprocessing", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-caseholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-caseholdrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/get-classificationrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessarray", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ClientAccessServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ClientAccessService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clientaccessservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Clutter.md", + "redirect_url": "/powershell/module/exchangepowershell/get-clutter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-cmdletextensionagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancecase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancecasemember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceRetentionEvent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-complianceretentionevent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/get-complianceretentioneventtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesearchaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancesecurityfilter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancetag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ComplianceTagStorage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compliancetagstorage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CompromisedUserAggregateReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compromiseduseraggregatereport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CompromisedUserDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-compromiseduserdetailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ConfigAnalyzerPolicyRecommendation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-configanalyzerpolicyrecommendation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ConnectionInformation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-connectioninformation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Contact.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ContentFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ContentFilterPhrase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentfilterphrase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ContentMalwareMdoAggregateReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentmalwaremdoaggregatereport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ContentMalwareMdoDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-contentmalwaremdodetailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DataClassificationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataclassificationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DataEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DataRetentionReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dataretentionreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/get-databaseavailabilitygroupnetwork", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DefaultTenantBriefingConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-defaulttenantbriefingconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-defaulttenantmyanalyticsfeatureconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deliveryagentconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DetailZapReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-detailzapreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DetailsTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-detailstemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconditionalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconditionalaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconfigurationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-deviceconfigurationrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DevicePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-devicepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-devicetenantpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-devicetenantrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-distributiongroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dkimsigningconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpdetailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpDetectionsReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpdetectionsreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpedmschema", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpIncidentDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpincidentdetailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpkeyworddictionary", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlppolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpPolicyTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlppolicytemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsensitiveinformationtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DlpSiDetectionsReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dlpsidetectionsreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DnssecStatusForVerifiedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dnssecstatusforverifieddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DomainController.md", + "redirect_url": "/powershell/module/exchangepowershell/get-domaincontroller", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dynamicdistributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-DynamicDistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-dynamicdistributiongroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOCasMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exocasmailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxfolderpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMailboxFolderStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxfolderstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMailboxStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomailboxstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXOMobileDeviceStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exomobiledevicestatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXORecipient.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exorecipient", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EXORecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exorecipientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ecpvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EdgeSubscription.md", + "redirect_url": "/powershell/module/exchangepowershell/get-edgesubscription", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EdgeSyncServiceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-edgesyncserviceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EligibleDistributionGroupForMigration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-eligibledistributiongroupformigration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-emailaddresspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EmailTenantSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-emailtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EtrLimits.md", + "redirect_url": "/powershell/module/exchangepowershell/get-etrlimits", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EventLogLevel.md", + "redirect_url": "/powershell/module/exchangepowershell/get-eventloglevel", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-EventsFromEmailConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-eventsfromemailconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeAssistanceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeassistanceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeDiagnosticInfo.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangediagnosticinfo", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeFeature.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangefeature", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeServerAccessLicense.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserveraccesslicense", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeServerAccessLicenseUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangeserveraccesslicenseuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExchangeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exchangesettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExoInformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exoinformationbarrierpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExoInformationBarrierRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exoinformationbarrierrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExoInformationBarrierSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exoinformationbarriersegment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExoPhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exophishsimoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExoSecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-exosecopsoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ExternalInOutlook.md", + "redirect_url": "/powershell/module/exchangepowershell/get-externalinoutlook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FailedContentIndexDocuments.md", + "redirect_url": "/powershell/module/exchangepowershell/get-failedcontentindexdocuments", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FeatureConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-featureconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FederatedDomainProof.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federateddomainproof", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FederatedOrganizationIdentifier.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federatedorganizationidentifier", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FederationInformation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federationinformation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/get-federationtrust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyAuthority.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertyauthority", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertycategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyCitation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertycitation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyDepartment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertydepartment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyReferenceId.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertyreferenceid", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertyStructure.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertystructure", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FilePlanPropertySubCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-fileplanpropertysubcategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FocusedInbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-focusedinbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-foreignconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-FrontendTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-frontendtransportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/get-globaladdresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-GlobalMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/get-globalmonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Group.md", + "redirect_url": "/powershell/module/exchangepowershell/get-group", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HealthReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-healthreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HistoricalSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-historicalsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-holdcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-holdcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HostedConnectionFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedconnectionfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedcontentfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedoutboundspamfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HybridMailflowDatacenterIPs.md", + "redirect_url": "/powershell/module/exchangepowershell/get-hybridmailflowdatacenterips", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPAllowListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPAllowListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPAllowListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipallowlistprovidersconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPBlockListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPBlockListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPBlockListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipblocklistprovidersconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IPv6StatusForAcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ipv6statusforaccepteddomain", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IRMConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-irmconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ImapSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-imapsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-inboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-InformationBarrierPoliciesApplicationStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierpoliciesapplicationstatus", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-InformationBarrierRecipientStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-informationbarrierrecipientstatus", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IntraOrganizationConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-intraorganizationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-intraorganizationconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/get-label", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-labelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-LinkedUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-linkeduser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-LogonStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-logonstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-M365DataAtRestEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-m365dataatrestencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-m365dataatrestencryptionpolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailATPReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailatpreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailDlpPolicyReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetaildlppolicyreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailEncryptionReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailencryptionreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailTransportRuleReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-maildetailtransportrulereport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailFilterListReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailfilterlistreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficATPReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficatpreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficEncryptionReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficencryptionreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficPolicyReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficpolicyreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficSummaryReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailtrafficsummaryreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxAuditBypassAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxauditbypassassociation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxAutoReplyConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxautoreplyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxCalendarConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxcalendarconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxCalendarFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxcalendarfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxDatabaseCopyStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxdatabasecopystatus", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxExportRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxexportrequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolderpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxFolderStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxfolderstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxIRMAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxirmaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxImportRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboximportrequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxJunkEmailConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxjunkemailconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxLocation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxlocation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxMessageConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxmessageconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxRegionalConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxregionalconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrepairrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxRestoreRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxrestorerequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxSentItemsConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxsentitemsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxSpellingConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxspellingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxtransportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxUserConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailboxuserconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailflowStatusReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mailflowstatusreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MalwareFilteringServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-malwarefilteringserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managedcontentsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managedfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managedfoldermailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagementRole.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementroleassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementroleentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/get-managementscope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mapivirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/get-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagecategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messageclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTrace.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrace", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTraceDetail.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetracedetail", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTraceDetailV2.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetracedetailv2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTraceV2.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetracev2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTrackingLog.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrackinglog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MessageTrackingReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-messagetrackingreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationendpoint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MigrationUserStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-migrationuserstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MobileDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevicemailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MobileDeviceStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mobiledevicestatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MonitoringItemHelp.md", + "redirect_url": "/powershell/module/exchangepowershell/get-monitoringitemhelp", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MonitoringItemIdentity.md", + "redirect_url": "/powershell/module/exchangepowershell/get-monitoringitemidentity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MoveRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-moverequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MxRecordReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-mxrecordreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MyAnalyticsFeatureConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-NetworkConnectionInfo.md", + "redirect_url": "/powershell/module/exchangepowershell/get-networkconnectioninfo", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Notification.md", + "redirect_url": "/powershell/module/exchangepowershell/get-notification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-omeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OMEMessageStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-omemessagestatus", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-oabvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/get-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/get-onpremisesorganization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OnlineMeetingConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/get-onlinemeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OrganizationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationsegment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OrganizationalUnit.md", + "redirect_url": "/powershell/module/exchangepowershell/get-organizationalunit", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OutboundConnectorReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outboundconnectorreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookanywhere", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/get-outlookprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-owamailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-owavirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/get-partnerapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PendingDelicenseUser.md", + "redirect_url": "/powershell/module/exchangepowershell/get-pendingdelicenseuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PendingFederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-pendingfederateddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PerimeterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-perimeterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PhishSimOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-phishsimoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Place.md", + "redirect_url": "/powershell/module/exchangepowershell/get-place", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PolicyConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-policyconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-policytipconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PopSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-popsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-powershellvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/get-protectionalert", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderAdministrativePermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderadministrativepermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderClientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderclientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderItemStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderitemstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMailboxDiagnostics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxdiagnostics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMailboxMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMigrationRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermigrationrequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderMoveRequestStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfoldermoverequeststatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PublicFolderStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-publicfolderstatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-quarantinemessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-QuarantineMessageHeader.md", + "redirect_url": "/powershell/module/exchangepowershell/get-quarantinemessageheader", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-QuarantinePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-quarantinepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/get-queue", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-QueueDigest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-queuedigest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RMSTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rmstemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-receiveconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Recipient.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipient", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RecipientFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RecipientStatisticsReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recipientstatisticsreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RecordReviewNotificationTemplateConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recordreviewnotificationtemplateconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RecoverableItems.md", + "redirect_url": "/powershell/module/exchangepowershell/get-recoverableitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RegulatoryComplianceUI.md", + "redirect_url": "/powershell/module/exchangepowershell/get-regulatorycomplianceui", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-remotedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ReportExecutionInstance.md", + "redirect_url": "/powershell/module/exchangepowershell/get-reportexecutioninstance", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ReportSubmissionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-reportsubmissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ResourceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-resourceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/get-resubmitrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RetentionEvent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionevent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/get-retentionpolicytag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ReviewItems.md", + "redirect_url": "/powershell/module/exchangepowershell/get-reviewitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-roleassignmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rolegroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rolegroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-routinggroupconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/get-rpcclientaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SCInsights.md", + "redirect_url": "/powershell/module/exchangepowershell/get-scinsights", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safeattachmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeLinksAggregateReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksaggregatereport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeLinksDetailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksdetailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinkspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/get-searchdocumentformat", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SecOpsOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-secopsoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SecurityPrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/get-securityprincipal", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sendconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SenderFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-senderfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SenderIdConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-senderidconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SenderReputationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-senderreputationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ServerComponentState.md", + "redirect_url": "/powershell/module/exchangepowershell/get-servercomponentstate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ServerHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/get-serverhealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ServerMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/get-servermonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ServiceDeliveryReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-servicedeliveryreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ServicePrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/get-serviceprincipal", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/get-settingoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sharingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SiteMailboxDiagnostics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailboxdiagnostics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sitemailboxprovisioningpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SmimeConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-smimeconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SmtpDaneInboundStatus.md", + "redirect_url": "/powershell/module/exchangepowershell/get-smtpdaneinboundstatus", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SpoofIntelligenceInsight.md", + "redirect_url": "/powershell/module/exchangepowershell/get-spoofintelligenceinsight", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SpoofMailReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-spoofmailreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-StoreUsageStatistics.md", + "redirect_url": "/powershell/module/exchangepowershell/get-storeusagestatistics", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewActivity.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewactivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewOverallProgressReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewoverallprogressreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewPolicyReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewpolicyreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewpolicyv2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SupervisoryReviewTopCasesReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-supervisoryreviewtopcasesreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/get-systemmessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TeamsProtectionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-teamsprotectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TeamsProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-teamsprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TenantAllowBlockListItems.md", + "redirect_url": "/powershell/module/exchangepowershell/get-tenantallowblocklistitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TenantAllowBlockListSpoofItems.md", + "redirect_url": "/powershell/module/exchangepowershell/get-tenantallowblocklistspoofitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TextMessagingAccount.md", + "redirect_url": "/powershell/module/exchangepowershell/get-textmessagingaccount", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-throttlingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ThrottlingPolicyAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/get-throttlingpolicyassociation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportPipeline.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportpipeline", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportRuleAction.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportruleaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportRulePredicate.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportrulepredicate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-transportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-Trust.md", + "redirect_url": "/powershell/module/exchangepowershell/get-trust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMActiveCalls.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umactivecalls", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMCallDataRecord.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcalldatarecord", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMCallRouterSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallroutersettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMCallSummaryReport.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umcallsummaryreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umdialplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMHuntGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umhuntgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMMailboxPIN.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailboxpin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ummailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UmServer.md", + "redirect_url": "/powershell/module/exchangepowershell/get-umserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedauditlogretentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UnifiedGroupLinks.md", + "redirect_url": "/powershell/module/exchangepowershell/get-unifiedgrouplinks", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-User.md", + "redirect_url": "/powershell/module/exchangepowershell/get-user", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UserBriefingConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/get-userbriefingconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UserPhoto.md", + "redirect_url": "/powershell/module/exchangepowershell/get-userphoto", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UserPrincipalNamesSuffix.md", + "redirect_url": "/powershell/module/exchangepowershell/get-userprincipalnamessuffix", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaInsightsSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/get-vivainsightssettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaModuleFeature.md", + "redirect_url": "/powershell/module/exchangepowershell/get-vivamodulefeature", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaModuleFeatureEnablement.md", + "redirect_url": "/powershell/module/exchangepowershell/get-vivamodulefeatureenablement", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaModuleFeaturePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/get-vivamodulefeaturepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaOrgInsightsDelegatedRole.md", + "redirect_url": "/powershell/module/exchangepowershell/get-vivaorginsightsdelegatedrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/get-webservicesvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/get-x400authoritativedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/get-ediscoverycaseadmin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-DlpPolicyCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/import-dlppolicycollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-DlpPolicyTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/import-dlppolicytemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/import-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-FilePlanProperty.md", + "redirect_url": "/powershell/module/exchangepowershell/import-fileplanproperty", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-JournalRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/import-journalrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-RecipientDataProperty.md", + "redirect_url": "/powershell/module/exchangepowershell/import-recipientdataproperty", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-TransportRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/import-transportrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-UMPrompt.md", + "redirect_url": "/powershell/module/exchangepowershell/import-umprompt", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Install-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/install-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Install-UnifiedCompliancePrerequisite.md", + "redirect_url": "/powershell/module/exchangepowershell/install-unifiedcomplianceprerequisite", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Invoke-ComplianceSearchActionStep.md", + "redirect_url": "/powershell/module/exchangepowershell/invoke-compliancesearchactionstep", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Invoke-ComplianceSecurityFilterAction.md", + "redirect_url": "/powershell/module/exchangepowershell/invoke-compliancesecurityfilteraction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Invoke-HoldRemovalAction.md", + "redirect_url": "/powershell/module/exchangepowershell/invoke-holdremovalaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Invoke-MonitoringProbe.md", + "redirect_url": "/powershell/module/exchangepowershell/invoke-monitoringprobe", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Mount-Database.md", + "redirect_url": "/powershell/module/exchangepowershell/mount-database", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Move-ActiveMailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/move-activemailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Move-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/move-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Move-DatabasePath.md", + "redirect_url": "/powershell/module/exchangepowershell/move-databasepath", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Move-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/move-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ATPBuiltInProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-atpbuiltinprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/new-accepteddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncdeviceaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncmailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-activesyncvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AdaptiveScope.md", + "redirect_url": "/powershell/module/exchangepowershell/new-adaptivescope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-addressbookpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/new-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/new-addressrewriteentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AdminAuditLogSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-adminauditlogsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-antiphishpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-App.md", + "redirect_url": "/powershell/module/exchangepowershell/new-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AppRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-appretentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AppRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-appretentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-applicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/new-authredirect", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/new-authserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-authenticationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AutoSensitivityLabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-autosensitivitylabelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AutoSensitivityLabelRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-autosensitivitylabelrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-autodiscovervirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-availabilityconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-availabilityreportoutage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-caseholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-caseholdrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/new-classificationrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/new-clientaccessarray", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-clientaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancecase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceRetentionEvent.md", + "redirect_url": "/powershell/module/exchangepowershell/new-complianceretentionevent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/new-complianceretentioneventtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesearchaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancesecurityfilter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/new-compliancetag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dataclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DataEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dataencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/new-databaseavailabilitygroupnetwork", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deliveryagentconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconditionalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconditionalaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconfigurationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-deviceconfigurationrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-devicetenantpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-devicetenantrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dkimsigningconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpedmschema", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpFingerprint.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpfingerprint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpkeyworddictionary", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlppolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpsensitiveinformationtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-dynamicdistributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-ecpvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EdgeSubscription.md", + "redirect_url": "/powershell/module/exchangepowershell/new-edgesubscription", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EdgeSyncServiceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-edgesyncserviceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-emailaddresspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ExchangeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exchangesettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ExoPhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exophishsimoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ExoSecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-exosecopsoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FeatureConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/new-featureconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/new-federationtrust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertyAuthority.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertyauthority", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertyCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertycategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertyCitation.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertycitation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertyDepartment.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertydepartment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertyReferenceId.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertyreferenceid", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-FilePlanPropertySubCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fileplanpropertysubcategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-Fingerprint.md", + "redirect_url": "/powershell/module/exchangepowershell/new-fingerprint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-foreignconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/new-globaladdresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-holdcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-holdcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedcontentfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedoutboundspamfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/new-hybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-inboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-informationbarrierpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-intraorganizationconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/new-label", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-labelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-M365DataAtRestEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-m365dataatrestencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailmessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxAuditLogSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxauditlogsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxrepairrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-malwarefilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managedcontentsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managedfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managedfoldermailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagementRole.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managementrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managementroleassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/new-managementscope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mapivirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/new-messageclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/new-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/new-migrationendpoint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-mobiledevicemailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/new-omeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-oabvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/new-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/new-onpremisesorganization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/new-organizationrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/new-organizationsegment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-outboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/new-outlookprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-owamailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-owavirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/new-partnerapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PhishSimOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-phishsimoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/new-policytipconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-powershellvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/new-protectionalert", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolderdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PublicFolderDatabaseRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfolderdatabaserepairrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/new-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-QuarantinePermissions.md", + "redirect_url": "/powershell/module/exchangepowershell/new-quarantinepermissions", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-QuarantinePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-quarantinepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-receiveconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/new-remotedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/new-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ReportSubmissionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-reportsubmissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/new-retentionpolicytag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-roleassignmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-rolegroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-routinggroupconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/new-rpcclientaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safeattachmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safelinkspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/new-searchdocumentformat", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SecOpsOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-secopsoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sendconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ServicePrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/new-serviceprincipal", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/new-settingoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sharingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sitemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sitemailboxprovisioningpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/new-supervisoryreviewpolicyv2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SupervisoryReviewRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-supervisoryreviewrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SyncMailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/new-syncmailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/new-systemmessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-TeamsProtectionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-teamsprotectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-TeamsProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-teamsprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-TenantAllowBlockListItems.md", + "redirect_url": "/powershell/module/exchangepowershell/new-tenantallowblocklistitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-TenantAllowBlockListSpoofItems.md", + "redirect_url": "/powershell/module/exchangepowershell/new-tenantallowblocklistspoofitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-throttlingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umdialplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMHuntGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umhuntgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/new-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-ummailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/new-unifiedauditlogretentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/new-unifiedgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/new-webservicesvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/New-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/new-x400authoritativedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Preview-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/preview-quarantinemessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Redirect-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/redirect-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Release-QuarantineMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/release-quarantinemessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ADPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-adpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-accepteddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActiveSyncDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdeviceaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActiveSyncDeviceClass.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncdeviceclass", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncmailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-activesyncvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AdaptiveScope.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-adaptivescope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-addressbookpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-addressrewriteentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-antiphishpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-App.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AppRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-appretentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AppRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-appretentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-applicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AttachmentFilterEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-attachmentfilterentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-authredirect", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-authserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-authenticationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AutoSensitivityLabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-autosensitivitylabelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AutoSensitivityLabelRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-autosensitivitylabelrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-autodiscovervirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AvailabilityAddressSpace.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityaddressspace", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-availabilityreportoutage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-BlockedConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-blockedconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-BlockedSenderAddress.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-blockedsenderaddress", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-CalendarEvents.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-calendarevents", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-caseholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-caseholdrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-classificationrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-clientaccessarray", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-clientaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancecase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancecasemember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-complianceretentioneventtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesearchaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancesecurityfilter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-compliancetag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ContentFilterPhrase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-contentfilterphrase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dataclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroupnetwork", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DatabaseAvailabilityGroupServer.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-databaseavailabilitygroupserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deliveryagentconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconditionalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconditionalaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconfigurationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-deviceconfigurationrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-devicetenantpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-devicetenantrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-distributiongroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpedmschema", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpkeyworddictionary", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlppolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpPolicyTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlppolicytemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-dynamicdistributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ecpvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EdgeSubscription.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-edgesubscription", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-emailaddresspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ExchangeCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-exchangecertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ExoPhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-exophishsimoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ExoSecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-exosecopsoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FeatureConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-featureconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-federateddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-federationtrust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertyAuthority.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertyauthority", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertyCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertycategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertyCitation.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertycitation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertyDepartment.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertydepartment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertyReferenceId.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertyreferenceid", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-FilePlanPropertySubCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-fileplanpropertysubcategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-foreignconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-globaladdresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-GlobalMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-globalmonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-holdcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-holdcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedcontentfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-hybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-IPAllowListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipallowlistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipallowlistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-IPBlockListEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipblocklistentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ipblocklistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-inboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-informationbarrierpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-intraorganizationconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-label", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-labelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxfolderpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxIRMAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxirmaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxRepairRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxrepairrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MailboxUserConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mailboxuserconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-malwarefilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedcontentsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managedfoldermailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagementRole.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementroleassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementroleentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-managementscope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mapivirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-messageclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationendpoint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-migrationuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MobileDevice.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mobiledevice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-mobiledevicemailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-omeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-oabvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-onpremisesorganization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-organizationrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-organizationsegment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-outboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-outlookprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-owamailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-owavirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-partnerapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PhishSimOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-phishsimoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-policytipconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-powershellvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-protectionalert", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderAdministrativePermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderadministrativepermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderClientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderclientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfolderdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderMailboxMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermailboxmigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-QuarantinePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-quarantinepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-receiveconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RecipientPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-recipientpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-remotedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ReportSubmissionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-reportsubmissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-resubmitrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-retentionpolicytag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-roleassignmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-rolegroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-rolegroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-routinggroupconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-rpcclientaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safeattachmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safelinkspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-searchdocumentformat", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SecOpsOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-secopsoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sendconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ServerMonitoringOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-servermonitoringoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ServicePrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-serviceprincipal", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-settingoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sharingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sitemailboxprovisioningpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-StoreMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-storemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-supervisoryreviewpolicyv2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SyncMailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-syncmailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-systemmessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-TenantAllowBlockListItems.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-tenantallowblocklistitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-TenantAllowBlockListSpoofItems.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-tenantallowblocklistspoofitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-throttlingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umdialplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMHuntGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umhuntgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ummailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedauditlogretentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UnifiedGroupLinks.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-unifiedgrouplinks", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-UserPhoto.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-userphoto", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-VivaModuleFeaturePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-vivamodulefeaturepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-VivaOrgInsightsDelegatedRole.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-vivaorginsightsdelegatedrole", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-webservicesvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-x400authoritativedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/remove-ediscoverycaseadmin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Reset-ProvisioningCache.md", + "redirect_url": "/powershell/module/exchangepowershell/reset-provisioningcache", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Restore-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Restore-DetailsTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-detailstemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Restore-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Restore-RecoverableItems.md", + "redirect_url": "/powershell/module/exchangepowershell/restore-recoverableitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-PublicFolderReplication.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-publicfolderreplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Resume-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/resume-queue", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Retry-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/retry-queue", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Rotate-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/rotate-dkimsigningconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Search-AdminAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/search-adminauditlog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Search-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/search-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Search-MailboxAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/search-mailboxauditlog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Search-MessageTrackingReport.md", + "redirect_url": "/powershell/module/exchangepowershell/search-messagetrackingreport", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Search-UnifiedAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/search-unifiedauditlog", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Send-TextMessagingVerificationCode.md", + "redirect_url": "/powershell/module/exchangepowershell/send-textmessagingverificationcode", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ADServerSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adserversettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ADSite.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adsite", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ATPBuiltInProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-atpbuiltinprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ATPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-atpprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AcceptedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-accepteddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AccessToCustomerDataRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-accesstocustomerdatarequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActiveSyncDeviceAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncdeviceaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncdeviceautoblockthreshold", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActiveSyncMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncmailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActiveSyncOrganizationSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncorganizationsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActiveSyncVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-activesyncvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AdSiteLink.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adsitelink", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AdaptiveScope.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adaptivescope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AddressBookPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-addressbookpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/set-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AddressRewriteEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/set-addressrewriteentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AdminAuditLogConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-adminauditlogconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AntiPhishPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-antiphishpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AntiPhishRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-antiphishrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-App.md", + "redirect_url": "/powershell/module/exchangepowershell/set-app", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AppRetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-appretentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AppRetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-appretentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-applicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ArcConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-arcconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AtpPolicyForO365.md", + "redirect_url": "/powershell/module/exchangepowershell/set-atppolicyforo365", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AttachmentFilterListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-attachmentfilterlistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuditConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-auditconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuthConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuthRedirect.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authredirect", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuthServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuthenticationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-authenticationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AutoSensitivityLabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-autosensitivitylabelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AutoSensitivityLabelRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-autosensitivitylabelrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AutodiscoverVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-autodiscovervirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AvailabilityConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-availabilityconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AvailabilityReportOutage.md", + "redirect_url": "/powershell/module/exchangepowershell/set-availabilityreportoutage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CASMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-casmailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CASMailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/set-casmailboxplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CalendarNotification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-calendarnotification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CalendarProcessing.md", + "redirect_url": "/powershell/module/exchangepowershell/set-calendarprocessing", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CaseHoldPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-caseholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CaseHoldRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-caseholdrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ClassificationRuleCollection.md", + "redirect_url": "/powershell/module/exchangepowershell/set-classificationrulecollection", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ClientAccessArray.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessarray", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ClientAccessServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ClientAccessService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clientaccessservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Clutter.md", + "redirect_url": "/powershell/module/exchangepowershell/set-clutter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CmdletExtensionAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/set-cmdletextensionagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceCase.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancecase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceRetentionEventType.md", + "redirect_url": "/powershell/module/exchangepowershell/set-complianceretentioneventtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceSearchAction.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesearchaction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceSecurityFilter.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancesecurityfilter", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ComplianceTag.md", + "redirect_url": "/powershell/module/exchangepowershell/set-compliancetag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Contact.md", + "redirect_url": "/powershell/module/exchangepowershell/set-contact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ContentFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-contentfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dataclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DataEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dataencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DatabaseAvailabilityGroupNetwork.md", + "redirect_url": "/powershell/module/exchangepowershell/set-databaseavailabilitygroupnetwork", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DefaultTenantBriefingConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-defaulttenantbriefingconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-defaulttenantmyanalyticsfeatureconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeliveryAgentConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deliveryagentconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DetailsTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/set-detailstemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceConditionalAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconditionalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceConditionalAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconditionalaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconfigurationpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceConfigurationRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-deviceconfigurationrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceTenantPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-devicetenantpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DeviceTenantRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-devicetenantrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DkimSigningConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dkimsigningconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpEdmSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpedmschema", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpKeywordDictionary.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpkeyworddictionary", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlppolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpSensitiveInformationType.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpsensitiveinformationtype", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DlpSensitiveInformationTypeRulePackage.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dlpsensitiveinformationtyperulepackage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-DynamicDistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-dynamicdistributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-eopprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EcpVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ecpvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EdgeSyncServiceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-edgesyncserviceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-emailaddresspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EmailTenantSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-emailtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EventLogLevel.md", + "redirect_url": "/powershell/module/exchangepowershell/set-eventloglevel", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EventsFromEmailConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-eventsfromemailconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExchangeAssistanceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangeassistanceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExchangeFeature.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangefeature", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExchangeServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangeserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExchangeSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exchangesettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExoPhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exophishsimoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExoSecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-exosecopsoverriderule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ExternalInOutlook.md", + "redirect_url": "/powershell/module/exchangepowershell/set-externalinoutlook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FeatureConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-featureconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FederatedOrganizationIdentifier.md", + "redirect_url": "/powershell/module/exchangepowershell/set-federatedorganizationidentifier", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/set-federationtrust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertyAuthority.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertyauthority", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertyCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertycategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertyCitation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertycitation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertyDepartment.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertydepartment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertyReferenceId.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertyreferenceid", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FilePlanPropertySubCategory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-fileplanpropertysubcategory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FocusedInbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-focusedinbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ForeignConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-foreignconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-FrontendTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-frontendtransportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/set-globaladdresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Group.md", + "redirect_url": "/powershell/module/exchangepowershell/set-group", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HoldCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-holdcompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HoldComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-holdcompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HostedConnectionFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedconnectionfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HostedContentFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedcontentfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HostedContentFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedcontentfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HostedOutboundSpamFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedoutboundspamfilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HostedOutboundSpamFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hostedoutboundspamfilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-hybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPAllowListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPAllowListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipallowlistprovidersconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPBlockListConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IPBlockListProvidersConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ipblocklistprovidersconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IRMConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-irmconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ImapSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-imapsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-InboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-inboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-InboxRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-inboxrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-InformationBarrierPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-informationbarrierpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-IntraOrganizationConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-intraorganizationconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-JournalRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-journalrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Label.md", + "redirect_url": "/powershell/module/exchangepowershell/set-label", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-LabelPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-labelpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-LinkedUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-linkeduser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-M365DataAtRestEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-m365dataatrestencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/set-m365dataatrestencryptionpolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailContact.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailcontact", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailPublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailpublicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Mailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxAuditBypassAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxauditbypassassociation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxAutoReplyConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxautoreplyconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxCalendarConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxcalendarconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxCalendarFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxcalendarfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxFolderPermission.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxfolderpermission", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxIRMAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxirmaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxJunkEmailConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxjunkemailconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxMessageConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxmessageconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxRegionalConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxregionalconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxSentItemsConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxsentitemsconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxSpellingConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxspellingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MailboxTransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mailboxtransportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MalwareFilterPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilterpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MalwareFilterRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilterrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MalwareFilteringServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-malwarefilteringserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagedContentSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managedcontentsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagedFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managedfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagedFolderMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managedfoldermailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagementRoleAssignment.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managementroleassignment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagementRoleEntry.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managementroleentry", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ManagementScope.md", + "redirect_url": "/powershell/module/exchangepowershell/set-managementscope", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MapiVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mapivirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MessageClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-messageclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MigrationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MigrationEndpoint.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationendpoint", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/set-migrationuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MobileDeviceMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-mobiledevicemailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-MyAnalyticsFeatureConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-myanalyticsfeatureconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Notification.md", + "redirect_url": "/powershell/module/exchangepowershell/set-notification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OMEConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/set-omeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OMEMessageRevocation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-omemessagerevocation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OabVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-oabvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/set-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OnPremisesOrganization.md", + "redirect_url": "/powershell/module/exchangepowershell/set-onpremisesorganization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OrganizationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OrganizationSegment.md", + "redirect_url": "/powershell/module/exchangepowershell/set-organizationsegment", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OutlookAnywhere.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookanywhere", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OutlookProtectionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookprotectionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OutlookProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/set-outlookprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OwaMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-owamailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-OwaVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-owavirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PartnerApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/set-partnerapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PendingFederatedDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-pendingfederateddomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PerimeterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-perimeterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PhishSimOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-phishsimoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-Place.md", + "redirect_url": "/powershell/module/exchangepowershell/set-place", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PolicyConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-policyconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PolicyTipConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-policytipconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PopSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-popsettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PowerShellVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-powershellvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ProtectionAlert.md", + "redirect_url": "/powershell/module/exchangepowershell/set-protectionalert", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PublicFolderDatabase.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfolderdatabase", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-QuarantinePermissions.md", + "redirect_url": "/powershell/module/exchangepowershell/set-quarantinepermissions", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-QuarantinePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-quarantinepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RMSTemplate.md", + "redirect_url": "/powershell/module/exchangepowershell/set-rmstemplate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ReceiveConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-receiveconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RecipientFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-recipientfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RecordReviewNotificationTemplateConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-recordreviewnotificationtemplateconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RegulatoryComplianceUI.md", + "redirect_url": "/powershell/module/exchangepowershell/set-regulatorycomplianceui", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RemoteDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-remotedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RemoteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-remotemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ReportSubmissionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-reportsubmissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ReportSubmissionRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-reportsubmissionrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ResourceConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-resourceconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ResubmitRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/set-resubmitrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RetentionCompliancePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RetentionComplianceRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentioncompliancerule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RetentionPolicyTag.md", + "redirect_url": "/powershell/module/exchangepowershell/set-retentionpolicytag", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RoleAssignmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-roleassignmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RoleGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-rolegroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RoutingGroupConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-routinggroupconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RpcClientAccess.md", + "redirect_url": "/powershell/module/exchangepowershell/set-rpcclientaccess", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SafeAttachmentPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safeattachmentpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SafeAttachmentRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safeattachmentrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SafeLinksPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safelinkspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SafeLinksRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-safelinksrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SearchDocumentFormat.md", + "redirect_url": "/powershell/module/exchangepowershell/set-searchdocumentformat", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SecOpsOverridePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-secopsoverridepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SendConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sendconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SenderFilterConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-senderfilterconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SenderIdConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-senderidconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SenderReputationConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-senderreputationconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ServerComponentState.md", + "redirect_url": "/powershell/module/exchangepowershell/set-servercomponentstate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ServerMonitor.md", + "redirect_url": "/powershell/module/exchangepowershell/set-servermonitor", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ServicePrincipal.md", + "redirect_url": "/powershell/module/exchangepowershell/set-serviceprincipal", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SettingOverride.md", + "redirect_url": "/powershell/module/exchangepowershell/set-settingoverride", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SharingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sharingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sitemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SiteMailboxProvisioningPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sitemailboxprovisioningpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SmimeConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-smimeconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SupervisoryReviewPolicyV2.md", + "redirect_url": "/powershell/module/exchangepowershell/set-supervisoryreviewpolicyv2", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SupervisoryReviewRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-supervisoryreviewrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SweepRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-sweeprule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SystemMessage.md", + "redirect_url": "/powershell/module/exchangepowershell/set-systemmessage", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TeamsProtectionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-teamsprotectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TeamsProtectionPolicyRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-teamsprotectionpolicyrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TenantAllowBlockListItems.md", + "redirect_url": "/powershell/module/exchangepowershell/set-tenantallowblocklistitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TenantAllowBlockListSpoofItems.md", + "redirect_url": "/powershell/module/exchangepowershell/set-tenantallowblocklistspoofitems", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TextMessagingAccount.md", + "redirect_url": "/powershell/module/exchangepowershell/set-textmessagingaccount", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ThrottlingPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-throttlingpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ThrottlingPolicyAssociation.md", + "redirect_url": "/powershell/module/exchangepowershell/set-throttlingpolicyassociation", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TransportConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TransportRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TransportServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TransportService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-transportservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMAutoAttendant.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umautoattendant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMCallAnsweringRule.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umcallansweringrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMCallRouterSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umcallroutersettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMDialPlan.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umdialplan", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMIPGateway.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umipgateway", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMMailboxPIN.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailboxpin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMMailboxPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-ummailboxpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UMService.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UmServer.md", + "redirect_url": "/powershell/module/exchangepowershell/set-umserver", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UnifiedAuditLogRetentionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/set-unifiedauditlogretentionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/set-unifiedgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-User.md", + "redirect_url": "/powershell/module/exchangepowershell/set-user", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UserBriefingConfig.md", + "redirect_url": "/powershell/module/exchangepowershell/set-userbriefingconfig", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UserPhoto.md", + "redirect_url": "/powershell/module/exchangepowershell/set-userphoto", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-VivaInsightsSettings.md", + "redirect_url": "/powershell/module/exchangepowershell/set-vivainsightssettings", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-WebServicesVirtualDirectory.md", + "redirect_url": "/powershell/module/exchangepowershell/set-webservicesvirtualdirectory", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-X400AuthoritativeDomain.md", + "redirect_url": "/powershell/module/exchangepowershell/set-x400authoritativedomain", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/start-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-EdgeSynchronization.md", + "redirect_url": "/powershell/module/exchangepowershell/start-edgesynchronization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-HistoricalSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-historicalsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-InformationBarrierPoliciesApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/start-informationbarrierpoliciesapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-MailboxAssistant.md", + "redirect_url": "/powershell/module/exchangepowershell/start-mailboxassistant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-ManagedFolderAssistant.md", + "redirect_url": "/powershell/module/exchangepowershell/start-managedfolderassistant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/start-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/start-migrationuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Start-RetentionAutoTagLearning.md", + "redirect_url": "/powershell/module/exchangepowershell/start-retentionautotaglearning", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-ComplianceSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-compliancesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-DatabaseAvailabilityGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-databaseavailabilitygroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-HistoricalSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-historicalsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-InformationBarrierPoliciesApplication.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-informationbarrierpoliciesapplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-MailboxSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-mailboxsearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-ManagedFolderAssistant.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-managedfolderassistant", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-MigrationBatch.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-migrationbatch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Stop-MigrationUser.md", + "redirect_url": "/powershell/module/exchangepowershell/stop-migrationuser", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-MailboxExportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxexportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-MailboxImportRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboximportrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-MailboxRestoreRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-mailboxrestorerequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-MoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-moverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-PublicFolderMailboxMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermailboxmigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-PublicFolderMigrationRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermigrationrequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-PublicFolderMoveRequest.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfoldermoverequest", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-PublicFolderReplication.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-publicfolderreplication", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Suspend-Queue.md", + "redirect_url": "/powershell/module/exchangepowershell/suspend-queue", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ActiveSyncConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-activesyncconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/test-applicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ArchiveConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-archiveconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-AssistantHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-assistanthealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-CalendarConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-calendarconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ClientAccessRule.md", + "redirect_url": "/powershell/module/exchangepowershell/test-clientaccessrule", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-DataClassification.md", + "redirect_url": "/powershell/module/exchangepowershell/test-dataclassification", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-EcpConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-ecpconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-EdgeSynchronization.md", + "redirect_url": "/powershell/module/exchangepowershell/test-edgesynchronization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ExchangeSearch.md", + "redirect_url": "/powershell/module/exchangepowershell/test-exchangesearch", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-FederationTrust.md", + "redirect_url": "/powershell/module/exchangepowershell/test-federationtrust", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-FederationTrustCertificate.md", + "redirect_url": "/powershell/module/exchangepowershell/test-federationtrustcertificate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-IPAllowListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/test-ipallowlistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-IPBlockListProvider.md", + "redirect_url": "/powershell/module/exchangepowershell/test-ipblocklistprovider", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-IRMConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/test-irmconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ImapConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-imapconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-M365DataAtRestEncryptionPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/test-m365dataatrestencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-MAPIConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-mapiconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-MRSHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-mrshealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-Mailflow.md", + "redirect_url": "/powershell/module/exchangepowershell/test-mailflow", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-Message.md", + "redirect_url": "/powershell/module/exchangepowershell/test-message", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-MigrationServerAvailability.md", + "redirect_url": "/powershell/module/exchangepowershell/test-migrationserveravailability", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-OAuthConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-oauthconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-OrganizationRelationship.md", + "redirect_url": "/powershell/module/exchangepowershell/test-organizationrelationship", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-OutlookConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-outlookconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-OutlookWebServices.md", + "redirect_url": "/powershell/module/exchangepowershell/test-outlookwebservices", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-OwaConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-owaconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-PopConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-popconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-PowerShellConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-powershellconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ReplicationHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-replicationhealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-SenderId.md", + "redirect_url": "/powershell/module/exchangepowershell/test-senderid", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ServiceHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-servicehealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-ServicePrincipalAuthorization.md", + "redirect_url": "/powershell/module/exchangepowershell/test-serviceprincipalauthorization", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/test-sitemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-SmtpConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-smtpconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-SystemHealth.md", + "redirect_url": "/powershell/module/exchangepowershell/test-systemhealth", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-TextExtraction.md", + "redirect_url": "/powershell/module/exchangepowershell/test-textextraction", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-UMConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-umconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Test-WebServicesConnectivity.md", + "redirect_url": "/powershell/module/exchangepowershell/test-webservicesconnectivity", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Undo-SoftDeletedMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/undo-softdeletedmailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Undo-SoftDeletedUnifiedGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/undo-softdeletedunifiedgroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Uninstall-TransportAgent.md", + "redirect_url": "/powershell/module/exchangepowershell/uninstall-transportagent", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-AddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/update-addresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-ComplianceCaseMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-compliancecasemember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-DatabaseSchema.md", + "redirect_url": "/powershell/module/exchangepowershell/update-databaseschema", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-DistributionGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-distributiongroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-EmailAddressPolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-emailaddresspolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-ExchangeHelp.md", + "redirect_url": "/powershell/module/exchangepowershell/update-exchangehelp", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-FileDistributionService.md", + "redirect_url": "/powershell/module/exchangepowershell/update-filedistributionservice", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-GlobalAddressList.md", + "redirect_url": "/powershell/module/exchangepowershell/update-globaladdresslist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-HybridConfiguration.md", + "redirect_url": "/powershell/module/exchangepowershell/update-hybridconfiguration", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-MailboxDatabaseCopy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-mailboxdatabasecopy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-OfflineAddressBook.md", + "redirect_url": "/powershell/module/exchangepowershell/update-offlineaddressbook", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-PublicFolder.md", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfolder", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-PublicFolderHierarchy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfolderhierarchy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-PublicFolderMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/update-publicfoldermailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-Recipient.md", + "redirect_url": "/powershell/module/exchangepowershell/update-recipient", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-RoleGroupMember.md", + "redirect_url": "/powershell/module/exchangepowershell/update-rolegroupmember", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-SafeList.md", + "redirect_url": "/powershell/module/exchangepowershell/update-safelist", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-SiteMailbox.md", + "redirect_url": "/powershell/module/exchangepowershell/update-sitemailbox", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-StoreMailboxState.md", + "redirect_url": "/powershell/module/exchangepowershell/update-storemailboxstate", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-VivaModuleFeaturePolicy.md", + "redirect_url": "/powershell/module/exchangepowershell/update-vivamodulefeaturepolicy", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-eDiscoveryCaseAdmin.md", + "redirect_url": "/powershell/module/exchangepowershell/update-ediscoverycaseadmin", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Upgrade-DistributionGroup.md", + "redirect_url": "/powershell/module/exchangepowershell/upgrade-distributiongroup", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Validate-OutboundConnector.md", + "redirect_url": "/powershell/module/exchangepowershell/validate-outboundconnector", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Validate-RetentionRuleQuery.md", + "redirect_url": "/powershell/module/exchangepowershell/validate-retentionrulequery", + "redirect_document_id": true + }, + { + "source_path": "exchange/virtual-folder/exchange/Write-AdminAuditLog.md", + "redirect_url": "/powershell/module/exchangepowershell/write-adminauditlog", + "redirect_document_id": true } ] -} \ No newline at end of file +} diff --git a/.openpublishing.redirection.skype.json b/.openpublishing.redirection.skype.json index c034ac18a3..c4bdfdadd4 100644 --- a/.openpublishing.redirection.skype.json +++ b/.openpublishing.redirection.skype.json @@ -2,6303 +2,6323 @@ "redirections": [ { "source_path": "skype/virtual-folder/skype/Disable-CsOnlineSipDomain.md", - "redirect_url": "/powershell/module/teams/Disable-CsOnlineSipDomain", + "redirect_url": "/powershell/module/MicrosoftTeams/Disable-CsOnlineSipDomain", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Enable-CsOnlineSipDomain.md", - "redirect_url": "/powershell/module/teams/Enable-CsOnlineSipDomain", + "redirect_url": "/powershell/module/MicrosoftTeams/Enable-CsOnlineSipDomain", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Export-CsAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/Export-CsAutoAttendantHolidays", + "redirect_url": "/powershell/module/MicrosoftTeams/Export-CsAutoAttendantHolidays", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/export-csonlineaudiofile.md", - "redirect_url": "/powershell/module/teams/export-csonlineaudiofile", + "redirect_url": "/powershell/module/MicrosoftTeams/export-csonlineaudiofile", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Find-CsGroup.md", - "redirect_url": "/powershell/module/teams/Find-CsGroup", + "redirect_url": "/powershell/module/MicrosoftTeams/Find-CsGroup", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Find-CsOnlineApplicationInstance.md", - "redirect_url": "/powershell/module/teams/Find-CsOnlineApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/Find-CsOnlineApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsApplicationAccessPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsApplicationAccessPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsApplicationMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsApplicationMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsApplicationMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendant.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendant", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantHolidays", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantHolidays", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantStatus.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantStatus", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantStatus", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantSupportedLanguage.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantSupportedLanguage", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantSupportedTimeZone.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantSupportedTimeZone", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantTenantInformation.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantTenantInformation", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantTenantInformation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsCallingLineIdentity.md", - "redirect_url": "/powershell/module/teams/Get-CsCallingLineIdentity", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsCallingLineIdentity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsCallQueue.md", - "redirect_url": "/powershell/module/teams/Get-CsCallQueue", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsCallQueue", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsEffectiveTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Get-CsEffectiveTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsEffectiveTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsInboundBlockedNumberPattern.md", - "redirect_url": "/powershell/module/teams/Get-CsInboundBlockedNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsInboundBlockedNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsInboundExemptNumberPattern.md", - "redirect_url": "/powershell/module/teams/Get-CsInboundExemptNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsInboundExemptNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsMeetingMigrationStatus.md", - "redirect_url": "/powershell/module/teams/Get-CsMeetingMigrationStatus", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsMeetingMigrationStatus", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstance.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstanceAssociation.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstanceAssociation", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstanceAssociationStatus.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstanceAssociationStatus", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineAudioFile.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineAudioFile", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineAudioFile", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingBridge.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingBridge", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingLanguagesSupported", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialinConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialinConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingServiceNumber.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingServiceNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialinConferencingTenantConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingTenantSettings.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingTenantSettings", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUser.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingUser", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingUser", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialOutPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialOutPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialOutPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDirectoryTenant.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDirectoryTenant", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDirectoryTenant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisCivicAddress.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisCivicAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisCivicAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisLocation.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisLocation", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisLocation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisPort.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisPort", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisPort", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisSubnet.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisSwitch.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisSwitch", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisSwitch", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisWirelessAccessPoint.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisWirelessAccessPoint", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlinePSTNGateway.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlinePSTNGateway", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlinePSTNGateway", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlinePstnUsage.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlinePstnUsage", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlinePstnUsage", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineSchedule.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineSchedule", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineSchedule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineSipDomain.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineSipDomain", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineSipDomain", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumber.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineTelephoneNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineTelephoneNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineUser.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineUser", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineUser", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoicemailPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineVoicemailPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoicemailPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoicemailUserSettings.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineVoicemailUserSettings", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceRoute.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceRoute", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoiceRoute", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceUser.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceUser", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoiceUser", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsAppPermissionPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsAppPermissionPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsAppSetupPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsAppSetupPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsAppSetupPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsAudioConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsAudioConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallHoldPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsCallHoldPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCallHoldPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallParkPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsCallParkPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCallParkPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsChannelsPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsChannelsPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsChannelsPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsClientConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsClientConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsClientConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsComplianceRecordingApplication.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsComplianceRecordingApplication", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsComplianceRecordingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsComplianceRecordingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsComplianceRecordingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsCortanaPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsCortanaPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCortanaPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsEducationAssignmentsAppPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsEducationAssignmentsAppPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsEmergencyCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsEmergencyCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsEmergencyCallRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsEmergencyCallRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsFeedbackPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsFeedbackPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsFeedbackPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestCallingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestCallingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestMessagingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestMessagingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsIPPhonePolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsIPPhonePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsIPPhonePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBrandingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBrandingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBroadcastConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBroadcastConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBroadcastPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBroadcastPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMessagingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMessagingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMessagingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMobilityPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMobilityPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMobilityPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsNetworkRoamingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsNetworkRoamingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsTranslationRule.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsTranslationRule", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsTranslationRule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsVideoInteropServicePolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsVideoInteropServicePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenant.md", - "redirect_url": "/powershell/module/teams/Get-CsTenant", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantBlockedCallingNumbers.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantBlockedCallingNumbers", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantFederationConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantFederationConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantFederationConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantLicensingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantLicensingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantLicensingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantMigrationConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantMigrationConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantMigrationConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkRegion.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkRegion", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantNetworkRegion", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkSite.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkSite", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantNetworkSite", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkSubnet.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantNetworkSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantTrustedIPAddress.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantTrustedIPAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantTrustedIPAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsVideoInteropServiceProvider.md", - "redirect_url": "/powershell/module/teams/Get-CsVideoInteropServiceProvider", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsVideoInteropServiceProvider", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsApplicationAccessPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsApplicationAccessPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsCallingLineIdentity.md", - "redirect_url": "/powershell/module/teams/Grant-CsCallingLineIdentity", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsCallingLineIdentity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsCloudMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsCloudMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsCloudMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsDialoutPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsDialoutPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsDialoutPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsExternalUserCommunicationPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsExternalUserCommunicationPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsExternalUserCommunicationPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsOnlineVoicemailPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsOnlineVoicemailPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsOnlineVoiceRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsOnlineVoiceRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAppPermissionPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsAppPermissionPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsAppPermissionPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAppSetupPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsAppSetupPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAudioConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsAudioConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallHoldPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallHoldPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallParkPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallParkPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCallParkPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsChannelsPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsChannelsPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsChannelsPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsComplianceRecordingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsComplianceRecordingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCortanaPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsCortanaPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCortanaPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsEmergencyCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsEmergencyCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsEmergencyCallRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsEmergencyCallRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsFeedbackPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsFeedbackPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsIPPhonePolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsIPPhonePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingBrandingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingBrandingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingBroadcastPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingBroadcastPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMessagingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsMessagingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMessagingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMobilityPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsMobilityPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMobilityPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsVideoInteropServicePolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsVideoInteropServicePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Grant-CsTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Import-CsAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/Import-CsAutoAttendantHolidays", + "redirect_url": "/powershell/module/MicrosoftTeams/Import-CsAutoAttendantHolidays", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Import-CsOnlineAudioFile.md", - "redirect_url": "/powershell/module/teams/Import-CsOnlineAudioFile", + "redirect_url": "/powershell/module/MicrosoftTeams/Import-CsOnlineAudioFile", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsApplicationAccessPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsApplicationAccessPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendant.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendant", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallableEntity.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallableEntity", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantCallableEntity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallFlow.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallFlow", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantCallFlow", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallHandlingAssociation.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallHandlingAssociation", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantDialScope.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantDialScope", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantDialScope", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantMenu.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantMenu", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantMenu", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantMenuOption.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantMenuOption", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantMenuOption", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantPrompt.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantPrompt", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantPrompt", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsCallingLineIdentity.md", - "redirect_url": "/powershell/module/teams/New-CsCallingLineIdentity", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsCallingLineIdentity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsCallQueue.md", - "redirect_url": "/powershell/module/teams/New-CsCallQueue", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsCallQueue", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsEdgeAllowAllKnownDomains.md", - "redirect_url": "/powershell/module/teams/New-CsEdgeAllowAllKnownDomains", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsEdgeAllowList.md", - "redirect_url": "/powershell/module/teams/New-CsEdgeAllowList", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsEdgeAllowList", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsEdgeDomainPattern.md", - "redirect_url": "/powershell/module/teams/New-CsEdgeDomainPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsEdgeDomainPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsInboundBlockedNumberPattern.md", - "redirect_url": "/powershell/module/teams/New-CsInboundBlockedNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsInboundBlockedNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsInboundExemptNumberPattern.md", - "redirect_url": "/powershell/module/teams/New-CsInboundExemptNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsInboundExemptNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationInstance.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationInstanceAssociation.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineApplicationInstanceAssociation", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineDateTimeRange.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineDateTimeRange", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineDateTimeRange", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineLisCivicAddress.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineLisCivicAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineLisCivicAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineLisLocation.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineLisLocation", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineLisLocation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlinePSTNGateway.md", - "redirect_url": "/powershell/module/teams/New-CsOnlinePSTNGateway", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlinePSTNGateway", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineSchedule.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineSchedule", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineSchedule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineTimeRange.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineTimeRange", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineTimeRange", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineVoicemailPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineVoicemailPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineVoicemailPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineVoiceRoute.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineVoiceRoute", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineVoiceRoute", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineVoiceRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineVoiceRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsAppPermissionPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsAppPermissionPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsAppPermissionPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsAppSetupPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsAppSetupPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsAppSetupPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsAudioConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsAudioConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsCallHoldPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsCallHoldPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCallHoldPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsCallingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsCallParkPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsCallParkPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCallParkPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsChannelsPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsChannelsPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsChannelsPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingApplication.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingApplication", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingPairedApplication.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingPairedApplication", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsCortanaPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsCortanaPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCortanaPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallingExtendedNotification.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallingExtendedNotification", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyNumber.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsFeedbackPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsFeedbackPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsFeedbackPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsIPPhonePolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsIPPhonePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsIPPhonePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingBrandingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingBrandingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingBroadcastPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingBroadcastPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsMessagingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsMessagingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMessagingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsMobilityPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsMobilityPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMobilityPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsNetworkRoamingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsNetworkRoamingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsPinnedApp.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsPinnedApp", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsPinnedApp", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsTranslationRule.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsTranslationRule", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsTranslationRule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/New-CsTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkRegion.md", - "redirect_url": "/powershell/module/teams/New-CsTenantNetworkRegion", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantNetworkRegion", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkSite.md", - "redirect_url": "/powershell/module/teams/New-CsTenantNetworkSite", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantNetworkSite", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkSubnet.md", - "redirect_url": "/powershell/module/teams/New-CsTenantNetworkSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantNetworkSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTenantTrustedIPAddress.md", - "redirect_url": "/powershell/module/teams/New-CsTenantTrustedIPAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantTrustedIPAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsVideoInteropServiceProvider.md", - "redirect_url": "/powershell/module/teams/New-CsVideoInteropServiceProvider", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsVideoInteropServiceProvider", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Register-CsOnlineDialInConferencingServiceNumber.md", - "redirect_url": "/powershell/module/teams/Register-CsOnlineDialInConferencingServiceNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsApplicationAccessPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsApplicationAccessPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsAutoAttendant.md", - "redirect_url": "/powershell/module/teams/Remove-CsAutoAttendant", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsAutoAttendant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsCallingLineIdentity.md", - "redirect_url": "/powershell/module/teams/Remove-CsCallingLineIdentity", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsCallingLineIdentity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsCallQueue.md", - "redirect_url": "/powershell/module/teams/Remove-CsCallQueue", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsCallQueue", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsInboundBlockedNumberPattern.md", - "redirect_url": "/powershell/module/teams/Remove-CsInboundBlockedNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsInboundExemptNumberPattern.md", - "redirect_url": "/powershell/module/teams/Remove-CsInboundExemptNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsInboundExemptNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineApplicationInstanceAssociation.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineApplicationInstanceAssociation", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineAudioFile.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineAudioFile", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineAudioFile", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineDialInConferencingTenantSettings.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineDialInConferencingTenantSettings", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisCivicAddress.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisCivicAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisCivicAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisLocation.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisLocation", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisLocation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisPort.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisPort", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisPort", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisSubnet.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisSwitch.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisSwitch", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisSwitch", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisWirelessAccessPoint.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisWirelessAccessPoint", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlinePSTNGateway.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlinePSTNGateway", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlinePSTNGateway", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineSchedule.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineSchedule", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineSchedule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineTelephoneNumber.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineTelephoneNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineTelephoneNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoicemailPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoicemailPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoiceRoute.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoiceRoute", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineVoiceRoute", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoiceRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoiceRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAppPermissionPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsAppPermissionPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAppSetupPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsAppSetupPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAudioConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsAudioConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallHoldPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallHoldPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallParkPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallParkPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCallParkPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsChannelsPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsChannelsPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsChannelsPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsComplianceRecordingApplication.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsComplianceRecordingApplication", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsComplianceRecordingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsComplianceRecordingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCortanaPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsCortanaPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCortanaPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsEmergencyCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsEmergencyCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsEmergencyCallRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsEmergencyCallRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsFeedbackPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsFeedbackPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsIPPhonePolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsIPPhonePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingBrandingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingBrandingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingBroadcastPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingBroadcastPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMessagingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsMessagingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMessagingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMobilityPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsMobilityPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMobilityPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsNetworkRoamingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsNetworkRoamingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsPinnedApp.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsPinnedApp", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsPinnedApp", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsTranslationRule.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsTranslationRule", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsTranslationRule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Remove-CsTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkRegion.md", - "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkRegion", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantNetworkRegion", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkSite.md", - "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkSite", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantNetworkSite", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkSubnet.md", - "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantNetworkSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTenantTrustedIPAddress.md", - "redirect_url": "/powershell/module/teams/Remove-CsTenantTrustedIPAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantTrustedIPAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsVideoInteropServiceProvider.md", - "redirect_url": "/powershell/module/teams/Remove-CsVideoInteropServiceProvider", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsVideoInteropServiceProvider", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsApplicationAccessPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsApplicationAccessPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsApplicationMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsApplicationMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsApplicationMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsAutoAttendant.md", - "redirect_url": "/powershell/module/teams/Set-CsAutoAttendant", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsAutoAttendant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsCallingLineIdentity.md", - "redirect_url": "/powershell/module/teams/Set-CsCallingLineIdentity", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsCallingLineIdentity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsCallQueue.md", - "redirect_url": "/powershell/module/teams/Set-CsCallQueue", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsCallQueue", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsInboundBlockedNumberPattern.md", - "redirect_url": "/powershell/module/teams/Set-CsInboundBlockedNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsInboundBlockedNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsInboundExemptNumberPattern.md", - "redirect_url": "/powershell/module/teams/Set-CsInboundExemptNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsInboundExemptNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineApplicationInstance.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingBridge.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingBridge", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingServiceNumber.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingServiceNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingTenantSettings.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingTenantSettings", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingUser.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingUser", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingUser", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingUserDefaultNumber.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingUserDefaultNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingUserDefaultNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisCivicAddress.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisCivicAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisCivicAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisLocation.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisLocation", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisLocation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisPort.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisPort", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisPort", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisSubnet.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisSwitch.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisSwitch", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisSwitch", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisWirelessAccessPoint.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisWirelessAccessPoint", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlinePSTNGateway.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlinePSTNGateway", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlinePSTNGateway", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlinePstnUsage.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlinePstnUsage", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlinePstnUsage", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineSchedule.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineSchedule", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineSchedule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceApplicationInstance.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoicemailPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoicemailPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoicemailPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoicemailUserSettings.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoicemailUserSettings", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceRoute.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceRoute", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceRoute", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceUser.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceUser", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceUser", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsAppPermissionPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsAppPermissionPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsAppSetupPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsAppSetupPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsAppSetupPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsAudioConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsAudioConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallHoldPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsCallHoldPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCallHoldPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallParkPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsCallParkPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCallParkPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsChannelsPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsChannelsPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsChannelsPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsClientConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsClientConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsClientConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsComplianceRecordingApplication.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsComplianceRecordingApplication", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsComplianceRecordingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsComplianceRecordingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsCortanaPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsCortanaPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCortanaPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsEducationAssignmentsAppPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsEducationAssignmentsAppPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsEmergencyCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsEmergencyCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsEmergencyCallRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsEmergencyCallRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsFeedbackPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsFeedbackPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsFeedbackPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestCallingConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestCallingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestMessagingConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestMessagingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsIPPhonePolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsIPPhonePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsIPPhonePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBrandingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBrandingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBroadcastConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBroadcastConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBroadcastPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBroadcastPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMessagingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMessagingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMessagingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMobilityPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMobilityPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMobilityPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsNetworkRoamingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsNetworkRoamingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsPinnedApp.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsPinnedApp", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsPinnedApp", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsTranslationRule.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsTranslationRule", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsTranslationRule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantBlockedCallingNumbers.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantBlockedCallingNumbers", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantFederationConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantFederationConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantFederationConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantMigrationConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantMigrationConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantMigrationConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkRegion.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkRegion", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantNetworkRegion", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkSite.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkSite", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantNetworkSite", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkSubnet.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantNetworkSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantTrustedIPAddress.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantTrustedIPAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantTrustedIPAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServiceProvider.md", - "redirect_url": "/powershell/module/teams/Set-CsVideoInteropServiceProvider", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsVideoInteropServiceProvider", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Start-CsExMeetingMigration.md", - "redirect_url": "/powershell/module/teams/Start-CsExMeetingMigration", + "redirect_url": "/powershell/module/MicrosoftTeams/Start-CsExMeetingMigration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Sync-CsOnlineApplicationInstance.md", - "redirect_url": "/powershell/module/teams/Sync-CsOnlineApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/Sync-CsOnlineApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsEffectiveTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Test-CsEffectiveTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Test-CsEffectiveTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsInboundBlockedNumberPattern.md", - "redirect_url": "/powershell/module/teams/Test-CsInboundBlockedNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Test-CsInboundBlockedNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsTeamsTranslationRule.md", - "redirect_url": "/powershell/module/teams/Test-CsTeamsTranslationRule", + "redirect_url": "/powershell/module/MicrosoftTeams/Test-CsTeamsTranslationRule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md", - "redirect_url": "/powershell/module/teams/Unregister-CsOnlineDialInConferencingServiceNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Update-CsAutoAttendant.md", - "redirect_url": "/powershell/module/teams/Update-CsAutoAttendant", + "redirect_url": "/powershell/module/MicrosoftTeams/Update-CsAutoAttendant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Clear-CsOnlineTelephoneNumberReservation.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Disable-CsOnlineDialInConferencingUser.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Enable-CsOnlineDialInConferencingUser.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Export-CsOrganizationalAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsHuntGroup.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsHuntGroupTenantInformation.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationEndpoint.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUserInfo.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUserState.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDirectoryTenantNumberCities.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineNumberPortInOrder.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineNumberPortOutOrderPin.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberAvailableCount.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryCities.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendant.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantStatus.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsUpgradeStatus.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantPublicProvider.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsBroadcastMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Import-CsOrganizationalAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsHuntGroup.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationEndpoint.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineAudioFile.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineBulkAssignmentInput.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineNumberPortInOrder.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineSession.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendant.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallableEntity.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallFlow.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantDialScope.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantMenu.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantMenuOption.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantPrompt.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsHuntGroup.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineApplicationEndpoint.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineNumberPortInOrder.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOrganizationalAutoAttendant.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Search-CsOnlineTelephoneNumberInventory.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Select-CsOnlineTelephoneNumberInventory.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsHuntGroup.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineApplicationEndpoint.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDirectoryUser.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineNumberPortInOrder.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineNumberPortOutOrderPin.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceUserBulk.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOrganizationalAutoAttendant.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantPublicProvider.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsOnlineCarrierPortabilityIn.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsOnlineLisCivicAddress.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsOnlinePortabilityIn.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Update-CsOrganizationalAutoAttendant.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { - "source_path": "skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md", + "source_path": "skype/virtual-folder/skype/Clear-CsDeviceUpdateFile.md", "redirect_url": "/powershell/module/skypeforbusiness/clear-csdeviceupdatefile", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md", + "source_path": "skype/virtual-folder/skype/Clear-CsDeviceUpdateLog.md", "redirect_url": "/powershell/module/skypeforbusiness/clear-csdeviceupdatelog", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Clear-CsPersistentChatRoom.md", + "source_path": "skype/virtual-folder/skype/Clear-CsPersistentChatRoom.md", "redirect_url": "/powershell/module/skypeforbusiness/clear-cspersistentchatroom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Convert-CsUserData.md", + "source_path": "skype/virtual-folder/skype/Convert-CsUserData.md", "redirect_url": "/powershell/module/skypeforbusiness/convert-csuserdata", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/ConvertTo-JsonForPSWS.md", + "source_path": "skype/virtual-folder/skype/ConvertTo-JsonForPSWS.md", "redirect_url": "/powershell/module/skypeforbusiness/convertto-jsonforpsws", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Copy-CsVoicePolicy.md", + "source_path": "skype/virtual-folder/skype/Copy-CsVoicePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/copy-csvoicepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Debug-CsAddressBookReplication.md", + "source_path": "skype/virtual-folder/skype/Debug-CsAddressBookReplication.md", "redirect_url": "/powershell/module/skypeforbusiness/debug-csaddressbookreplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Debug-CsDataConference.md", + "source_path": "skype/virtual-folder/skype/Debug-CsDataConference.md", "redirect_url": "/powershell/module/skypeforbusiness/debug-csdataconference", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Debug-CsInterPoolReplication.md", + "source_path": "skype/virtual-folder/skype/Debug-CsInterPoolReplication.md", "redirect_url": "/powershell/module/skypeforbusiness/debug-csinterpoolreplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Debug-CsIntraPoolReplication.md", + "source_path": "skype/virtual-folder/skype/Debug-CsIntraPoolReplication.md", "redirect_url": "/powershell/module/skypeforbusiness/debug-csintrapoolreplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Debug-CsLisConfiguration.md", + "source_path": "skype/virtual-folder/skype/Debug-CsLisConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/debug-cslisconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Debug-CsStorageServiceFailures.md", + "source_path": "skype/virtual-folder/skype/Debug-CsStorageServiceFailures.md", "redirect_url": "/powershell/module/skypeforbusiness/debug-csstorageservicefailures", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Debug-CsUnifiedContactStore.md", + "source_path": "skype/virtual-folder/skype/Debug-CsUnifiedContactStore.md", "redirect_url": "/powershell/module/skypeforbusiness/debug-csunifiedcontactstore", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Disable-CsAdDomain.md", + "source_path": "skype/virtual-folder/skype/Disable-CsAdDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/disable-csaddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Disable-CsAdForest.md", + "source_path": "skype/virtual-folder/skype/Disable-CsAdForest.md", "redirect_url": "/powershell/module/skypeforbusiness/disable-csadforest", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Disable-CsComputer.md", + "source_path": "skype/virtual-folder/skype/Disable-CsComputer.md", "redirect_url": "/powershell/module/skypeforbusiness/disable-cscomputer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Disable-CsHostingProvider.md", + "source_path": "skype/virtual-folder/skype/Disable-CsHostingProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/disable-cshostingprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Disable-CsMeetingRoom.md", + "source_path": "skype/virtual-folder/skype/Disable-CsMeetingRoom.md", "redirect_url": "/powershell/module/skypeforbusiness/disable-csmeetingroom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Disable-CsPublicProvider.md", + "source_path": "skype/virtual-folder/skype/Disable-CsPublicProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/disable-cspublicprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Disable-CsUser.md", + "source_path": "skype/virtual-folder/skype/Disable-CsUser.md", "redirect_url": "/powershell/module/skypeforbusiness/disable-csuser", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Enable-CsAdDomain.md", + "source_path": "skype/virtual-folder/skype/Enable-CsAdDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/enable-csaddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Enable-CsAdForest.md", + "source_path": "skype/virtual-folder/skype/Enable-CsAdForest.md", "redirect_url": "/powershell/module/skypeforbusiness/enable-csadforest", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Enable-CsComputer.md", + "source_path": "skype/virtual-folder/skype/Enable-CsComputer.md", "redirect_url": "/powershell/module/skypeforbusiness/enable-cscomputer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Enable-CsHostingProvider.md", + "source_path": "skype/virtual-folder/skype/Enable-CsHostingProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/enable-cshostingprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Enable-CsMeetingRoom.md", + "source_path": "skype/virtual-folder/skype/Enable-CsMeetingRoom.md", "redirect_url": "/powershell/module/skypeforbusiness/enable-csmeetingroom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Enable-CsPublicProvider.md", + "source_path": "skype/virtual-folder/skype/Enable-CsPublicProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/enable-cspublicprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Enable-CsReplica.md", + "source_path": "skype/virtual-folder/skype/Enable-CsReplica.md", "redirect_url": "/powershell/module/skypeforbusiness/enable-csreplica", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Enable-CsTopology.md", + "source_path": "skype/virtual-folder/skype/Enable-CsTopology.md", "redirect_url": "/powershell/module/skypeforbusiness/enable-cstopology", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Enable-CsUser.md", + "source_path": "skype/virtual-folder/skype/Enable-CsUser.md", "redirect_url": "/powershell/module/skypeforbusiness/enable-csuser", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Export-CsArchivingData.md", + "source_path": "skype/virtual-folder/skype/Export-CsArchivingData.md", "redirect_url": "/powershell/module/skypeforbusiness/export-csarchivingdata", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Export-CsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Export-CsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/export-csconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Export-CsLisConfiguration.md", + "source_path": "skype/virtual-folder/skype/Export-CsLisConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/export-cslisconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Export-CsPersistentChatData.md", + "source_path": "skype/virtual-folder/skype/Export-CsPersistentChatData.md", "redirect_url": "/powershell/module/skypeforbusiness/export-cspersistentchatdata", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Export-CsRgsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Export-CsRgsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/export-csrgsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Export-CsUserData.md", + "source_path": "skype/virtual-folder/skype/Export-CsUserData.md", "redirect_url": "/powershell/module/skypeforbusiness/export-csuserdata", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsAccessEdgeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csaccessedgeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAdContact.md", + "source_path": "skype/virtual-folder/skype/Get-CsAdContact.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csadcontact", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md", + "source_path": "skype/virtual-folder/skype/Get-CsAdditionalInternalDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csadditionalinternaldomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAdDomain.md", + "source_path": "skype/virtual-folder/skype/Get-CsAdDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csaddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAddressBookConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsAddressBookConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csaddressbookconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsAddressBookNormalizationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csaddressbooknormalizationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md", + "source_path": "skype/virtual-folder/skype/Get-CsAddressBookNormalizationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csaddressbooknormalizationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAdForest.md", + "source_path": "skype/virtual-folder/skype/Get-CsAdForest.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csadforest", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAdminRole.md", + "source_path": "skype/virtual-folder/skype/Get-CsAdminRole.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csadminrole", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAdminRoleAssignment.md", + "source_path": "skype/virtual-folder/skype/Get-CsAdminRoleAssignment.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csadminroleassignment", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAdPrincipal.md", + "source_path": "skype/virtual-folder/skype/Get-CsAdPrincipal.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csadprincipal", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAdServerSchema.md", + "source_path": "skype/virtual-folder/skype/Get-CsAdServerSchema.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csadserverschema", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAdUser.md", + "source_path": "skype/virtual-folder/skype/Get-CsAdUser.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csaduser", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAllowedDomain.md", + "source_path": "skype/virtual-folder/skype/Get-CsAllowedDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csalloweddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAnalogDevice.md", + "source_path": "skype/virtual-folder/skype/Get-CsAnalogDevice.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csanalogdevice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAnnouncement.md", + "source_path": "skype/virtual-folder/skype/Get-CsAnnouncement.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csannouncement", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsApplicationEndpoint.md", + "source_path": "skype/virtual-folder/skype/Get-CsApplicationEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csapplicationendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsArchivingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsArchivingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csarchivingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsArchivingPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsArchivingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csarchivingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAudioConferencingProvider.md", + "source_path": "skype/virtual-folder/skype/Get-CsAudioConferencingProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csaudioconferencingprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md", + "source_path": "skype/virtual-folder/skype/Get-CsAudioTestServiceApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csaudiotestserviceapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAuthConfig.md", + "source_path": "skype/virtual-folder/skype/Get-CsAuthConfig.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csauthconfig", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsAutodiscoverConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csautodiscoverconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsAVEdgeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csavedgeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsBackupServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csbackupserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsBackupServiceStatus.md", + "source_path": "skype/virtual-folder/skype/Get-CsBackupServiceStatus.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csbackupservicestatus", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsBandwidthPolicyServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csbandwidthpolicyserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsBlockedDomain.md", + "source_path": "skype/virtual-folder/skype/Get-CsBlockedDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csblockeddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsBroadcastMeetingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csbroadcastmeetingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsBroadcastMeetingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csbroadcastmeetingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsBusyOptions.md", + "source_path": "skype/virtual-folder/skype/Get-CsBusyOptions.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csbusyoptions", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsCallParkOrbit.md", + "source_path": "skype/virtual-folder/skype/Get-CsCallParkOrbit.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cscallparkorbit", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsCallViaWorkPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cscallviaworkpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsCdrConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsCdrConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cscdrconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsCertificate.md", + "source_path": "skype/virtual-folder/skype/Get-CsCertificate.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cscertificate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClientAccessLicense.md", + "source_path": "skype/virtual-folder/skype/Get-CsClientAccessLicense.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclientaccesslicense", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClientCertificate.md", + "source_path": "skype/virtual-folder/skype/Get-CsClientCertificate.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclientcertificate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClientPinInfo.md", + "source_path": "skype/virtual-folder/skype/Get-CsClientPinInfo.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclientpininfo", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClientPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsClientPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclientpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClientVersionConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsClientVersionConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclientversionconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClientVersionPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsClientVersionPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclientversionpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md", + "source_path": "skype/virtual-folder/skype/Get-CsClientVersionPolicyRule.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclientversionpolicyrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsCloudCallDataConnector.md", + "source_path": "skype/virtual-folder/skype/Get-CsCloudCallDataConnector.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cscloudcalldataconnector", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsCloudCallDataConnectorConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cscloudcalldataconnectorconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsCloudMeetingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cscloudmeetingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClsAgentStatus.md", + "source_path": "skype/virtual-folder/skype/Get-CsClsAgentStatus.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclsagentstatus", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsClsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClsRegion.md", + "source_path": "skype/virtual-folder/skype/Get-CsClsRegion.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclsregion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClsScenario.md", + "source_path": "skype/virtual-folder/skype/Get-CsClsScenario.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclsscenario", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClsSearchTerm.md", + "source_path": "skype/virtual-folder/skype/Get-CsClsSearchTerm.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclssearchterm", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsClsSecurityGroup.md", + "source_path": "skype/virtual-folder/skype/Get-CsClsSecurityGroup.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csclssecuritygroup", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsCommonAreaPhone.md", + "source_path": "skype/virtual-folder/skype/Get-CsCommonAreaPhone.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cscommonareaphone", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsComputer.md", + "source_path": "skype/virtual-folder/skype/Get-CsComputer.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cscomputer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsConferenceDirectory.md", + "source_path": "skype/virtual-folder/skype/Get-CsConferenceDirectory.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencedirectory", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsConferenceDisclaimer.md", + "source_path": "skype/virtual-folder/skype/Get-CsConferenceDisclaimer.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencedisclaimer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsConferencingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsConferencingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsConferencingPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsConferencingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md", + "source_path": "skype/virtual-folder/skype/Get-CsConfigurationStoreLocation.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csconfigurationstorelocation", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsConversationHistoryConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csconversationhistoryconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsCpsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsCpsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cscpsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsDatabaseMirrorState.md", + "source_path": "skype/virtual-folder/skype/Get-CsDatabaseMirrorState.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csdatabasemirrorstate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsDeviceUpdateConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csdeviceupdateconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsDeviceUpdateRule.md", + "source_path": "skype/virtual-folder/skype/Get-CsDeviceUpdateRule.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csdeviceupdaterule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsDiagnosticConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csdiagnosticconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsDiagnosticHeaderConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csdiagnosticheaderconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md", + "source_path": "skype/virtual-folder/skype/Get-CsDialInConferencingAccessNumber.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencingaccessnumber", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsDialInConferencingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsDialInConferencingDtmfConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencingdtmfconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md", + "source_path": "skype/virtual-folder/skype/Get-CsDialInConferencingLanguageList.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencinglanguagelist", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsDialPlan.md", + "source_path": "skype/virtual-folder/skype/Get-CsDialPlan.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csdialplan", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsEffectivePolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsEffectivePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cseffectivepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md", + "source_path": "skype/virtual-folder/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csenhancedemergencyservicedisclaimer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsExternalAccessPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsExternalAccessPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csexternalaccesspolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsExternalUserCommunicationPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csexternalusercommunicationpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsExUmContact.md", + "source_path": "skype/virtual-folder/skype/Get-CsExUmContact.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csexumcontact", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsFileTransferFilterConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csfiletransferfilterconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsFIPSConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsFIPSConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csfipsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsGraphPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsGraphPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csgraphpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md", + "source_path": "skype/virtual-folder/skype/Get-CsGroupPickupUserOrbit.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csgrouppickupuserorbit", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsHealthMonitoringConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cshealthmonitoringconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsHostedVoicemailPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cshostedvoicemailpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsHostingProvider.md", + "source_path": "skype/virtual-folder/skype/Get-CsHostingProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cshostingprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md", + "source_path": "skype/virtual-folder/skype/Get-CsHybridApplicationEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsHybridMediationServer.md", + "source_path": "skype/virtual-folder/skype/Get-CsHybridMediationServer.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridmediationserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md", + "source_path": "skype/virtual-folder/skype/Get-CsHybridPSTNAppliance.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridpstnappliance", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsHybridPSTNSite.md", + "source_path": "skype/virtual-folder/skype/Get-CsHybridPSTNSite.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridpstnsite", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsImConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsImConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csimconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsImFilterConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsImFilterConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csimfilterconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsImTranslationConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsImTranslationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csimtranslationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsIPPhonePolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsIPPhonePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csipphonepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md", + "source_path": "skype/virtual-folder/skype/Get-CsKerberosAccountAssignment.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cskerberosaccountassignment", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsLisCivicAddress.md", + "source_path": "skype/virtual-folder/skype/Get-CsLisCivicAddress.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csliscivicaddress", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsLisLocation.md", + "source_path": "skype/virtual-folder/skype/Get-CsLisLocation.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cslislocation", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsLisPort.md", + "source_path": "skype/virtual-folder/skype/Get-CsLisPort.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cslisport", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsLisServiceProvider.md", + "source_path": "skype/virtual-folder/skype/Get-CsLisServiceProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cslisserviceprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsLisSubnet.md", + "source_path": "skype/virtual-folder/skype/Get-CsLisSubnet.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cslissubnet", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsLisSwitch.md", + "source_path": "skype/virtual-folder/skype/Get-CsLisSwitch.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cslisswitch", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md", + "source_path": "skype/virtual-folder/skype/Get-CsLisWirelessAccessPoint.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csliswirelessaccesspoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsLocationPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsLocationPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cslocationpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsManagementConnection.md", + "source_path": "skype/virtual-folder/skype/Get-CsManagementConnection.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csmanagementconnection", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md", + "source_path": "skype/virtual-folder/skype/Get-CsManagementStoreReplicationStatus.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csmanagementstorereplicationstatus", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsMcxConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsMcxConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csmcxconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsMediaConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsMediaConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csmediaconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsMeetingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsMeetingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csmeetingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsMeetingRoom.md", + "source_path": "skype/virtual-folder/skype/Get-CsMeetingRoom.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csmeetingroom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsMobilityPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsMobilityPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csmobilitypolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md", + "source_path": "skype/virtual-folder/skype/Get-CsNetworkBandwidthPolicyProfile.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkbandwidthpolicyprofile", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsNetworkConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsNetworkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsNetworkInterface.md", + "source_path": "skype/virtual-folder/skype/Get-CsNetworkInterface.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkinterface", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md", + "source_path": "skype/virtual-folder/skype/Get-CsNetworkInterRegionRoute.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkinterregionroute", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsNetworkInterSitePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkintersitepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsNetworkRegion.md", + "source_path": "skype/virtual-folder/skype/Get-CsNetworkRegion.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkregion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsNetworkRegionLink.md", + "source_path": "skype/virtual-folder/skype/Get-CsNetworkRegionLink.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkregionlink", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsNetworkSite.md", + "source_path": "skype/virtual-folder/skype/Get-CsNetworkSite.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworksite", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsNetworkSubnet.md", + "source_path": "skype/virtual-folder/skype/Get-CsNetworkSubnet.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworksubnet", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsOAuthConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsOAuthConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csoauthconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsOAuthServer.md", + "source_path": "skype/virtual-folder/skype/Get-CsOAuthServer.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csoauthserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md", + "source_path": "skype/virtual-folder/skype/Get-CsOutboundCallingNumberTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csoutboundcallingnumbertranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsOutboundTranslationRule.md", + "source_path": "skype/virtual-folder/skype/Get-CsOutboundTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csoutboundtranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPartnerApplication.md", + "source_path": "skype/virtual-folder/skype/Get-CsPartnerApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspartnerapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPersistentChatAddin.md", + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatAddin.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchataddin", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPersistentChatCategory.md", + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatCategory.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatcategory", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatComplianceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatcomplianceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md", + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatEligiblePrincipal.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchateligibleprincipal", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md", + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPersistentChatPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPersistentChatRoom.md", + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatRoom.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatroom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPersistentChatState.md", + "source_path": "skype/virtual-folder/skype/Get-CsPersistentChatState.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatstate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPinPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsPinPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspinpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPlatformServiceSettings.md", + "source_path": "skype/virtual-folder/skype/Get-CsPlatformServiceSettings.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csplatformservicesettings", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPool.md", + "source_path": "skype/virtual-folder/skype/Get-CsPool.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspool", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPoolBackupRelationship.md", + "source_path": "skype/virtual-folder/skype/Get-CsPoolBackupRelationship.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspoolbackuprelationship", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPoolFabricState.md", + "source_path": "skype/virtual-folder/skype/Get-CsPoolFabricState.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspoolfabricstate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md", + "source_path": "skype/virtual-folder/skype/Get-CsPoolUpgradeReadinessState.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspoolupgradereadinessstate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPresenceManagementState.md", + "source_path": "skype/virtual-folder/skype/Get-CsPresenceManagementState.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspresencemanagementstate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPresencePolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsPresencePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspresencepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPresenceProvider.md", + "source_path": "skype/virtual-folder/skype/Get-CsPresenceProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspresenceprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPrivacyConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsPrivacyConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csprivacyconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsProxyConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsProxyConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csproxyconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPstnUsage.md", + "source_path": "skype/virtual-folder/skype/Get-CsPstnUsage.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspstnusage", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPublicProvider.md", + "source_path": "skype/virtual-folder/skype/Get-CsPublicProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspublicprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsPushNotificationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cspushnotificationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsQoEConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsQoEConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csqoeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsRegistrarConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsRegistrarConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csregistrarconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsReportingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsReportingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csreportingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsRgsAgentGroup.md", + "source_path": "skype/virtual-folder/skype/Get-CsRgsAgentGroup.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsagentgroup", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsRgsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsRgsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsRgsHolidaySet.md", + "source_path": "skype/virtual-folder/skype/Get-CsRgsHolidaySet.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsholidayset", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md", + "source_path": "skype/virtual-folder/skype/Get-CsRgsHoursOfBusiness.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csrgshoursofbusiness", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsRgsQueue.md", + "source_path": "skype/virtual-folder/skype/Get-CsRgsQueue.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsqueue", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsRgsWorkflow.md", + "source_path": "skype/virtual-folder/skype/Get-CsRgsWorkflow.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsworkflow", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsRoutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsRoutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsServerApplication.md", + "source_path": "skype/virtual-folder/skype/Get-CsServerApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csserverapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsServerPatchVersion.md", + "source_path": "skype/virtual-folder/skype/Get-CsServerPatchVersion.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csserverpatchversion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsServerVersion.md", + "source_path": "skype/virtual-folder/skype/Get-CsServerVersion.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csserverversion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsService.md", + "source_path": "skype/virtual-folder/skype/Get-CsService.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csservice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsSimpleUrlConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cssimpleurlconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsSipDomain.md", + "source_path": "skype/virtual-folder/skype/Get-CsSipDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cssipdomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md", + "source_path": "skype/virtual-folder/skype/Get-CsSipResponseCodeTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cssipresponsecodetranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsSite.md", + "source_path": "skype/virtual-folder/skype/Get-CsSite.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cssite", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsSlaConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsSlaConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csslaconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsStaticRoutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csstaticroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsStorageServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csstorageserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsTeamsUpgradeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csteamsupgradeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsTeamsUpgradePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csteamsupgradepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTelemetryConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsTelemetryConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstelemetryconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsTenantHybridConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstenanthybridconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md", + "source_path": "skype/virtual-folder/skype/Get-CsTenantUpdateTimeWindow.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstenantupdatetimewindow", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTestDevice.md", + "source_path": "skype/virtual-folder/skype/Get-CsTestDevice.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstestdevice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTestUserCredential.md", + "source_path": "skype/virtual-folder/skype/Get-CsTestUserCredential.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstestusercredential", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md", + "source_path": "skype/virtual-folder/skype/Get-CsThirdPartyVideoSystem.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csthirdpartyvideosystem", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsThirdPartyVideoSystemPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csthirdpartyvideosystempolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTopology.md", + "source_path": "skype/virtual-folder/skype/Get-CsTopology.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstopology", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTrunk.md", + "source_path": "skype/virtual-folder/skype/Get-CsTrunk.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstrunk", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTrunkConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsTrunkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstrunkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTrustedApplication.md", + "source_path": "skype/virtual-folder/skype/Get-CsTrustedApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md", + "source_path": "skype/virtual-folder/skype/Get-CsTrustedApplicationComputer.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplicationcomputer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md", + "source_path": "skype/virtual-folder/skype/Get-CsTrustedApplicationEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplicationendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsTrustedApplicationPool.md", + "source_path": "skype/virtual-folder/skype/Get-CsTrustedApplicationPool.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplicationpool", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsUCPhoneConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csucphoneconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUICulture.md", + "source_path": "skype/virtual-folder/skype/Get-CsUICulture.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuiculture", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUnassignedNumber.md", + "source_path": "skype/virtual-folder/skype/Get-CsUnassignedNumber.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csunassignednumber", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md", + "source_path": "skype/virtual-folder/skype/Get-CsUpgradeDomainInfo.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csupgradedomaininfo", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUser.md", + "source_path": "skype/virtual-folder/skype/Get-CsUser.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuser", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserAcp.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserAcp.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuseracp", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserCallForwardingSettings.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csusercallforwardingsettings", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserDatabaseState.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserDatabaseState.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuserdatabasestate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserDelegates.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserDelegates.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuserdelegates", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserLocationStatus.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserLocationStatus.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuserlocationstatus", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserPoolInfo.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserPoolInfo.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuserpoolinfo", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserPstnSettings.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserPstnSettings.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuserpstnsettings", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserReplicatorConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuserreplicatorconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserServicesConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserServicesConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuserservicesconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserServicesPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserServicesPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuserservicespolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserSession.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserSession.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csusersession", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserSettingsPageConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csusersettingspageconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsUserTeamMembers.md", + "source_path": "skype/virtual-folder/skype/Get-CsUserTeamMembers.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csuserteammembers", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsVideoInteropServerConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvideointeropserverconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvideointeropserversynthetictransactionconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVideoTrunk.md", + "source_path": "skype/virtual-folder/skype/Get-CsVideoTrunk.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvideotrunk", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsVideoTrunkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvideotrunkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVoiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsVoiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvoiceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsVoicemailReroutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicemailreroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md", + "source_path": "skype/virtual-folder/skype/Get-CsVoiceNormalizationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicenormalizationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVoicePolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsVoicePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVoiceRoute.md", + "source_path": "skype/virtual-folder/skype/Get-CsVoiceRoute.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvoiceroute", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md", + "source_path": "skype/virtual-folder/skype/Get-CsVoiceRoutingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvoiceroutingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsVoiceTestConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicetestconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsWatcherNodeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cswatchernodeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsWebServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsWebServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cswebserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsWindowsService.md", + "source_path": "skype/virtual-folder/skype/Get-CsWindowsService.md", "redirect_url": "/powershell/module/skypeforbusiness/get-cswindowsservice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsXmppAllowedPartner.md", + "source_path": "skype/virtual-folder/skype/Get-CsXmppAllowedPartner.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csxmppallowedpartner", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md", + "source_path": "skype/virtual-folder/skype/Get-CsXmppGatewayConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/get-csxmppgatewayconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsArchivingPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsArchivingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csarchivingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsCallViaWorkPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-cscallviaworkpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsClientPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsClientPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csclientpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsClientVersionPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsClientVersionPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csclientversionpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsConferencingPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsConferencingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csconferencingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsDialPlan.md", + "source_path": "skype/virtual-folder/skype/Grant-CsDialPlan.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csdialplan", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsExternalAccessPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csexternalaccesspolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsGraphPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsGraphPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csgraphpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsHostedVoicemailPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-cshostedvoicemailpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsIPPhonePolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsIPPhonePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csipphonepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsLocationPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsLocationPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-cslocationpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsMobilityPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsMobilityPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csmobilitypolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsOUPermission.md", + "source_path": "skype/virtual-folder/skype/Grant-CsOUPermission.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csoupermission", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsPersistentChatPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-cspersistentchatpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsPinPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsPinPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-cspinpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsPresencePolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsPresencePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-cspresencepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsSetupPermission.md", + "source_path": "skype/virtual-folder/skype/Grant-CsSetupPermission.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-cssetuppermission", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsUpgradePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csteamsupgradepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsThirdPartyVideoSystemPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csthirdpartyvideosystempolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsUserServicesPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsUserServicesPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csuserservicespolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsVoicePolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsVoicePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csvoicepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md", + "source_path": "skype/virtual-folder/skype/Grant-CsVoiceRoutingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/grant-csvoiceroutingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CSAnnouncementFile.md", + "source_path": "skype/virtual-folder/skype/Import-CSAnnouncementFile.md", "redirect_url": "/powershell/module/skypeforbusiness/import-csannouncementfile", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsCertificate.md", + "source_path": "skype/virtual-folder/skype/Import-CsCertificate.md", "redirect_url": "/powershell/module/skypeforbusiness/import-cscertificate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md", + "source_path": "skype/virtual-folder/skype/Import-CsCompanyPhoneNormalizationRules.md", "redirect_url": "/powershell/module/skypeforbusiness/import-cscompanyphonenormalizationrules", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Import-CsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/import-csconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsDeviceUpdate.md", + "source_path": "skype/virtual-folder/skype/Import-CsDeviceUpdate.md", "redirect_url": "/powershell/module/skypeforbusiness/import-csdeviceupdate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md", + "source_path": "skype/virtual-folder/skype/Import-CsLegacyConferenceDirectory.md", "redirect_url": "/powershell/module/skypeforbusiness/import-cslegacyconferencedirectory", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsLegacyConfiguration.md", + "source_path": "skype/virtual-folder/skype/Import-CsLegacyConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/import-cslegacyconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsLisConfiguration.md", + "source_path": "skype/virtual-folder/skype/Import-CsLisConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/import-cslisconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsPersistentChatData.md", + "source_path": "skype/virtual-folder/skype/Import-CsPersistentChatData.md", "redirect_url": "/powershell/module/skypeforbusiness/import-cspersistentchatdata", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsRgsAudioFile.md", + "source_path": "skype/virtual-folder/skype/Import-CsRgsAudioFile.md", "redirect_url": "/powershell/module/skypeforbusiness/import-csrgsaudiofile", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsRgsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Import-CsRgsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/import-csrgsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Import-CsUserData.md", + "source_path": "skype/virtual-folder/skype/Import-CsUserData.md", "redirect_url": "/powershell/module/skypeforbusiness/import-csuserdata", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Install-CsAdServerSchema.md", + "source_path": "skype/virtual-folder/skype/Install-CsAdServerSchema.md", "redirect_url": "/powershell/module/skypeforbusiness/install-csadserverschema", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Install-CsDatabase.md", + "source_path": "skype/virtual-folder/skype/Install-CsDatabase.md", "redirect_url": "/powershell/module/skypeforbusiness/install-csdatabase", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Install-CsMirrorDatabase.md", + "source_path": "skype/virtual-folder/skype/Install-CsMirrorDatabase.md", "redirect_url": "/powershell/module/skypeforbusiness/install-csmirrordatabase", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsArchivingDatabasePurge.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-csarchivingdatabasepurge", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsBackupServiceSync.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsBackupServiceSync.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-csbackupservicesync", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsCdrDatabasePurge.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-cscdrdatabasepurge", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsComputerFailBack.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsComputerFailBack.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-cscomputerfailback", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsComputerFailOver.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsComputerFailOver.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-cscomputerfailover", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsDatabaseFailover.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsDatabaseFailover.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-csdatabasefailover", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsManagementServerFailover.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsManagementServerFailover.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-csmanagementserverfailover", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsManagementStoreReplication.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-csmanagementstorereplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsPoolFailBack.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsPoolFailBack.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-cspoolfailback", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsPoolFailOver.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsPoolFailOver.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-cspoolfailover", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsQoEDatabasePurge.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-csqoedatabasepurge", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsRgsStoreReplicateData.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-csrgsstorereplicatedata", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsStorageServiceFlush.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-csstorageserviceflush", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Invoke-CsUcsRollback.md", + "source_path": "skype/virtual-folder/skype/Invoke-CsUcsRollback.md", "redirect_url": "/powershell/module/skypeforbusiness/invoke-csucsrollback", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Lock-CsClientPin.md", + "source_path": "skype/virtual-folder/skype/Lock-CsClientPin.md", "redirect_url": "/powershell/module/skypeforbusiness/lock-csclientpin", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Merge-CsLegacyTopology.md", + "source_path": "skype/virtual-folder/skype/Merge-CsLegacyTopology.md", "redirect_url": "/powershell/module/skypeforbusiness/merge-cslegacytopology", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsAnalogDevice.md", + "source_path": "skype/virtual-folder/skype/Move-CsAnalogDevice.md", "redirect_url": "/powershell/module/skypeforbusiness/move-csanalogdevice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsApplicationEndpoint.md", + "source_path": "skype/virtual-folder/skype/Move-CsApplicationEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/move-csapplicationendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsCommonAreaPhone.md", + "source_path": "skype/virtual-folder/skype/Move-CsCommonAreaPhone.md", "redirect_url": "/powershell/module/skypeforbusiness/move-cscommonareaphone", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsConferenceDirectory.md", + "source_path": "skype/virtual-folder/skype/Move-CsConferenceDirectory.md", "redirect_url": "/powershell/module/skypeforbusiness/move-csconferencedirectory", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsExUmContact.md", + "source_path": "skype/virtual-folder/skype/Move-CsExUmContact.md", "redirect_url": "/powershell/module/skypeforbusiness/move-csexumcontact", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsLegacyUser.md", + "source_path": "skype/virtual-folder/skype/Move-CsLegacyUser.md", "redirect_url": "/powershell/module/skypeforbusiness/move-cslegacyuser", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsManagementServer.md", + "source_path": "skype/virtual-folder/skype/Move-CsManagementServer.md", "redirect_url": "/powershell/module/skypeforbusiness/move-csmanagementserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsMeetingRoom.md", + "source_path": "skype/virtual-folder/skype/Move-CsMeetingRoom.md", "redirect_url": "/powershell/module/skypeforbusiness/move-csmeetingroom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsRgsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Move-CsRgsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/move-csrgsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md", + "source_path": "skype/virtual-folder/skype/Move-CsThirdPartyVideoSystem.md", "redirect_url": "/powershell/module/skypeforbusiness/move-csthirdpartyvideosystem", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Move-CsUser.md", + "source_path": "skype/virtual-folder/skype/Move-CsUser.md", "redirect_url": "/powershell/module/skypeforbusiness/move-csuser", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsAdditionalInternalDomain.md", + "source_path": "skype/virtual-folder/skype/New-CsAdditionalInternalDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csadditionalinternaldomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsAddressBookConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsAddressBookConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csaddressbookconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsAddressBookNormalizationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csaddressbooknormalizationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md", + "source_path": "skype/virtual-folder/skype/New-CsAddressBookNormalizationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csaddressbooknormalizationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsAdminRole.md", + "source_path": "skype/virtual-folder/skype/New-CsAdminRole.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csadminrole", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsAllowedDomain.md", + "source_path": "skype/virtual-folder/skype/New-CsAllowedDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csalloweddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsAnalogDevice.md", + "source_path": "skype/virtual-folder/skype/New-CsAnalogDevice.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csanalogdevice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsAnnouncement.md", + "source_path": "skype/virtual-folder/skype/New-CsAnnouncement.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csannouncement", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsArchivingConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsArchivingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csarchivingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsArchivingPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsArchivingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csarchivingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsAutodiscoverConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csautodiscoverconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsAVEdgeConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsAVEdgeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csavedgeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsBandwidthPolicyServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csbandwidthpolicyserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsBlockedDomain.md", + "source_path": "skype/virtual-folder/skype/New-CsBlockedDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csblockeddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsCallParkOrbit.md", + "source_path": "skype/virtual-folder/skype/New-CsCallParkOrbit.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cscallparkorbit", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsCallViaWorkPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsCallViaWorkPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cscallviaworkpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsCdrConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsCdrConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cscdrconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsClientPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsClientPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csclientpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsClientPolicyEntry.md", + "source_path": "skype/virtual-folder/skype/New-CsClientPolicyEntry.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csclientpolicyentry", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsClientVersionConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsClientVersionConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csclientversionconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsClientVersionPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsClientVersionPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csclientversionpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsClientVersionPolicyRule.md", + "source_path": "skype/virtual-folder/skype/New-CsClientVersionPolicyRule.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csclientversionpolicyrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsCloudCallDataConnectorConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cscloudcalldataconnectorconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsClsConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsClsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csclsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsClsProvider.md", + "source_path": "skype/virtual-folder/skype/New-CsClsProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csclsprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsClsRegion.md", + "source_path": "skype/virtual-folder/skype/New-CsClsRegion.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csclsregion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsClsScenario.md", + "source_path": "skype/virtual-folder/skype/New-CsClsScenario.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csclsscenario", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsClsSecurityGroup.md", + "source_path": "skype/virtual-folder/skype/New-CsClsSecurityGroup.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csclssecuritygroup", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsCommonAreaPhone.md", + "source_path": "skype/virtual-folder/skype/New-CsCommonAreaPhone.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cscommonareaphone", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsConferenceDirectory.md", + "source_path": "skype/virtual-folder/skype/New-CsConferenceDirectory.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csconferencedirectory", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsConferencingConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsConferencingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csconferencingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsConferencingPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsConferencingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csconferencingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsCpsConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsCpsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cscpsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsDeviceUpdateConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csdeviceupdateconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsDiagnosticConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsDiagnosticConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csdiagnosticconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsDiagnosticHeaderConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csdiagnosticheaderconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsDiagnosticsFilter.md", + "source_path": "skype/virtual-folder/skype/New-CsDiagnosticsFilter.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csdiagnosticsfilter", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md", + "source_path": "skype/virtual-folder/skype/New-CsDialInConferencingAccessNumber.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csdialinconferencingaccessnumber", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsDialInConferencingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csdialinconferencingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsDialInConferencingDtmfConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csdialinconferencingdtmfconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsDialPlan.md", + "source_path": "skype/virtual-folder/skype/New-CsDialPlan.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csdialplan", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsEmergencyNumber.md", + "source_path": "skype/virtual-folder/skype/New-CsEmergencyNumber.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csemergencynumber", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsExtendedTest.md", + "source_path": "skype/virtual-folder/skype/New-CsExtendedTest.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csextendedtest", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsExternalAccessPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsExternalAccessPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csexternalaccesspolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsExternalUserCommunicationPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csexternalusercommunicationpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsExUmContact.md", + "source_path": "skype/virtual-folder/skype/New-CsExUmContact.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csexumcontact", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsFileTransferFilterConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csfiletransferfilterconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsFIPSConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsFIPSConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csfipsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md", + "source_path": "skype/virtual-folder/skype/New-CsGroupPickupUserOrbit.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csgrouppickupuserorbit", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsHealthMonitoringConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cshealthmonitoringconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsHostedVoicemailPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cshostedvoicemailpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsHostingProvider.md", + "source_path": "skype/virtual-folder/skype/New-CsHostingProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cshostingprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md", + "source_path": "skype/virtual-folder/skype/New-CsHybridApplicationEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsHybridPSTNSite.md", + "source_path": "skype/virtual-folder/skype/New-CsHybridPSTNSite.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cshybridpstnsite", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsImConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsImConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csimconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsImFilterConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsImFilterConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csimfilterconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsImTranslationConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsImTranslationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csimtranslationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsIssuedCertId.md", + "source_path": "skype/virtual-folder/skype/New-CsIssuedCertId.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csissuedcertid", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsKerberosAccount.md", + "source_path": "skype/virtual-folder/skype/New-CsKerberosAccount.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cskerberosaccount", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsKerberosAccountAssignment.md", + "source_path": "skype/virtual-folder/skype/New-CsKerberosAccountAssignment.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cskerberosaccountassignment", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsLocationPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsLocationPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cslocationpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsMcxConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsMcxConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csmcxconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsMediaConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsMediaConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csmediaconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsMeetingConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsMeetingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csmeetingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsMobilityPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsMobilityPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csmobilitypolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md", + "source_path": "skype/virtual-folder/skype/New-CsNetworkBandwidthPolicyProfile.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkbandwidthpolicyprofile", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md", + "source_path": "skype/virtual-folder/skype/New-CsNetworkBWAlternatePath.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkbwalternatepath", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsNetworkBWPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsNetworkBWPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkbwpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md", + "source_path": "skype/virtual-folder/skype/New-CsNetworkInterRegionRoute.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkinterregionroute", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsNetworkInterSitePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkintersitepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsNetworkMediaBypassConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkmediabypassconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsNetworkRegion.md", + "source_path": "skype/virtual-folder/skype/New-CsNetworkRegion.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkregion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsNetworkRegionLink.md", + "source_path": "skype/virtual-folder/skype/New-CsNetworkRegionLink.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkregionlink", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsNetworkSite.md", + "source_path": "skype/virtual-folder/skype/New-CsNetworkSite.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworksite", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsNetworkSubnet.md", + "source_path": "skype/virtual-folder/skype/New-CsNetworkSubnet.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworksubnet", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsOAuthServer.md", + "source_path": "skype/virtual-folder/skype/New-CsOAuthServer.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csoauthserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md", + "source_path": "skype/virtual-folder/skype/New-CsOutboundCallingNumberTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csoutboundcallingnumbertranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsOutboundTranslationRule.md", + "source_path": "skype/virtual-folder/skype/New-CsOutboundTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csoutboundtranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPartnerApplication.md", + "source_path": "skype/virtual-folder/skype/New-CsPartnerApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspartnerapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPersistentChatAddin.md", + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatAddin.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchataddin", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPersistentChatCategory.md", + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatCategory.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatcategory", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatComplianceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatcomplianceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPersistentChatConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPersistentChatEndpoint.md", + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPersistentChatPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPersistentChatRoom.md", + "source_path": "skype/virtual-folder/skype/New-CsPersistentChatRoom.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatroom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPinPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsPinPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspinpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPlatformServiceSettings.md", + "source_path": "skype/virtual-folder/skype/New-CsPlatformServiceSettings.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csplatformservicesettings", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPresencePolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsPresencePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspresencepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPresenceProvider.md", + "source_path": "skype/virtual-folder/skype/New-CsPresenceProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspresenceprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPrivacyConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsPrivacyConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csprivacyconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsProxyConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsProxyConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csproxyconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPublicProvider.md", + "source_path": "skype/virtual-folder/skype/New-CsPublicProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspublicprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsPushNotificationConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsPushNotificationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cspushnotificationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsQoEConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsQoEConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csqoeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRegistrarConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsRegistrarConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csregistrarconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsReportingConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsReportingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csreportingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsAgentGroup.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsAgentGroup.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsagentgroup", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsAnswer.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsAnswer.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsanswer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsCallAction.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsCallAction.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgscallaction", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsHoliday.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsHoliday.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsholiday", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsHolidaySet.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsHolidaySet.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsholidayset", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsHoursOfBusiness.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgshoursofbusiness", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsPrompt.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsPrompt.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsprompt", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsQuestion.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsQuestion.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsquestion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsQueue.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsQueue.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsqueue", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsTimeRange.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsTimeRange.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgstimerange", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRgsWorkflow.md", + "source_path": "skype/virtual-folder/skype/New-CsRgsWorkflow.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsworkflow", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsRoutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsRoutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsServerApplication.md", + "source_path": "skype/virtual-folder/skype/New-CsServerApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csserverapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSimpleUrl.md", + "source_path": "skype/virtual-folder/skype/New-CsSimpleUrl.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssimpleurl", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsSimpleUrlConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssimpleurlconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSimpleUrlEntry.md", + "source_path": "skype/virtual-folder/skype/New-CsSimpleUrlEntry.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssimpleurlentry", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSipDomain.md", + "source_path": "skype/virtual-folder/skype/New-CsSipDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssipdomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSipProxyCustom.md", + "source_path": "skype/virtual-folder/skype/New-CsSipProxyCustom.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxycustom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSipProxyRealm.md", + "source_path": "skype/virtual-folder/skype/New-CsSipProxyRealm.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxyrealm", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSipProxyTCP.md", + "source_path": "skype/virtual-folder/skype/New-CsSipProxyTCP.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxytcp", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSipProxyTLS.md", + "source_path": "skype/virtual-folder/skype/New-CsSipProxyTLS.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxytls", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSipProxyTransport.md", + "source_path": "skype/virtual-folder/skype/New-CsSipProxyTransport.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxytransport", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSipProxyUseDefault.md", + "source_path": "skype/virtual-folder/skype/New-CsSipProxyUseDefault.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxyusedefault", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md", + "source_path": "skype/virtual-folder/skype/New-CsSipProxyUseDefaultCert.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxyusedefaultcert", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md", + "source_path": "skype/virtual-folder/skype/New-CsSipResponseCodeTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cssipresponsecodetranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsStaticRoute.md", + "source_path": "skype/virtual-folder/skype/New-CsStaticRoute.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csstaticroute", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsStaticRoutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csstaticroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsStorageServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsStorageServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csstorageserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsTeamsUpgradePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csteamsupgradepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsTelemetryConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsTelemetryConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cstelemetryconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md", + "source_path": "skype/virtual-folder/skype/New-CsTenantUpdateTimeWindow.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cstenantupdatetimewindow", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsTestDevice.md", + "source_path": "skype/virtual-folder/skype/New-CsTestDevice.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cstestdevice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md", + "source_path": "skype/virtual-folder/skype/New-CsThirdPartyVideoSystem.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csthirdpartyvideosystem", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsThirdPartyVideoSystemPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csthirdpartyvideosystempolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsTrunkConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsTrunkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cstrunkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsTrustedApplication.md", + "source_path": "skype/virtual-folder/skype/New-CsTrustedApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsTrustedApplicationComputer.md", + "source_path": "skype/virtual-folder/skype/New-CsTrustedApplicationComputer.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplicationcomputer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md", + "source_path": "skype/virtual-folder/skype/New-CsTrustedApplicationEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplicationendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsTrustedApplicationPool.md", + "source_path": "skype/virtual-folder/skype/New-CsTrustedApplicationPool.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplicationpool", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsUCPhoneConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsUCPhoneConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csucphoneconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsUnassignedNumber.md", + "source_path": "skype/virtual-folder/skype/New-CsUnassignedNumber.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csunassignednumber", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsUserReplicatorConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csuserreplicatorconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsUserServicesConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsUserServicesConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csuserservicesconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsUserServicesPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsUserServicesPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csuserservicespolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsVideoInteropServerConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csvideointeropserverconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csvideointeropserversynthetictransactionconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsVideoTrunkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csvideotrunkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsVoicemailReroutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicemailreroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsVoiceNormalizationRule.md", + "source_path": "skype/virtual-folder/skype/New-CsVoiceNormalizationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicenormalizationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsVoicePolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsVoicePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsVoiceRegex.md", + "source_path": "skype/virtual-folder/skype/New-CsVoiceRegex.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csvoiceregex", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsVoiceRoute.md", + "source_path": "skype/virtual-folder/skype/New-CsVoiceRoute.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csvoiceroute", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md", + "source_path": "skype/virtual-folder/skype/New-CsVoiceRoutingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csvoiceroutingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsVoiceTestConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsVoiceTestConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicetestconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsWatcherNodeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cswatchernodeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsWebLink.md", + "source_path": "skype/virtual-folder/skype/New-CsWebLink.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csweblink", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsWebOrigin.md", + "source_path": "skype/virtual-folder/skype/New-CsWebOrigin.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csweborigin", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsWebServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/New-CsWebServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cswebserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsWebTrustedCACertificate.md", + "source_path": "skype/virtual-folder/skype/New-CsWebTrustedCACertificate.md", "redirect_url": "/powershell/module/skypeforbusiness/new-cswebtrustedcacertificate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/New-CsXmppAllowedPartner.md", + "source_path": "skype/virtual-folder/skype/New-CsXmppAllowedPartner.md", "redirect_url": "/powershell/module/skypeforbusiness/new-csxmppallowedpartner", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Publish-CsLisConfiguration.md", + "source_path": "skype/virtual-folder/skype/Publish-CsLisConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/publish-cslisconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Publish-CsTopology.md", + "source_path": "skype/virtual-folder/skype/Publish-CsTopology.md", "redirect_url": "/powershell/module/skypeforbusiness/publish-cstopology", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md", + "source_path": "skype/virtual-folder/skype/Register-CsHybridPSTNAppliance.md", "redirect_url": "/powershell/module/skypeforbusiness/register-cshybridpstnappliance", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md", + "source_path": "skype/virtual-folder/skype/Remove-CsAdditionalInternalDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csadditionalinternaldomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsAddressBookConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csaddressbookconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsAddressBookNormalizationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csaddressbooknormalizationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md", + "source_path": "skype/virtual-folder/skype/Remove-CsAddressBookNormalizationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csaddressbooknormalizationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsAdminRole.md", + "source_path": "skype/virtual-folder/skype/Remove-CsAdminRole.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csadminrole", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsAllowedDomain.md", + "source_path": "skype/virtual-folder/skype/Remove-CsAllowedDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csalloweddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsAnalogDevice.md", + "source_path": "skype/virtual-folder/skype/Remove-CsAnalogDevice.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csanalogdevice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsAnnouncement.md", + "source_path": "skype/virtual-folder/skype/Remove-CsAnnouncement.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csannouncement", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsArchivingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsArchivingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csarchivingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsArchivingPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsArchivingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csarchivingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsAutodiscoverConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csautodiscoverconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsAVEdgeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csavedgeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsBackupServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csbackupserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsBandwidthPolicyServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csbandwidthpolicyserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsBlockedDomain.md", + "source_path": "skype/virtual-folder/skype/Remove-CsBlockedDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csblockeddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsBusyOptions.md", + "source_path": "skype/virtual-folder/skype/Remove-CsBusyOptions.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csbusyoptions", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsCallParkOrbit.md", + "source_path": "skype/virtual-folder/skype/Remove-CsCallParkOrbit.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cscallparkorbit", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsCallViaWorkPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cscallviaworkpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsCdrConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsCdrConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cscdrconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsCertificate.md", + "source_path": "skype/virtual-folder/skype/Remove-CsCertificate.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cscertificate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsClientPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsClientPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsClientVersionConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientversionconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsClientVersionPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsClientVersionPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientversionpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md", + "source_path": "skype/virtual-folder/skype/Remove-CsClientVersionPolicyRule.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientversionpolicyrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsClsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsClsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csclsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsClsRegion.md", + "source_path": "skype/virtual-folder/skype/Remove-CsClsRegion.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csclsregion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsClsScenario.md", + "source_path": "skype/virtual-folder/skype/Remove-CsClsScenario.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csclsscenario", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsClsSecurityGroup.md", + "source_path": "skype/virtual-folder/skype/Remove-CsClsSecurityGroup.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csclssecuritygroup", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsCommonAreaPhone.md", + "source_path": "skype/virtual-folder/skype/Remove-CsCommonAreaPhone.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cscommonareaphone", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsConferenceDirectory.md", + "source_path": "skype/virtual-folder/skype/Remove-CsConferenceDirectory.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencedirectory", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md", + "source_path": "skype/virtual-folder/skype/Remove-CsConferenceDisclaimer.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencedisclaimer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsConferencingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsConferencingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsConferencingPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsConferencingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md", + "source_path": "skype/virtual-folder/skype/Remove-CsConfigurationStoreLocation.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csconfigurationstorelocation", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsConversationHistoryConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csconversationhistoryconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsCpsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsCpsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cscpsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsDeviceUpdateConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csdeviceupdateconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md", + "source_path": "skype/virtual-folder/skype/Remove-CsDeviceUpdateRule.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csdeviceupdaterule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsDiagnosticConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csdiagnosticconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsDiagnosticHeaderConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csdiagnosticheaderconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md", + "source_path": "skype/virtual-folder/skype/Remove-CsDialInConferencingAccessNumber.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialinconferencingaccessnumber", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsDialInConferencingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialinconferencingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsDialInConferencingDtmfConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialinconferencingdtmfconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsDialPlan.md", + "source_path": "skype/virtual-folder/skype/Remove-CsDialPlan.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialplan", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md", + "source_path": "skype/virtual-folder/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csenhancedemergencyservicedisclaimer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsExternalAccessPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csexternalaccesspolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsExternalUserCommunicationPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csexternalusercommunicationpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsExUmContact.md", + "source_path": "skype/virtual-folder/skype/Remove-CsExUmContact.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csexumcontact", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsFileTransferFilterConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csfiletransferfilterconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsFIPSConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsFIPSConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csfipsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md", + "source_path": "skype/virtual-folder/skype/Remove-CsGroupPickupUserOrbit.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csgrouppickupuserorbit", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsHealthMonitoringConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cshealthmonitoringconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsHostedVoicemailPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cshostedvoicemailpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsHostingProvider.md", + "source_path": "skype/virtual-folder/skype/Remove-CsHostingProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cshostingprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md", + "source_path": "skype/virtual-folder/skype/Remove-CsHybridApplicationEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsHybridPSTNSite.md", + "source_path": "skype/virtual-folder/skype/Remove-CsHybridPSTNSite.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cshybridpstnsite", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsImConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsImConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csimconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsImFilterConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsImFilterConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csimfilterconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsImTranslationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csimtranslationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md", + "source_path": "skype/virtual-folder/skype/Remove-CsKerberosAccountAssignment.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cskerberosaccountassignment", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsLisLocation.md", + "source_path": "skype/virtual-folder/skype/Remove-CsLisLocation.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cslislocation", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsLisPort.md", + "source_path": "skype/virtual-folder/skype/Remove-CsLisPort.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cslisport", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsLisServiceProvider.md", + "source_path": "skype/virtual-folder/skype/Remove-CsLisServiceProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cslisserviceprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsLisSubnet.md", + "source_path": "skype/virtual-folder/skype/Remove-CsLisSubnet.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cslissubnet", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsLisSwitch.md", + "source_path": "skype/virtual-folder/skype/Remove-CsLisSwitch.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cslisswitch", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md", + "source_path": "skype/virtual-folder/skype/Remove-CsLisWirelessAccessPoint.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csliswirelessaccesspoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsLocationPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsLocationPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cslocationpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsManagementConnection.md", + "source_path": "skype/virtual-folder/skype/Remove-CsManagementConnection.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csmanagementconnection", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsMcxConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsMcxConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csmcxconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsMediaConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsMediaConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csmediaconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsMeetingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsMeetingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csmeetingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsMobilityPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsMobilityPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csmobilitypolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md", + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkBandwidthPolicyProfile.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkbandwidthpolicyprofile", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsNetworkConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md", + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkInterRegionRoute.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkinterregionroute", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkInterSitePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkintersitepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsNetworkRegion.md", + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkRegion.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkregion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsNetworkRegionLink.md", + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkRegionLink.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkregionlink", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsNetworkSite.md", + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkSite.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworksite", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsNetworkSubnet.md", + "source_path": "skype/virtual-folder/skype/Remove-CsNetworkSubnet.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworksubnet", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsOAuthServer.md", + "source_path": "skype/virtual-folder/skype/Remove-CsOAuthServer.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csoauthserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md", + "source_path": "skype/virtual-folder/skype/Remove-CsOutboundCallingNumberTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csoutboundcallingnumbertranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md", + "source_path": "skype/virtual-folder/skype/Remove-CsOutboundTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csoutboundtranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPartnerApplication.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPartnerApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspartnerapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatAddin.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatAddin.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchataddin", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatCategory.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatCategory.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatcategory", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatComplianceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatcomplianceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatMessage.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatMessage.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatmessage", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatRoom.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPersistentChatRoom.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatroom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPinPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPinPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspinpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPlatformServiceSettings.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csplatformservicesettings", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPresencePolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPresencePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspresencepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPresenceProvider.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPresenceProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspresenceprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPrivacyConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csprivacyconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsProxyConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsProxyConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csproxyconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPublicProvider.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPublicProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspublicprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsPushNotificationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cspushnotificationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsQoEConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsQoEConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csqoeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsRegistrarConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csregistrarconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsReportingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsReportingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csreportingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsRgsAgentGroup.md", + "source_path": "skype/virtual-folder/skype/Remove-CsRgsAgentGroup.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsagentgroup", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsRgsHolidaySet.md", + "source_path": "skype/virtual-folder/skype/Remove-CsRgsHolidaySet.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsholidayset", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md", + "source_path": "skype/virtual-folder/skype/Remove-CsRgsHoursOfBusiness.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgshoursofbusiness", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsRgsQueue.md", + "source_path": "skype/virtual-folder/skype/Remove-CsRgsQueue.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsqueue", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsRgsWorkflow.md", + "source_path": "skype/virtual-folder/skype/Remove-CsRgsWorkflow.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsworkflow", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsRoutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsRoutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsServerApplication.md", + "source_path": "skype/virtual-folder/skype/Remove-CsServerApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csserverapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsSimpleUrlConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cssimpleurlconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsSipDomain.md", + "source_path": "skype/virtual-folder/skype/Remove-CsSipDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cssipdomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md", + "source_path": "skype/virtual-folder/skype/Remove-CsSipResponseCodeTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cssipresponsecodetranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsSlaConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsSlaConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csslaconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsSlaDelegates.md", + "source_path": "skype/virtual-folder/skype/Remove-CsSlaDelegates.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cssladelegates", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsStaticRoutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csstaticroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsStorageServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csstorageserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsUpgradePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csteamsupgradepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsTelemetryConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cstelemetryconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md", + "source_path": "skype/virtual-folder/skype/Remove-CsTenantUpdateTimeWindow.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cstenantupdatetimewindow", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsTestDevice.md", + "source_path": "skype/virtual-folder/skype/Remove-CsTestDevice.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cstestdevice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsTestUserCredential.md", + "source_path": "skype/virtual-folder/skype/Remove-CsTestUserCredential.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cstestusercredential", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md", + "source_path": "skype/virtual-folder/skype/Remove-CsThirdPartyVideoSystem.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csthirdpartyvideosystem", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsThirdPartyVideoSystemPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csthirdpartyvideosystempolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsTrunkConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsTrunkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrunkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsTrustedApplication.md", + "source_path": "skype/virtual-folder/skype/Remove-CsTrustedApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md", + "source_path": "skype/virtual-folder/skype/Remove-CsTrustedApplicationComputer.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplicationcomputer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md", + "source_path": "skype/virtual-folder/skype/Remove-CsTrustedApplicationEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplicationendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md", + "source_path": "skype/virtual-folder/skype/Remove-CsTrustedApplicationPool.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplicationpool", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsUCPhoneConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csucphoneconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsUnassignedNumber.md", + "source_path": "skype/virtual-folder/skype/Remove-CsUnassignedNumber.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csunassignednumber", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsUserAcp.md", + "source_path": "skype/virtual-folder/skype/Remove-CsUserAcp.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csuseracp", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsUserReplicatorConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserreplicatorconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsUserServicesConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserservicesconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsUserServicesPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsUserServicesPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserservicespolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsUserStoreBackupData.md", + "source_path": "skype/virtual-folder/skype/Remove-CsUserStoreBackupData.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserstorebackupdata", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsVideoInteropServerConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csvideointeropserverconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csvideointeropserversynthetictransactionconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsVideoTrunkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csvideotrunkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsVoiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsVoiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoiceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsVoicemailReroutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicemailreroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md", + "source_path": "skype/virtual-folder/skype/Remove-CsVoiceNormalizationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicenormalizationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsVoicePolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsVoicePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsVoiceRoute.md", + "source_path": "skype/virtual-folder/skype/Remove-CsVoiceRoute.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoiceroute", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md", + "source_path": "skype/virtual-folder/skype/Remove-CsVoiceRoutingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoiceroutingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsVoiceTestConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicetestconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsWatcherNodeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cswatchernodeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Remove-CsWebServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-cswebserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md", + "source_path": "skype/virtual-folder/skype/Remove-CsXmppAllowedPartner.md", "redirect_url": "/powershell/module/skypeforbusiness/remove-csxmppallowedpartner", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Request-CsCertificate.md", + "source_path": "skype/virtual-folder/skype/Request-CsCertificate.md", "redirect_url": "/powershell/module/skypeforbusiness/request-cscertificate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md", + "source_path": "skype/virtual-folder/skype/Reset-CsDeviceUpdateRule.md", "redirect_url": "/powershell/module/skypeforbusiness/reset-csdeviceupdaterule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Reset-CsNotificationQueues.md", + "source_path": "skype/virtual-folder/skype/Reset-CsNotificationQueues.md", "redirect_url": "/powershell/module/skypeforbusiness/reset-csnotificationqueues", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Reset-CsPoolRegistrarState.md", + "source_path": "skype/virtual-folder/skype/Reset-CsPoolRegistrarState.md", "redirect_url": "/powershell/module/skypeforbusiness/reset-cspoolregistrarstate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Reset-CsRoutingGroup.md", + "source_path": "skype/virtual-folder/skype/Reset-CsRoutingGroup.md", "redirect_url": "/powershell/module/skypeforbusiness/reset-csroutinggroup", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md", + "source_path": "skype/virtual-folder/skype/Restore-CsDeviceUpdateRule.md", "redirect_url": "/powershell/module/skypeforbusiness/restore-csdeviceupdaterule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Revoke-CsClientCertificate.md", + "source_path": "skype/virtual-folder/skype/Revoke-CsClientCertificate.md", "redirect_url": "/powershell/module/skypeforbusiness/revoke-csclientcertificate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Revoke-CsOUPermission.md", + "source_path": "skype/virtual-folder/skype/Revoke-CsOUPermission.md", "redirect_url": "/powershell/module/skypeforbusiness/revoke-csoupermission", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Revoke-CsSetupPermission.md", + "source_path": "skype/virtual-folder/skype/Revoke-CsSetupPermission.md", "redirect_url": "/powershell/module/skypeforbusiness/revoke-cssetuppermission", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Search-CsClsLogging.md", + "source_path": "skype/virtual-folder/skype/Search-CsClsLogging.md", "redirect_url": "/powershell/module/skypeforbusiness/search-csclslogging", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsAccessEdgeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csaccessedgeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAddressBookConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsAddressBookConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csaddressbookconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsAddressBookNormalizationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csaddressbooknormalizationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md", + "source_path": "skype/virtual-folder/skype/Set-CsAddressBookNormalizationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csaddressbooknormalizationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAdminRole.md", + "source_path": "skype/virtual-folder/skype/Set-CsAdminRole.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csadminrole", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAllowedDomain.md", + "source_path": "skype/virtual-folder/skype/Set-CsAllowedDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csalloweddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAnalogDevice.md", + "source_path": "skype/virtual-folder/skype/Set-CsAnalogDevice.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csanalogdevice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAnnouncement.md", + "source_path": "skype/virtual-folder/skype/Set-CsAnnouncement.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csannouncement", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsApplicationServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsApplicationServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csapplicationserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsArchivingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsArchivingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csarchivingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsArchivingPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsArchivingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csarchivingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsArchivingServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsArchivingServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csarchivingserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md", + "source_path": "skype/virtual-folder/skype/Set-CsAudioTestServiceApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csaudiotestserviceapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAuthConfig.md", + "source_path": "skype/virtual-folder/skype/Set-CsAuthConfig.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csauthconfig", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsAutodiscoverConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csautodiscoverconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsAVEdgeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csavedgeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsBackupServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csbackupserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsBandwidthPolicyServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csbandwidthpolicyserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsBlockedDomain.md", + "source_path": "skype/virtual-folder/skype/Set-CsBlockedDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csblockeddomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsBroadcastMeetingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csbroadcastmeetingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsBusyOptions.md", + "source_path": "skype/virtual-folder/skype/Set-CsBusyOptions.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csbusyoptions", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCallParkOrbit.md", + "source_path": "skype/virtual-folder/skype/Set-CsCallParkOrbit.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscallparkorbit", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md", + "source_path": "skype/virtual-folder/skype/Set-CsCallParkServiceMusicOnHoldFile.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscallparkservicemusiconholdfile", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsCallViaWorkPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscallviaworkpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md", + "source_path": "skype/virtual-folder/skype/Set-CsCceApplianceConfigurationReplicationStatus.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscceapplianceconfigurationreplicationstatus", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md", + "source_path": "skype/virtual-folder/skype/Set-CsCceApplianceDeploymentStatus.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscceappliancedeploymentstatus", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCceApplianceStatus.md", + "source_path": "skype/virtual-folder/skype/Set-CsCceApplianceStatus.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscceappliancestatus", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCdrConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsCdrConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscdrconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCertificate.md", + "source_path": "skype/virtual-folder/skype/Set-CsCertificate.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscertificate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsClientPin.md", + "source_path": "skype/virtual-folder/skype/Set-CsClientPin.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csclientpin", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsClientPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsClientPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csclientpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsClientVersionConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsClientVersionConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csclientversionconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsClientVersionPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsClientVersionPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csclientversionpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md", + "source_path": "skype/virtual-folder/skype/Set-CsClientVersionPolicyRule.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csclientversionpolicyrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCloudCallDataConnector.md", + "source_path": "skype/virtual-folder/skype/Set-CsCloudCallDataConnector.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscloudcalldataconnector", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsCloudCallDataConnectorConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscloudcalldataconnectorconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsClsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsClsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csclsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsClsRegion.md", + "source_path": "skype/virtual-folder/skype/Set-CsClsRegion.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csclsregion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsClsScenario.md", + "source_path": "skype/virtual-folder/skype/Set-CsClsScenario.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csclsscenario", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsClsSearchTerm.md", + "source_path": "skype/virtual-folder/skype/Set-CsClsSearchTerm.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csclssearchterm", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsClsSecurityGroup.md", + "source_path": "skype/virtual-folder/skype/Set-CsClsSecurityGroup.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csclssecuritygroup", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCommonAreaPhone.md", + "source_path": "skype/virtual-folder/skype/Set-CsCommonAreaPhone.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscommonareaphone", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsConferenceDisclaimer.md", + "source_path": "skype/virtual-folder/skype/Set-CsConferenceDisclaimer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csconferencedisclaimer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsConferenceServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsConferenceServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csconferenceserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsConferencingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsConferencingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csconferencingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsConferencingPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsConferencingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csconferencingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md", + "source_path": "skype/virtual-folder/skype/Set-CsConfigurationStoreLocation.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csconfigurationstorelocation", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsConversationHistoryConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csconversationhistoryconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsCpsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsCpsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cscpsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsDeviceUpdateConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csdeviceupdateconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsDiagnosticConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csdiagnosticconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsDiagnosticHeaderConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csdiagnosticheaderconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md", + "source_path": "skype/virtual-folder/skype/Set-CsDialInConferencingAccessNumber.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csdialinconferencingaccessnumber", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsDialInConferencingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csdialinconferencingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsDialInConferencingDtmfConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csdialinconferencingdtmfconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsDialPlan.md", + "source_path": "skype/virtual-folder/skype/Set-CsDialPlan.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csdialplan", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsDirector.md", + "source_path": "skype/virtual-folder/skype/Set-CsDirector.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csdirector", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsEdgeServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsEdgeServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csedgeserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md", + "source_path": "skype/virtual-folder/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csenhancedemergencyservicedisclaimer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsExternalAccessPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsExternalAccessPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csexternalaccesspolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsExternalUserCommunicationPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csexternalusercommunicationpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsExUmContact.md", + "source_path": "skype/virtual-folder/skype/Set-CsExUmContact.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csexumcontact", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsFileTransferFilterConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csfiletransferfilterconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsFIPSConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsFIPSConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csfipsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md", + "source_path": "skype/virtual-folder/skype/Set-CsGroupPickupUserOrbit.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csgrouppickupuserorbit", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsHealthMonitoringConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cshealthmonitoringconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsHostedVoicemailPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cshostedvoicemailpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsHostingProvider.md", + "source_path": "skype/virtual-folder/skype/Set-CsHostingProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cshostingprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md", + "source_path": "skype/virtual-folder/skype/Set-CsHybridApplicationEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsHybridMediationServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsHybridMediationServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridmediationserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md", + "source_path": "skype/virtual-folder/skype/Set-CsHybridPSTNAppliance.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridpstnappliance", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsHybridPSTNSite.md", + "source_path": "skype/virtual-folder/skype/Set-CsHybridPSTNSite.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridpstnsite", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsImConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsImConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csimconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsImFilterConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsImFilterConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csimfilterconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsImTranslationConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsImTranslationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csimtranslationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsIPPhonePolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsIPPhonePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csipphonepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md", + "source_path": "skype/virtual-folder/skype/Set-CsKerberosAccountAssignment.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cskerberosaccountassignment", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsKerberosAccountPassword.md", + "source_path": "skype/virtual-folder/skype/Set-CsKerberosAccountPassword.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cskerberosaccountpassword", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsLisLocation.md", + "source_path": "skype/virtual-folder/skype/Set-CsLisLocation.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cslislocation", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsLisPort.md", + "source_path": "skype/virtual-folder/skype/Set-CsLisPort.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cslisport", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsLisServiceProvider.md", + "source_path": "skype/virtual-folder/skype/Set-CsLisServiceProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cslisserviceprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsLisSubnet.md", + "source_path": "skype/virtual-folder/skype/Set-CsLisSubnet.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cslissubnet", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsLisSwitch.md", + "source_path": "skype/virtual-folder/skype/Set-CsLisSwitch.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cslisswitch", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md", + "source_path": "skype/virtual-folder/skype/Set-CsLisWirelessAccessPoint.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csliswirelessaccesspoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsLocationPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsLocationPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cslocationpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsManagementConnection.md", + "source_path": "skype/virtual-folder/skype/Set-CsManagementConnection.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csmanagementconnection", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsManagementServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsManagementServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csmanagementserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsMcxConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsMcxConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csmcxconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsMediaConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsMediaConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csmediaconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsMediationServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsMediationServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csmediationserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsMeetingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsMeetingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csmeetingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsMeetingRoom.md", + "source_path": "skype/virtual-folder/skype/Set-CsMeetingRoom.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csmeetingroom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsMobilityPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsMobilityPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csmobilitypolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsMonitoringServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsMonitoringServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csmonitoringserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md", + "source_path": "skype/virtual-folder/skype/Set-CsNetworkBandwidthPolicyProfile.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkbandwidthpolicyprofile", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsNetworkConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsNetworkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md", + "source_path": "skype/virtual-folder/skype/Set-CsNetworkInterRegionRoute.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkinterregionroute", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsNetworkInterSitePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkintersitepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsNetworkRegion.md", + "source_path": "skype/virtual-folder/skype/Set-CsNetworkRegion.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkregion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsNetworkRegionLink.md", + "source_path": "skype/virtual-folder/skype/Set-CsNetworkRegionLink.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkregionlink", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsNetworkSite.md", + "source_path": "skype/virtual-folder/skype/Set-CsNetworkSite.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworksite", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsNetworkSubnet.md", + "source_path": "skype/virtual-folder/skype/Set-CsNetworkSubnet.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworksubnet", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsOAuthConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsOAuthConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csoauthconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsOAuthServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsOAuthServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csoauthserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md", + "source_path": "skype/virtual-folder/skype/Set-CsOutboundCallingNumberTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csoutboundcallingnumbertranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsOutboundTranslationRule.md", + "source_path": "skype/virtual-folder/skype/Set-CsOutboundTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csoutboundtranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPartnerApplication.md", + "source_path": "skype/virtual-folder/skype/Set-CsPartnerApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspartnerapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatActiveServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatactiveserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPersistentChatAddin.md", + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatAddin.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchataddin", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPersistentChatCategory.md", + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatCategory.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatcategory", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatComplianceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatcomplianceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPersistentChatPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPersistentChatRoom.md", + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatRoom.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatroom", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPersistentChatState.md", + "source_path": "skype/virtual-folder/skype/Set-CsPersistentChatState.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatstate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPinPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsPinPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspinpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPlatformServiceSettings.md", + "source_path": "skype/virtual-folder/skype/Set-CsPlatformServiceSettings.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csplatformservicesettings", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPresenceManagementState.md", + "source_path": "skype/virtual-folder/skype/Set-CsPresenceManagementState.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspresencemanagementstate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPresencePolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsPresencePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspresencepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPresenceProvider.md", + "source_path": "skype/virtual-folder/skype/Set-CsPresenceProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspresenceprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPrivacyConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsPrivacyConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csprivacyconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsProxyConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsProxyConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csproxyconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPstnGateway.md", + "source_path": "skype/virtual-folder/skype/Set-CsPstnGateway.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspstngateway", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPstnUsage.md", + "source_path": "skype/virtual-folder/skype/Set-CsPstnUsage.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspstnusage", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPublicProvider.md", + "source_path": "skype/virtual-folder/skype/Set-CsPublicProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspublicprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsPushNotificationConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsQoEConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsQoEConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csqoeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsRegistrar.md", + "source_path": "skype/virtual-folder/skype/Set-CsRegistrar.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csregistrar", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsRegistrarConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsRegistrarConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csregistrarconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsReportingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsReportingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csreportingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsRgsAgentGroup.md", + "source_path": "skype/virtual-folder/skype/Set-CsRgsAgentGroup.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsagentgroup", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsRgsConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsRgsConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsRgsHolidaySet.md", + "source_path": "skype/virtual-folder/skype/Set-CsRgsHolidaySet.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsholidayset", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md", + "source_path": "skype/virtual-folder/skype/Set-CsRgsHoursOfBusiness.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csrgshoursofbusiness", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsRgsQueue.md", + "source_path": "skype/virtual-folder/skype/Set-CsRgsQueue.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsqueue", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsRgsWorkflow.md", + "source_path": "skype/virtual-folder/skype/Set-CsRgsWorkflow.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsworkflow", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsRoutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsRoutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsServerApplication.md", + "source_path": "skype/virtual-folder/skype/Set-CsServerApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csserverapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsSimpleUrlConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cssimpleurlconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsSipDomain.md", + "source_path": "skype/virtual-folder/skype/Set-CsSipDomain.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cssipdomain", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md", + "source_path": "skype/virtual-folder/skype/Set-CsSipResponseCodeTranslationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cssipresponsecodetranslationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsSite.md", + "source_path": "skype/virtual-folder/skype/Set-CsSite.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cssite", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsSlaConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsSlaConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csslaconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsStaticRoutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csstaticroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsStorageServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csstorageserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsTeamsUpgradeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csteamsupgradeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsTeamsUpgradePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csteamsupgradepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTelemetryConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsTelemetryConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cstelemetryconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsTenantHybridConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cstenanthybridconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md", + "source_path": "skype/virtual-folder/skype/Set-CsTenantUpdateTimeWindow.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cstenantupdatetimewindow", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTestDevice.md", + "source_path": "skype/virtual-folder/skype/Set-CsTestDevice.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cstestdevice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTestUserCredential.md", + "source_path": "skype/virtual-folder/skype/Set-CsTestUserCredential.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cstestusercredential", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md", + "source_path": "skype/virtual-folder/skype/Set-CsThirdPartyVideoSystem.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csthirdpartyvideosystem", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsThirdPartyVideoSystemPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csthirdpartyvideosystempolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTrunkConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsTrunkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cstrunkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTrustedApplication.md", + "source_path": "skype/virtual-folder/skype/Set-CsTrustedApplication.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cstrustedapplication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md", + "source_path": "skype/virtual-folder/skype/Set-CsTrustedApplicationEndpoint.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cstrustedapplicationendpoint", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsTrustedApplicationPool.md", + "source_path": "skype/virtual-folder/skype/Set-CsTrustedApplicationPool.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cstrustedapplicationpool", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsUCPhoneConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csucphoneconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUICulture.md", + "source_path": "skype/virtual-folder/skype/Set-CsUICulture.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuiculture", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUnassignedNumber.md", + "source_path": "skype/virtual-folder/skype/Set-CsUnassignedNumber.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csunassignednumber", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUser.md", + "source_path": "skype/virtual-folder/skype/Set-CsUser.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuser", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUserAcp.md", + "source_path": "skype/virtual-folder/skype/Set-CsUserAcp.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuseracp", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md", + "source_path": "skype/virtual-folder/skype/Set-CsUserCallForwardingSettings.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csusercallforwardingsettings", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUserDatabaseState.md", + "source_path": "skype/virtual-folder/skype/Set-CsUserDatabaseState.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuserdatabasestate", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUserDelegates.md", + "source_path": "skype/virtual-folder/skype/Set-CsUserDelegates.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuserdelegates", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUserPstnSettings.md", + "source_path": "skype/virtual-folder/skype/Set-CsUserPstnSettings.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuserpstnsettings", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsUserReplicatorConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuserreplicatorconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUserServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsUserServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuserserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUserServicesConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsUserServicesConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuserservicesconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUserServicesPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsUserServicesPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuserservicespolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsUserTeamMembers.md", + "source_path": "skype/virtual-folder/skype/Set-CsUserTeamMembers.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csuserteammembers", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVideoGateway.md", + "source_path": "skype/virtual-folder/skype/Set-CsVideoGateway.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvideogateway", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVideoInteropServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvideointeropserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServerConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvideointeropserverconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvideointeropserversynthetictransactionconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsVideoTrunkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvideotrunkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVoiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsVoiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvoiceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsVoicemailReroutingConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicemailreroutingconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md", + "source_path": "skype/virtual-folder/skype/Set-CsVoiceNormalizationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicenormalizationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVoicePolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsVoicePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVoiceRoute.md", + "source_path": "skype/virtual-folder/skype/Set-CsVoiceRoute.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvoiceroute", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md", + "source_path": "skype/virtual-folder/skype/Set-CsVoiceRoutingPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvoiceroutingpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsVoiceTestConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicetestconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsWatcherNodeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cswatchernodeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsWebServer.md", + "source_path": "skype/virtual-folder/skype/Set-CsWebServer.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cswebserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsWebServiceConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsWebServiceConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-cswebserviceconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsXmppAllowedPartner.md", + "source_path": "skype/virtual-folder/skype/Set-CsXmppAllowedPartner.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csxmppallowedpartner", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md", + "source_path": "skype/virtual-folder/skype/Set-CsXmppGatewayConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/set-csxmppgatewayconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Show-CsClsLogging.md", + "source_path": "skype/virtual-folder/skype/Show-CsClsLogging.md", "redirect_url": "/powershell/module/skypeforbusiness/show-csclslogging", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/skype.md", - "redirect_url": "/powershell/module/skypeforbusiness/skypeforbusiness", + "source_path": "skype/virtual-folder/skype/skype.md", + "redirect_url": "/powershell/module/skypeforbusiness/", "redirect_document_id": false }, { - "source_path": "skype/skype-ps/skype/Start-CsClsLogging.md", + "source_path": "skype/virtual-folder/skype/index.md", + "redirect_url": "/powershell/module/skypeforbusiness/", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Start-CsClsLogging.md", "redirect_url": "/powershell/module/skypeforbusiness/start-csclslogging", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Start-CsPool.md", + "source_path": "skype/virtual-folder/skype/Start-CsPool.md", "redirect_url": "/powershell/module/skypeforbusiness/start-cspool", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Start-CsWindowsService.md", + "source_path": "skype/virtual-folder/skype/Start-CsWindowsService.md", "redirect_url": "/powershell/module/skypeforbusiness/start-cswindowsservice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Stop-CsClsLogging.md", + "source_path": "skype/virtual-folder/skype/Stop-CsClsLogging.md", "redirect_url": "/powershell/module/skypeforbusiness/stop-csclslogging", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Stop-CsWindowsService.md", + "source_path": "skype/virtual-folder/skype/Stop-CsWindowsService.md", "redirect_url": "/powershell/module/skypeforbusiness/stop-cswindowsservice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Sync-CsClsLogging.md", + "source_path": "skype/virtual-folder/skype/Sync-CsClsLogging.md", "redirect_url": "/powershell/module/skypeforbusiness/sync-csclslogging", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Sync-CsUserData.md", + "source_path": "skype/virtual-folder/skype/Sync-CsUserData.md", "redirect_url": "/powershell/module/skypeforbusiness/sync-csuserdata", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsAddressBookService.md", + "source_path": "skype/virtual-folder/skype/Test-CsAddressBookService.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csaddressbookservice", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsAddressBookWebQuery.md", + "source_path": "skype/virtual-folder/skype/Test-CsAddressBookWebQuery.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csaddressbookwebquery", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsASConference.md", + "source_path": "skype/virtual-folder/skype/Test-CsASConference.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csasconference", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsAudioConferencingProvider.md", + "source_path": "skype/virtual-folder/skype/Test-CsAudioConferencingProvider.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csaudioconferencingprovider", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsAVConference.md", + "source_path": "skype/virtual-folder/skype/Test-CsAVConference.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csavconference", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md", + "source_path": "skype/virtual-folder/skype/Test-CsAVEdgeConnectivity.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csavedgeconnectivity", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsCertificateConfiguration.md", + "source_path": "skype/virtual-folder/skype/Test-CsCertificateConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cscertificateconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsClientAuth.md", + "source_path": "skype/virtual-folder/skype/Test-CsClientAuth.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csclientauth", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsClientAuthentication.md", + "source_path": "skype/virtual-folder/skype/Test-CsClientAuthentication.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csclientauthentication", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsComputer.md", + "source_path": "skype/virtual-folder/skype/Test-CsComputer.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cscomputer", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsDatabase.md", + "source_path": "skype/virtual-folder/skype/Test-CsDatabase.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csdatabase", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsDataConference.md", + "source_path": "skype/virtual-folder/skype/Test-CsDataConference.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csdataconference", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsDialInConferencing.md", + "source_path": "skype/virtual-folder/skype/Test-CsDialInConferencing.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csdialinconferencing", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsDialPlan.md", + "source_path": "skype/virtual-folder/skype/Test-CsDialPlan.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csdialplan", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsExStorageConnectivity.md", + "source_path": "skype/virtual-folder/skype/Test-CsExStorageConnectivity.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csexstorageconnectivity", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsExStorageNotification.md", + "source_path": "skype/virtual-folder/skype/Test-CsExStorageNotification.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csexstoragenotification", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsExUMConnectivity.md", + "source_path": "skype/virtual-folder/skype/Test-CsExUMConnectivity.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csexumconnectivity", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsExUMVoiceMail.md", + "source_path": "skype/virtual-folder/skype/Test-CsExUMVoiceMail.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csexumvoicemail", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsFederatedPartner.md", + "source_path": "skype/virtual-folder/skype/Test-CsFederatedPartner.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csfederatedpartner", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsGroupExpansion.md", + "source_path": "skype/virtual-folder/skype/Test-CsGroupExpansion.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csgroupexpansion", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsGroupIM.md", + "source_path": "skype/virtual-folder/skype/Test-CsGroupIM.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csgroupim", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsIM.md", + "source_path": "skype/virtual-folder/skype/Test-CsIM.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csim", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsInterTrunkRouting.md", + "source_path": "skype/virtual-folder/skype/Test-CsInterTrunkRouting.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csintertrunkrouting", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md", + "source_path": "skype/virtual-folder/skype/Test-CsKerberosAccountAssignment.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cskerberosaccountassignment", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsLisCivicAddress.md", + "source_path": "skype/virtual-folder/skype/Test-CsLisCivicAddress.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csliscivicaddress", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsLisConfiguration.md", + "source_path": "skype/virtual-folder/skype/Test-CsLisConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cslisconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsLocationPolicy.md", + "source_path": "skype/virtual-folder/skype/Test-CsLocationPolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cslocationpolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsManagementServer.md", + "source_path": "skype/virtual-folder/skype/Test-CsManagementServer.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csmanagementserver", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsMcxConference.md", + "source_path": "skype/virtual-folder/skype/Test-CsMcxConference.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csmcxconference", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsMcxP2PIM.md", + "source_path": "skype/virtual-folder/skype/Test-CsMcxP2PIM.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csmcxp2pim", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsMcxPushNotification.md", + "source_path": "skype/virtual-folder/skype/Test-CsMcxPushNotification.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csmcxpushnotification", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsOUPermission.md", + "source_path": "skype/virtual-folder/skype/Test-CsOUPermission.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csoupermission", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsP2PAV.md", + "source_path": "skype/virtual-folder/skype/Test-CsP2PAV.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csp2pav", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md", + "source_path": "skype/virtual-folder/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csp2pvideointeropserversiptrunkav", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsPersistentChatMessage.md", + "source_path": "skype/virtual-folder/skype/Test-CsPersistentChatMessage.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cspersistentchatmessage", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsPhoneBootstrap.md", + "source_path": "skype/virtual-folder/skype/Test-CsPhoneBootstrap.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csphonebootstrap", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsPresence.md", + "source_path": "skype/virtual-folder/skype/Test-CsPresence.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cspresence", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsPstnOutboundCall.md", + "source_path": "skype/virtual-folder/skype/Test-CsPstnOutboundCall.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cspstnoutboundcall", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md", + "source_path": "skype/virtual-folder/skype/Test-CsPstnPeerToPeerCall.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cspstnpeertopeercall", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsRegistration.md", + "source_path": "skype/virtual-folder/skype/Test-CsRegistration.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csregistration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsReplica.md", + "source_path": "skype/virtual-folder/skype/Test-CsReplica.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csreplica", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsSetupPermission.md", + "source_path": "skype/virtual-folder/skype/Test-CsSetupPermission.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cssetuppermission", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsTopology.md", + "source_path": "skype/virtual-folder/skype/Test-CsTopology.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cstopology", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsTrunkConfiguration.md", + "source_path": "skype/virtual-folder/skype/Test-CsTrunkConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cstrunkconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsUcwaConference.md", + "source_path": "skype/virtual-folder/skype/Test-CsUcwaConference.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csucwaconference", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsUnifiedContactStore.md", + "source_path": "skype/virtual-folder/skype/Test-CsUnifiedContactStore.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csunifiedcontactstore", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md", + "source_path": "skype/virtual-folder/skype/Test-CsVoiceNormalizationRule.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csvoicenormalizationrule", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsVoicePolicy.md", + "source_path": "skype/virtual-folder/skype/Test-CsVoicePolicy.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csvoicepolicy", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsVoiceRoute.md", + "source_path": "skype/virtual-folder/skype/Test-CsVoiceRoute.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csvoiceroute", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md", + "source_path": "skype/virtual-folder/skype/Test-CsVoiceTestConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csvoicetestconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsVoiceUser.md", + "source_path": "skype/virtual-folder/skype/Test-CsVoiceUser.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csvoiceuser", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md", + "source_path": "skype/virtual-folder/skype/Test-CsWatcherNodeConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cswatchernodeconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsWebApp.md", + "source_path": "skype/virtual-folder/skype/Test-CsWebApp.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cswebapp", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsWebAppAnonymous.md", + "source_path": "skype/virtual-folder/skype/Test-CsWebAppAnonymous.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cswebappanonymous", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsWebScheduler.md", + "source_path": "skype/virtual-folder/skype/Test-CsWebScheduler.md", "redirect_url": "/powershell/module/skypeforbusiness/test-cswebscheduler", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Test-CsXmppIM.md", + "source_path": "skype/virtual-folder/skype/Test-CsXmppIM.md", "redirect_url": "/powershell/module/skypeforbusiness/test-csxmppim", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Uninstall-CsDatabase.md", + "source_path": "skype/virtual-folder/skype/Uninstall-CsDatabase.md", "redirect_url": "/powershell/module/skypeforbusiness/uninstall-csdatabase", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md", + "source_path": "skype/virtual-folder/skype/Uninstall-CsMirrorDatabase.md", "redirect_url": "/powershell/module/skypeforbusiness/uninstall-csmirrordatabase", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Unlock-CsClientPin.md", + "source_path": "skype/virtual-folder/skype/Unlock-CsClientPin.md", "redirect_url": "/powershell/module/skypeforbusiness/unlock-csclientpin", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Unpublish-CsLisConfiguration.md", + "source_path": "skype/virtual-folder/skype/Unpublish-CsLisConfiguration.md", "redirect_url": "/powershell/module/skypeforbusiness/unpublish-cslisconfiguration", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md", + "source_path": "skype/virtual-folder/skype/Unregister-CsHybridPSTNAppliance.md", "redirect_url": "/powershell/module/skypeforbusiness/unregister-cshybridpstnappliance", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Update-CsAddressBook.md", + "source_path": "skype/virtual-folder/skype/Update-CsAddressBook.md", "redirect_url": "/powershell/module/skypeforbusiness/update-csaddressbook", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Update-CsAdminRole.md", + "source_path": "skype/virtual-folder/skype/Update-CsAdminRole.md", "redirect_url": "/powershell/module/skypeforbusiness/update-csadminrole", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Update-CsClsLogging.md", + "source_path": "skype/virtual-folder/skype/Update-CsClsLogging.md", "redirect_url": "/powershell/module/skypeforbusiness/update-csclslogging", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Update-CsTenantMeetingUrl.md", + "source_path": "skype/virtual-folder/skype/Update-CsTenantMeetingUrl.md", "redirect_url": "/powershell/module/skypeforbusiness/update-cstenantmeetingurl", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Update-CsUserData.md", + "source_path": "skype/virtual-folder/skype/Update-CsUserData.md", "redirect_url": "/powershell/module/skypeforbusiness/update-csuserdata", - "redirect_document_id": false + "redirect_document_id": true }, { - "source_path": "skype/skype-ps/skype/Update-CsUserDatabase.md", + "source_path": "skype/virtual-folder/skype/Update-CsUserDatabase.md", "redirect_url": "/powershell/module/skypeforbusiness/update-csuserdatabase", - "redirect_document_id": false + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Add-CsSlaDelegates.md", + "redirect_url": "/powershell/module/skypeforbusiness/add-cssladelegates", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Approve-CsDeviceUpdateRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/approve-csdeviceupdaterule", + "redirect_document_id": true + }, + { + "source_path": "skype/virtual-folder/skype/Backup-CsPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/backup-cspool", + "redirect_document_id": true } ] } diff --git a/.openpublishing.redirection.teams.json b/.openpublishing.redirection.teams.json index ca0a088c34..7cc7ac6b8b 100644 --- a/.openpublishing.redirection.teams.json +++ b/.openpublishing.redirection.teams.json @@ -1,9 +1,3019 @@ { "redirections": [ + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/", + "redirect_document_id": false + }, { "source_path": "teams/docs-conceptual/intro.md", - "redirect_url": "/powershell/teams", + "redirect_url": "/powershell/module/microsoftteams/", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Add-TeamChannelUser.md", + "redirect_url": "/powershell/module/microsoftteams/add-teamchanneluser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Add-TeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/add-teamuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Clear-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Clear-TeamsEnvironmentConfig.md", + "redirect_url": "/powershell/module/microsoftteams/clear-teamsenvironmentconfig", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Complete-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Connect-MicrosoftTeams.md", + "redirect_url": "/powershell/module/microsoftteams/connect-microsoftteams", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Disable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/microsoftteams/disable-csonlinesipdomain", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Disconnect-MicrosoftTeams.md", + "redirect_url": "/powershell/module/microsoftteams/disconnect-microsoftteams", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Enable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/microsoftteams/enable-csonlinesipdomain", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Export-CsAcquiredPhoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/export-csacquiredphonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Export-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/microsoftteams/export-csautoattendantholidays", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Find-CsGroup.md", + "redirect_url": "/powershell/module/microsoftteams/find-csgroup", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Find-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/find-csonlineapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-ALLM365TeamsApps.md", + "redirect_url": "/powershell/module/microsoftteams/get-allm365teamsapps", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-AssociatedTeam.md", + "redirect_url": "/powershell/module/microsoftteams/get-associatedteam", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csapplicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csapplicationmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantholidays", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendantStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantstatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendantSupportedLanguage.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendantSupportedTimeZone.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsAutoAttendantTenantInformation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendanttenantinformation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsBatchPolicyAssignmentOperation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csbatchpolicyassignmentoperation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsBatchTeamsDeploymentStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csbatchteamsdeploymentstatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscallqueue", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscallinglineidentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsCloudCallDataConnection.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscloudcalldataconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/get-cseffectivetenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsExportAcquiredPhoneNumberStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csgrouppolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsHybridTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/get-cshybridtelephonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/get-csinboundblockednumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/get-csinboundexemptnumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsMeetingMigrationStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csmeetingmigrationstatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineaudiofile", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingbridge", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencinglanguagessupported", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingservicenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencinguser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialoutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialinConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineDirectoryTenant.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedirectorytenant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineenhancedemergencyservicedisclaimer", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineliscivicaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelislocation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelisport", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelissubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelisswitch", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineliswirelessaccesspoint", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinepstngateway", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinepstnusage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineschedule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinesipdomain", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineTelephoneNumberCountry.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumberorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineTelephoneNumberType.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumbertype", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoiceroute", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoiceuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoicemailusersettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsPhoneNumberAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csphonenumberassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/get-csphonenumbertag", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/get-cspolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsSdgBulkSignInRequestStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-cssdgbulksigninrequeststatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsSdgBulkSignInRequestsSummary.md", + "redirect_url": "/powershell/module/microsoftteams/get-cssdgbulksigninrequestssummary", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/get-cssharedcallqueuehistorytemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamtemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamTemplateList.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamtemplatelist", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsaipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsAcsFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsacsfederationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsapppermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsappsetuppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscallholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscallparkpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamschannelspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsclientconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscortanapolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscustombannertext", "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamseducationassignmentsapppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEducationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamseducationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamseventspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsExternalAccessConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsexternalaccessconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsfeedbackpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsfilespolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsfirstpartymeetingtemplateconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsguestcallingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsguestmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsguestmessagingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMediaLoggingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmedialoggingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingbroadcastconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingbroadcastpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingTemplateConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingtemplateconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmessagingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmultitenantorganizationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsnetworkroamingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsNotificationAndFeedsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsnotificationandfeedspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsrecordingrolloutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsSettingsCustomApp.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssettingscustomapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsapppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionConnector.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionconnector", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionErrorReport.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionerrorreport", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionOperation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionoperation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionSyncResult.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionsyncresult", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionteammap", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionWfmTeam.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmteam", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsConnectionWfmUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsSipDevicesConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssipdevicesconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssurvivablebranchappliance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsTargetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamstargetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamstranslationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsupdatemanagementpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsUpgradeConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsupgradeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsupgradepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvdipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvideointeropservicepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsworkloadpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenant.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantfederationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantLicensingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantlicensingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantmigrationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantNetworkConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworkconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworksite", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenanttrustedipaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsUserCallingSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-csusercallingsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsUserPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csuserpolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsUserPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/get-csuserpolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsUserPolicyPackageRecommendation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/get-csvideointeropserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-M365TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/get-m365teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-M365UnifiedCustomPendingApps.md", + "redirect_url": "/powershell/module/microsoftteams/get-m365unifiedcustompendingapps", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-M365UnifiedTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-m365unifiedtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-SharedWithTeam.md", + "redirect_url": "/powershell/module/microsoftteams/get-sharedwithteam", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-SharedWithTeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-sharedwithteamuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-Team.md", + "redirect_url": "/powershell/module/microsoftteams/get-team", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamAllChannel.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamallchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamChannelUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamchanneluser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamIncomingChannel.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamincomingchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamTargetingHierarchyStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamtargetinghierarchystatus", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csapplicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/grant-cscallinglineidentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsDialoutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csdialoutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsGroupPolicyPackageAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csgrouppolicypackageassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsaipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsapppermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsappsetuppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscallholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscallparkpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamschannelspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscortanapolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamseventspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsfeedbackpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsfilespolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmediaconnectivitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMediaLoggingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmedialoggingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingbroadcastpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmessagingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsrecordingrolloutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsshiftspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsupdatemanagementpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsupgradepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvdipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvideointeropservicepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsworkloadpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/grant-cstenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsUserPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csuserpolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Import-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/microsoftteams/import-csautoattendantholidays", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Import-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/microsoftteams/import-csonlineaudiofile", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csapplicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantCallFlow.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantcallflow", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantCallHandlingAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantCallableEntity.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantcallableentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantDialScope.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantdialscope", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantMenu.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantmenu", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantMenuOption.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantmenuoption", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsAutoAttendantPrompt.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantprompt", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsBatchPolicyAssignmentOperation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csbatchpolicyassignmentoperation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsBatchPolicyPackageAssignmentOperation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csbatchpolicypackageassignmentoperation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsBatchTeamsDeployment.md", + "redirect_url": "/powershell/module/microsoftteams/new-csbatchteamsdeployment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscallqueue", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscallinglineidentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsCloudCallDataConnection.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscloudcalldataconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsCustomPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscustompolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsEdgeAllowAllKnownDomains.md", + "redirect_url": "/powershell/module/microsoftteams/new-csedgeallowallknowndomains", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsEdgeAllowList.md", + "redirect_url": "/powershell/module/microsoftteams/new-csedgeallowlist", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsEdgeDomainPattern.md", + "redirect_url": "/powershell/module/microsoftteams/new-csedgedomainpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/new-csgrouppolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsHybridTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/new-cshybridtelephonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/new-csinboundblockednumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/new-csinboundexemptnumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineDateTimeRange.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinedatetimerange", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinedirectroutingtelephonenumberuploadorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineliscivicaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinelislocation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinepstngateway", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineschedule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinetelephonenumberorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineTelephoneNumberReleaseOrder.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinetelephonenumberreleaseorder", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineTimeRange.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinetimerange", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinevoiceroute", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinevoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsSdgBulkSignInRequest.md", + "redirect_url": "/powershell/module/microsoftteams/new-cssdgbulksigninrequest", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-cssharedcallqueuehistorytemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamtemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsaipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsapppermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsappsetuppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscallholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscallparkpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamschannelspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsComplianceRecordingPairedApplication.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscortanapolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEmergencyCallingExtendedNotification.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencycallingextendednotification", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEmergencyNumber.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencynumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamseventspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsfeedbackpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsfilespolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsHiddenMeetingTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamshiddenmeetingtemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsHiddenTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamshiddentemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingbroadcastpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmessagingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsnetworkroamingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsrecordingrolloutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftsconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftsconnectionbatchteammap", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamssurvivablebranchappliance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamstranslationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsupdatemanagementpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsvdipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsworkloadpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantnetworksite", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenanttrustedipaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsUserCallingDelegate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csusercallingdelegate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/new-csvideointeropserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/microsoftteams/new-csvoicenormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-Team.md", + "redirect_url": "/powershell/module/microsoftteams/new-team", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/new-teamchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/New-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/new-teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Register-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/register-csonlinedialinconferencingservicenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csapplicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csautoattendant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscallqueue", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscallinglineidentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsCustomPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscustompolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csgrouppolicyassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsHybridTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cshybridtelephonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csinboundblockednumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineaudiofile", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinedialinconferencingtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineliscivicaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelislocation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelisport", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelissubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelisswitch", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineliswirelessaccesspoint", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinepstngateway", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineschedule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinetelephonenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinevoiceroute", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsPhoneNumberAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csphonenumberassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csphonenumbertag", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cssharedcallqueuehistorytemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamtemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsaipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsapppermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsappsetuppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsaudioconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscallholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscallparkpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamschannelspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscortanapolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamseventspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsfeedbackpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsfilespolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingbroadcastpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmessagingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsnetworkroamingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsnotificationandfeedspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsrecordingrolloutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsShiftsConnectionTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsconnectionteammap", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsShiftsScheduleRecord.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsschedulerecord", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamssurvivablebranchappliance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsTargetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamstargetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamstranslationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsupdatemanagementpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsvdipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsworkloadpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantnetworksite", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenanttrustedipaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsUserCallingDelegate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csusercallingdelegate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsUserLicenseGracePeriod.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csuserlicensegraceperiod", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csvideointeropserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-SharedWithTeam.md", + "redirect_url": "/powershell/module/microsoftteams/remove-sharedwithteam", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-Team.md", + "redirect_url": "/powershell/module/microsoftteams/remove-team", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamChannelUser.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamchanneluser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamTargetingHierarchy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamtargetinghierarchy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csapplicationaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csapplicationmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/set-csautoattendant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/set-cscallqueue", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/set-cscallinglineidentity", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/set-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csexternalaccesspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/set-csinboundblockednumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/set-csinboundexemptnumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencingbridge", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencingservicenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencingtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencinguser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineenhancedemergencyservicedisclaimer", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineliscivicaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelislocation", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelisport", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelissubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelisswitch", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineliswirelessaccesspoint", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinepstngateway", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinepstnusage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineschedule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoiceApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceroute", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoicemailpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoicemailusersettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsPhoneNumberAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/set-csphonenumberassignment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/set-csphonenumbertag", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/set-cssharedcallqueuehistorytemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsaipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsAcsFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsapppermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsappsetuppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscallholdpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscallparkpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamschannelspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsclientconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscortanapolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamseducationassignmentsapppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEducationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamseducationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamseventspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsExternalAccessConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsexternalaccessconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsfeedbackpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsfilespolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsguestcallingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsguestmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsguestmessagingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsipphonepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingbroadcastconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingbroadcastpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmessagingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmobilitypolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmultitenantorganizationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsnetworkroamingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsNotificationAndFeedsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsnotificationandfeedspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsrecordingrolloutpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsSettingsCustomApp.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssettingscustomapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsShiftsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftsapppolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftsconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsSipDevicesConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssipdevicesconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssurvivablebranchappliance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsTargetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamstargetingpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamstranslationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsupdatemanagementpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsUpgradeConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsupgradeconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsvdipolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsworkloadpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantblockedcallingnumbers", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantfederationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantmigrationconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantnetworkregion", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantnetworksite", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantnetworksubnet", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenanttrustedipaddress", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsUser.md", + "redirect_url": "/powershell/module/microsoftteams/set-csuser", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsUserCallingDelegate.md", + "redirect_url": "/powershell/module/microsoftteams/set-csusercallingdelegate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsUserCallingSettings.md", + "redirect_url": "/powershell/module/microsoftteams/set-csusercallingsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/set-csvideointeropserviceprovider", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-Team.md", + "redirect_url": "/powershell/module/microsoftteams/set-team", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamArchivedState.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamarchivedstate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamchannel", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamPicture.md", + "redirect_url": "/powershell/module/microsoftteams/set-teampicture", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamTargetingHierarchy.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamtargetinghierarchy", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamsEnvironmentConfig.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamsenvironmentconfig", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Start-CsExMeetingMigration.md", + "redirect_url": "/powershell/module/microsoftteams/start-csexmeetingmigration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Sync-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/sync-csonlineapplicationinstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/test-cseffectivetenantdialplan", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/test-csinboundblockednumberpattern", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsTeamsShiftsConnectionValidate.md", + "redirect_url": "/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/test-csteamstranslationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Test-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/microsoftteams/test-csvoicenormalizationrule", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/unregister-csonlinedialinconferencingservicenumber", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/update-csautoattendant", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsCustomPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/update-cscustompolicypackage", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/update-csphonenumbertag", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/update-csteamtemplate", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/update-csteamsshiftsconnection", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/update-csteamsshiftsconnectioninstance", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-M365TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/update-m365teamsapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-M365UnifiedCustomPendingApp.md", + "redirect_url": "/powershell/module/microsoftteams/update-m365unifiedcustompendingapp", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Update-M365UnifiedTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/update-m365unifiedtenantsettings", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/export-csonlineaudiofile.md", + "redirect_url": "/powershell/module/microsoftteams/export-csonlineaudiofile", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/get-csteamsmessagingconfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmessagingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/set-csteamsmessagingconfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmessagingconfiguration", + "redirect_document_id": true + }, + { + "source_path": "teams/virtual-folder/teams/Add-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Disable-CsTeamsShiftsConnectionErrorReport.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsMainlineAttendantFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-LicenseReportForChangeNotificationSubscription.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamFunSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamGuestSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamMemberSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamMessagingSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Get-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsCloudMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Grant-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/New-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Remove-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Remove-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamFunSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamGuestSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamMemberSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Set-TeamMessagingSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/Update-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/teams.md", + "redirect_url": "/powershell/module/microsoftteams/", + "redirect_document_id": false + }, + { + "source_path": "teams/virtual-folder/teams/index.md", + "redirect_url": "/powershell/module/microsoftteams/", + "redirect_document_id": true } ] } \ No newline at end of file diff --git a/exchange/exchange-ps/exchange/Add-ADPermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-ADPermission.md similarity index 85% rename from exchange/exchange-ps/exchange/Add-ADPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ADPermission.md index c1daf4b98b..0f883fb2c0 100644 --- a/exchange/exchange-ps/exchange/Add-ADPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ADPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-adpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-ADPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-adpermission +schema: 2.0.0 +title: Add-ADPermission --- # Add-ADPermission @@ -88,13 +89,15 @@ This example assumes that another security mechanism is used to ensure the Recei ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the object that's getting permissions added. You can specify either the distinguished name (DN) of the object or the object's name if it's unique. If the DN or name contains spaces, enclose the name in quotation marks ("). ```yaml Type: ADRawEntryIdParameter -Parameter Sets: AccessRights, Owner +Parameter Sets: AccessRights, Owner, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -103,27 +106,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: ADRawEntryIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Instance -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Instance The Instance parameter enables you to pass an entire object to the command to be processed. It's mainly used in scripts where an entire object must be passed to the command. ```yaml Type: ADAcePresentationObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -133,6 +125,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Owner parameter specifies the owner of the Active Directory object. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -158,7 +153,6 @@ You can't use this parameter with the AccessRights or User parameters. Type: SecurityPrincipalIdParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -168,6 +162,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The User parameter specifies who gets the permissions on the Active Directory object. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -196,9 +193,8 @@ You can't use this parameter with the Owner parameter. ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -207,20 +203,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -AccessRights -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -AccessRights The AccessRights parameter specifies the rights that you want to add for the user on the Active Directory object. Valid values include: - AccessSystemSecurity @@ -251,7 +237,6 @@ You can't use this parameter with the Owner parameter. Type: ActiveDirectoryRights[] Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,6 +246,9 @@ Accept wildcard characters: False ``` ### -ChildObjectTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ChildObjectTypes parameter specifies what type of object the permission should be applied to. The ChildObjectTypes parameter can only be used if the AccessRights parameter is set to CreateChild or DeleteChild. @@ -269,7 +257,6 @@ The ChildObjectTypes parameter can only be used if the AccessRights parameter is Type: ADSchemaObjectIdParameter[] Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -279,6 +266,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -288,7 +278,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -298,13 +287,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Deny switch specifies that the permissions you're adding are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -314,6 +305,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -322,7 +316,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,13 +325,15 @@ Accept wildcard characters: False ``` ### -ExtendedRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedRights parameter specifies the extended rights needed to perform the operation. ```yaml Type: ExtendedRightIdParameter[] Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -348,6 +343,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InheritanceType parameter specifies how permissions are inherited. Valid values are: - None @@ -360,7 +358,6 @@ The InheritanceType parameter specifies how permissions are inherited. Valid val Type: ActiveDirectorySecurityInheritance Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -370,13 +367,15 @@ Accept wildcard characters: False ``` ### -InheritedObjectType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InheritedObjectType parameter specifies what kind of object inherits this access control entry (ACE). ```yaml Type: ADSchemaObjectIdParameter Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -386,6 +385,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Properties parameter specifies what properties the object contains. The Properties parameter can only be used if the AccessRights parameter is set to ReadProperty, WriteProperty or Self. @@ -394,7 +396,6 @@ The Properties parameter can only be used if the AccessRights parameter is set t Type: ADSchemaObjectIdParameter[] Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -404,13 +405,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-AttachmentFilterEntry.md b/exchange/exchange-ps/ExchangePowerShell/Add-AttachmentFilterEntry.md similarity index 90% rename from exchange/exchange-ps/exchange/Add-AttachmentFilterEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Add-AttachmentFilterEntry.md index 000fae4281..89c8a158a9 100644 --- a/exchange/exchange-ps/exchange/Add-AttachmentFilterEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-AttachmentFilterEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-attachmentfilterentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-AttachmentFilterEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-attachmentfilterentry +schema: 2.0.0 +title: Add-AttachmentFilterEntry --- # Add-AttachmentFilterEntry @@ -29,7 +30,7 @@ Add-AttachmentFilterEntry -Name -Type ``` ## DESCRIPTION -On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchangepowershell/set-attachmentfilterlistconfig). On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. @@ -52,6 +53,9 @@ This example adds an attachment filter entry based on the MIME content type imag ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the files that you want to block. Valid values are: - A exact file name (for example, BadFile.exe) or file name extension (for example, \*.exe). You need to use the value Filename for the Type parameter. @@ -61,7 +65,6 @@ The Name parameter specifies the files that you want to block. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Type parameter specifies what type of attachment the attachment filter entry blocks. Valid values are: - ContentType: This value matches the attachment filter entry against the MIME content type that's specified in the Name parameter. @@ -80,7 +86,6 @@ The Type parameter specifies what type of attachment the attachment filter entry Type: AttachmentType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -99,7 +107,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -117,7 +127,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md b/exchange/exchange-ps/ExchangePowerShell/Add-AvailabilityAddressSpace.md similarity index 89% rename from exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md rename to exchange/exchange-ps/ExchangePowerShell/Add-AvailabilityAddressSpace.md index aedd7aee1a..dae8361398 100644 --- a/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-AvailabilityAddressSpace.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-availabilityaddressspace applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Add-AvailabilityAddressSpace -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-availabilityaddressspace +schema: 2.0.0 +title: Add-AvailabilityAddressSpace --- # Add-AvailabilityAddressSpace @@ -74,6 +75,9 @@ In Exchange Online, this example sets up the sharing of free/busy information wi ## PARAMETERS ### -AccessMethod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AccessMethod parameter specifies how the free/busy data is accessed. Valid values are: - PerUserFB: Per-user free/busy information can be requested. The free/busy data is accessed in the defined per-user free/busy proxy account or group, or in the All Exchange Servers group. This value requires a trust between the two forests, and requires you to use either the UseServiceAccount parameter or Credentials parameter. @@ -86,7 +90,6 @@ The AccessMethod parameter specifies how the free/busy data is accessed. Valid v Type: AvailabilityAccessMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -ForestName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ForestName parameter specifies the SMTP domain name of the target forest that contains the users you're trying to read free/busy information from. If users are distributed among multiple SMTP domains in the target forest, run the Add-AvailabilityAddressSpace command once for each SMTP domain. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -121,7 +129,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -Credentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Credentials parameter specifies the username and password that's used to access the Availability services in the target forest. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -139,7 +149,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -157,7 +169,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,17 +178,19 @@ Accept wildcard characters: False ``` ### -ProxyUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ProxyUrl parameter was used to specify the URL that directed an Exchange 2007 Client Access server to proxy free/busy requests through an Exchange 2010 or Exchange 2013 Client Access server when requesting federated free/busy data for a user in another organization. When you used this parameter, you needed to set the AccessMethod parameter value to InternalProxy. -This parameter required that you created the proper trust relationships and sharing relationships between the Exchange organizations. For more information, see [New-FederationTrust](https://learn.microsoft.com/powershell/module/exchange/new-federationtrust). +This parameter required that you created the proper trust relationships and sharing relationships between the Exchange organizations. For more information, see [New-FederationTrust](https://learn.microsoft.com/powershell/module/exchangepowershell/new-federationtrust). ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,13 +200,15 @@ Accept wildcard characters: False ``` ### -TargetAutodiscoverEpr + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization that you're trying to read free/busy information from. For example, `https://contoso.com/autodiscover/autodiscover.xml`. Exchange uses Autodiscover to automatically detect the correct server endpoint for external requests. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,6 +218,9 @@ Accept wildcard characters: False ``` ### -TargetServiceEpr + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The TargetServiceEpr parameter specifies the Exchange Online Calendar Service URL of the external Microsoft 365 organization that you're trying to read free/busy information from. Valid values are: @@ -215,7 +233,6 @@ The TargetServiceEpr parameter specifies the Exchange Online Calendar Service UR Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -225,6 +242,9 @@ Accept wildcard characters: False ``` ### -TargetTenantId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The TargetTenantID parameter specifies the tenant ID of the external Microsoft 365 organization that you're trying to read free/busy information from. @@ -233,7 +253,6 @@ The TargetTenantID parameter specifies the tenant ID of the external Microsoft 3 Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -UseServiceAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UseServiceAccount parameter specifies whether to use the local Availability service account for authorization. Valid values @@ -254,7 +276,6 @@ The UseServiceAccount parameter specifies whether to use the local Availability Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +285,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md b/exchange/exchange-ps/ExchangePowerShell/Add-ComplianceCaseMember.md similarity index 94% rename from exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ComplianceCaseMember.md index ddec608aad..c486c651c8 100644 --- a/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ComplianceCaseMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-compliancecasemember applicable: Security & Compliance -title: Add-ComplianceCaseMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-compliancecasemember +schema: 2.0.0 +title: Add-ComplianceCaseMember --- # Add-ComplianceCaseMember @@ -50,6 +51,9 @@ This example adds John Evans to the eDiscovery case named Case 2112. ## PARAMETERS ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the name of the eDiscovery case that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. @@ -58,7 +62,6 @@ To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Security & Compliance + The Member parameter specifies the user that you want to add to the eDiscovery case. You can use any value that uniquely identifies the user. For example: - Name @@ -79,7 +85,6 @@ The Member parameter specifies the user that you want to add to the eDiscovery c Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md b/exchange/exchange-ps/ExchangePowerShell/Add-ContentFilterPhrase.md similarity index 90% rename from exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ContentFilterPhrase.md index 72bcef12ec..6065a9815c 100644 --- a/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ContentFilterPhrase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-contentfilterphrase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-ContentFilterPhrase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-contentfilterphrase +schema: 2.0.0 +title: Add-ContentFilterPhrase --- # Add-ContentFilterPhrase @@ -45,13 +46,15 @@ This example adds the phrase Free credit report to the Block phrase list. Any me ## PARAMETERS ### -Phrase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Phrase parameter specifies a custom word or phrase for the Content Filter agent. When you pass an argument, you must enclose the Phrase parameter in quotation marks (") if the phrase contains spaces, for example: "This is a bad phrase". Custom phrases must be less than 257 characters in length. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Influence + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Influence parameter specifies whether the phrase being added will cause the messages that contain the phrase to be allowed or blocked. Valid values are GoodWord and BadWord. A message that contains a custom word or phrase that has an Influence value of GoodWord is automatically assigned a spam confidence level (SCL) rating of 0 and therefore bypasses downstream spam processing. A message that contains a custom word or phrase that has an Influence value of BadWord is automatically assigned an SCL rating of 9 and therefore is treated as spam. @@ -69,7 +75,6 @@ A message that contains a custom word or phrase that has an Influence value of G Type: Influence Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -106,7 +116,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md b/exchange/exchange-ps/ExchangePowerShell/Add-DatabaseAvailabilityGroupServer.md similarity index 90% rename from exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md rename to exchange/exchange-ps/ExchangePowerShell/Add-DatabaseAvailabilityGroupServer.md index d1e4a31542..897bf7a61f 100644 --- a/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-DatabaseAvailabilityGroupServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-databaseavailabilitygroupserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-DatabaseAvailabilityGroupServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-databaseavailabilitygroupserver +schema: 2.0.0 +title: Add-DatabaseAvailabilityGroupServer --- # Add-DatabaseAvailabilityGroupServer @@ -50,13 +51,15 @@ This example adds the Mailbox server MBX1 to the DAG DAG1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the DAG to which the server is being added. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies the Mailbox server to add to the DAG. You can use any value that uniquely identifies the server. For example: - Name @@ -77,7 +83,6 @@ The MailboxServer parameter specifies the Mailbox server to add to the DAG. You Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 2 @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -96,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -SkipDagValidation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when adding members to the DAG. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Add-DistributionGroupMember.md similarity index 87% rename from exchange/exchange-ps/exchange/Add-DistributionGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Add-DistributionGroupMember.md index 90029ad72b..b87a4f59b9 100644 --- a/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-DistributionGroupMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-distributiongroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Add-DistributionGroupMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-distributiongroupmember +schema: 2.0.0 +title: Add-DistributionGroupMember --- # Add-DistributionGroupMember @@ -45,6 +46,9 @@ This example adds John Evans to the distribution group named Staff. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the group that you want to modify. You can use Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -79,7 +85,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Member parameter specifies the recipient that you want to add to the group. A member can be any mail-enabled recipient in your organization. You can use any value that uniquely identifies the recipient. For example: - Name @@ -141,7 +153,6 @@ Although it isn't required, it's a good idea to add only security principals (fo Type: RecipientWithAdUserGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-FederatedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Add-FederatedDomain.md similarity index 89% rename from exchange/exchange-ps/exchange/Add-FederatedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Add-FederatedDomain.md index 1a193dfead..25568ab2fa 100644 --- a/exchange/exchange-ps/exchange/Add-FederatedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-FederatedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-federateddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-FederatedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-federateddomain +schema: 2.0.0 +title: Add-FederatedDomain --- # Add-FederatedDomain @@ -49,13 +50,15 @@ This example adds the domain Contoso.co.uk to the existing federation trust. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainName parameter specifies the secondary domain to be configured. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -90,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Add-GlobalMonitoringOverride.md similarity index 90% rename from exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Add-GlobalMonitoringOverride.md index 975a6bf632..7cdc6eb202 100644 --- a/exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-GlobalMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-globalmonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-GlobalMonitoringOverride -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-globalmonitoringoverride +schema: 2.0.0 +title: Add-GlobalMonitoringOverride --- # Add-GlobalMonitoringOverride @@ -64,13 +65,15 @@ This example adds a global monitoring override that disables the StorageLogicalD ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the probe, monitor, or responder. This parameter uses the syntax `HealthSetName\MonitoringItemName[\TargetResource]`. Note that the values are case sensitive. For example, use `AD\ActiveDirectoryConnectivityServerReboot`, not `ad\activedirectoryconnectivityserverreboot`. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -ApplyVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ApplyVersion parameter specifies the version of Exchange that gets the override. If an Exchange server is older or newer than the version you specify, the override isn't applied to the server. Typically, you increase the Exchange version by applying Cumulative Updates or Service Packs. Valid input for this parameter is an Exchange version number in the format 15.0x.xxxx.xxx. @@ -90,7 +96,6 @@ You can't use this parameter with the Duration parameter. Type: Version Parameter Sets: ApplyVersion Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -ItemType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ItemType parameter specifies the item type for the property that you want to override. Valid values are: - Probe @@ -110,7 +118,6 @@ The ItemType parameter specifies the item type for the property that you want to Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PropertyName parameter specifies the property that you want to override. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PropertyValue parameter specifies the new value for the property that you want to override. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -161,7 +175,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -179,7 +195,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,6 +204,9 @@ Accept wildcard characters: False ``` ### -Duration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Duration parameter specifies the length of time that the override is active. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -201,7 +219,6 @@ You can't use this parameter with the ApplyVersion parameter. Type: EnhancedTimeSpan Parameter Sets: Duration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,13 +228,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,13 +246,15 @@ Accept wildcard characters: False ``` ### -BuildRange + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: Duration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,13 +264,15 @@ Accept wildcard characters: False ``` ### -Roles + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListEntry.md similarity index 88% rename from exchange/exchange-ps/exchange/Add-IPAllowListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListEntry.md index d987ed4c56..8aeb4bef69 100644 --- a/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-ipallowlistentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-IPAllowListEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-ipallowlistentry +schema: 2.0.0 +title: Add-IPAllowListEntry --- # Add-IPAllowListEntry @@ -65,13 +66,15 @@ This example adds the IP address range 192.168.0.1/24 to the list of allowed IP ## PARAMETERS ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddress parameter specifies a single IP address to add to the IP Allow list, for example, 192.168.0.1. ```yaml Type: IPAddress Parameter Sets: IPAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -IPRange + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPRange parameter specifies a range of IP addresses to add to the IP Allow list. Valid values are: - IP address range: 192.168.0.1-192.168.0.254. @@ -90,7 +96,6 @@ The IPRange parameter specifies a range of IP addresses to add to the IP Allow l Type: IPRange Parameter Sets: IPRange Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -125,7 +135,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -ExpirationTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExpirationTime parameter specifies a day and time when the IP Allow list entry that you're creating will expire. If you specify a time only and you don't specify a date, the current day is assumed. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -143,7 +155,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,6 +164,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -168,7 +182,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-IPAllowListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListProvider.md similarity index 88% rename from exchange/exchange-ps/exchange/Add-IPAllowListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListProvider.md index 9b528293bd..d9f0360b2b 100644 --- a/exchange/exchange-ps/exchange/Add-IPAllowListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-IPAllowListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-ipallowlistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-IPAllowListProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-ipallowlistprovider +schema: 2.0.0 +title: Add-IPAllowListProvider --- # Add-IPAllowListProvider @@ -55,13 +56,15 @@ This example adds an IP Allow list provider and configures a bitmask return valu ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a descriptive name for the IP Allow list provider. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -LookupDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LookupDomain parameter specifies the host name that's required to use the allow list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An example value is allowlist.spamservice.com. The actual value you need to use is provided by the allow list provider. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -AnyMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnyMatch parameter specifies whether any response by the allow list provider is treated as a match. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, and connection filtering sends the IP address of the connecting SMTP server to the allow list provider, any response code returned by the allow list provider causes connection filtering to allow messages from that source. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -BitmaskMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BitmaskMatch parameter specifies the bit mask status code that's returned by the allow list provider. Use this parameter if the allow list provider returns bitmask responses. Valid input for this parameter is a single IP address in the format 127.0.0.1. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -128,7 +140,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -146,7 +160,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +169,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the connection filtering uses this IP Allow List provider. Valid input for this parameter is $true or $false. The default value is $true. By default, connection filtering uses new IP Allow List providers that you create. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +187,15 @@ Accept wildcard characters: False ``` ### -IPAddressesMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddressesMatch parameter specifies the IP address status codes that are returned by the allow list provider. Use this parameter if the allow list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. You can enter multiple IP addresses separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +205,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the order that the Connection Filtering agent queries the IP Allow list providers that you have configured. A lower priority integer value indicates a higher priority. By default, every time that you add a new IP Allow list provider, the entry is assigned a priority of N+1, where N is the number of IP Allow list providers that you have configured. If you set the Priority parameter to a value that's the same as another IP Allow list provider, the priority of the IP Allow list provider that you add first is incremented by 1. @@ -196,7 +216,6 @@ If you set the Priority parameter to a value that's the same as another IP Allow Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +225,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListEntry.md similarity index 88% rename from exchange/exchange-ps/exchange/Add-IPBlockListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListEntry.md index 35072b31fd..c121c4bd15 100644 --- a/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-ipblocklistentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-IPBlockListEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-ipblocklistentry +schema: 2.0.0 +title: Add-IPBlockListEntry --- # Add-IPBlockListEntry @@ -64,13 +65,15 @@ This example adds the IP address range 192.168.0.1/24 to the list of blocked IP ## PARAMETERS ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddress parameter specifies a single IP address to add to the IP Block list, for example, 192.168.0.1. ```yaml Type: IPAddress Parameter Sets: IPAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -IPRange + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPRange parameter specifies a range of IP addresses to add to the IP Block list. Valid values are: - IP address range: 192.168.0.1-192.168.0.254. @@ -89,7 +95,6 @@ The IPRange parameter specifies a range of IP addresses to add to the IP Block l Type: IPRange Parameter Sets: IPRange Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -124,7 +134,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -ExpirationTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExpirationTime parameter specifies a day and time when the IP Block list entry that you're creating will expire. If you specify a time only and you don't specify a date, the current day is assumed. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -142,7 +154,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -167,7 +181,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-IPBlockListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListProvider.md similarity index 88% rename from exchange/exchange-ps/exchange/Add-IPBlockListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListProvider.md index 29ca57a584..e87c1f2b8d 100644 --- a/exchange/exchange-ps/exchange/Add-IPBlockListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-IPBlockListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-ipblocklistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-IPBlockListProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-ipblocklistprovider +schema: 2.0.0 +title: Add-IPBlockListProvider --- # Add-IPBlockListProvider @@ -56,13 +57,15 @@ This example adds an IP Block list provider and configures a bitmask return valu ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a descriptive name for the IP Block list provider. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -LookupDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LookupDomain parameter specifies the host name that's required to use the block list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An example value is blocklist.spamservice.com. The actual value you need to use is provided by the block list provider. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -AnyMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnyMatch parameter specifies whether any response by the block list provider is treated as a match. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, and connection filtering sends the IP address of the connecting SMTP server to the block list provider, any response code returned by the block list provider causes connection filtering to block messages from that source. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -BitmaskMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BitmaskMatch parameter specifies the bit mask status code that's returned by the block list provider. Use this parameter if the block list provider returns bitmask responses. Valid input for this parameter is a single IP address in the format 127.0.0.1. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -129,7 +141,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +150,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -147,7 +161,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +170,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the connection filtering uses this IP Block list provider. Valid input for this parameter is $true or $false. The default value is $true. By default, connection filtering uses new IP Block List providers that you create. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,13 +188,15 @@ Accept wildcard characters: False ``` ### -IPAddressesMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddressesMatch parameter specifies the IP address status codes that are returned by the block list provider. Use this parameter if the block list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. You can enter multiple IP addresses separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,6 +206,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the order that the Connection Filtering agent queries the IP Block list providers. A lower priority integer value indicates a higher priority. By default, every time that you add a new IP Block list provider, the entry is assigned a priority of N+1, where N is the number of IP Block list provider services that you have configured. If you set the Priority parameter to a value that's the same as another IP Block list provider service, the priority of the IP Block list provider that you add first is incremented by 1. @@ -197,7 +217,6 @@ If you set the Priority parameter to a value that's the same as another IP Block Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +226,9 @@ Accept wildcard characters: False ``` ### -RejectionResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RejectionResponse parameter specifies the text that you want to include in the SMTP rejection response when messages are blocked by connection filtering. The argument can't exceed 240 characters. If the value contains spaces, enclose the value in quotation marks ("). You should always specify the block list provider in the response so that legitimate senders can contact the block list provider for removal instructions. For example, "Source IP address is listed at the Contoso.com block list provider". @@ -215,7 +237,6 @@ You should always specify the block list provider in the response so that legiti Type: AsciiString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +246,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxDatabaseCopy.md similarity index 90% rename from exchange/exchange-ps/exchange/Add-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Add-MailboxDatabaseCopy.md index df90710452..e255aaa90a 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-mailboxdatabasecopy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-MailboxDatabaseCopy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxdatabasecopy +schema: 2.0.0 +title: Add-MailboxDatabaseCopy --- # Add-MailboxDatabaseCopy @@ -72,6 +73,9 @@ This example adds a copy of mailbox database DB3 to the Mailbox server MBX4. Rep ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox database that's being copied. You can use any value that uniquely identifies the database. For example: - Name @@ -82,7 +86,6 @@ The Identity parameter specifies the mailbox database that's being copied. You c Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -92,13 +95,15 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies the name of the server that will host the database copy. This server must be a member of the same DAG and must not already host a copy of the database. ```yaml Type: MailboxServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 2 @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -ActivationPreference + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActivationPreference parameter value is used as part of Active Manager's best copy selection process and to redistribute active mailbox databases throughout the DAG when using the RedistributeActiveDatabases.ps1 script. The value for the activation preference is a number equal to or greater than 1, where 1 is at the top of the preference order. The preference number can't be larger than the number of copies of the mailbox database. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConfigurationOnly switch allows database copies to be added without invoking automatic seeding. You don't need to specify a value with this switch. The source database does not need to be online or present when using this parameter. It will create a new database in Active Directory without contacting the target server. This parameter may be useful in situations where the target server is down for maintenance and the new database copy does not yet exist on the target server. @@ -132,7 +142,6 @@ The source database does not need to be online or present when using this parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -151,7 +163,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,13 +172,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,6 +190,9 @@ Accept wildcard characters: False ``` ### -ReplayLagMaxDelay + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ReplayLagMaxDelay parameter specifies the maximum delay for lagged database copy play down (also known as deferred lagged copy play down). If the disk read IO latency is greater than 25 ms, lagged copy play down is delayed up to the value of this parameter. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -189,7 +205,6 @@ Note that when the disk is running out of space, the value of this parameter is Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,6 +214,9 @@ Accept wildcard characters: False ``` ### -ReplayLagTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReplayLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service waits before replaying log files that have been copied to the database copy. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -209,7 +227,6 @@ The default value is 00.00:00:00, which specifies that there's no truncation lag Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,13 +236,15 @@ Accept wildcard characters: False ``` ### -SeedingPostponed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SeedingPostponed switch specifies that the task doesn't seed the database copy, so you need to explicitly seed the database copy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -235,6 +254,9 @@ Accept wildcard characters: False ``` ### -TruncationLagTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TruncationLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service waits before truncating log files that have replayed into a copy of the database. The time period begins after the log has been successfully replayed into the copy of the database. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -245,7 +267,6 @@ The default value is 00.00:00:00, which specifies that there's no truncation lag Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,13 +276,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxFolderPermission.md similarity index 91% rename from exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-MailboxFolderPermission.md index bda1bfce49..721fa3fe78 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxFolderPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Add-MailboxFolderPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxfolderpermission +schema: 2.0.0 +title: Add-MailboxFolderPermission --- # Add-MailboxFolderPermission @@ -61,6 +62,9 @@ In Exchange Online, this example adds Laura as a calendar delegate to Ayla's mai ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the target mailbox and folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -82,7 +86,6 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Inb Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AccessRights parameter specifies the permissions that you want to add for the user on the mailbox folder. You can specify individual folder permissions or roles, which are combinations of permissions. You can specify multiple permissions and roles separated by commas. @@ -132,7 +138,6 @@ When the Editor role is applied to calendar folders, delegates can accept or dec Type: MailboxFolderAccessRight[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -142,6 +147,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The User parameter specifies who's granted permission to the mailbox folder. Valid values are mail-enabled security principals (mail-enabled accounts or groups that have security identifiers or SIDs that can have permissions assigned to them). For example: - User mailboxes @@ -166,7 +174,6 @@ Otherwise, you can use any value that uniquely identifies the user or group. For Type: MailboxFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -176,6 +183,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -185,7 +195,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -195,6 +204,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -203,7 +215,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -213,6 +224,9 @@ Accept wildcard characters: False ``` ### -SendNotificationToUser + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SendNotificationToUser parameter specifies whether to send a sharing invitation to the user when you add calendar permissions for them. The message will be a normal calendar sharing invitation that can be accepted by the recipient. Valid values are: @@ -231,7 +245,6 @@ This parameter only applies to calendar folders and can only be used with the fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -241,6 +254,9 @@ Accept wildcard characters: False ``` ### -SharingPermissionFlags + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SharingPermissionFlags parameter assigns calendar delegate permissions. This parameter only applies to calendar folders and can only be used when the AccessRights parameter value is Editor. Valid values are: @@ -257,7 +273,6 @@ You can specify multiple values separated by commas. Type: MailboxFolderPermissionFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -267,13 +282,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -299,10 +316,10 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderpermission) -[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxfolderpermission) -[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Add-MailboxPermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxPermission.md similarity index 84% rename from exchange/exchange-ps/exchange/Add-MailboxPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-MailboxPermission.md index 07ab0e946e..accc016d50 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-MailboxPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-mailboxpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Add-MailboxPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxpermission +schema: 2.0.0 +title: Add-MailboxPermission --- # Add-MailboxPermission @@ -101,6 +102,9 @@ In Exchange Online, this example assigns the administrator account admin@contoso ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox where you want to assign permissions to the user. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -116,9 +120,8 @@ The Identity parameter specifies the mailbox where you want to assign permission ```yaml Type: MailboxIdParameter -Parameter Sets: AccessRights, Owner +Parameter Sets: AccessRights, Owner, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -127,20 +130,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: MailboxIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -AccessRights -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -AccessRights The AccessRights parameter specifies the permission that you want to add for the user on the mailbox. Valid values are: - ChangeOwner @@ -156,9 +149,8 @@ You can't use this parameter with the Owner parameter. ```yaml Type: MailboxRights[] -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -167,20 +159,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxRights[] -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Instance -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Instance This parameter is available only in on-premises Exchange. This parameter has been deprecated and is no longer used. @@ -189,7 +171,6 @@ This parameter has been deprecated and is no longer used. Type: MailboxAcePresentationObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -199,6 +180,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Owner parameter specifies the owner of the mailbox object. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -226,7 +210,6 @@ You can't use this parameter with the AccessRights or User parameters. Type: SecurityPrincipalIdParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -236,6 +219,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The User parameter specifies who gets the permissions on the mailbox. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -266,9 +252,8 @@ You can't use this parameter with the Owner parameter. ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -277,20 +262,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -AutoMapping -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -AutoMapping The AutoMapping parameter includes or excludes the mailbox from the auto-mapping feature in Microsoft Outlook. Auto-mapping uses Autodiscover to automatically add mailboxes to a user's Outlook profile if the user has Full Access permission to the mailbox. However, Autodiscover won't enumerate security groups that are given Full Access permission to the mailbox. Valid values are: - $true: The mailbox is automatically added to the user's Outlook profile if the user has Full Access permission. This is the default value. @@ -302,7 +277,6 @@ The AutoMapping parameter includes or excludes the mailbox from the auto-mapping Type: Boolean Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -312,6 +286,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -321,7 +298,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -331,13 +307,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Deny switch specifies that the permissions you're adding are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -347,6 +325,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -355,7 +336,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -365,6 +345,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to add permissions to a Microsoft 365 Group mailbox. You don't need to specify a value with this switch. @@ -373,7 +356,6 @@ The GroupMailbox switch is required to add permissions to a Microsoft 365 Group Type: SwitchParameter Parameter Sets: AccessRights, Owner, Instance Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -383,6 +365,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -394,7 +379,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -404,6 +388,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InheritanceType parameter specifies how permissions are inherited by folders in the mailbox. Valid values are: - None @@ -416,7 +403,6 @@ The InheritanceType parameter specifies how permissions are inherited by folders Type: ActiveDirectorySecurityInheritance Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -426,13 +412,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md b/exchange/exchange-ps/ExchangePowerShell/Add-ManagementRoleEntry.md similarity index 87% rename from exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ManagementRoleEntry.md index 6b98323cb7..c356ae0e7b 100644 --- a/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ManagementRoleEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-managementroleentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Add-ManagementRoleEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-managementroleentry +schema: 2.0.0 +title: Add-ManagementRoleEntry --- # Add-ManagementRoleEntry @@ -88,6 +89,9 @@ In on-premises Exchange, this example adds the MailboxAudit script with the Depa ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the role entry that you want to add. This parameter uses the syntax: `Management role\role entry name` (for example, `CustomRole\Set-Mailbox`). For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). @@ -98,7 +102,6 @@ The role entry you want to add must exist in the parent role. If the role entry Type: RoleEntryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -108,13 +111,15 @@ Accept wildcard characters: False ``` ### -ParentRoleEntry + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ParentRoleEntry parameter specifies the role entry in the parent role to add to the role specified with the Role parameter. This parameter generally isn't used directly, but exists to enable the piping of role entries from the Get-ManagementRoleEntry cmdlet. If you use the ParentRoleEntry parameter, you can't use the UnScopedTopLevel switch. ```yaml Type: RoleEntryIdParameter Parameter Sets: ParentRoleEntry Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -124,13 +129,15 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Role parameter specifies the role to which the new role entry, specified by the ParentRoleEntry parameter, is added. ```yaml Type: RoleIdParameter Parameter Sets: ParentRoleEntry Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -149,7 +159,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -167,7 +179,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,6 +188,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -187,7 +201,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -197,13 +210,15 @@ Accept wildcard characters: False ``` ### -Overwrite + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Overwrite switch causes existing role entries to be overwritten by the role entries being added. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -213,13 +228,15 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Parameters parameter specifies the parameters to be included in the role being added. The parameters specified must exist on the cmdlet associated with the role entry. You can specify multiple parameters, separated with commas. ```yaml Type: String[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -229,6 +246,9 @@ Accept wildcard characters: False ``` ### -PSSnapinName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PSSnapinName parameter specifies the Windows PowerShell snap-in that contains the cmdlet associated with the role being added. Use the Get-PSSnapin cmdlet to retrieve a list of available Windows PowerShell snap-ins. @@ -237,7 +257,6 @@ The PSSnapinName parameter specifies the Windows PowerShell snap-in that contain Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -247,13 +266,15 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Type parameter specifies the type of role entry being added. The valid values are Cmdlet, Script and ApplicationPermission. ```yaml Type: ManagementRoleEntryType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -263,6 +284,9 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -277,7 +301,6 @@ You can't use this switch with the ParentRoleEntry parameter. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -287,13 +310,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderAdministrativePermission.md similarity index 89% rename from exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderAdministrativePermission.md index 153ba0c086..7049b48a5c 100644 --- a/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderAdministrativePermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-publicfolderadministrativepermission applicable: Exchange Server 2010 -title: Add-PublicFolderAdministrativePermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-publicfolderadministrativepermission +schema: 2.0.0 +title: Add-PublicFolderAdministrativePermission --- # Add-PublicFolderAdministrativePermission @@ -78,15 +79,17 @@ This example denies the user Chris the ViewInformationStore permission. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. ```yaml Type: PublicFolderIdParameter -Parameter Sets: Identity, Owner +Parameter Sets: Identity, Owner, Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -95,20 +98,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: PublicFolderIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 +### -AccessRights -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -AccessRights The AccessRights parameter specifies the rights that you want to add for the administrator on the public folder. Valid values include: - None The administrator has no rights to modify public folder attributes. @@ -128,9 +121,8 @@ You can't use this parameter with the Owner parameter. ```yaml Type: MultiValuedProperty -Parameter Sets: Identity +Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -139,27 +131,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MultiValuedProperty -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 +### -Instance -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -Instance The Instance parameter specifies whether to pass an entire object to the command to be processed. It's mainly used in scripts where an entire object must be passed to the command. ```yaml Type: PublicFolderAdministrativeAceObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -169,6 +150,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010 + The Owner parameter specifies the owner of the public folder object. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -194,7 +178,6 @@ You can't use this parameter with the AccessRights or User parameters. Type: SecurityPrincipalIdParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -204,6 +187,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010 + The User parameter specifies who gets the admin permissions on the public folder. You can specify the following types of users or groups: - Mailbox users @@ -227,9 +213,8 @@ You can't use this parameter with the Owner parameter. ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: Identity +Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -238,20 +223,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -261,7 +236,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -271,13 +245,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010 + The Deny switch specifies that the permissions you're adding are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -287,13 +263,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -303,6 +281,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010 + The InheritanceType parameter specifies how permissions are inherited. Valid values are: - None @@ -315,7 +296,6 @@ The InheritanceType parameter specifies how permissions are inherited. Valid val Type: ActiveDirectorySecurityInheritance Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -325,6 +305,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -338,7 +321,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -348,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderClientPermission.md similarity index 91% rename from exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderClientPermission.md index 059bc10445..e65cd078af 100644 --- a/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-PublicFolderClientPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-publicfolderclientpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Add-PublicFolderClientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-publicfolderclientpermission +schema: 2.0.0 +title: Add-PublicFolderClientPermission --- # Add-PublicFolderClientPermission @@ -51,6 +52,9 @@ This example adds permission for the user Chris to create items in the public fo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -59,7 +63,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AccessRights parameter specifies the rights that you want to add for the user on the public folder. You can specify individual folder permissions or roles, which are combinations of permissions. You can specify multiple permissions and roles separated by commas. @@ -102,7 +108,6 @@ In addition to access rights, you can create rights based upon roles, which incl Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The User parameter specifies the user for whom rights are being added. For the best results, we recommend using the following values: @@ -123,7 +131,6 @@ For the best results, we recommend using the following values: Type: PublicFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -142,7 +152,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -160,7 +172,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -185,7 +199,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -195,13 +208,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-RecipientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Add-RecipientPermission.md similarity index 95% rename from exchange/exchange-ps/exchange/Add-RecipientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Add-RecipientPermission.md index 06dfc9280a..2a629a5a0d 100644 --- a/exchange/exchange-ps/exchange/Add-RecipientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-RecipientPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-recipientpermission applicable: Exchange Online -title: Add-RecipientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-recipientpermission +schema: 2.0.0 +title: Add-RecipientPermission --- # Add-RecipientPermission @@ -44,6 +45,9 @@ This example gives the user Ayla Kol SendAs permission for the mailbox Help Desk ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the target recipient. The user or group specified by the Trustee parameter receives SendAs permission on this recipient. You can specify any type of recipient, for example: @@ -67,7 +71,6 @@ You can use any value that uniquely identifies the recipient. For example: Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Online + The AccessRights parameter specifies the permission that you want to add for the trustee on the target recipient. The only valid value for this parameter is SendAs. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Trustee + +> Applicable: Exchange Online + The Trustee parameter specifies the user or group that receives SendAs permission on the recipient specified by the Identity parameter. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -116,7 +124,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -137,7 +147,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-ResubmitRequest.md b/exchange/exchange-ps/ExchangePowerShell/Add-ResubmitRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Add-ResubmitRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ResubmitRequest.md index d1801a114d..05205b5d59 100644 --- a/exchange/exchange-ps/exchange/Add-ResubmitRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ResubmitRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-resubmitrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-ResubmitRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-resubmitrequest +schema: 2.0.0 +title: Add-ResubmitRequest --- # Add-ResubmitRequest @@ -64,6 +65,9 @@ This example replays the redundant copies of messages delivered from 6:00 PM Jun ## PARAMETERS ### -EndTime + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EndTime parameter specifies the delivery time of the latest messages that need to be resubmitted from Safety Net. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -74,7 +78,6 @@ The date and time specified by the EndTime parameter must be later than the date Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The StartTime parameter specifies the delivery time of the oldest messages that need to be resubmitted from Safety Net. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -94,7 +100,6 @@ The date and time specified by the StartTime parameter must be earlier than the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -113,7 +121,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -CorrelationId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -Destination + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Destination parameter specifies the GUID of the destination mailbox database. To find the GUID of the mailbox database, run the command: `Get-MailboxDatabase -Server | Format-List Name,GUID`. You can't use this parameter with the Recipient, ResubmitTo, or Sender parameters. @@ -147,7 +159,6 @@ You can't use this parameter with the Recipient, ResubmitTo, or Sender parameter Type: Guid Parameter Sets: MDBResubmit Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +168,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: ConditionalResubmit Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +186,9 @@ Accept wildcard characters: False ``` ### -Recipient + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Recipient parameter filters the messages to resubmit from Safety Net by the specified recipient's email address. You can't use this parameter with the Destination parameter. @@ -181,7 +197,6 @@ You can't use this parameter with the Destination parameter. Type: String Parameter Sets: ConditionalResubmit Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +206,15 @@ Accept wildcard characters: False ``` ### -ResubmitTo + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ResubmitTo parameter specifies the recipient's email address for resubmitted messages that are identified by using the Recipient or Sender parameters. ```yaml Type: String Parameter Sets: ConditionalResubmit Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +224,9 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Sender parameter filters the messages to resubmit from Safety Net by the specified sender's email address. You can't use this parameter with the Destination parameter. @@ -215,7 +235,6 @@ You can't use this parameter with the Destination parameter. Type: String Parameter Sets: ConditionalResubmit Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +244,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -238,7 +260,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,13 +269,15 @@ Accept wildcard characters: False ``` ### -TestOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +287,15 @@ Accept wildcard characters: False ``` ### -UnresponsivePrimaryServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UnresponsivePrimaryServers parameter identifies the primary servers that should resubmit the messages from Safety Net as being unavailable so other servers can resubmit the messages. If the primary servers are unavailable, you can designate other servers that hold redundant copies of the messages in Safety Net to resubmit their copies of the messages. However, you must identify the unresponsive primary servers to the other servers using this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +305,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Add-RoleGroupMember.md similarity index 89% rename from exchange/exchange-ps/exchange/Add-RoleGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Add-RoleGroupMember.md index 5f64ff5636..4b06eb4397 100644 --- a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-RoleGroupMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-rolegroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Add-RoleGroupMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-rolegroupmember +schema: 2.0.0 +title: Add-RoleGroupMember --- # Add-RoleGroupMember @@ -73,13 +74,15 @@ This example adds the Training Assistants USG to the Training Administrators rol ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group to add a member to. If the role group name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Member parameter specifies who you want to add to the role group. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -113,7 +119,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -134,7 +142,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -153,7 +163,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -171,7 +183,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -189,7 +203,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Add-ServerMonitoringOverride.md similarity index 90% rename from exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Add-ServerMonitoringOverride.md index 97858e26e8..09faae554b 100644 --- a/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-ServerMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-servermonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Add-ServerMonitoringOverride -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-servermonitoringoverride +schema: 2.0.0 +title: Add-ServerMonitoringOverride --- # Add-ServerMonitoringOverride @@ -52,6 +53,9 @@ This example adds a server monitoring override that disables the responder Activ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the monitoring item that you want to override. This parameter uses the syntax `HealthSet\MonitoringItemName[\TargetResource]`. Note that the values are case sensitive. For example, use `AD\ActiveDirectoryConnectivityConfigDCServerReboot`, not `ad\activedirectoryconnectivityconfigdcserverreboot`. You can use Get-ServerHealth to find the correct object for the monitoring item you want to override. @@ -60,7 +64,6 @@ You can use Get-ServerHealth to find the correct object for the monitoring item Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -ApplyVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ApplyVersion parameter specifies the version of Exchange that gets the override. If you update Exchange to a newer version (for example, you apply a Cumulative Update or Service Pack), the override is no longer applied to the server. Valid input for this parameter is an Exchange version number in the format 15.01.xxxx.xxx. @@ -80,7 +86,6 @@ You can't use this parameter with the Duration parameter. Type: Version Parameter Sets: ApplyVersion Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -ItemType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ItemType parameter specifies the server item type for the property that you want to override. Valid value are: - Probe @@ -100,7 +108,6 @@ The ItemType parameter specifies the server item type for the property that you Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PropertyName parameter specifies the server property that you want to override. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PropertyValue parameter specifies the new value for the server property that you want to override. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to add the monitoring override. You can use any value that uniquely identifies the server. For example: - Name @@ -155,7 +169,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -165,6 +178,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -174,7 +190,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +199,9 @@ Accept wildcard characters: False ``` ### -Duration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Duration parameter specifies the length of time that the override is active. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -196,7 +214,6 @@ You can't use this parameter with the ApplyVersion parameter. Type: EnhancedTimeSpan Parameter Sets: Duration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +223,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md b/exchange/exchange-ps/ExchangePowerShell/Add-UnifiedGroupLinks.md similarity index 95% rename from exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md rename to exchange/exchange-ps/ExchangePowerShell/Add-UnifiedGroupLinks.md index e58e810aba..a4786f7f64 100644 --- a/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-UnifiedGroupLinks.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-unifiedgrouplinks applicable: Exchange Online, Exchange Online Protection -title: Add-UnifiedGroupLinks -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-unifiedgrouplinks +schema: 2.0.0 +title: Add-UnifiedGroupLinks --- # Add-UnifiedGroupLinks @@ -60,6 +61,9 @@ This example shows how to add bulk members to a Microsoft 365 Group. Mailboxes w ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to modify. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to modify Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Links + +> Applicable: Exchange Online, Exchange Online Protection + The Links parameter specifies the recipients to add to the Microsoft 365 Group. You specify whether these recipients are members, owners, or subscribers by using the LinkType parameter. You can use any value that uniquely identifies the recipient. For example: @@ -104,7 +110,6 @@ You must use this parameter with the LinkType parameter, which means the specifi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -LinkType + +> Applicable: Exchange Online, Exchange Online Protection + The LinkType parameter specifies the recipient's role in the Microsoft 365 Group that you want to add. Valid values are: - Members: Participate in conversations, create Teams channels, collaborate on files, and edit the connected SharePoint site. @@ -128,7 +136,6 @@ You must use this parameter with the Links parameter. Type: LinkType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -147,7 +157,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -157,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Add-VivaModuleFeaturePolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Add-VivaModuleFeaturePolicy.md index 340921a576..c3ca0dd9e1 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-VivaModuleFeaturePolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/add-vivamodulefeaturepolicy applicable: Exchange Online -title: Add-VivaModuleFeaturePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-vivamodulefeaturepolicy +schema: 2.0.0 +title: Add-VivaModuleFeaturePolicy --- # Add-VivaModuleFeaturePolicy @@ -19,7 +19,7 @@ Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a spec - You can assign up to 10 policies per feature. An additional one policy per feature can be assigned to the entire tenant. - Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies. -- Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature) cmdlet. +- Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivamodulefeature) cmdlet. Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for. @@ -95,6 +95,9 @@ This example adds a policy for the ShowAISkills feature in Viva Skills. The poli ## PARAMETERS ### -FeatureId + +> Applicable: Exchange Online + The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for. To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. @@ -103,7 +106,6 @@ To view details about the features in a Viva module that support feature access Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -113,6 +115,9 @@ Accept wildcard characters: False ``` ### -IsFeatureEnabled + +> Applicable: Exchange Online + The IsFeatureEnabled parameter specifies whether or not the feature is enabled by the policy. Valid values are: - $true: The feature is enabled by the policy. @@ -122,7 +127,6 @@ The IsFeatureEnabled parameter specifies whether or not the feature is enabled b Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -132,13 +136,15 @@ Accept wildcard characters: False ``` ### -ModuleId + +> Applicable: Exchange Online + The ModuleId parameter specifies the Viva module that you want to add the feature policy for. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -148,6 +154,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the name of the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). Valid characters are English letters, numbers, commas, periods, and spaces. @@ -156,7 +165,6 @@ Valid characters are English letters, numbers, commas, periods, and spaces. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -166,6 +174,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -177,7 +188,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -187,6 +197,9 @@ Accept wildcard characters: False ``` ### -Everyone + +> Applicable: Exchange Online + The Everyone switch specifies that the policy applies to all users in the organization. You don't need to specify a value with this switch. Don't use this switch with the GroupIds or UserIds parameters. @@ -195,7 +208,6 @@ Don't use this switch with the GroupIds or UserIds parameters. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -205,6 +217,9 @@ Accept wildcard characters: False ``` ### -GroupIds + +> Applicable: Exchange Online + The GroupIds parameter specifies the email addresses or security group object IDs (GUIDs) of groups that the updated policy applies to. Both [Mail-enabled and non-mail-enabled Microsoft Entra groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. You can enter multiple values separated by commas. You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). @@ -217,7 +232,6 @@ To have the policy apply to all users in the organization, use the Everyone swit Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -227,6 +241,9 @@ Accept wildcard characters: False ``` ### -IsUserControlEnabled + +> Applicable: Exchange Online + This parameter is available in version 3.3.0 or later of the module. The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: @@ -240,7 +257,6 @@ Only features that allow admins to enable and disable user controls by policy ca Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -250,6 +266,9 @@ Accept wildcard characters: False ``` ### -IsUserOptedInByDefault + +> Applicable: Exchange Online + This parameter is available in version 3.8.0-Preview2 or later of the module. The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are: @@ -265,7 +284,6 @@ This parameter can be set only when the IsUserControlEnabled parameter is set to Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -275,13 +293,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -291,6 +311,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Exchange Online + The UserIds parameter specifies the user principal names (UPNs) of the users that the policy applies to. You can enter multiple values separated by commas. You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). @@ -301,7 +324,6 @@ To have the policy apply to all users in the organization, use the Everyone swit Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -311,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/ExchangePowerShell/Add-VivaOrgInsightsDelegatedRole.md similarity index 94% rename from exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md rename to exchange/exchange-ps/ExchangePowerShell/Add-VivaOrgInsightsDelegatedRole.md index 0bd5527745..3a6604d12d 100644 --- a/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-VivaOrgInsightsDelegatedRole.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/add-vivaorginsightsdelegatedrole -title: Add-VivaOrgInsightsDelegatedRole -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-vivaorginsightsdelegatedrole +schema: 2.0.0 +title: Add-VivaOrgInsightsDelegatedRole --- # Add-VivaOrgInsightsDelegatedRole @@ -47,6 +47,9 @@ This example adds the organization insights viewing capability of the specified ## PARAMETERS ### -Delegate + +> Applicable: Exchange Online + The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). A valid value for this parameter is the Microsoft Entra ObjectId value of the delegate account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. @@ -55,7 +58,6 @@ A valid value for this parameter is the Microsoft Entra ObjectId value of the de Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -Delegator + +> Applicable: Exchange Online + The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is delegated to the account specified by the Delegate parameter. A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. @@ -73,7 +78,6 @@ A valid value for this parameter is the ObjectID value of the delegator account. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -83,13 +87,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/ExchangePowerShell/Add-eDiscoveryCaseAdmin.md similarity index 95% rename from exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md rename to exchange/exchange-ps/ExchangePowerShell/Add-eDiscoveryCaseAdmin.md index ddb6eb30ff..c0127b3b6e 100644 --- a/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/ExchangePowerShell/Add-eDiscoveryCaseAdmin.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/add-ediscoverycaseadmin applicable: Security & Compliance -title: Add-eDiscoveryCaseAdmin -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/add-ediscoverycaseadmin +schema: 2.0.0 +title: Add-eDiscoveryCaseAdmin --- # Add-eDiscoveryCaseAdmin @@ -46,6 +47,9 @@ This example adds an eDiscovery Administrator. ## PARAMETERS ### -User + +> Applicable: Security & Compliance + The User parameter specifies the user that you want to add to the list of eDiscovery Administrators. You can use any value that uniquely identifies the user. For example: - Name @@ -57,7 +61,6 @@ The User parameter specifies the user that you want to add to the list of eDisco Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Check-PurviewConfig.md b/exchange/exchange-ps/ExchangePowerShell/Check-PurviewConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Check-PurviewConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Check-PurviewConfig.md index 831bdea8cb..27692105c9 100644 --- a/exchange/exchange-ps/exchange/Check-PurviewConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Check-PurviewConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/check-purviewconfig applicable: Security & Compliance -title: Check-PurviewConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/check-purviewconfig +schema: 2.0.0 +title: Check-PurviewConfig --- # Check-PurviewConfig @@ -89,6 +90,9 @@ This example runs the specified test cases. A UserPrincipalName value is require ## PARAMETERS ### -Component + +> Applicable: Security & Compliance + The Component parameter specifies the component to analyze in the test case. Valid values are: - DLP @@ -100,7 +104,6 @@ The Component parameter specifies the component to analyze in the test case. Val Type: PurviewConfigComponent Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -119,7 +125,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -129,6 +134,9 @@ Accept wildcard characters: False ``` ### -DateTimeUTC + +> Applicable: Security & Compliance + The DateTimeUTC specifies the date-time of the test case in Coordinated Universal Time (UTC). For example, "2025-06-05 14:30:00". This parameter is required for the following TestCases values: @@ -140,7 +148,6 @@ This parameter is required for the following TestCases values: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -150,13 +157,15 @@ Accept wildcard characters: False ``` ### -File + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 2 @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -IncidentId + +> Applicable: Security & Compliance + The IncidentId parameter specifies the incident to analyze in the test case. You can find a value for this parameter in audit log searches filtered by the operation DLPRuleMatch in the IncidentId property. @@ -176,7 +188,6 @@ This parameter is required for the TestCases value DlpAlerts_FindAlertForActivit Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 3 @@ -186,13 +197,15 @@ Accept wildcard characters: False ``` ### -ItemId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 4 @@ -202,13 +215,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 5 @@ -218,6 +233,9 @@ Accept wildcard characters: False ``` ### -RecordId + +> Applicable: Security & Compliance + The RuleName parameter specifies the record to analyze in the test case. You can find a value for this parameter in Activity Explorer filtered by the activity type DLPRuleMatch in the RecordId property. @@ -228,7 +246,6 @@ This parameter is optional with the TestCases value DlpAlerts_FindAlertForActivi Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 6 @@ -238,6 +255,9 @@ Accept wildcard characters: False ``` ### -RuleName + +> Applicable: Security & Compliance + The RuleName parameter specifies the DLP rule to analyze in the test case. This parameter is optional with the TestCases value DlpAlerts_CheckAlertsCreated. @@ -246,7 +266,6 @@ This parameter is optional with the TestCases value DlpAlerts_CheckAlertsCreated Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 7 @@ -256,6 +275,9 @@ Accept wildcard characters: False ``` ### -TestCases + +> Applicable: Security & Compliance + The TestCases parameter specifies the name of the test case to analyze. The available test cases and their required parameters are described in the following list: - **Encryption_EvaluationDetails**: Validates email encryption evaluation details. No other parameters are required. @@ -272,7 +294,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 8 @@ -282,6 +303,9 @@ Accept wildcard characters: False ``` ### -Theme + +> Applicable: Security & Compliance + The Theme parameter filters specifies the them to analyze in the test case. Valid values are: - EnabledEntities @@ -292,7 +316,6 @@ The Theme parameter filters specifies the them to analyze in the test case. Vali Type: PurviewConfigTheme Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 9 @@ -302,6 +325,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Security & Compliance + The UserPrincipalName parameter specifies the user account to analyze in the test case (for example, `sathya@contoso.onmicrosoft.com`). - Required for the TestCases value MipLabels_EnabledEntities_ScopedLabels. @@ -311,7 +337,6 @@ The UserPrincipalName parameter specifies the user account to analyze in the tes Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 10 @@ -321,13 +346,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -337,6 +364,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Security & Compliance + The Workload parameter specifies the service workload. Value values are: - EndpointDevices @@ -351,7 +381,6 @@ This parameter is required for the TestCases value DLP_ScopedEntities. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 11 diff --git a/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Clean-MailboxDatabase.md similarity index 96% rename from exchange/exchange-ps/exchange/Clean-MailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Clean-MailboxDatabase.md index 9e3829eb4e..feca97fac4 100644 --- a/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Clean-MailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/clean-mailboxdatabase applicable: Exchange Server 2010 -title: Clean-MailboxDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/clean-mailboxdatabase +schema: 2.0.0 +title: Clean-MailboxDatabase --- # Clean-MailboxDatabase @@ -49,6 +50,9 @@ This example cleans the mailbox database MBD01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the mailbox database that you want to update. You can use any value that uniquely identifies the database. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the mailbox database that you want to update. Y Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -96,7 +104,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md b/exchange/exchange-ps/ExchangePowerShell/Clear-ActiveSyncDevice.md similarity index 89% rename from exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Clear-ActiveSyncDevice.md index f729195ad5..bf8643a66b 100644 --- a/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Clear-ActiveSyncDevice.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/clear-activesyncdevice applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Clear-ActiveSyncDevice -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/clear-activesyncdevice +schema: 2.0.0 +title: Clear-ActiveSyncDevice --- # Clear-ActiveSyncDevice @@ -65,13 +66,15 @@ This example cancels a previously sent Clear-ActiveSyncDevice command request fo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the device that you want to reset. ```yaml Type: ActiveSyncDeviceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -Cancel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Cancel switch specifies whether to issue a cancellation request for a pending remote device wipe. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -108,7 +116,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -126,7 +136,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Clear-MobileDevice.md b/exchange/exchange-ps/ExchangePowerShell/Clear-MobileDevice.md similarity index 91% rename from exchange/exchange-ps/exchange/Clear-MobileDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Clear-MobileDevice.md index 9a5eda7425..0c9f6522b3 100644 --- a/exchange/exchange-ps/exchange/Clear-MobileDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Clear-MobileDevice.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/clear-mobiledevice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Clear-MobileDevice -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/clear-mobiledevice +schema: 2.0.0 +title: Clear-MobileDevice --- # Clear-MobileDevice @@ -64,6 +65,9 @@ This example cancels a previously sent Clear-MobileDevice command request for th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mobile device that you want to reset. You can use the following values that uniquely identifies the mobile device: - Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) @@ -74,7 +78,6 @@ The Identity parameter specifies the mobile device that you want to reset. You c Type: MobileDeviceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -AccountOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AccountOnly switch specifies whether to perform an account-only remote device wipe where only Exchange mailbox data is removed from the device. You don't need to specify a value with this switch. You don't need to use this switch for the DeviceType value Outlook, because an account-only remote device wipe is the only type of wipe that's used on Outlook devices. @@ -92,7 +98,6 @@ You don't need to use this switch for the DeviceType value Outlook, because an a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -Cancel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Cancel switch specifies whether to issue a cancellation request for a pending remote device wipe. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -129,7 +139,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -147,7 +159,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +168,15 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -173,13 +186,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md b/exchange/exchange-ps/ExchangePowerShell/Clear-TextMessagingAccount.md similarity index 89% rename from exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md rename to exchange/exchange-ps/ExchangePowerShell/Clear-TextMessagingAccount.md index 0cfbdb03d1..8a3a2a9579 100644 --- a/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md +++ b/exchange/exchange-ps/ExchangePowerShell/Clear-TextMessagingAccount.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/clear-textmessagingaccount applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Clear-TextMessagingAccount -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/clear-textmessagingaccount +schema: 2.0.0 +title: Clear-TextMessagingAccount --- # Clear-TextMessagingAccount @@ -46,6 +47,9 @@ This example clears the text messaging account settings and notification setting ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the target mailbox. You can any value that uniquely identifies the mailbox. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the target mailbox. You can any value that uniq Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -100,7 +108,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -121,7 +131,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md b/exchange/exchange-ps/ExchangePowerShell/Compare-TextMessagingVerificationCode.md similarity index 89% rename from exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md rename to exchange/exchange-ps/ExchangePowerShell/Compare-TextMessagingVerificationCode.md index c536c48908..1eb6f7ca40 100644 --- a/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md +++ b/exchange/exchange-ps/ExchangePowerShell/Compare-TextMessagingVerificationCode.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/compare-textmessagingverificationcode applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Compare-TextMessagingVerificationCode -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/compare-textmessagingverificationcode +schema: 2.0.0 +title: Compare-TextMessagingVerificationCode --- # Compare-TextMessagingVerificationCode @@ -61,6 +62,9 @@ This example compares the verification code 111555 to the code sent to Tony Smit ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox where you are trying to enable text messaging notifications. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -78,7 +82,6 @@ The Identity parameter specifies the mailbox where you are trying to enable text Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -VerificationCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The VerificationCode parameter contains the verification code that the user specified. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -113,7 +121,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -131,7 +141,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,13 +150,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Complete-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Complete-MigrationBatch.md similarity index 92% rename from exchange/exchange-ps/exchange/Complete-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Complete-MigrationBatch.md index 922eeca5b8..a47891ea77 100644 --- a/exchange/exchange-ps/exchange/Complete-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Complete-MigrationBatch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/complete-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Complete-MigrationBatch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/complete-migrationbatch +schema: 2.0.0 +title: Complete-MigrationBatch --- # Complete-MigrationBatch @@ -59,13 +60,15 @@ This example completes the migration batch LocalMove1 and sends a notification e ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the migration batch that you want to complete. The value for this parameter is specified by the Name parameter for the New-MigrationBatch cmdlet. Use the Get-MigrationBatch cmdlet to determine the value of this parameter for the migration batch. ```yaml Type: MigrationBatchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -CompletePublicFolderMigrationWithDataLoss + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -83,7 +89,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -104,7 +112,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -122,7 +132,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -NotificationEmails + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The NotificationEmails parameter specifies one or more email addresses that status reports are sent to after the migration batch is completed. You can specify multiple email addresses separated by commas. @@ -142,7 +154,6 @@ If you don't use this parameter, the final status report is sent to the administ Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -160,7 +174,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -SyncAndComplete + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SyncAndComplete switch specifies whether to trigger a synchronization immediately followed by a completion of the migration batch if the synchronization was successful. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/ExchangePowerShell/Connect-ExchangeOnline.md similarity index 95% rename from exchange/exchange-ps/exchange/Connect-ExchangeOnline.md rename to exchange/exchange-ps/ExchangePowerShell/Connect-ExchangeOnline.md index 241205492f..04e48a420d 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/ExchangePowerShell/Connect-ExchangeOnline.md @@ -1,13 +1,13 @@ --- -external help file: ExchangeOnlineManagement-help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/connect-exchangeonline applicable: Exchange Online -title: Connect-ExchangeOnline -schema: 2.0.0 author: chrisda +external help file: ExchangeOnlineManagement-help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/connect-exchangeonline +schema: 2.0.0 +title: Connect-ExchangeOnline --- # Connect-ExchangeOnline @@ -17,7 +17,7 @@ This cmdlet is available only in the Exchange Online PowerShell module. For more Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to use modern authentication to connect to Exchange Online PowerShell or Exchange Online Protection PowerShell for cloud protection of on-premises email environments. This cmdlet works for accounts with or without multi-factor authentication (MFA). -To connect to Security & Compliance PowerShell, use the [Connect-IPPSSession](https://learn.microsoft.com/powershell/module/exchange/connect-ippssession) cmdlet. +To connect to Security & Compliance PowerShell, use the [Connect-IPPSSession](https://learn.microsoft.com/powershell/module/exchangepowershell/connect-ippssession) cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -111,6 +111,9 @@ In PowerShell 7.0.3 or later using version 2.0.4 or later of the module, this ex ## PARAMETERS ### -ConnectionUri + +> Applicable: Exchange Online + **Note**: If you use the ExchangeEnvironmentName parameter, you don't need to use the AzureADAuthorizationEndpointUri or ConnectionUri parameters. The ConnectionUri parameter specifies the connection endpoint for the PowerShell session. The following Exchange Online PowerShell environments and related values are supported: @@ -125,7 +128,6 @@ The ConnectionUri parameter specifies the connection endpoint for the PowerShell Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -135,6 +137,9 @@ Accept wildcard characters: False ``` ### -AzureADAuthorizationEndpointUri + +> Applicable: Exchange Online + **Note**: If you use the ExchangeEnvironmentName parameter, you don't need to use the AzureADAuthorizationEndpointUri or ConnectionUri parameters. The AzureADAuthorizationEndpointUri parameter specifies the Microsoft Entra Authorization endpoint that can issue OAuth2 access tokens. The following Exchange Online PowerShell environments and related values are supported: @@ -151,7 +156,6 @@ If you use the UserPrincipalName parameter, you don't need to use the AzureADAut Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -161,6 +165,9 @@ Accept wildcard characters: False ``` ### -ExchangeEnvironmentName + +> Applicable: Exchange Online + The ExchangeEnvironmentName specifies the Exchange Online environment and eliminates the need to use the AzureADAuthorizationEndpointUri and ConnectionUri parameters. The following Exchange Online PowerShell environments are supported: - Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `O365Default`, but that's also the default value, so you don't need to use this parameter. @@ -173,7 +180,6 @@ The ExchangeEnvironmentName specifies the Exchange Online environment and elimin Type: ExchangeEnvironment Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 @@ -183,6 +189,9 @@ Accept wildcard characters: False ``` ### -PSSessionOption + +> Applicable: Exchange Online + **Note**: This parameter doesn't work in REST API connections. The PSSessionOption parameter specifies the PowerShell session options to use in your connection to Exchange Online. This parameter works only if you also use the UseRPSSession switch in the same command. @@ -193,7 +202,6 @@ Store the output of the [New-PSSessionOption](https://learn.microsoft.com/powers Type: PSSessionOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 3 @@ -203,6 +211,9 @@ Accept wildcard characters: False ``` ### -DelegatedOrganization + +> Applicable: Exchange Online + The DelegatedOrganization parameter specifies the customer organization that you want to manage. A valid value for this parameter is the primary .onmicrosoft.com domain or tenant ID of the customer organization. This parameter works only if the customer organization has agreed to your delegated management via the CSP program. @@ -213,7 +224,6 @@ After you successfully authenticate, the cmdlets in this session are mapped to t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 4 @@ -223,6 +233,9 @@ Accept wildcard characters: False ``` ### -Prefix + +> Applicable: Exchange Online + The Prefix parameter specifies a text value to add to the names of Exchange Online PowerShell cmdlets when you connect. For example, Get-InboundConnector becomes Get-ContosoInboundConnector when you use the value Contoso for this parameter. - The Prefix value can't contain spaces or special characters like underscores or asterisks. @@ -233,7 +246,6 @@ The Prefix parameter specifies a text value to add to the names of Exchange Onli Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 5 @@ -243,13 +255,15 @@ Accept wildcard characters: False ``` ### -CommandName + +> Applicable: Exchange Online + The CommandName parameter specifies the comma separated list of commands to import into the session. Use this parameter for applications or scripts that use a specific set of cmdlets. Reducing the number of cmdlets in the session helps improve performance and reduces the memory footprint of the application or script. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 6 @@ -259,13 +273,15 @@ Accept wildcard characters: False ``` ### -FormatTypeName + +> Applicable: Exchange Online + The FormatTypeName parameter specifies the output format of the cmdlet. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 7 @@ -275,6 +291,9 @@ Accept wildcard characters: False ``` ### -AccessToken + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.1.0 or later of the module. The AccessToken parameter specifies the OAuth JSON Web Token (JWT) that's used to connect to Exchange Online. @@ -285,7 +304,6 @@ Depending on the type of access token, you need to use this parameter with the O Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -295,6 +313,9 @@ Accept wildcard characters: False ``` ### -AppId + +> Applicable: Exchange Online + The AppId parameter specifies the application ID of the service principal that's used in certificate based authentication (CBA). A valid value is the GUID of the application ID (service principal). For example, `36ee4c6c-0812-40a2-b820-b22ebd02bce3`. For more information, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). @@ -303,7 +324,6 @@ For more information, see [App-only authentication for unattended scripts in the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -313,13 +333,15 @@ Accept wildcard characters: False ``` ### -BypassMailboxAnchoring + +> Applicable: Exchange Online + The BypassMailboxAnchoring switch bypasses the use of the mailbox anchoring hint. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -329,6 +351,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: Exchange Online + The Certificate parameter specifies the certificate that's used for certificate-based authentication (CBA). A valid value is the X509Certificate2 object value of the certificate. Don't use this parameter with the CertificateFilePath or CertificateThumbprint parameters. @@ -339,7 +364,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: X509Certificate2 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -349,6 +373,9 @@ Accept wildcard characters: False ``` ### -CertificateFilePath + +> Applicable: Exchange Online + The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter. Don't use this parameter with the Certificate or CertificateThumbprint parameters. @@ -359,7 +386,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -369,6 +395,9 @@ Accept wildcard characters: False ``` ### -CertificatePassword + +> Applicable: Exchange Online + The CertificatePassword parameter specifies the password that's required to open the certificate file when you use the CertificateFilePath parameter to identify the certificate that's used for CBA. You can use the following methods as a value for this parameter: @@ -385,7 +414,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -395,6 +423,9 @@ Accept wildcard characters: False ``` ### -CertificateThumbprint + +> Applicable: Exchange Online + The CertificateThumbprint parameter specifies the certificate that's used for CBA. A valid value is the thumbprint value of the certificate. For example, `83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1`. Don't use this parameter with the Certificate or CertificateFilePath parameters. @@ -407,7 +438,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -417,6 +447,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Online + The Credential parameter specifies the username and password that's used to connect to Exchange Online PowerShell. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. Don't use this parameter for accounts that use multi-factor authentication (MFA). Before you run the Connect-ExchangeOnline command, store the username and password in a variable (for example, `$UserCredential = Get-Credential`). Then, use the variable name (`$UserCredential`) for this parameter. @@ -429,7 +462,6 @@ To specify the password for a certificate file, don't use this parameter; use th Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -439,6 +471,9 @@ Accept wildcard characters: False ``` ### -Device + +> Applicable: Exchange Online + **Note**: This parameter is available in version 2.0.4 or later of the module, and only in PowerShell 7. The Device switch is typically used on computers without web browsers. You don't need to specify a value with this switch. @@ -451,7 +486,6 @@ If your login was successful, the PowerShell connection continues. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -461,6 +495,9 @@ Accept wildcard characters: False ``` ### -DisableWAM + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.7.2-Preview1 or later of the module. The DisableWAM switch disables Web Account Manager (WAM). You don't need to specify a value with this switch. @@ -471,7 +508,6 @@ Starting in version 3.7.0, WAM is enabled by default when connecting to Exchange Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -481,13 +517,15 @@ Accept wildcard characters: False ``` ### -EnableErrorReporting + +> Applicable: Exchange Online + The EnableErrorReporting switch specifies whether to enable error reporting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -497,6 +535,9 @@ Accept wildcard characters: False ``` ### -InlineCredential + +> Applicable: Exchange Online + **Note**: This parameter is available in version 2.0.4 or later of the module, and only in PowerShell 7. The InlineCredential switch specifies whether to pass credentials directly in the Windows PowerShell window. You don't need to specify a value with this switch. @@ -509,7 +550,6 @@ This switch does not work with accounts that use MFA. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -519,6 +559,9 @@ Accept wildcard characters: False ``` ### -LoadCmdletHelp + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.7.0-Preview1 or later of the module. The LoadCmdletHelp switch downloads cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch. @@ -531,7 +574,6 @@ Starting in v3.7.0-Preview1, help files for the command line aren't downloaded b Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -541,6 +583,9 @@ Accept wildcard characters: False ``` ### -LogDirectoryPath + +> Applicable: Exchange Online + The LogDirectoryPath parameter specifies the location of the log files. The default location is `%TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv`. If you specify a custom location and filename that contains spaces, enclose the value in quotation marks ("). @@ -549,7 +594,6 @@ If you specify a custom location and filename that contains spaces, enclose the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -559,13 +603,15 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Online + The LogLevel parameter specifies the logging level. Valid values are Default and All. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -575,6 +621,9 @@ Accept wildcard characters: False ``` ### -ManagedIdentity + +> Applicable: Exchange Online + The ManagedIdentity switch specifies that you're using managed identity to connect. You don't need to specify a value with this switch. Managed identity connections are currently supported for the following types of Azure resources: @@ -594,7 +643,6 @@ For more information about connecting with managed identity, see [Use Azure mana Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -604,6 +652,9 @@ Accept wildcard characters: False ``` ### -ManagedIdentityAccountId + +> Applicable: Exchange Online + The ManagedIdentityAccountId parameter specifies the user-assigned managed identity that you're using to connect. A valid value for this parameter is the application ID (GUID) of the service principal that corresponds to the user-assigned managed identity in Azure. You must use this parameter with the Organization parameter and the ManagedIdentity switch. @@ -614,7 +665,6 @@ For more information about connecting with managed identity, see [Use Azure mana Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -624,6 +674,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + The Organization parameter specifies the organization when you connect using CBA or managed identity. A valid value for this parameter is the primary .onmicrosoft.com domain or tenant ID of the organization. For more information about connecting with CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). @@ -634,7 +687,6 @@ For more information about connecting with managed identity, see [Use Azure mana Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -644,13 +696,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 1000. The default value is 1000. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -660,6 +714,9 @@ Accept wildcard characters: False ``` ### -ShowBanner + +> Applicable: Exchange Online + The ShowBanner switch shows or hides the banner message that's displayed when you run Connect-ExchangeOnline. You don't need to specify a value with this switch. - To show the banner, you don't need to use this switch (the banner is displayed by default). @@ -669,7 +726,6 @@ The ShowBanner switch shows or hides the banner message that's displayed when yo Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -679,6 +735,9 @@ Accept wildcard characters: False ``` ### -ShowProgress + +> Applicable: Exchange Online + The ShowProgress parameter specifies whether to show or hide the progress bar of imported cmdlets when you connect. Valid values are: - $true: The progress bar is displayed. This is the default value. @@ -688,7 +747,6 @@ The ShowProgress parameter specifies whether to show or hide the progress bar of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -698,6 +756,9 @@ Accept wildcard characters: False ``` ### -SigningCertificate + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.2.0 or later of the module. The SigningCertificate parameter specifies the client certificate that's used to sign the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that Connect-ExchangeOnline creates. @@ -710,7 +771,6 @@ To find the certificate, use the Get-PfxCertificate cmdlet in the Microsoft.Powe Type: X509Certificate2 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -720,6 +780,9 @@ Accept wildcard characters: False ``` ### -SkipLoadingCmdletHelp + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.3.0 or later of the module. In version 3.7.0-Preview1 or later, this parameter is replaced by the LoadCmdletHelp parameter. The SkipLoadingCmdletHelp parameter is no longer required and no longer does anything, because cmdlet help files are no longer downloaded by default. Eventually, this parameter will be retired, so remove it from any scripts. @@ -734,7 +797,6 @@ This switch doesn't work with the UseRPSSession switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -744,6 +806,9 @@ Accept wildcard characters: False ``` ### -SkipLoadingFormatData + +> Applicable: Exchange Online + The SkipLoadingFormatData switch prevents downloading the format data for REST API connections. You don't need to specify a value with this switch. When you use this switch, the output of any Exchange cmdlet will be unformatted. @@ -756,7 +821,6 @@ This switch doesn't work with the UseRPSSession switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -766,6 +830,9 @@ Accept wildcard characters: False ``` ### -TrackPerformance + +> Applicable: Exchange Online + The TrackPerformance parameter measures additional events (for example, CPU load and memory consumed). Valid values are: - $true: Performance tracking is enabled. @@ -777,7 +844,6 @@ This parameter works only when logging is enabled. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -787,6 +853,9 @@ Accept wildcard characters: False ``` ### -UseMultithreading + +> Applicable: Exchange Online + The UseMultithreading parameter specifies whether to disable or enable multi-threading in the Exchange Online PowerShell module. Valid values are: - $true: Enable multi-threading. This is the default value. @@ -796,7 +865,6 @@ The UseMultithreading parameter specifies whether to disable or enable multi-thr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -806,6 +874,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter specifies the account that you want to use to connect (for example, `navin@contoso.onmicrosoft.com`). Using this parameter allows you to skip entering a username in the modern authentication credentials prompt (you're prompted to enter a password). If you use the UserPrincipalName parameter, you don't need to use the AzureADAuthorizationEndpointUri parameter for MFA or federated users in environments that normally require it (UserPrincipalName or AzureADAuthorizationEndpointUri is required; OK to use both). @@ -814,7 +885,6 @@ If you use the UserPrincipalName parameter, you don't need to use the AzureADAut Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -824,6 +894,9 @@ Accept wildcard characters: False ``` ### -UseRPSSession + +> Applicable: Exchange Online + **Note**: Remote PowerShell connections to Exchange Online PowerShell are deprecated. For more information, see [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). The UseRPSSession switch allows you to connect to Exchange Online PowerShell using traditional remote PowerShell access to all cmdlets. You don't need to specify a value with this switch. @@ -836,7 +909,6 @@ If you don't use this switch, REST API mode is used for the connection, so Basic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/ExchangePowerShell/Connect-IPPSSession.md similarity index 96% rename from exchange/exchange-ps/exchange/Connect-IPPSSession.md rename to exchange/exchange-ps/ExchangePowerShell/Connect-IPPSSession.md index a260cad194..1fdc9b65e9 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/ExchangePowerShell/Connect-IPPSSession.md @@ -1,13 +1,13 @@ --- -external help file: ExchangeOnlineManagement-help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/connect-ippssession applicable: Exchange Online -title: Connect-IPPSSession -schema: 2.0.0 author: chrisda +external help file: ExchangeOnlineManagement-help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/connect-ippssession +schema: 2.0.0 +title: Connect-IPPSSession --- # Connect-IPPSSession @@ -82,6 +82,9 @@ This example connects to Security & Compliance PowerShell in an unattended scrip ## PARAMETERS ### -ConnectionUri + +> Applicable: Exchange Online + The ConnectionUri parameter specifies the connection endpoint for the PowerShell session. The following PowerShell environments and related values are supported: - Security & Compliance PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://ps.compliance.protection.outlook.com/powershell-liveid/`, but that's also the default value, so you don't need to use this parameter. @@ -93,7 +96,6 @@ The ConnectionUri parameter specifies the connection endpoint for the PowerShell Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -103,6 +105,9 @@ Accept wildcard characters: False ``` ### -AzureADAuthorizationEndpointUri + +> Applicable: Exchange Online + The AzureADAuthorizationEndpointUri parameter specifies the Microsoft Entra Authorization endpoint that can issue OAuth2 access tokens. The following PowerShell environments and related values are supported: - Security & Compliance PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://login.microsoftonline.com/common`, but that's also the default value, so you don't need to use this parameter. @@ -115,7 +120,6 @@ If you use the UserPrincipalName parameter, you don't need to use the AzureADAut Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -125,6 +129,9 @@ Accept wildcard characters: False ``` ### -DelegatedOrganization + +> Applicable: Exchange Online + The DelegatedOrganization parameter specifies the customer organization that you want to manage (for example, contosoelectronics.onmicrosoft.com). This parameter works only if the customer organization has agreed to your delegated management via the CSP program. After you successfully authenticate, the cmdlets in this session are mapped to the customer organization, and all operations in this session are done on the customer organization. @@ -138,7 +145,6 @@ After you successfully authenticate, the cmdlets in this session are mapped to t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 @@ -148,6 +154,9 @@ Accept wildcard characters: False ``` ### -PSSessionOption + +> Applicable: Exchange Online + **Note**: This parameter doesn't work in REST API connections. The PSSessionOption parameter specifies the remote PowerShell session options to use in your connection to Security & Compliance PowerShell. This parameter works only if you also use the UseRPSSession switch in the same command. @@ -158,7 +167,6 @@ Store the output of the [New-PSSessionOption](https://learn.microsoft.com/powers Type: PSSessionOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 3 @@ -168,6 +176,9 @@ Accept wildcard characters: False ``` ### -Prefix + +> Applicable: Exchange Online + The Prefix parameter specifies a text value to add to the names of Security & Compliance PowerShell cmdlets when you connect. For example, Get-ComplianceCase becomes Get-ContosoComplianceCase when you use the value Contoso for this parameter. - The Prefix value can't contain spaces or special characters like underscores or asterisks. @@ -178,7 +189,6 @@ The Prefix parameter specifies a text value to add to the names of Security & Co Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 4 @@ -188,13 +198,15 @@ Accept wildcard characters: False ``` ### -CommandName + +> Applicable: Exchange Online + The CommandName parameter specifies the comma separated list of commands to import into the session. Use this parameter for applications or scripts that use a specific set of cmdlets. Reducing the number of cmdlets in the session helps improve performance and reduces the memory footprint of the application or script. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 5 @@ -204,13 +216,15 @@ Accept wildcard characters: False ``` ### -FormatTypeName + +> Applicable: Exchange Online + The FormatTypeName parameter specifies the output format of the cmdlet. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 6 @@ -220,6 +234,9 @@ Accept wildcard characters: False ``` ### -AccessToken + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.8.0-Preview1 or later of the module. The AccessToken parameter specifies the OAuth JSON Web Token (JWT) that's used to connect to Security and Compliance PowerShell. @@ -230,7 +247,6 @@ Depending on the type of access token, you need to use this parameter with the O Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -240,6 +256,9 @@ Accept wildcard characters: False ``` ### -AppId + +> Applicable: Exchange Online + The AppId parameter specifies the application ID of the service principal that's used in certificate based authentication (CBA). A valid value is the GUID of the application ID (service principal). For example, `36ee4c6c-0812-40a2-b820-b22ebd02bce3`. For more information, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). @@ -248,7 +267,6 @@ For more information, see [App-only authentication for unattended scripts in the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -258,13 +276,15 @@ Accept wildcard characters: False ``` ### -BypassMailboxAnchoring + +> Applicable: Exchange Online + The BypassMailboxAnchoring switch bypasses the use of the mailbox anchoring hint. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -274,6 +294,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: Exchange Online + The Certificate parameter specifies the certificate that's used for certificate-based authentication (CBA). A valid value is the X509Certificate2 object value of the certificate. Don't use this parameter with the CertificateFilePath or CertificateThumbprint parameters. @@ -284,7 +307,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: X509Certificate2 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -294,6 +316,9 @@ Accept wildcard characters: False ``` ### -CertificateFilePath + +> Applicable: Exchange Online + The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter. Don't use this parameter with the Certificate or CertificateThumbprint parameters. @@ -304,7 +329,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -314,6 +338,9 @@ Accept wildcard characters: False ``` ### -CertificatePassword + +> Applicable: Exchange Online + The CertificatePassword parameter specifies the password that's required to open the certificate file when you use the CertificateFilePath parameter to identify the certificate that's used for CBA. You can use the following methods as a value for this parameter: @@ -330,7 +357,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -340,6 +366,9 @@ Accept wildcard characters: False ``` ### -CertificateThumbprint + +> Applicable: Exchange Online + The CertificateThumbprint parameter specifies the certificate that's used for CBA. A valid value is the thumbprint value of the certificate. For example, `83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1`. Don't use this parameter with the Certificate or CertificateFilePath parameters. @@ -352,7 +381,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -362,6 +390,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Online + The Credential parameter specifies the username and password that's used to connect to Exchange Online PowerShell. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. Don't use this parameter for accounts that use multi-factor authentication (MFA). Before you run the Connect-IPPSSession command, store the username and password in a variable (for example, `$UserCredential = Get-Credential`). Then, use the variable name (`$UserCredential`) for this parameter. @@ -372,7 +403,6 @@ After the Connect-IPPSSession command is complete, the password key in the varia Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -382,6 +412,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + The Organization parameter specifies the organization when you connect using CBA. You must use the primary .onmicrosoft.com domain of the organization for the value of this parameter. For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). @@ -390,7 +423,6 @@ For more information about CBA, see [App-only authentication for unattended scri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -400,6 +432,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter specifies the account that you want to use to connect (for example, navin@contoso.onmicrosoft.com). Using this parameter allows you to skip entering a username in the modern authentication credentials prompt (you're prompted to enter a password). If you use the UserPrincipalName parameter, you don't need to use the AzureADAuthorizationEndpointUri parameter for MFA or federated users in environments that normally require it (UserPrincipalName or AzureADAuthorizationEndpointUri is required; OK to use both). @@ -408,7 +443,6 @@ If you use the UserPrincipalName parameter, you don't need to use the AzureADAut Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -418,6 +452,9 @@ Accept wildcard characters: False ``` ### -UseRPSSession + +> Applicable: Exchange Online + This parameter is available in version 3.2.0 or later of the module. **Note**: Remote PowerShell connections to Security & Compliance are deprecated. For more information, see [Deprecation of Remote PowerShell in Security and Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). @@ -432,7 +469,6 @@ If you don't use this switch, Basic authentication in WinRM is not required. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Connect-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Connect-Mailbox.md similarity index 89% rename from exchange/exchange-ps/exchange/Connect-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Connect-Mailbox.md index 87bea6279a..cb4c8cfa49 100644 --- a/exchange/exchange-ps/exchange/Connect-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Connect-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/connect-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Connect-Mailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/connect-mailbox +schema: 2.0.0 +title: Connect-Mailbox --- # Connect-Mailbox @@ -166,6 +167,9 @@ This example connects a room mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox that you want to connect to a user account. This parameter doesn't specify an Active Directory object. You can use the following values to identify the mailbox: - Display name @@ -178,7 +182,6 @@ You use this parameter with the Database parameter to specify the mailbox that y Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -188,6 +191,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Database parameter specifies the Exchange database that contains the mailbox that you want to connect. You can use any value that uniquely identifies the database. For example: - Name @@ -200,7 +206,6 @@ You use this parameter with the Identity parameter to specify the mailbox that y Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 2 @@ -210,6 +215,9 @@ Accept wildcard characters: False ``` ### -Equipment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Equipment switch is required to connect equipment mailboxes. You don't need to specify a value with this switch. Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers). @@ -218,7 +226,6 @@ Equipment mailboxes are resource mailboxes that aren't associated with a specifi Type: SwitchParameter Parameter Sets: Equipment Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -228,6 +235,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if the mailbox is a linked mailbox. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter. Use the fully qualified domain name (FQDN) of the domain controller that you want to use as the value for this parameter. This parameter is required only if you're connecting a linked mailbox. @@ -236,7 +246,6 @@ This parameter is required only if you're connecting a linked mailbox. Type: Fqdn Parameter Sets: Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -246,6 +255,9 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if this mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. This parameter is required only if you're creating a linked mailbox. You can use any value that uniquely identifies the master account. For example: - Name @@ -259,7 +271,6 @@ This parameter is required only if you're connecting a linked mailbox. Type: UserIdParameter Parameter Sets: Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -269,6 +280,9 @@ Accept wildcard characters: False ``` ### -Room + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Room switch is required to connect room mailboxes. You don't need to specify a value with this switch. Room mailboxes are resource mailboxes that are associated with a specific location (for example, conference rooms). @@ -277,7 +291,6 @@ Room mailboxes are resource mailboxes that are associated with a specific locati Type: SwitchParameter Parameter Sets: Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -287,6 +300,9 @@ Accept wildcard characters: False ``` ### -Shared + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Shared switch is required to connect shared mailboxes. You don't need to specify a value with this switch. A shared mailbox is a mailbox where multiple users can log on to access the mailbox contents. This mailbox isn't associated with any of the users that can log on. It's associated with a disabled user account. @@ -295,7 +311,6 @@ A shared mailbox is a mailbox where multiple users can log on to access the mail Type: SwitchParameter Parameter Sets: Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -305,6 +320,9 @@ Accept wildcard characters: False ``` ### -ValidateOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. You don't need to specify a value with this switch. No changes are made when you use this switch. @@ -313,7 +331,6 @@ No changes are made when you use this switch. Type: SwitchParameter Parameter Sets: ValidateOnly Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -323,6 +340,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveSyncMailboxPolicy parameter specifies the mobile device mailbox policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example:. - Name @@ -335,7 +355,6 @@ If you don't use this parameter, the default mobile device mailbox policy is use Type: MailboxPolicyIdParameter Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -345,6 +364,9 @@ Accept wildcard characters: False ``` ### -AddressBookPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AddressBookPolicy parameter specifies the address book policy that's applied to the mailbox. You can use any value that uniquely identifies the address book policy. For example: - Name @@ -357,7 +379,6 @@ For more information about address book policies, see [Address book policies in Type: AddressBookMailboxPolicyIdParameter Parameter Sets: User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -367,6 +388,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -391,7 +415,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -401,13 +424,15 @@ Accept wildcard characters: False ``` ### -AllowLegacyDNMismatch + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: User Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -417,13 +442,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Archive switch specifies whether to connect the associated archive mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +460,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -442,7 +472,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -452,13 +481,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,6 +499,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -476,7 +510,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -486,6 +519,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LinkedCredential parameter specifies the credentials used to access the domain controller that's specified by the LinkedDomainController parameter. This parameter is optional, even if you're connecting a linked mailbox. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -494,7 +530,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -504,13 +539,15 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -520,13 +557,15 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicyAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -536,6 +575,9 @@ Accept wildcard characters: False ``` ### -RetentionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RetentionPolicy parameter specifies the retention policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example: - Name @@ -548,7 +590,6 @@ Retention policies consist of tags that are applied to mailbox folders and mail Type: MailboxPolicyIdParameter Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -558,6 +599,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The User parameter specifies the user object in Active Directory that you want to connect the mailbox to. For the best results, we recommend using the following values: @@ -578,7 +622,6 @@ If you don't use this parameter, the command uses the LegacyExchangeDN and Displ Type: UserIdParameter Parameter Sets: Equipment, Linked, Room, Shared, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -588,13 +631,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/ExchangePowerShell/Delete-QuarantineMessage.md similarity index 88% rename from exchange/exchange-ps/exchange/Delete-QuarantineMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Delete-QuarantineMessage.md index 3dc21e421f..4fb377a2a5 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Delete-QuarantineMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/delete-quarantinemessage applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Delete-QuarantineMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/delete-quarantinemessage +schema: 2.0.0 +title: Delete-QuarantineMessage --- # Delete-QuarantineMessage @@ -76,6 +77,9 @@ This example deletes all quarantined messages. The Identity parameter is require ## PARAMETERS ### -Identities + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2...valueN`. Each value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. @@ -86,7 +90,6 @@ When you use this parameter, the Identity parameter is required, but the value i Type: QuarantineMessageIdentity[] Parameter Sets: Identities Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -96,15 +99,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the quarantined message that you want to delete. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. ```yaml Type: QuarantineMessageIdentity -Parameter Sets: Identities +Parameter Sets: Identities, IdentityOnly Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -113,20 +118,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: IdentityOnly -Aliases: -Applicable: Exchange Online, Exchange Online Protection +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection -### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -136,7 +131,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -146,6 +140,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -157,7 +154,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -167,6 +163,9 @@ Accept wildcard characters: False ``` ### -HardDelete + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The HardDelete switch specifies the message is permanently deleted and isn't recoverable. You don't need to specify a value with this switch. If you don't use this switch, the message is deleted, but is potentially recoverable. @@ -175,7 +174,6 @@ If you don't use this switch, the message is deleted, but is potentially recover Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -185,13 +183,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -201,13 +201,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-ATPProtectionPolicyRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-ATPProtectionPolicyRule.md index fe87141f2e..8352e7a409 100644 --- a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-atpprotectionpolicyrule applicable: Exchange Online -title: Disable-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-atpprotectionpolicyrule +schema: 2.0.0 +title: Disable-ATPProtectionPolicyRule --- # Disable-ATPProtectionPolicyRule @@ -46,6 +47,9 @@ In organizations with Defender for Office 365, this example turns off the Standa ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-AddressListPaging.md b/exchange/exchange-ps/ExchangePowerShell/Disable-AddressListPaging.md similarity index 91% rename from exchange/exchange-ps/exchange/Disable-AddressListPaging.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-AddressListPaging.md index 45471267d2..eaf4c603a6 100644 --- a/exchange/exchange-ps/exchange/Disable-AddressListPaging.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-AddressListPaging.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-addresslistpaging applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-AddressListPaging -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-addresslistpaging +schema: 2.0.0 +title: Disable-AddressListPaging --- # Disable-AddressListPaging @@ -42,6 +43,9 @@ This example disables virtual list view for address lists in your organization. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -53,7 +57,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-AntiPhishRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Disable-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-AntiPhishRule.md index df08fecd4f..e736bcd2b3 100644 --- a/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: Disable-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-antiphishrule +schema: 2.0.0 +title: Disable-AntiPhishRule --- # Disable-AntiPhishRule @@ -42,6 +43,9 @@ This example disables the antiphish rule named Engineering Department Phishing R ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the antiphish rule that you want to disable. Yo Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-App.md b/exchange/exchange-ps/ExchangePowerShell/Disable-App.md similarity index 91% rename from exchange/exchange-ps/exchange/Disable-App.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-App.md index 881f7f9195..42abdab2d3 100644 --- a/exchange/exchange-ps/exchange/Disable-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-App.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-App -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-app +schema: 2.0.0 +title: Disable-App --- # Disable-App @@ -62,13 +63,15 @@ This example disables the Share to Teams app for user Tony. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID of the app. ```yaml Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -89,7 +95,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -107,7 +115,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the identity of the mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -136,7 +146,6 @@ You can't use this parameter with the Identity parameter. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md b/exchange/exchange-ps/ExchangePowerShell/Disable-CmdletExtensionAgent.md similarity index 90% rename from exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-CmdletExtensionAgent.md index fa38ef00f2..950d45cb73 100644 --- a/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-CmdletExtensionAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-cmdletextensionagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-CmdletExtensionAgent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-cmdletextensionagent +schema: 2.0.0 +title: Disable-CmdletExtensionAgent --- # Disable-CmdletExtensionAgent @@ -47,6 +48,9 @@ This example disables the cmdlet extension agent named Scripting Agent. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the enabled cmdlet extension agent that you want to disable. You can use any value that uniquely identifies the agent. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the enabled cmdlet extension agent that you wan Type: CmdletExtensionAgentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Disable-DistributionGroup.md similarity index 90% rename from exchange/exchange-ps/exchange/Disable-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-DistributionGroup.md index e773646d76..1bf77a6557 100644 --- a/exchange/exchange-ps/exchange/Disable-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-DistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-DistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-distributiongroup +schema: 2.0.0 +title: Disable-DistributionGroup --- # Disable-DistributionGroup @@ -46,6 +47,9 @@ This example mail-disables the distribution group named Distribution Group1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the distribution group or mail-enabled security group that you want to mail-disable. You can use any value that uniquely identifies the group. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -117,7 +127,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Disable-DnssecForVerifiedDomain.md similarity index 93% rename from exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-DnssecForVerifiedDomain.md index 9b1751508e..d6bba5f7e1 100644 --- a/exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-DnssecForVerifiedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-dnssecforverifieddomain applicable: Exchange Online -title: Disable-DnssecForVerifiedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-dnssecforverifieddomain +schema: 2.0.0 +title: Disable-DnssecForVerifiedDomain --- # Disable-DnssecForVerifiedDomain @@ -44,13 +45,15 @@ This example disables DNSSEC for mail sent to contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to disable DNSSEC (for example, contoso.com). Use the Get-DnssecForVerifiedDomain cmdlet to see information about DNSSEC for the domain. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -76,13 +81,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-EOPProtectionPolicyRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-EOPProtectionPolicyRule.md index b611fc63b1..df608cff7f 100644 --- a/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: Disable-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-eopprotectionpolicyrule +schema: 2.0.0 +title: Disable-EOPProtectionPolicyRule --- # Disable-EOPProtectionPolicyRule @@ -53,6 +54,9 @@ In organizations with Defender for Office 365, this example turns off the Standa ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +69,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -86,7 +92,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-HostedContentFilterRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-HostedContentFilterRule.md index 7adfa0cbae..7630a48749 100644 --- a/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection -title: Disable-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-hostedcontentfilterrule +schema: 2.0.0 +title: Disable-HostedContentFilterRule --- # Disable-HostedContentFilterRule @@ -42,6 +43,9 @@ This example disables the enabled spam filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the spam filter rule that you want to disable. Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-HostedOutboundSpamFilterRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-HostedOutboundSpamFilterRule.md index 442273d3c0..9a3ea41209 100644 --- a/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: Disable-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-hostedoutboundspamfilterrule +schema: 2.0.0 +title: Disable-HostedOutboundSpamFilterRule --- # Disable-HostedOutboundSpamFilterRule @@ -42,6 +43,9 @@ This example disables the enabled outbound spam filter rule named Contoso Execut ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the outbound spam filter rule that you want to Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Disable-IPv6ForAcceptedDomain.md similarity index 94% rename from exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-IPv6ForAcceptedDomain.md index 59ff3a79b1..3e0dadb098 100644 --- a/exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-IPv6ForAcceptedDomain.md @@ -1,12 +1,12 @@ --- -external help file: -online version: https://learn.microsoft.com/powershell/module/exchange/disable-ipv6foraccepteddomain applicable: Exchange Online -title: Disable-IPv6ForAcceptedDomain -schema: 2.0.0 author: chrisda +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-ipv6foraccepteddomain +schema: 2.0.0 +title: Disable-IPv6ForAcceptedDomain --- # Disable-IPv6ForAcceptedDomain @@ -46,13 +46,15 @@ This example disables IPv6 support for mail sent to contoso.com. Mail can be del ## PARAMETERS ### -Domain + +> Applicable: Exchange Online + The Domain parameter specifies the accepted domain that you want to disable mail delivery using IPv6 for. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -62,13 +64,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -78,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-InboxRule.md similarity index 87% rename from exchange/exchange-ps/exchange/Disable-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-InboxRule.md index 7bc6e6bce3..63aca8800c 100644 --- a/exchange/exchange-ps/exchange/Disable-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-InboxRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-InboxRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-inboxrule +schema: 2.0.0 +title: Disable-InboxRule --- # Disable-InboxRule @@ -48,6 +49,9 @@ This example disables the Inbox rule MoveAnnouncements in the mailbox Joe@Contos ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Inbox rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the Inbox rule that you want to disable. You ca Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -96,7 +104,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -114,7 +124,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -134,7 +146,6 @@ A confirmation prompt warns you if the mailbox contains rules that were created Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -144,6 +155,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -161,7 +175,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-JournalArchiving.md b/exchange/exchange-ps/ExchangePowerShell/Disable-JournalArchiving.md similarity index 95% rename from exchange/exchange-ps/exchange/Disable-JournalArchiving.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-JournalArchiving.md index a1bf697510..cc3806b3c5 100644 --- a/exchange/exchange-ps/exchange/Disable-JournalArchiving.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-JournalArchiving.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-journalarchiving applicable: Exchange Online -title: Disable-JournalArchiving -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-journalarchiving +schema: 2.0.0 +title: Disable-JournalArchiving --- # Disable-JournalArchiving @@ -49,6 +50,9 @@ This example disables the journal archiving for the user named Timothy Amaral. T ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the identity of the user's journal archive mailbox in Exchange Online. You can use any value that uniquely identifies the journal archive mailbox. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the identity of the user's journal archive mail Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -PreserveMailUser + +> Applicable: Exchange Online + The PreserveMailUser switch specifies that you want to keep the mail user that's associated with the archive mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-JournalRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Disable-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-JournalRule.md index f36f1eaaaa..d3a8397ba1 100644 --- a/exchange/exchange-ps/exchange/Disable-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-JournalRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-journalrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-JournalRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-journalrule +schema: 2.0.0 +title: Disable-JournalRule --- # Disable-JournalRule @@ -52,13 +53,15 @@ This example disables all journal rules. The Get-JournalRule cmdlet is used to a ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the journal rule you want to disable. Enter either the name or the GUID of the journal rule. You can omit this parameter label. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -97,7 +105,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MailContact.md similarity index 90% rename from exchange/exchange-ps/exchange/Disable-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MailContact.md index 97902c5fd6..3f7988f388 100644 --- a/exchange/exchange-ps/exchange/Disable-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MailContact.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailcontact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-MailContact -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-mailcontact +schema: 2.0.0 +title: Disable-MailContact --- # Disable-MailContact @@ -46,6 +47,9 @@ This example mail-disables the mail contact named Ed Meadows. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mail contact that you want to mail-disable. You can use any value that uniquely identifies the mail contact. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the mail contact that you want to mail-disable. Type: MailContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -117,7 +127,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MailPublicFolder.md similarity index 90% rename from exchange/exchange-ps/exchange/Disable-MailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MailPublicFolder.md index a4aadbbe70..e3f87cb3ae 100644 --- a/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MailPublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailpublicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-MailPublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-mailpublicfolder +schema: 2.0.0 +title: Disable-MailPublicFolder --- # Disable-MailPublicFolder @@ -44,6 +45,9 @@ This example mail-disables the public folder Help Desk. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label Identity so that only the public folder name or GUID is supplied. @@ -52,7 +56,6 @@ You can omit the parameter label Identity so that only the public folder name or Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -91,7 +99,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -116,7 +126,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MailUser.md similarity index 90% rename from exchange/exchange-ps/exchange/Disable-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MailUser.md index c0728ff91a..c2a47e5857 100644 --- a/exchange/exchange-ps/exchange/Disable-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MailUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-MailUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-mailuser +schema: 2.0.0 +title: Disable-MailUser --- # Disable-MailUser @@ -47,6 +48,9 @@ This example mail-disables an existing mail user. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mail user that you want to mail-disable. You can use any value that uniquely identifies the mail user. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the mail user that you want to mail-disable. Yo Type: MailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -81,7 +87,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -118,7 +128,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. @@ -138,7 +150,6 @@ After you disable or remove a mailbox, you can't include it in a discovery searc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Disable-Mailbox.md similarity index 89% rename from exchange/exchange-ps/exchange/Disable-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-Mailbox.md index 8997b03b35..57ce870b95 100644 --- a/exchange/exchange-ps/exchange/Disable-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Disable-Mailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-mailbox +schema: 2.0.0 +title: Disable-Mailbox --- # Disable-Mailbox @@ -99,6 +100,9 @@ This example disables the remote archive for the on-premises user named John Woo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to mailbox-disable. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -116,7 +120,6 @@ The Identity parameter specifies the mailbox that you want to mailbox-disable. Y Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -126,6 +129,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Arbitration switch is required to mailbox-disable arbitration mailboxes. You don't need to specify a value with this switch. @@ -136,7 +142,6 @@ Arbitration mailboxes are system mailboxes that are used for storing different t Type: SwitchParameter Parameter Sets: Arbitration Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +151,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Archive switch specifies whether to disconnect the archive mailbox from the associated user. You don't need to specify a value with this switch. You can't use this switch with the RemoteArchive switch. @@ -154,7 +162,6 @@ You can't use this switch with the RemoteArchive switch. Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -164,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -175,7 +185,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -185,6 +194,9 @@ Accept wildcard characters: False ``` ### -DisableArbitrationMailboxWithOABsAllowed + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DisableArbitrationMailboxWithOABsAllowed switch specifies whether to bypass the checks for offline address books (OABs) within the specified arbitration mailbox that is being mail-disabled. When you use this switch, the arbitration mailbox is disabled even if OABs are present in the mailbox. You don't need to specify a value with this switch. @@ -193,7 +205,6 @@ The DisableArbitrationMailboxWithOABsAllowed switch specifies whether to bypass Type: SwitchParameter Parameter Sets: Arbitration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,6 +214,9 @@ Accept wildcard characters: False ``` ### -DisableLastArbitrationMailboxAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DisableLastArbitrationMailboxAllowed switch specifies whether to disable the specified mailbox, even if it's the last arbitration mailbox in the organization. If you disable the last arbitration mailbox in the organization, you can't have user-created distribution groups or moderated recipients. You don't need to specify a value with this switch. @@ -211,7 +225,6 @@ The DisableLastArbitrationMailboxAllowed switch specifies whether to disable the Type: SwitchParameter Parameter Sets: Arbitration Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -221,6 +234,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -229,7 +245,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,6 +254,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -252,7 +270,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,6 +279,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. @@ -274,7 +294,6 @@ After you disable or remove a mailbox, you can't include it in a discovery searc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,6 +303,9 @@ Accept wildcard characters: False ``` ### -PermanentlyDisable + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PermanentlyDisable switch specifies whether to permanently disable the mailbox. You don't need to specify a value with this switch. @@ -297,7 +319,6 @@ The PermanentlyDisable switch specifies whether to permanently disable the mailb Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -307,6 +328,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PublicFolder switch is required to mailbox-disable public folder mailboxes. You don't need to specify a value with this switch. @@ -317,7 +341,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -327,6 +350,9 @@ Accept wildcard characters: False ``` ### -RemoteArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoteArchive switch specifies whether to disconnect the remote archive for this mailbox. Remote archives exist in the cloud-based service. When you use this switch, the RemoteRecipientType property for the mailbox is reset to specify that this mailbox doesn't have a remote archive. You don't need to specify a value with this switch. @@ -337,7 +363,6 @@ You can't use this switch with the Archive switch. Type: SwitchParameter Parameter Sets: RemoteArchive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -347,13 +372,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MailboxQuarantine.md similarity index 90% rename from exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MailboxQuarantine.md index 98aaf73776..1bb4f37eb4 100644 --- a/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MailboxQuarantine.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailboxquarantine applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-MailboxQuarantine -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-mailboxquarantine +schema: 2.0.0 +title: Disable-MailboxQuarantine --- # Disable-MailboxQuarantine @@ -83,6 +84,9 @@ This example releases the mailbox for the user Brian Johnson from quarantine. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013 + The Identity parameter specifies the mailbox that you want to release from quarantine. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -100,9 +104,8 @@ You can't use this parameter with the Database or Server parameters. ```yaml Type: GeneralMailboxIdParameter -Parameter Sets: MailboxIdentity +Parameter Sets: MailboxIdentity, MailboxOrMailUserIdentity Aliases: -Applicable: Exchange Server 2013 Required: True Position: 1 @@ -111,20 +114,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: MailboxOrMailUserIdentity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -Database -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019 -### -Database The Database parameter specifies the database that contains the mailboxes you want to release from quarantine. You can use any value that uniquely identifies the database. For example: - Name @@ -139,7 +132,6 @@ You can't use this parameter with the Identity or Server parameters. Type: DatabaseIdParameter Parameter Sets: StoreMailboxIdentity, IncludeAllMailboxes Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -149,6 +141,9 @@ Accept wildcard characters: False ``` ### -IncludeAllDatabases + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The IncludeAllDatabases switch specifies that you want to release all quarantined mailboxes in all databases on the server you specify with the Server parameter. You don't need to specify a value with this switch. You can only use this switch with the Identity or Database parameters. @@ -157,7 +152,6 @@ You can only use this switch with the Identity or Database parameters. Type: SwitchParameter Parameter Sets: IncludeAllDatabases Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -167,6 +161,9 @@ Accept wildcard characters: False ``` ### -IncludeAllMailboxes + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The IncludeAllMailboxes switch specifies that you want to release all mailboxes from quarantine in the database you specify with the Database parameter. You don't need to specify a value with this switch. You can't use this switch with the StoreMailboxIdentity parameter. @@ -175,7 +172,6 @@ You can't use this switch with the StoreMailboxIdentity parameter. Type: SwitchParameter Parameter Sets: IncludeAllMailboxes Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -185,6 +181,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the server that contains the mailboxes that you want to release from quarantine by using the IncludeAllDatabases switch. You can use any value that uniquely identifies the server. For example: - Name @@ -198,7 +197,6 @@ You can't use this parameter with the Identity or Database parameters. Type: ServerIdParameter Parameter Sets: IncludeAllDatabases Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -208,6 +206,9 @@ Accept wildcard characters: False ``` ### -StoreMailboxIdentity + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The StoreMailboxIdentity parameter specifies the mailbox that you want to release from quarantine when you use the Database parameter. You identify the mailbox by its GUID value. You can find the GUID value by using the Get-Mailbox or Get-MailboxStatistics cmdlets. @@ -218,7 +219,6 @@ You can't use this switch with the IncludeAllMailboxes switch. Type: StoreMailboxIdParameter Parameter Sets: StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -228,6 +228,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -239,7 +242,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -249,13 +251,15 @@ Accept wildcard characters: False ``` ### -IncludePassive + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The IncludePassive switch specifies that you also want to release inactive copies of the mailbox from quarantine. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, IncludeAllMailboxes, MailboxOrMailUserIdentity, IncludeAllDatabases Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -265,13 +269,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MalwareFilterRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MalwareFilterRule.md index 127a8f0542..44824fbe35 100644 --- a/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MalwareFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Disable-MalwareFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-malwarefilterrule +schema: 2.0.0 +title: Disable-MalwareFilterRule --- # Disable-MalwareFilterRule @@ -43,13 +44,15 @@ This example disables the enabled malware filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter rule that you want to disable. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -88,7 +96,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Disable-MetaCacheDatabase.md similarity index 95% rename from exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-MetaCacheDatabase.md index 87451f2763..3d4485454e 100644 --- a/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-MetaCacheDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-metacachedatabase applicable: Exchange Server 2019 -title: Disable-MetaCacheDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-metacachedatabase +schema: 2.0.0 +title: Disable-MetaCacheDatabase --- # Disable-MetaCacheDatabase @@ -42,6 +43,9 @@ This example disables the metacache database on the Exchange server named Mailbo ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2019 + The Server parameter specifies the Mailbox server where you want to disable the metacache database. You can use any value that uniquely identifies the server. For example: - Name @@ -55,7 +59,6 @@ You can specify multiple values separated by commas. If the value contains space Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: True Position: Named @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md b/exchange/exchange-ps/ExchangePowerShell/Disable-OutlookAnywhere.md similarity index 95% rename from exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-OutlookAnywhere.md index 30685164f7..8cfbf56343 100644 --- a/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-OutlookAnywhere.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-outlookanywhere applicable: Exchange Server 2010 -title: Disable-OutlookAnywhere -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-outlookanywhere +schema: 2.0.0 +title: Disable-OutlookAnywhere --- # Disable-OutlookAnywhere @@ -66,6 +67,9 @@ This example disables Outlook Anywhere on the specified virtual directory on the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Outlook Anywhere virtual directory that you want to disable. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -80,7 +84,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -99,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Client Access server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -136,7 +146,6 @@ The Server parameter specifies the Client Access server where you want to run th Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-OutlookProtectionRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-OutlookProtectionRule.md index 6032b60587..17ffbc57db 100644 --- a/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-OutlookProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-outlookprotectionrule +schema: 2.0.0 +title: Disable-OutlookProtectionRule --- # Disable-OutlookProtectionRule @@ -49,13 +50,15 @@ This example disables the Outlook protection rule Project Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the rule being disabled. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md b/exchange/exchange-ps/ExchangePowerShell/Disable-PushNotificationProxy.md similarity index 93% rename from exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-PushNotificationProxy.md index ade8f3935d..069b955360 100644 --- a/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-PushNotificationProxy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-pushnotificationproxy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-PushNotificationProxy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-pushnotificationproxy +schema: 2.0.0 +title: Disable-PushNotificationProxy --- # Disable-PushNotificationProxy @@ -43,6 +44,9 @@ This example disables the push notification proxy in the on-premises Exchange or ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -54,7 +58,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Disable-RemoteMailbox.md similarity index 91% rename from exchange/exchange-ps/exchange/Disable-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-RemoteMailbox.md index 8039e5d1fd..3549b91ef4 100644 --- a/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-RemoteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-remotemailbox +schema: 2.0.0 +title: Disable-RemoteMailbox --- # Disable-RemoteMailbox @@ -67,6 +68,9 @@ This example removes the cloud-based archive mailbox but keeps the cloud-based m ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the cloud-based mailbox. Valid values are: - ADObjectID @@ -82,7 +86,6 @@ The Identity parameter specifies the cloud-based mailbox. Valid values are: Type: RemoteMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Archive switch specifies whether to disconnect the cloud-based archive mailbox from the associated cloud-based mailbox. You don't need to specify a value with this switch. The on-premises mail user and its associated cloud-based mailbox aren't removed if you use this switch. @@ -100,7 +106,6 @@ The on-premises mail user and its associated cloud-based mailbox aren't removed Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -121,7 +129,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,6 +156,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -158,7 +170,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +179,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreLegalHold switch ignores the legal hold status of the remote user. You don't need to specify a value with this switch. This switch disables the instance of the remote object in the on-premises organization, and the request to disable the mailbox is synchronized to the cloud. However, if the cloud mailbox is on hold, the request to disable the mailbox is blocked, and an error is returned. @@ -176,7 +190,6 @@ This switch disables the instance of the remote object in the on-premises organi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-ReportSubmissionRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-ReportSubmissionRule.md index 8e8073a184..1fbb643e5a 100644 --- a/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-reportsubmissionrule applicable: Exchange Online -title: Disable-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-reportsubmissionrule +schema: 2.0.0 +title: Disable-ReportSubmissionRule --- # Disable-ReportSubmissionRule @@ -42,13 +43,15 @@ This example disables the report submission rule if it's already enabled. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission rule that you want to disable. The default rule is named DefaultReportSubmissionRule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -69,7 +75,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-SafeAttachmentRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-SafeAttachmentRule.md index 35ef4b854d..953b770117 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-safeattachmentrule applicable: Exchange Online -title: Disable-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-safeattachmentrule +schema: 2.0.0 +title: Disable-SafeAttachmentRule --- # Disable-SafeAttachmentRule @@ -44,6 +45,9 @@ This example disables the safe attachment rule named Engineering Department Atta ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the enabled safe attachment rule that you want to disable. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -77,7 +83,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-SafeLinksRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Disable-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-SafeLinksRule.md index fa714bf72f..3327a72700 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-safelinksrule applicable: Exchange Online -title: Disable-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-safelinksrule +schema: 2.0.0 +title: Disable-SafeLinksRule --- # Disable-SafeLinksRule @@ -44,6 +45,9 @@ This example disables the enabled Safe Links rule named Engineering Department U ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the enabled Safe Links rule that you want to disable. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -77,7 +83,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md b/exchange/exchange-ps/ExchangePowerShell/Disable-ServiceEmailChannel.md similarity index 91% rename from exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-ServiceEmailChannel.md index 13a29e56ed..4e82617c25 100644 --- a/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-ServiceEmailChannel.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-serviceemailchannel applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-ServiceEmailChannel -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-serviceemailchannel +schema: 2.0.0 +title: Disable-ServiceEmailChannel --- # Disable-ServiceEmailChannel @@ -59,6 +60,9 @@ This example disables the .NET service channel for the user Jeff Hay without req ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the user for which you want to enable the .NET service channel. The user specified must be a valid user in Active Directory who has an Exchange mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -78,7 +82,6 @@ You can use any value that uniquely identifies the mailbox. For example: Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -99,7 +105,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md b/exchange/exchange-ps/ExchangePowerShell/Disable-SmtpDaneInbound.md similarity index 94% rename from exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-SmtpDaneInbound.md index 927fd4cd53..658111797e 100644 --- a/exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-SmtpDaneInbound.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-smtpdaneinbound applicable: Exchange Online -title: Disable-SmtpDaneInbound -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-smtpdaneinbound +schema: 2.0.0 +title: Disable-SmtpDaneInbound --- # Disable-SmtpDaneInbound @@ -44,13 +45,15 @@ This example disables SMTP DANE for mail sent to contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to disable SMTP DANE (for example, contoso.com). Use the Get-SmtpDaneInboundStatus cmdlet to see information about SMTP DNAME for the domain. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -76,13 +81,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-SweepRule.md similarity index 91% rename from exchange/exchange-ps/exchange/Disable-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-SweepRule.md index 225c628693..95de0ed658 100644 --- a/exchange/exchange-ps/exchange/Disable-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-SweepRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Disable-SweepRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-sweeprule +schema: 2.0.0 +title: Disable-SweepRule --- # Disable-SweepRule @@ -51,6 +52,9 @@ This example disables all Sweep rules in the specified mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Sweep rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). @@ -61,7 +65,6 @@ The Identity parameter specifies the Sweep rule that you want to disable. You ca Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the rule you want to disable. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +135,6 @@ The Mailbox parameter specifies the mailbox that contains the rule you want to d Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Disable-TransportAgent.md similarity index 90% rename from exchange/exchange-ps/exchange/Disable-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-TransportAgent.md index 5ccd3fab73..dde2c3a4c3 100644 --- a/exchange/exchange-ps/exchange/Disable-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Disable-TransportAgent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-transportagent +schema: 2.0.0 +title: Disable-TransportAgent --- # Disable-TransportAgent @@ -44,13 +45,15 @@ This example shows how a fictitious application named Test App is disabled in th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the display name of the transport agent to be disabled. The length of the name can't exceed 64 characters. ```yaml Type: TransportAgentObjectId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -89,7 +97,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -111,7 +121,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-TransportRule.md similarity index 88% rename from exchange/exchange-ps/exchange/Disable-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-TransportRule.md index 03d4189525..1921db70e4 100644 --- a/exchange/exchange-ps/exchange/Disable-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-TransportRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Disable-TransportRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-transportrule +schema: 2.0.0 +title: Disable-TransportRule --- # Disable-TransportRule @@ -45,6 +46,9 @@ This example disables the rule named Sales Disclaimer. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the rule that you want to disable. You can use Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -96,7 +104,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMAutoAttendant.md similarity index 92% rename from exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMAutoAttendant.md index 9a332903c9..1ef66ad50b 100644 --- a/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Disable-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-umautoattendant +schema: 2.0.0 +title: Disable-UMAutoAttendant --- # Disable-UMAutoAttendant @@ -47,13 +48,15 @@ This example disables the UM auto attendant MyUMAutoAttendant. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM auto attendant that's being disabled. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMCallAnsweringRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMCallAnsweringRule.md index d9f8154eaf..28f9e0bd91 100644 --- a/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: Disable-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-umcallansweringrule +schema: 2.0.0 +title: Disable-UMCallAnsweringRule --- # Disable-UMCallAnsweringRule @@ -62,13 +63,15 @@ This example disables the call answering rule MyUMCallAnsweringRule in the mailb ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the UM call answering rule in a UM-enabled mailbox that's to be disabled. ```yaml Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -89,7 +95,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox that contains the UM call answering rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -134,7 +144,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMIPGateway.md similarity index 91% rename from exchange/exchange-ps/exchange/Disable-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMIPGateway.md index f0738b7185..a715ac322d 100644 --- a/exchange/exchange-ps/exchange/Disable-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Disable-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-umipgateway +schema: 2.0.0 +title: Disable-UMIPGateway --- # Disable-UMIPGateway @@ -53,13 +54,15 @@ This example disables the UM IP gateway MyUMIPGateway and disconnects all curren ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM IP gateway being disabled. This is the directory object ID for the UM IP gateway. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -Immediate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Immediate parameter specifies whether the Mailbox server running the Microsoft Exchange Unified Messaging service drops incoming calls associated with this UM IP gateway immediately or waits for the current calls to finish processing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMMailbox.md similarity index 91% rename from exchange/exchange-ps/exchange/Disable-UMMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMMailbox.md index f9ea3dd8ba..ea3727bee6 100644 --- a/exchange/exchange-ps/exchange/Disable-UMMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Disable-UMMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-ummailbox +schema: 2.0.0 +title: Disable-UMMailbox --- # Disable-UMMailbox @@ -47,6 +48,9 @@ This example disables Unified Messaging on the mailbox for tonysmith@contoso.com ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the mailbox that you want to disable for Unified Messaging. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the mailbox that you want to disable for Unifie Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -120,7 +130,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -KeepProperties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The KeepProperties parameter specifies whether to keep or remove the UM properties for the mailbox. Valid values are: - $true: The UM properties are retained on the mailbox. This is the default value. @@ -139,7 +151,6 @@ The KeepProperties parameter specifies whether to keep or remove the UM properti Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMServer.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMServer.md similarity index 95% rename from exchange/exchange-ps/exchange/Disable-UMServer.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMServer.md index 2b34bd0f25..a4713a795f 100644 --- a/exchange/exchange-ps/exchange/Disable-UMServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-umserver applicable: Exchange Server 2010 -title: Disable-UMServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-umserver +schema: 2.0.0 +title: Disable-UMServer --- # Disable-UMServer @@ -60,13 +61,15 @@ This example disables Unified Messaging on the Unified Messaging server named My ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the identifier for the Unified Messaging server being disabled. This is the directory object ID for the UM server. ```yaml Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -85,7 +91,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -111,13 +118,15 @@ Accept wildcard characters: False ``` ### -Immediate + +> Applicable: Exchange Server 2010 + The Immediate parameter specifies whether the Unified Messaging server drops all current calls or enables current calls to finish. If this parameter is set to $true, all calls that are currently connected are disconnected. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-UMService.md b/exchange/exchange-ps/ExchangePowerShell/Disable-UMService.md similarity index 94% rename from exchange/exchange-ps/exchange/Disable-UMService.md rename to exchange/exchange-ps/ExchangePowerShell/Disable-UMService.md index 48cc82a85b..f712294833 100644 --- a/exchange/exchange-ps/exchange/Disable-UMService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disable-UMService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/disable-umservice applicable: Exchange Server 2013, Exchange Server 2016 -title: Disable-UMService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disable-umservice +schema: 2.0.0 +title: Disable-UMService --- # Disable-UMService @@ -62,6 +63,9 @@ This example disables Unified Messaging on the UM server MyUMServer and disconne ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the Exchange 2010 UM server that you want to disable. You can use any value that uniquely identifies the UM server. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the Exchange 2010 UM server that you want to di Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -92,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -Immediate + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Immediate parameter specifies whether the UM server drops all current calls or enables current calls to finish. If this parameter is set to $true, all calls that are currently connected are disconnected. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md b/exchange/exchange-ps/ExchangePowerShell/Disconnect-ExchangeOnline.md similarity index 96% rename from exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md rename to exchange/exchange-ps/ExchangePowerShell/Disconnect-ExchangeOnline.md index c2a6bb1153..c79725b236 100644 --- a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md +++ b/exchange/exchange-ps/ExchangePowerShell/Disconnect-ExchangeOnline.md @@ -1,13 +1,13 @@ --- -external help file: ExchangeOnlineManagement-help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/disconnect-exchangeonline applicable: Exchange Online -title: Disconnect-ExchangeOnline -schema: 2.0.0 author: chrisda +external help file: ExchangeOnlineManagement-help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/disconnect-exchangeonline +schema: 2.0.0 +title: Disconnect-ExchangeOnline --- # Disconnect-ExchangeOnline @@ -85,6 +85,9 @@ This example disconnects the REST-based Exchange Online PowerShell connections t ## PARAMETERS ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -94,7 +97,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -104,6 +106,9 @@ Accept wildcard characters: False ``` ### -ConnectionId + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.2.0 or later of the module. The ConnectionId parameter specifies the REST API connections to disconnect by ConnectionId. ConnectionId is a GUID value in the output of the Get-ConnectionInformation cmdlet that uniquely identifies a connection, even if you have multiple connections open. You can specify multiple ConnectionId values separated by commas. @@ -114,7 +119,6 @@ Don't use this parameter with the ModulePrefix parameter. Type: String[] Parameter Sets: ConnectionId Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -124,6 +128,9 @@ Accept wildcard characters: False ``` ### -ModulePrefix + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.2.0 or later of the module. The ModulePrefix parameter specifies the REST API connections to disconnect by ModulePrefix. When you use the Prefix parameter with the Connect-ExchangeOnline cmdlet, the specified text is added to the names of all Exchange Online cmdlets (for example, Get-InboundConnector becomes Get-ContosoInboundConnector). The ModulePrefix value is visible in the output of the Get-ConnectionInformation cmdlet. You can specify multiple ModulePrefix values separated by commas. @@ -134,7 +141,6 @@ Don't use this parameter with the ConnectionId parameter. Type: String[] Parameter Sets: ModulePrefix Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -144,13 +150,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Dismount-Database.md b/exchange/exchange-ps/ExchangePowerShell/Dismount-Database.md similarity index 90% rename from exchange/exchange-ps/exchange/Dismount-Database.md rename to exchange/exchange-ps/ExchangePowerShell/Dismount-Database.md index 7159912a4e..f71b315592 100644 --- a/exchange/exchange-ps/exchange/Dismount-Database.md +++ b/exchange/exchange-ps/ExchangePowerShell/Dismount-Database.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/dismount-database applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Dismount-Database -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/dismount-database +schema: 2.0.0 +title: Dismount-Database --- # Dismount-Database @@ -45,6 +46,9 @@ Regardless of where you run this cmdlet, it operates against the server hosting ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the database that you want to dismount. You can use any value that uniquely identifies the database. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the database that you want to dismount. You can Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md b/exchange/exchange-ps/ExchangePowerShell/Dump-ProvisioningCache.md similarity index 90% rename from exchange/exchange-ps/exchange/Dump-ProvisioningCache.md rename to exchange/exchange-ps/ExchangePowerShell/Dump-ProvisioningCache.md index b16e9a249e..caf85044ed 100644 --- a/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md +++ b/exchange/exchange-ps/ExchangePowerShell/Dump-ProvisioningCache.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/dump-provisioningcache applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Dump-ProvisioningCache -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/dump-provisioningcache +schema: 2.0.0 +title: Dump-ProvisioningCache --- # Dump-ProvisioningCache @@ -60,13 +61,15 @@ This example displays all cache keys for the specified server and Windows PowerS ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the fully qualified domain name (FQDN) of the server that the application you want to reset is running on. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Application + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Application parameter specifies the specific administrative application to reset the provisioning cache for. You can use the following values: - Powershell @@ -89,7 +95,6 @@ The Application parameter specifies the specific administrative application to r Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -GlobalCache + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GlobalCache switch specifies that all cache keys are cleared. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: GlobalCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -CacheKeys + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CacheKeys parameter specifies the value for the cache key that you want to clear. The format for the values should contain 32 digits separated by four dashes: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Use the Dump-ProvisioningCache cmdlet to return a list of cache keys. @@ -123,7 +133,6 @@ Use the Dump-ProvisioningCache cmdlet to return a list of cache keys. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -142,7 +154,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -CurrentOrganization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CurrentOrganization switch specifies that the provision cache is reset for this organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: OrganizationCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -Organizations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Organizations parameter specifies the organizations that the provisioning cache will be reset. This parameter is used in multi-tenant deployments. ```yaml Type: MultiValuedProperty Parameter Sets: OrganizationCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,13 +199,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-ATPProtectionPolicyRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-ATPProtectionPolicyRule.md index af887e025f..c62fb63b78 100644 --- a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-atpprotectionpolicyrule applicable: Exchange Online -title: Enable-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-atpprotectionpolicyrule +schema: 2.0.0 +title: Enable-ATPProtectionPolicyRule --- # Enable-ATPProtectionPolicyRule @@ -46,6 +47,9 @@ In organizations with Defender for Office 365, this example turns on the Standar ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-AddressListPaging.md b/exchange/exchange-ps/ExchangePowerShell/Enable-AddressListPaging.md similarity index 91% rename from exchange/exchange-ps/exchange/Enable-AddressListPaging.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-AddressListPaging.md index 7bdc8deb33..7cf35a1dd4 100644 --- a/exchange/exchange-ps/exchange/Enable-AddressListPaging.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-AddressListPaging.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-addresslistpaging applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-AddressListPaging -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-addresslistpaging +schema: 2.0.0 +title: Enable-AddressListPaging --- # Enable-AddressListPaging @@ -44,6 +45,9 @@ This example enables virtual list view for your organization. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -53,7 +57,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-AntiPhishRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Enable-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-AntiPhishRule.md index 55bc463ac2..418b53848b 100644 --- a/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: Enable-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-antiphishrule +schema: 2.0.0 +title: Enable-AntiPhishRule --- # Enable-AntiPhishRule @@ -42,6 +43,9 @@ This example enables the antiphish rule named Marketing Department Phishing Rule ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the antiphish rule that you want to enable. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md b/exchange/exchange-ps/ExchangePowerShell/Enable-AntispamUpdates.md similarity index 85% rename from exchange/exchange-ps/exchange/Enable-AntispamUpdates.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-AntispamUpdates.md index 40a8ec1a57..6a01e8936d 100644 --- a/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-AntispamUpdates.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-antispamupdates applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-AntispamUpdates -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-antispamupdates +schema: 2.0.0 +title: Enable-AntispamUpdates --- # Enable-AntispamUpdates @@ -41,13 +42,15 @@ This cmdlet was deprecated in Microsoft Exchange Server 2010 Service Pack 1 and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -57,13 +60,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -73,13 +78,15 @@ Accept wildcard characters: False ``` ### -SpamSignatureUpdatesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +96,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-App.md b/exchange/exchange-ps/ExchangePowerShell/Enable-App.md similarity index 91% rename from exchange/exchange-ps/exchange/Enable-App.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-App.md index 788dc99c86..fe719c307f 100644 --- a/exchange/exchange-ps/exchange/Enable-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-App.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-App -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-app +schema: 2.0.0 +title: Enable-App --- # Enable-App @@ -62,13 +63,15 @@ This example enables the Share to Teams app for user Tony. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID of the app. ```yaml Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -87,7 +93,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -105,7 +113,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -132,7 +142,6 @@ The Mailbox parameter specifies the mailbox. You can use any value that uniquely Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md b/exchange/exchange-ps/ExchangePowerShell/Enable-CmdletExtensionAgent.md similarity index 91% rename from exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-CmdletExtensionAgent.md index 926da3eb88..b954efdd4a 100644 --- a/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-CmdletExtensionAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-cmdletextensionagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-CmdletExtensionAgent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-cmdletextensionagent +schema: 2.0.0 +title: Enable-CmdletExtensionAgent --- # Enable-CmdletExtensionAgent @@ -49,6 +50,9 @@ This example enables the cmdlet extension agent named Scripting Agent. Before yo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the disabled cmdlet extension agent that you want to enable. You can use any value that uniquely identifies the agent. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the disabled cmdlet extension agent that you wa Type: CmdletExtensionAgentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md b/exchange/exchange-ps/ExchangePowerShell/Enable-ComplianceTagStorage.md similarity index 95% rename from exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-ComplianceTagStorage.md index c2a69f5215..a28f12032f 100644 --- a/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-ComplianceTagStorage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-compliancetagstorage applicable: Security & Compliance -title: Enable-ComplianceTagStorage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-compliancetagstorage +schema: 2.0.0 +title: Enable-ComplianceTagStorage --- # Enable-ComplianceTagStorage @@ -45,6 +46,9 @@ This example creates the label policy in the Microsoft Purview compliance portal ## PARAMETERS ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -54,7 +58,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -RecordsManagementSecurityGroupEmail + +> Applicable: Security & Compliance + This RecordsManagementSecurityGroupEmail parameter specifies the email address of the mail-enabled security group that contains the records managers in the organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Enable-DistributionGroup.md similarity index 91% rename from exchange/exchange-ps/exchange/Enable-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-DistributionGroup.md index cda305dfb4..2b0bca1bab 100644 --- a/exchange/exchange-ps/exchange/Enable-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-DistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-DistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-distributiongroup +schema: 2.0.0 +title: Enable-DistributionGroup --- # Enable-DistributionGroup @@ -50,6 +51,9 @@ This example mail-enables the universal distribution group named Distribution Gr ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the universal security group or universal distribution group that you want to mail-enable. You can use any value that uniquely identifies the group. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the universal security group or universal distr Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -95,7 +101,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -114,7 +122,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. By default, the primary SMTP address is generated based on the default email address policy and the value of the Alias parameter or the Name property. If you use the PrimarySmtpAddress parameter to specify the primary email address, the EmailAddressPolicyEnabled property is set to the value False, which means the email addresses of the group won't be automatically updated by email address policies. @@ -164,7 +178,6 @@ By default, the primary SMTP address is generated based on the default email add Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Enable-DnssecForVerifiedDomain.md similarity index 94% rename from exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-DnssecForVerifiedDomain.md index 785b0029ab..ba66a7d906 100644 --- a/exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-DnssecForVerifiedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-dnssecforverifieddomain applicable: Exchange Online -title: Enable-DnssecForVerifiedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-dnssecforverifieddomain +schema: 2.0.0 +title: Enable-DnssecForVerifiedDomain --- # Enable-DnssecForVerifiedDomain @@ -46,13 +47,15 @@ This example enables DNSSEC for mail sent to contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to enable DNSSEC (for example, contoso.com). Use the Get-AcceptedDomain cmdlet to see the accepted domains in the organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-EOPProtectionPolicyRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-EOPProtectionPolicyRule.md index a73b54c47d..55ab46f3c3 100644 --- a/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: Enable-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-eopprotectionpolicyrule +schema: 2.0.0 +title: Enable-EOPProtectionPolicyRule --- # Enable-EOPProtectionPolicyRule @@ -53,6 +54,9 @@ In organizations with Defender for Office 365, this example turns on the Standar ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +69,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -84,7 +90,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Enable-ExchangeCertificate.md similarity index 91% rename from exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-ExchangeCertificate.md index 29cc1af6d3..8ac543b37b 100644 --- a/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-ExchangeCertificate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-exchangecertificate +schema: 2.0.0 +title: Enable-ExchangeCertificate --- # Enable-ExchangeCertificate @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-ExchangeCertificate cmdlet to enable an existing certificate on the Exchange server for Exchange services such as Internet Information Services (IIS), SMTP, POP, IMAP and Unified Messaging (UM). Once you enable a certificate for a service, you can't disable it. -To see the existing certificates that are used for Exchange services, use [Get-ExchangeCertificate](https://learn.microsoft.com/powershell/module/exchange/get-exchangecertificate). +To see the existing certificates that are used for Exchange services, use [Get-ExchangeCertificate](https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangecertificate). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -70,6 +71,9 @@ This example enables a certificate for POP, IMAP, SMTP and IIS services. ## PARAMETERS ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Thumbprint parameter specifies the certificate that you want to configure. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. @@ -78,7 +82,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: String Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the certificate that you want to configure. Valid values are: - `ServerNameOrFQDN\Thumbprint` @@ -103,7 +109,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: ExchangeCertificateIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Services + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Services parameter specifies the Exchange services that the certificate is enabled for. Valid values are: - Federation: Don't use this command to enable a certificate for federation. Creating or modifying a federation trust enables or modifies how certificates are used for federation. You manage the certificates that used for federation trusts with the New-FederationTrust and Set-FederationTrust cmdlets. @@ -133,7 +141,6 @@ Different services have different certificate requirements. For example, some se Type: AllowedServices Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -143,6 +150,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -152,7 +162,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -170,7 +182,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,6 +191,9 @@ Accept wildcard characters: False ``` ### -DoNotRequireSsl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DoNotRequireSsl switch prevents the command from enabling the "require SSL" setting on the default web site when you enable the certificate for IIS. You don't need to specify a value with this switch. If you don't use this switch, and you use the Services parameter to enable the certificate for IIS, the command enables the "require SSL" setting for the default web site in IIS. @@ -188,7 +202,6 @@ If you don't use this switch, and you use the Services parameter to enable the c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -208,7 +224,6 @@ By default, when you enable a certificate for SMTP, the command prompts you to r Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -218,13 +233,15 @@ Accept wildcard characters: False ``` ### -NetworkServiceAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The NetworkServiceAllowed switch gives the built-in Network Service account permission to read the certificate's private key without enabling the certificate for SMTP. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -234,6 +251,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -249,7 +269,6 @@ You can't use this parameter with the Identity parameter, but you can use it wit Type: ServerIdParameter Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,13 +278,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-HostedContentFilterRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-HostedContentFilterRule.md index 8b49e06134..2e2746777a 100644 --- a/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection -title: Enable-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-hostedcontentfilterrule +schema: 2.0.0 +title: Enable-HostedContentFilterRule --- # Enable-HostedContentFilterRule @@ -42,6 +43,9 @@ This example enables the disabled spam filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the spam filter rule that you want to enable. Y Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-HostedOutboundSpamFilterRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-HostedOutboundSpamFilterRule.md index b0b6d2ea45..ea9fd1312b 100644 --- a/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: Enable-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-hostedoutboundspamfilterrule +schema: 2.0.0 +title: Enable-HostedOutboundSpamFilterRule --- # Enable-HostedOutboundSpamFilterRule @@ -42,6 +43,9 @@ This example enables the disabled outbound spam filter rule named Contoso Execut ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the outbound spam filter rule that you want to Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Enable-IPv6ForAcceptedDomain.md similarity index 94% rename from exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-IPv6ForAcceptedDomain.md index 1ce4f5db89..742bc1c935 100644 --- a/exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-IPv6ForAcceptedDomain.md @@ -1,12 +1,12 @@ --- -external help file: -online version: https://learn.microsoft.com/powershell/module/exchange/enable-ipv6foraccepteddomain applicable: Exchange Online -title: Enable-IPv6ForAcceptedDomain -schema: 2.0.0 author: chrisda +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-ipv6foraccepteddomain +schema: 2.0.0 +title: Enable-IPv6ForAcceptedDomain --- # Enable-IPv6ForAcceptedDomain @@ -46,13 +46,15 @@ This example enables IPv6 support for mail sent to contoso.com. Mail can be deli ## PARAMETERS ### -Domain + +> Applicable: Exchange Online + The Domain parameter specifies the accepted domain that you want to enable mail delivery using IPv6 for. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -62,13 +64,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -78,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-InboxRule.md similarity index 88% rename from exchange/exchange-ps/exchange/Enable-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-InboxRule.md index a4e38bdcbb..d1680d3778 100644 --- a/exchange/exchange-ps/exchange/Enable-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-InboxRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-InboxRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-inboxrule +schema: 2.0.0 +title: Enable-InboxRule --- # Enable-InboxRule @@ -48,6 +49,9 @@ This example enables the Inbox rule named Move To Junk Mail in the mailbox that ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Inbox rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the Inbox rule that you want to enable. You can Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -94,7 +102,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -112,7 +122,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -132,7 +144,6 @@ A confirmation prompt warns you if the mailbox contains rules that were created Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -159,7 +173,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -169,13 +182,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-JournalRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Enable-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-JournalRule.md index a642ee6b6f..9cfd07daa1 100644 --- a/exchange/exchange-ps/exchange/Enable-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-JournalRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-journalrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-JournalRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-journalrule +schema: 2.0.0 +title: Enable-JournalRule --- # Enable-JournalRule @@ -45,13 +46,15 @@ This example enables the existing journal rule Brokerage Communications. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the journal rule you want to enable. Enter either the name or GUID of the journal rule. You can omit this parameter label. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -88,7 +96,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MailContact.md similarity index 90% rename from exchange/exchange-ps/exchange/Enable-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MailContact.md index 32afb576cd..14a850f520 100644 --- a/exchange/exchange-ps/exchange/Enable-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MailContact.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailcontact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-MailContact -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-mailcontact +schema: 2.0.0 +title: Enable-MailContact --- # Enable-MailContact @@ -52,6 +53,9 @@ This example mail-enables an existing contact that isn't mail-enabled. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the non-mail-enabled contact that you want to mail-enable. You can use any value that uniquely identifies the contact. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the non-mail-enabled contact that you want to m Type: ContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. @@ -81,7 +87,6 @@ In on-premises environments, you can use the PrimarySMTPAddress parameter to set Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -115,7 +123,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -134,7 +144,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DisplayName parameter specifies the display name of the mail contact. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -176,6 +189,9 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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) @@ -192,7 +208,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -217,7 +235,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,6 +244,9 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -243,7 +263,6 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,6 +272,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. By default, the primary address is the same as the ExternalEmailAddress parameter value. @@ -263,7 +285,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,6 +294,9 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -282,7 +306,6 @@ The UsePreferMessageFormat specifies whether the message format settings configu Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -292,13 +315,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MailPublicFolder.md similarity index 89% rename from exchange/exchange-ps/exchange/Enable-MailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MailPublicFolder.md index a029579014..1c467a88f0 100644 --- a/exchange/exchange-ps/exchange/Enable-MailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MailPublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailpublicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-MailPublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-mailpublicfolder +schema: 2.0.0 +title: Enable-MailPublicFolder --- # Enable-MailPublicFolder @@ -53,6 +54,9 @@ This example mail-enables the public folder Reports that's in the parent folder ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -61,7 +65,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HiddenFromAddressListsEnabled parameter specifies whether the folder is hidden from address lists. Valid values are $true and $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -OverrideRecipientQuotas + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -132,7 +144,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -157,7 +171,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -167,13 +180,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MailUser.md similarity index 88% rename from exchange/exchange-ps/exchange/Enable-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MailUser.md index 0a00e13f2c..431b7b0427 100644 --- a/exchange/exchange-ps/exchange/Enable-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MailUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-MailUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-mailuser +schema: 2.0.0 +title: Enable-MailUser --- # Enable-MailUser @@ -68,6 +69,9 @@ This example mail-enables user John with the external email address john@contoso ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the user that you want to mail-enable. You can use any value that uniquely identifies the user. For example: - Name @@ -79,7 +83,6 @@ The Identity parameter specifies the user that you want to mail-enable. You can Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalEmailAddress parameter specifies an email address outside the organization. Email messages sent to the mail-enabled user are sent to this external address. ```yaml Type: ProxyAddress -Parameter Sets: EnabledUser +Parameter Sets: EnabledUser, EnableGuestUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -104,20 +109,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: ProxyAddress -Parameter Sets: EnableGuestUser -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Alias -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -142,7 +137,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +146,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -161,7 +158,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +167,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,13 +185,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,6 +203,9 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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) @@ -219,7 +222,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -229,6 +231,9 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -244,7 +249,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,6 +258,9 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -270,7 +277,6 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,6 +286,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. By default, the primary address is the same as the ExternalEmailAddress parameter value. @@ -290,7 +299,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,6 +308,9 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -309,7 +320,6 @@ The UsePreferMessageFormat specifies whether the message format settings configu Type: Boolean Parameter Sets: EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -319,13 +329,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Enable-Mailbox.md similarity index 90% rename from exchange/exchange-ps/exchange/Enable-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-Mailbox.md index 3a49c7ac0c..dc154ed3be 100644 --- a/exchange/exchange-ps/exchange/Enable-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Enable-Mailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-mailbox +schema: 2.0.0 +title: Enable-Mailbox --- # Enable-Mailbox @@ -302,6 +303,9 @@ This example creates a remote archive for the existing on-premises user named Ay ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the user or InetOrgPerson object that you want to mailbox-enable. You can use any value that uniquely identifies the user. For example: - Name @@ -313,7 +317,6 @@ The Identity parameter specifies the user or InetOrgPerson object that you want Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -323,6 +326,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Arbitration switch is required to mailbox-enable arbitration mailboxes. You don't need to specify a value with this switch. @@ -333,7 +339,6 @@ Arbitration mailboxes are system mailboxes that are used for storing different t Type: SwitchParameter Parameter Sets: Arbitration Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -343,6 +348,9 @@ Accept wildcard characters: False ``` ### -ArchiveDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArchiveDomain parameter specifies the domain in the cloud-based service where the archive that's associated with this mailbox exists. For example, if the SMTP email address of the user is tony@contoso.com, the SMTP domain could be archive.contoso.com. @@ -353,7 +361,6 @@ Only use this parameter if the archive is hosted in the cloud-based service. Type: SmtpDomain Parameter Sets: RemoteArchive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -363,6 +370,9 @@ Accept wildcard characters: False ``` ### -Discovery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Discovery switch is required to mailbox-enable Discovery mailboxes. You don't need to specify a value with this switch. @@ -373,7 +383,6 @@ Discovery mailboxes are created as target mailboxes for Discovery searches. Afte Type: SwitchParameter Parameter Sets: Discovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -383,6 +392,9 @@ Accept wildcard characters: False ``` ### -Equipment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Equipment switch is required to mailbox-enable equipment mailboxes. You don't need to specify a value with this switch. @@ -393,7 +405,6 @@ Equipment mailboxes are resource mailboxes that aren't associated with a specifi Type: SwitchParameter Parameter Sets: Equipment Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -403,6 +414,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if the mailbox is a linked mailbox. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter. Use the fully qualified domain name (FQDN) of the domain controller that you want to use as the value for this parameter. @@ -413,7 +427,6 @@ This parameter is required only if you're enabling a linked mailbox. Type: String Parameter Sets: LinkedRoomMailbox, Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -423,6 +436,9 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: @@ -438,7 +454,6 @@ This parameter is required only if you're enabling a linked mailbox. Type: UserIdParameter Parameter Sets: LinkedRoomMailbox, Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -448,6 +463,9 @@ Accept wildcard characters: False ``` ### -LinkedRoom + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedRoom switch is required to mailbox-enable linked resource mailboxes. You don't need to specify a value with this switch. @@ -458,7 +476,6 @@ A linked resource mailbox is useful in a scenario where you have an account in a Type: SwitchParameter Parameter Sets: LinkedRoomMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -468,6 +485,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PublicFolder switch is required to mailbox-enable public folder mailboxes. You don't need to specify a value with this switch. @@ -478,7 +498,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -488,6 +507,9 @@ Accept wildcard characters: False ``` ### -Room + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Room switch is required to mailbox-enable room mailboxes. You don't need to specify a value with this switch. @@ -498,7 +520,6 @@ Room mailboxes are resource mailboxes that are associated with a specific locati Type: SwitchParameter Parameter Sets: Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -508,6 +529,9 @@ Accept wildcard characters: False ``` ### -Shared + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Shared switch is required to connect shared mailboxes. You don't need to specify a value with this switch. @@ -518,7 +542,6 @@ A shared mailbox is a mailbox where multiple users can log on to access the mail Type: SwitchParameter Parameter Sets: Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -528,6 +551,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ActiveSyncMailboxPolicy parameter specifies the mobile device mailbox policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example:. @@ -542,7 +568,6 @@ If you don't use this parameter, the default mobile device mailbox policy is app Type: MailboxPolicyIdParameter Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -552,6 +577,9 @@ Accept wildcard characters: False ``` ### -AddressBookPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AddressBookPolicy parameter specifies the address book policy that's applied to the mailbox. You can use any value that uniquely identifies the address book policy. For example: @@ -566,7 +594,6 @@ For more information about address book policies, see [Address book policies in Type: AddressBookMailboxPolicyIdParameter Parameter Sets: User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -576,6 +603,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. @@ -602,7 +632,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -612,13 +641,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Archive switch creates an archive mailbox for an existing user that already has a mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -628,6 +659,9 @@ Accept wildcard characters: False ``` ### -ArchiveDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArchiveDatabase parameter specifies the Exchange database that contains the archive that's associated with this mailbox. You can use any value that uniquely identifies the database. For example: @@ -640,7 +674,6 @@ The ArchiveDatabase parameter specifies the Exchange database that contains the Type: DatabaseIdParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -650,6 +683,9 @@ Accept wildcard characters: False ``` ### -ArchiveGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -658,7 +694,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -668,6 +703,9 @@ Accept wildcard characters: False ``` ### -ArchiveName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). In on-premises Exchange, if you don't use this parameter, the following default values are used based on the version of Exchange: @@ -684,7 +722,6 @@ In Outlook in Exchange Online, the value of this parameter is ignored. The name Type: MultiValuedProperty Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -694,6 +731,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -702,7 +742,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: AuditLog Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -712,6 +751,9 @@ Accept wildcard characters: False ``` ### -AutoExpandingArchive + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AutoExpandingArchive switch enables the auto-expanding archiving feature for the specified mailbox. You don't need to specify a value with this switch. @@ -727,7 +769,6 @@ After you enable auto-expanding archiving, additional storage space is automatic Type: SwitchParameter Parameter Sets: AutoExpandingArchive Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -737,6 +778,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -746,7 +790,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -756,6 +799,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Database parameter specifies the Exchange database that contains the new mailbox. You can use any value that uniquely identifies the database. For example: @@ -768,7 +814,6 @@ The Database parameter specifies the Exchange database that contains the new mai Type: DatabaseIdParameter Parameter Sets: Arbitration, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -778,6 +823,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -788,7 +836,6 @@ If you don't use DisplayName parameter, the value of the Name property is used f Type: String Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -798,6 +845,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -806,7 +856,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -816,6 +865,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -824,7 +876,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -834,6 +885,9 @@ Accept wildcard characters: False ``` ### -HoldForMigration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The HoldForMigration switch specifies whether to prevent any client or user, except the Microsoft Exchange Mailbox Replication service (MRS) process, from logging on to a public folder mailbox. You don't need to specify a value with this switch. @@ -846,7 +900,6 @@ Use this switch only if you plan to migrate legacy Exchange 2010 public folders Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -856,6 +909,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the credentials used to access the domain controller that's specified by the LinkedDomainController parameter. This parameter is optional, even if you're enabling a linked mailbox. @@ -866,7 +922,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: LinkedRoomMailbox, Linked Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -876,6 +931,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicy + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox policy to enable for the mailbox that you create. If you don't specify this parameter, the default managed folder mailbox policy is used. @@ -884,7 +942,6 @@ The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox po Type: MailboxPolicyIdParameter Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -894,6 +951,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicyAllowed + +> Applicable: Exchange Server 2010 + This parameter is available in Exchange Server 2010. The ManagedFolderMailboxPolicyAllowed switch specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for clients using versions of Outlook earlier than Office Outlook 2007. You don't need to specify a value with this switch. @@ -906,7 +966,6 @@ Outlook 2003 Service Pack 3 clients are supported but are provided limited funct Type: SwitchParameter Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -916,6 +975,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. @@ -926,7 +988,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -936,6 +997,9 @@ Accept wildcard characters: False ``` ### -RemoteArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoteArchive switch specifies that a remote archive mailbox is created for this mailbox. A remote archive exists in the cloud-based service. You don't need to specify a value with this switch. @@ -946,7 +1010,6 @@ You need to use this parameter with the ArchiveDomain parameter, and you can't u Type: SwitchParameter Parameter Sets: RemoteArchive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -956,6 +1019,9 @@ Accept wildcard characters: False ``` ### -RetentionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RetentionPolicy parameter specifies the retention policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example: @@ -970,7 +1036,6 @@ Retention policies consist of tags that are applied to mailbox folders and mail Type: MailboxPolicyIdParameter Parameter Sets: Arbitration, RemoteArchive, Discovery, Equipment, LinkedRoomMailbox, Linked, PublicFolder, Room, Shared, User, Archive, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -980,6 +1045,9 @@ Accept wildcard characters: False ``` ### -RoleAssignmentPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RoleAssignmentPolicy parameter specifies the management role assignment policy that's assigned to the mailbox. You can use any value that uniquely identifies the policy. For example: - Name @@ -992,7 +1060,6 @@ If you don't use this parameter, the default role assignment policy is used. If Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1002,13 +1069,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MailboxQuarantine.md similarity index 89% rename from exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MailboxQuarantine.md index 94f1b1b2d7..cf97201621 100644 --- a/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MailboxQuarantine.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailboxquarantine applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-MailboxQuarantine -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-mailboxquarantine +schema: 2.0.0 +title: Enable-MailboxQuarantine --- # Enable-MailboxQuarantine @@ -67,6 +68,9 @@ This example quarantines the mailbox for the user Brian Johnson. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013 + The Identity parameter specifies the mailbox that you want to quarantine. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -84,9 +88,8 @@ You can't use this parameter with the Database parameter. ```yaml Type: GeneralMailboxIdParameter -Parameter Sets: MailboxIdentity +Parameter Sets: MailboxIdentity, MailboxOrMailUserIdentity Aliases: -Applicable: Exchange Server 2013 Required: True Position: 1 @@ -95,20 +98,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: MailboxOrMailUserIdentity -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -Database -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019 -### -Database The Database parameter specifies the database that contains the mailboxes you want to quarantine. You can use any value that uniquely identifies the database. For example: - Name @@ -123,7 +116,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -133,6 +125,9 @@ Accept wildcard characters: False ``` ### -StoreMailboxIdentity + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The StoreMailboxIdentity parameter specifies the mailbox that you want to quarantine when you use the Database parameter. You identify the mailbox by its GUID value. You can find the GUID value by using the Get-Mailbox or Get-MailboxStatistics cmdlets. @@ -143,7 +138,6 @@ You can't use this parameter with the Identity parameter. Type: StoreMailboxIdParameter Parameter Sets: StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -153,6 +147,9 @@ Accept wildcard characters: False ``` ### -AllowMigration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AllowMigration switch allows a quarantined mailbox to be moved to another mailbox database or to the cloud. You don't need to specify a value with this switch. Moving a mailbox is one method of correcting data corruption that's required before releasing the mailbox from quarantine. @@ -161,7 +158,6 @@ Moving a mailbox is one method of correcting data corruption that's required bef Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +167,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -182,7 +181,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,6 +190,9 @@ Accept wildcard characters: False ``` ### -Duration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Duration parameter specifies how long the mailbox should remain quarantined. The default value is 24 hours. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -200,7 +201,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,13 +210,15 @@ Accept wildcard characters: False ``` ### -QuarantineReason + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The QuarantineReason parameter specifies why you quarantined the mailbox. The maximum length is 255 characters. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: StoreMailboxIdentity, MailboxOrMailUserIdentity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -226,13 +228,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MalwareFilterRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MalwareFilterRule.md index d671effeae..b323fd1b21 100644 --- a/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MalwareFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Enable-MalwareFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-malwarefilterrule +schema: 2.0.0 +title: Enable-MalwareFilterRule --- # Enable-MalwareFilterRule @@ -43,13 +44,15 @@ This example enables the disabled malware filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter rule that you want to enable. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -86,7 +94,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Enable-MetaCacheDatabase.md similarity index 95% rename from exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-MetaCacheDatabase.md index 642a0ec9b8..e498da9e61 100644 --- a/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-MetaCacheDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-metacachedatabase applicable: Exchange Server 2019 -title: Enable-MetaCacheDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-metacachedatabase +schema: 2.0.0 +title: Enable-MetaCacheDatabase --- # Enable-MetaCacheDatabase @@ -42,6 +43,9 @@ This example enables the metacache database on the Exchange server named Mailbox ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2019 + The Server parameter specifies the Mailbox server where you want to enable the metacache database. You can use any value that uniquely identifies the server. For example: - Name @@ -55,7 +59,6 @@ You can specify multiple values separated by commas. If the value contains space Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: True Position: Named @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md b/exchange/exchange-ps/ExchangePowerShell/Enable-OrganizationCustomization.md similarity index 95% rename from exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-OrganizationCustomization.md index 23f178be9e..0737dacb31 100644 --- a/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-OrganizationCustomization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-organizationcustomization applicable: Exchange Online, Exchange Online Protection -title: Enable-OrganizationCustomization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-organizationcustomization +schema: 2.0.0 +title: Enable-OrganizationCustomization --- # Enable-OrganizationCustomization @@ -56,6 +57,9 @@ This example runs the command as required. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -65,7 +69,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md b/exchange/exchange-ps/ExchangePowerShell/Enable-OutlookAnywhere.md similarity index 96% rename from exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-OutlookAnywhere.md index f2706fde72..f3108d903a 100644 --- a/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-OutlookAnywhere.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-outlookanywhere applicable: Exchange Server 2010 -title: Enable-OutlookAnywhere -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-outlookanywhere +schema: 2.0.0 +title: Enable-OutlookAnywhere --- # Enable-OutlookAnywhere @@ -84,6 +85,9 @@ This example enables the Exchange Client Access server for Outlook Anywhere. The ## PARAMETERS ### -ClientAuthenticationMethod + +> Applicable: Exchange Server 2010 + The ClientAuthenticationMethod parameter specifies the authentication method that the Autodiscover service provides to the Outlook Anywhere clients to authenticate to the Client Access server. Valid values are: - Basic @@ -97,7 +101,6 @@ Although this parameter only allows setting one authentication method, the comma Type: AuthenticationMethod Parameter Sets: CustomIdentity Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -DefaultAuthenticationMethod + +> Applicable: Exchange Server 2010 + The DefaultAuthenticationMethod parameter specifies whether to set both the ClientAuthenticationMethod and IISAuthenticationMethods parameters to the same authentication value. When you set an authentication value by using the DefaultAuthenticationMethod parameter, you force the specified authentication method to be used on the /rpc virtual directory in Internet Information Services (IIS). Valid values are: @@ -120,7 +126,6 @@ If the DefaultAuthenticationMethod parameter is specified, neither the ClientAut Type: AuthenticationMethod Parameter Sets: DefaultIdentity Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -130,13 +135,15 @@ Accept wildcard characters: False ``` ### -ExternalHostname + +> Applicable: Exchange Server 2010 + The ExternalHostname parameter specifies the external host name to use in the Outlook profiles for users enabled for Outlook Anywhere. ```yaml Type: Hostname Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -146,13 +153,15 @@ Accept wildcard characters: False ``` ### -SSLOffloading + +> Applicable: Exchange Server 2010 + The SSLOffloading parameter specifies whether the Client Access server requires Secure Sockets Layer (SSL). This value should be set only to $true when an SSL hardware solution is running in front of the Client Access server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -171,7 +183,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -181,13 +192,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -197,6 +210,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010 + The ExtendedProtectionFlags parameter is used to customize the options you use if you're using Extended Protection for Authentication. The possible values are: - None: Default setting. @@ -209,7 +225,6 @@ The ExtendedProtectionFlags parameter is used to customize the options you use i Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the specified virtual directory. The possible values are: @@ -230,7 +248,6 @@ The possible values are: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -240,6 +257,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the specified Exchange virtual directory. Extended Protection for Authentication isn't enabled by default. The available settings are: - None Extended Protection for Authentication won't be used. Connections between the client and Exchange won't use Extended Protection for Authentication on this virtual directory. This is the default setting. @@ -257,7 +277,6 @@ To learn more about Extended Protection for Authentication, see [Understanding E Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -267,6 +286,9 @@ Accept wildcard characters: False ``` ### -IISAuthenticationMethods + +> Applicable: Exchange Server 2010 + The IISAuthenticationMethods parameter specifies the authentication method that's enabled on the /rpc virtual directory in IIS. You can set the virtual directory to allow Basic authentication or NTLM authentication. Alternatively, you can also set the virtual directory to allow both Basic and NTLM authentication. All other authentication methods are disabled. You may want to enable both Basic and NTLM authentication if you're using the IIS virtual directory with multiple applications that require different authentication methods. @@ -279,7 +301,6 @@ For more information about configuring this parameter with multiple values, see Type: MultiValuedProperty Parameter Sets: CustomIdentity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -289,6 +310,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Client Access server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -300,7 +324,6 @@ The Server parameter specifies the Client Access server where you want to run th Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -310,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-OutlookProtectionRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-OutlookProtectionRule.md index 63e2c39801..1224f593ff 100644 --- a/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-OutlookProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-outlookprotectionrule +schema: 2.0.0 +title: Enable-OutlookProtectionRule --- # Enable-OutlookProtectionRule @@ -47,13 +48,15 @@ This example enables the Outlook protection rule Project Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the rule being enabled. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -90,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md b/exchange/exchange-ps/ExchangePowerShell/Enable-PushNotificationProxy.md similarity index 92% rename from exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-PushNotificationProxy.md index e23369448c..468851c7ae 100644 --- a/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-PushNotificationProxy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-pushnotificationproxy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-PushNotificationProxy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-pushnotificationproxy +schema: 2.0.0 +title: Enable-PushNotificationProxy --- # Enable-PushNotificationProxy @@ -54,6 +55,9 @@ This example enables the push notification proxy in the on-premises Exchange org ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -63,7 +67,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Organization parameter specifies the domain name of the Microsoft 365 organization. For example, contoso.onmicrosoft.com. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Uri parameter specifies the push notification service endpoint in Microsoft 365. The default value is . ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Enable-RemoteMailbox.md similarity index 90% rename from exchange/exchange-ps/exchange/Enable-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-RemoteMailbox.md index e2ca574784..a6256027c7 100644 --- a/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-RemoteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-remotemailbox +schema: 2.0.0 +title: Enable-RemoteMailbox --- # Enable-RemoteMailbox @@ -134,6 +135,9 @@ To mail-enable an on-premises user, create the associated mailbox in the service ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the existing on-premises user. You can use any value that uniquely identifies the user. For example: - ADObjectID @@ -148,7 +152,6 @@ The Identity parameter specifies the identity of the existing on-premises user. Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -158,6 +161,9 @@ Accept wildcard characters: False ``` ### -Equipment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox. You don't need to specify a value with this switch. Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers). @@ -168,7 +174,6 @@ You can't use this switch with the Room or Shared switches. Type: SwitchParameter Parameter Sets: Equipment, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -178,6 +183,9 @@ Accept wildcard characters: False ``` ### -Room + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Room switch specifies that the mailbox in the service should be created as a room resource mailbox. You don't need to specify a value with this switch. You can't use this switch with the Equipment or Shared switches. @@ -186,7 +194,6 @@ You can't use this switch with the Equipment or Shared switches. Type: SwitchParameter Parameter Sets: Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -196,6 +203,9 @@ Accept wildcard characters: False ``` ### -Shared + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + **Note**: This switch is available only in Exchange 2013 CU21 or later and Exchange 2016 CU10 or later. To use this switch, you also need to run setup.exe /PrepareAD. For more information, see [KB4133605](https://support.microsoft.com/help/4133605). The Shared switch specifies that the mailbox in the service should be created as a shared mailbox. You don't need to specify a value with this switch. @@ -206,7 +216,6 @@ You can't use this switch with the Room or Equipment switches. Type: SwitchParameter Parameter Sets: Shared Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -216,13 +225,15 @@ Accept wildcard characters: False ``` ### -ACLableSyncedObjectEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -232,6 +243,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -256,7 +270,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -266,13 +279,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Archive switch creates an archive mailbox for an existing cloud-based user that already has a mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -282,6 +297,9 @@ Accept wildcard characters: False ``` ### -ArchiveName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). If you don't use this parameter, the following default values are used based on the version of Exchange: @@ -296,7 +314,6 @@ In Outlook, the value of this parameter is ignored. The name of the archive mail Type: MultiValuedProperty Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -306,6 +323,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -315,7 +335,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,13 +344,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DisplayName parameter specifies the display name for the mailbox that's created in the service. The display name is visible in the Exchange admin center, address lists and Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -341,13 +362,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,13 +380,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -373,13 +398,15 @@ Accept wildcard characters: False ``` ### -RemoteRoutingAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoteRoutingAddress parameter specifies the SMTP address of the mailbox in the service that this user is associated with. ```yaml Type: ProxyAddress Parameter Sets: Default, Room, Equipment, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -389,13 +416,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-ReportSubmissionRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-ReportSubmissionRule.md index 9bf1aa79ac..56e3f4dd50 100644 --- a/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-reportsubmissionrule applicable: Exchange Online -title: Enable-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-reportsubmissionrule +schema: 2.0.0 +title: Enable-ReportSubmissionRule --- # Enable-ReportSubmissionRule @@ -42,13 +43,15 @@ This example enables the report submission rule if it's already disabled. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission rule that you want to enable. The default rule is named DefaultReportSubmissionRule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-SafeAttachmentRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-SafeAttachmentRule.md index 2642212149..f90229ee73 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-safeattachmentrule applicable: Exchange Online -title: Enable-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-safeattachmentrule +schema: 2.0.0 +title: Enable-SafeAttachmentRule --- # Enable-SafeAttachmentRule @@ -44,6 +45,9 @@ This example enables the disabled safe attachment rule named Marketing Departmen ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the disabled safe attachment rule that you want to enable. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-SafeLinksRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Enable-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-SafeLinksRule.md index 1314b22664..c328540126 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-safelinksrule applicable: Exchange Online -title: Enable-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-safelinksrule +schema: 2.0.0 +title: Enable-SafeLinksRule --- # Enable-SafeLinksRule @@ -44,6 +45,9 @@ This example enables the disabled Safe Links rule named Marketing Department URL ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the disabled Safe Links rule that you want to enable. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md b/exchange/exchange-ps/ExchangePowerShell/Enable-ServiceEmailChannel.md similarity index 91% rename from exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-ServiceEmailChannel.md index 206921ec6f..2e4d132aa7 100644 --- a/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-ServiceEmailChannel.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-serviceemailchannel applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-ServiceEmailChannel -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-serviceemailchannel +schema: 2.0.0 +title: Enable-ServiceEmailChannel --- # Enable-ServiceEmailChannel @@ -59,6 +60,9 @@ This example enables the .NET service channel for the user Tony Smith. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the user for which you want to enable the .NET service channel. The user specified must be a valid user in Active Directory who has an Exchange mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -78,7 +82,6 @@ You can use any value that uniquely identifies the mailbox. For example: Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md b/exchange/exchange-ps/ExchangePowerShell/Enable-SmtpDaneInbound.md similarity index 94% rename from exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-SmtpDaneInbound.md index 84502bb3b4..98ea3d22e8 100644 --- a/exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-SmtpDaneInbound.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-smtpdaneinbound applicable: Exchange Online -title: Enable-SmtpDaneInbound -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-smtpdaneinbound +schema: 2.0.0 +title: Enable-SmtpDaneInbound --- # Enable-SmtpDaneInbound @@ -44,13 +45,15 @@ This example enables SMTP DANE for mail sent to contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to enable SMTP DANE (for example, contoso.com). Use the Get-AcceptedDomain cmdlet to see the accepted domains in the organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -76,13 +81,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-SweepRule.md similarity index 91% rename from exchange/exchange-ps/exchange/Enable-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-SweepRule.md index a5d16d3d5f..db15150448 100644 --- a/exchange/exchange-ps/exchange/Enable-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-SweepRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Enable-SweepRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-sweeprule +schema: 2.0.0 +title: Enable-SweepRule --- # Enable-SweepRule @@ -51,6 +52,9 @@ This example enables all Sweep rules in the specified mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Sweep rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). @@ -61,7 +65,6 @@ The Identity parameter specifies the Sweep rule that you want to enable. You can Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the rule you want to enable. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +135,6 @@ The Mailbox parameter specifies the mailbox that contains the rule you want to e Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Enable-TransportAgent.md similarity index 90% rename from exchange/exchange-ps/exchange/Enable-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-TransportAgent.md index 1985292cfa..1c9fd5b5c9 100644 --- a/exchange/exchange-ps/exchange/Enable-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Enable-TransportAgent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-transportagent +schema: 2.0.0 +title: Enable-TransportAgent --- # Enable-TransportAgent @@ -44,13 +45,15 @@ This example enables a fictitious application named Test App in the Transport se ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the display name of the transport agent to be enabled. The length of the name can't exceed 64 characters. ```yaml Type: TransportAgentObjectId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -87,7 +95,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,6 +104,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -109,7 +119,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-TransportRule.md similarity index 88% rename from exchange/exchange-ps/exchange/Enable-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-TransportRule.md index 4f9a620693..fad19405e6 100644 --- a/exchange/exchange-ps/exchange/Enable-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-TransportRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Enable-TransportRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-transportrule +schema: 2.0.0 +title: Enable-TransportRule --- # Enable-TransportRule @@ -53,6 +54,9 @@ This example enables the transport rule named "Require approval of messages to c ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the rule that you want to enable. You can use a Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -102,7 +110,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Mode parameter specifies how the rule operates after it's enabled. Valid values are: - Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery. @@ -124,7 +134,6 @@ The value that has already been set in the rule will be persevered, unless -Mode Type: RuleMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMAutoAttendant.md similarity index 91% rename from exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMAutoAttendant.md index b5a6029718..fdf6d70163 100644 --- a/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Enable-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-umautoattendant +schema: 2.0.0 +title: Enable-UMAutoAttendant --- # Enable-UMAutoAttendant @@ -45,13 +46,15 @@ This example enables the UM auto attendant MyUMAutoAttendant. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM auto attendant being enabled. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMCallAnsweringRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMCallAnsweringRule.md index 871ebf54fd..1d442c6278 100644 --- a/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: Enable-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-umcallansweringrule +schema: 2.0.0 +title: Enable-UMCallAnsweringRule --- # Enable-UMCallAnsweringRule @@ -62,13 +63,15 @@ This example enables the call answering rule MyUMCallAnsweringRule in the mailbo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the UM call answering rule in a UM-enabled mailbox that's to be enabled. ```yaml Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -87,7 +93,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox that contains the UM call answering rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -132,7 +142,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMIPGateway.md similarity index 92% rename from exchange/exchange-ps/exchange/Enable-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMIPGateway.md index 2b49427750..a26ffb5377 100644 --- a/exchange/exchange-ps/exchange/Enable-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Enable-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-umipgateway +schema: 2.0.0 +title: Enable-UMIPGateway --- # Enable-UMIPGateway @@ -47,13 +48,15 @@ This example enables the UM IP gateway MyUMIPGateway. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM IP gateway being enabled. This parameter is the directory object ID for the UM IP gateway. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMMailbox.md similarity index 89% rename from exchange/exchange-ps/exchange/Enable-UMMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMMailbox.md index 64d7a8d5d7..67cdd97fb3 100644 --- a/exchange/exchange-ps/exchange/Enable-UMMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Enable-UMMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-ummailbox +schema: 2.0.0 +title: Enable-UMMailbox --- # Enable-UMMailbox @@ -83,6 +84,9 @@ This example enables Unified Messaging on a SIP-enabled mailbox for tonysmith@co ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the mailbox that you want to enable for Unified Messaging. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -100,7 +104,6 @@ The Identity parameter specifies the mailbox that you want to enable for Unified Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -UMMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMMailboxPolicy parameter specifies the UM mailbox policy that you want to associate with the mailbox. You can use any value that uniquely identifies the policy. For example: - Name @@ -118,9 +124,8 @@ The UMMailboxPolicy parameter specifies the UM mailbox policy that you want to a ```yaml Type: MailboxPolicyIdParameter -Parameter Sets: Identity +Parameter Sets: Identity, CloudVoiceMail Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -129,20 +134,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: CloudVoiceMail -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 +### -AutomaticSpeechRecognitionEnabled -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -### -AutomaticSpeechRecognitionEnabled The AutomaticSpeechRecognitionEnabled parameter specifies whether to enable Automatic Speech Recognition (ASR) for the UM mailbox. Valid values are: - $true: ASR is enabled for the mailbox. This is the default value. ASR is available only if the user's specified preferred language is installed. @@ -152,7 +147,6 @@ The AutomaticSpeechRecognitionEnabled parameter specifies whether to enable Auto Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -162,6 +156,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -171,7 +168,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -181,13 +177,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -197,13 +195,15 @@ Accept wildcard characters: False ``` ### -EnableCloudVoiceMail + +> Applicable: Exchange Server 2016 + The EnableCloudVoiceMail switch specifies whether to enable the mailbox for UM in Skype for Business Online. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: CloudVoiceMail Aliases: -Applicable: Exchange Server 2016 Required: True Position: Named @@ -213,6 +213,9 @@ Accept wildcard characters: False ``` ### -Extensions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Extensions parameter specifies the extension number for the user. Either a single extension number or an array of telephone number extensions can be specified. The user's extension must be unique to the UM dial plan. If you don't use this parameter, the command attempts to use a default telephone number value for the user. If you're using a Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) or E.164 dial plan, you also need to use the SIPResourceIdentifier parameter. @@ -221,7 +224,6 @@ If you don't use this parameter, the command attempts to use a default telephone Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -231,6 +233,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -242,7 +247,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -252,13 +256,15 @@ Accept wildcard characters: False ``` ### -NotifyEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NotifyEmail parameter specifies the email address where the Unified Messaging welcome message is sent. By default, the message is sent to the user's SMTP email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -268,13 +274,15 @@ Accept wildcard characters: False ``` ### -PilotNumber + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PilotNumber parameter specifies the subscriber access number users can dial to gain access to their mailboxes. The default value is the subscriber access number that's specified on the UM dial plan. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -284,6 +292,9 @@ Accept wildcard characters: False ``` ### -PIN + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PIN parameter specifies the value for the initial PIN that's used for the UM mailbox. The PIN is checked against the UM mailbox policy rules. The PIN value must be from 4 through 24 numeric characters. If you don't use this parameter, a system-generated PIN is sent to the user. By default, the PIN generated by the system contains six numeric characters. @@ -292,7 +303,6 @@ If you don't use this parameter, a system-generated PIN is sent to the user. By Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -302,6 +312,9 @@ Accept wildcard characters: False ``` ### -PINExpired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PINExpired parameter specifies whether the PIN is treated as expired. If the PIN isn't supplied, the PIN is treated as expired and users are prompted to reset their PIN the next time they log on. - $true: The user is required to reset their PIN the next time they log on. @@ -311,7 +324,6 @@ The PINExpired parameter specifies whether the PIN is treated as expired. If the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -321,6 +333,9 @@ Accept wildcard characters: False ``` ### -SendWelcomeMail + +> Applicable: Exchange Server 2016 + 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. @@ -330,7 +345,6 @@ The SendWelcomeMail parameter specifies whether you want to send a welcome messa Type: Boolean Parameter Sets: CloudVoiceMail Aliases: -Applicable: Exchange Server 2016 Required: False Position: Named @@ -340,13 +354,15 @@ Accept wildcard characters: False ``` ### -SIPResourceIdentifier + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SIPResourceIdentifier parameter specifies the SIP address or E.164 address for the user. This property is compared to the URI type defined on the UM dial plan. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -356,6 +372,9 @@ Accept wildcard characters: False ``` ### -ValidateOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. You don't need to specify a value with this switch. No changes are made when the ValidateOnly switch is used. @@ -364,7 +383,6 @@ No changes are made when the ValidateOnly switch is used. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -374,13 +392,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMServer.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMServer.md similarity index 95% rename from exchange/exchange-ps/exchange/Enable-UMServer.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMServer.md index 01417d0e76..8ee6d80f46 100644 --- a/exchange/exchange-ps/exchange/Enable-UMServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-umserver applicable: Exchange Server 2010 -title: Enable-UMServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-umserver +schema: 2.0.0 +title: Enable-UMServer --- # Enable-UMServer @@ -47,13 +48,15 @@ This example enables Unified Messaging on the Unified Messaging server named MyU ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the identifier for the Unified Messaging server being enabled. This is the directory object ID for the UM server. ```yaml Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-UMService.md b/exchange/exchange-ps/ExchangePowerShell/Enable-UMService.md similarity index 94% rename from exchange/exchange-ps/exchange/Enable-UMService.md rename to exchange/exchange-ps/ExchangePowerShell/Enable-UMService.md index d0441b4357..3207726463 100644 --- a/exchange/exchange-ps/exchange/Enable-UMService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Enable-UMService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/enable-umservice applicable: Exchange Server 2013, Exchange Server 2016 -title: Enable-UMService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/enable-umservice +schema: 2.0.0 +title: Enable-UMService --- # Enable-UMService @@ -49,6 +50,9 @@ This example enables Unified Messaging on the UM server MyUMServer. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the Exchange 2010 UM server that you want to enable. You can use any value that uniquely identifies the UM server. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the Exchange 2010 UM server that you want to en Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md similarity index 99% rename from exchange/exchange-ps/exchange/exchange.md rename to exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md index 7aab792266..144bee1b49 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md @@ -1,6 +1,7 @@ --- -Module Name: Exchange PowerShell -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +Locale: en-US +Module Guid: 00000000-0000-0000-0000-000000000000 +Module Name: ExchangePowerShell title: exchange --- @@ -34,7 +35,7 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Get-ADSite](Get-ADSite.md) -### [Get-AdSiteLink](Get-AdSiteLink.md) +### [Get-ADSiteLink](Get-ADSiteLink.md) ### [Get-DomainController](Get-DomainController.md) @@ -52,7 +53,7 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Set-ADSite](Set-ADSite.md) -### [Set-AdSiteLink](Set-AdSiteLink.md) +### [Set-ADSiteLink](Set-ADSiteLink.md) ## defender-for-office-365 Cmdlets ### [Disable-AntiPhishRule](Disable-AntiPhishRule.md) @@ -398,7 +399,7 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Set-ExoPhishSimOverrideRule](Set-ExoPhishSimOverrideRule.md) -### [Set-ExoSecOpsOverrideRule](Remove-ExoSecOpsOverrideRule.md) +### [Set-ExoSecOpsOverrideRule](Set-ExoSecOpsOverrideRule.md) ### [Set-HostedConnectionFilterPolicy](Set-HostedConnectionFilterPolicy.md) @@ -940,6 +941,8 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Test-IRMConfiguration](Test-IRMConfiguration.md) +### [Test-M365DataAtRestEncryptionPolicy](Test-M365DataAtRestEncryptionPolicy.md) + ## federation-and-hybrid Cmdlets ### [Add-FederatedDomain](Add-FederatedDomain.md) @@ -1344,8 +1347,12 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Get-MessageTrace](Get-MessageTrace.md) +### [Get-MessageTraceV2](Get-MessageTraceV2.md) + ### [Get-MessageTraceDetail](Get-MessageTraceDetail.md) +### [Get-MessageTraceDetailV2](Get-MessageTraceDetailV2.md) + ### [Get-MessageTrackingLog](Get-MessageTrackingLog.md) ### [Get-MessageTrackingReport](Get-MessageTrackingReport.md) @@ -2156,7 +2163,7 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Get-FilePlanPropertyReferenceId](Get-FilePlanPropertyReferenceId.md) -### [Get-FilePlanPropertyStructure](Get-FilePlanPropertyStructur.md) +### [Get-FilePlanPropertyStructure](Get-FilePlanPropertyStructure.md) ### [Get-FilePlanPropertySubCategory](Get-FilePlanPropertySubCategory.md) @@ -2250,7 +2257,7 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Remove-FilePlanPropertyReferenceId](Remove-FilePlanPropertyReferenceId.md) -### [Remove-FilePlanPropertySubCategory](Remove-FilePlanPropertySubCategor.md) +### [Remove-FilePlanPropertySubCategory](Remove-FilePlanPropertySubCategory.md) ### [Remove-HoldCompliancePolicy](Remove-HoldCompliancePolicy.md) @@ -2280,7 +2287,7 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Set-ComplianceTag](Set-ComplianceTag.md) -### [Set-FilePlanPropertyAuthority](Set-FilePlanPropertyAuthorit.md) +### [Set-FilePlanPropertyAuthority](Set-FilePlanPropertyAuthority.md) ### [Set-FilePlanPropertyCategory](Set-FilePlanPropertyCategory.md) @@ -2404,7 +2411,7 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Get-MailFilterListReport](Get-MailFilterListReport.md) -### [Get-MailflowStatusReport](Get-MailflowStatusReport.md) +### [Get-MailFlowStatusReport](Get-MailFlowStatusReport.md) ### [Get-MailTrafficEncryptionReport](Get-MailTrafficEncryptionReport.md) @@ -2434,7 +2441,7 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Get-SupervisoryReviewTopCasesReport](Get-SupervisoryReviewTopCasesReport.md) -### [Test-Message](Test-Message.md] +### [Test-Message](Test-Message.md) ## role-based-access-control Cmdlets ### [Add-ManagementRoleEntry](Add-ManagementRoleEntry.md) @@ -2706,11 +2713,11 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Get-UMMailbox](Get-UMMailbox.md) -### [Get-UMMailboxPIN](Get-UMMailboxPIN.md) +### [Get-UMMailboxPin](Get-UMMailboxPin.md) ### [Get-UMMailboxPolicy](Get-UMMailboxPolicy.md) -### [Get-UmServer](Get-UmServer.md) +### [Get-UMServer](Get-UMServer.md) ### [Get-UMService](Get-UMService.md) @@ -2756,7 +2763,7 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Set-UMMailboxPolicy](Set-UMMailboxPolicy.md) -### [Set-UmServer](Set-UmServer.md) +### [Set-UMServer](Set-UMServer.md) ### [Set-UMService](Set-UMService.md) diff --git a/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md b/exchange/exchange-ps/ExchangePowerShell/Execute-AzureADLabelSync.md similarity index 95% rename from exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md rename to exchange/exchange-ps/ExchangePowerShell/Execute-AzureADLabelSync.md index 8da13825b6..3868bcd8ea 100644 --- a/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md +++ b/exchange/exchange-ps/ExchangePowerShell/Execute-AzureADLabelSync.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/execute-azureadlabelsync applicable: Security & Compliance -title: Execute-AzureADLabelSync -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/execute-azureadlabelsync +schema: 2.0.0 +title: Execute-AzureADLabelSync --- # Execute-AzureADLabelSync diff --git a/exchange/exchange-ps/exchange/Expedite-Delicensing.md b/exchange/exchange-ps/ExchangePowerShell/Expedite-Delicensing.md similarity index 95% rename from exchange/exchange-ps/exchange/Expedite-Delicensing.md rename to exchange/exchange-ps/ExchangePowerShell/Expedite-Delicensing.md index f5c2af5041..f490e9a900 100644 --- a/exchange/exchange-ps/exchange/Expedite-Delicensing.md +++ b/exchange/exchange-ps/ExchangePowerShell/Expedite-Delicensing.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/expedite-delicensing applicable: Exchange Online -title: Expedite-Delicensing -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/expedite-delicensing +schema: 2.0.0 +title: Expedite-Delicensing --- # Expedite-Delicensing @@ -40,6 +41,9 @@ This example ends the delay for the mailbox license removal request on the speci ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox with a pending mailbox license removal request. You can use any value that uniquely identifies the mailbox. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the mailbox. For example: Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 diff --git a/exchange/exchange-ps/exchange/Export-ActiveSyncLog.md b/exchange/exchange-ps/ExchangePowerShell/Export-ActiveSyncLog.md similarity index 87% rename from exchange/exchange-ps/exchange/Export-ActiveSyncLog.md rename to exchange/exchange-ps/ExchangePowerShell/Export-ActiveSyncLog.md index 2af091f5e0..044fde6d46 100644 --- a/exchange/exchange-ps/exchange/Export-ActiveSyncLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-ActiveSyncLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-activesynclog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-ActiveSyncLog -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-activesynclog +schema: 2.0.0 +title: Export-ActiveSyncLog --- # Export-ActiveSyncLog @@ -64,13 +65,15 @@ This example exports the Exchange ActiveSync log for the date range 02/01/18 to ## PARAMETERS ### -Filename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filename parameter specifies the name of the input file. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -89,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EndDate parameter specifies the end date of the date range of the report. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -123,7 +133,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -OutputPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OutputPath parameter specifies the name and location for the output file. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -OutputPrefix + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OutputPrefix parameter specifies a prefix to append to the name of the output file. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The StartDate parameter specifies the start date of the date range for the report. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +196,9 @@ Accept wildcard characters: False ``` ### -UseGMT + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UseGMT switch specifies that Coordinated Universal Time (Greenwich Mean Time) is used for the time in the report output. You don't need to specify a value with this switch. If you don't use this switch, local time is used. @@ -189,7 +207,6 @@ If you don't use this switch, local time is used. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,13 +216,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md b/exchange/exchange-ps/ExchangePowerShell/Export-ActivityExplorerData.md similarity index 96% rename from exchange/exchange-ps/exchange/Export-ActivityExplorerData.md rename to exchange/exchange-ps/ExchangePowerShell/Export-ActivityExplorerData.md index 78b9dd23dd..9da4987e32 100644 --- a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-ActivityExplorerData.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata applicable: Security & Compliance -title: Export-ActivityExplorerData -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-activityexplorerdata +schema: 2.0.0 +title: Export-ActivityExplorerData --- # Export-ActivityExplorerData @@ -219,6 +220,9 @@ This example exports up to 100 records for the specified date range in JSON form ## PARAMETERS ### -EndTime + +> Applicable: Security & Compliance + The EndTime parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -227,7 +231,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -237,6 +240,9 @@ Accept wildcard characters: False ``` ### -OutputFormat + +> Applicable: Security & Compliance + The OutputFormat parameter specifies the output format. Valid values are: - Csv @@ -247,7 +253,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: csv, json -Applicable: Security & Compliance Required: True Position: Named @@ -257,6 +262,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: Security & Compliance + The StartTime parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -265,7 +273,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -275,6 +282,9 @@ Accept wildcard characters: False ``` ### -Filter1 + +> Applicable: Security & Compliance + The Filter1 parameter filters the data to export. This parameter takes a minimum of two values as input: a filter name and at least one filter value. For example, `@("Activity", "LabelApplied")` returns records with the activity value `LabelApplied`. If you specify multiple filter values for the same parameter, OR behavior is used. For example, `@("Activity", "LabelApplied", "LabelRemoved")` returns records with the activity values `LabelApplied` or `LabelRemoved`. @@ -287,7 +297,6 @@ If you use this parameter with other filter parameters, AND behavior is used acr Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -297,6 +306,9 @@ Accept wildcard characters: False ``` ### -Filter2 + +> Applicable: Security & Compliance + The Filter2 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. Use this parameter only if you're also using the Filter1 parameter in the same command. @@ -305,7 +317,6 @@ Use this parameter only if you're also using the Filter1 parameter in the same c Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -315,6 +326,9 @@ Accept wildcard characters: False ``` ### -Filter3 + +> Applicable: Security & Compliance + The Filter3 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. Use this parameter only if you're also using the Filter2 and Filter1 parameters in the same command. @@ -323,7 +337,6 @@ Use this parameter only if you're also using the Filter2 and Filter1 parameters Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -333,6 +346,9 @@ Accept wildcard characters: False ``` ### -Filter4 + +> Applicable: Security & Compliance + The Filter4 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. Use this parameter only if you're also using the Filter3, Filter2, and Filter1 parameters in the same command. @@ -341,7 +357,6 @@ Use this parameter only if you're also using the Filter3, Filter2, and Filter1 p Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -351,6 +366,9 @@ Accept wildcard characters: False ``` ### -Filter5 + +> Applicable: Security & Compliance + The Filter5 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. Use this parameter only if you're also using the Filter4, Filter3, Filter2, and Filter1 parameters in the same command. @@ -359,7 +377,6 @@ Use this parameter only if you're also using the Filter4, Filter3, Filter2, and Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -369,13 +386,15 @@ Accept wildcard characters: False ``` ### -PageCookie + +> Applicable: Security & Compliance + The PageCookie parameter specifies whether to get more data when the value of the LastPage property in the command output is False. If you don't use the PageSize parameter, a maximum of 100 records are returned. If you use the PageSize parameter, a maximum of 5000 records can be returned. To get more records than what as returned in the current command, use the value of the Watermark property from the output of the current command as the value for the PageCookie parameter in a new command with the same date range and filters. The PageCookie value is valid for 120 seconds to fetch the next set of records for same query. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -385,13 +404,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 100. Consider using a smaller PageSize value to avoid PageCookie expiry when exporting large datasets. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md b/exchange/exchange-ps/ExchangePowerShell/Export-AutoDiscoverConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Export-AutoDiscoverConfig.md index 01b6148ebe..b0ec8af14a 100644 --- a/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-AutoDiscoverConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-autodiscoverconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-AutoDiscoverConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-autodiscoverconfig +schema: 2.0.0 +title: Export-AutoDiscoverConfig --- # Export-AutoDiscoverConfig @@ -56,6 +57,9 @@ This example specifies that Exchange is deployed in more than one Active Directo ## PARAMETERS ### -TargetForestDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetForestDomainController parameter specifies the forest or domain controller that you want to export the Autodiscover configuration to. If the target domain controller requires signing, you'll get the error: "A more secure authentication method is required for this server". Domain controllers that require signing aren't supported. @@ -64,7 +68,6 @@ If the target domain controller requires signing, you'll get the error: "A more Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DeleteConfig + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeleteConfig parameter causes the command to delete your configuration settings on the service connection point object. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -MultipleExchangeDeployments + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MultipleExchangeDeployments parameter specifies whether multiple Exchange deployments exist. Valid values are: - $true: Exchange is deployed in more than one Active Directory forest, and the forests are connected. The list of authoritative accepted domains for the source forest is written to the Autodiscover service connection point object. Outlook clients use this object to select the most appropriate forest to search for the Autodiscover service. @@ -134,7 +146,6 @@ The MultipleExchangeDeployments parameter specifies whether multiple Exchange de Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +155,15 @@ Accept wildcard characters: False ``` ### -PreferredSourceFqdn + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PreferredSourceFqdn parameter specifies the FQDN of the Active Directory domain for the Autodiscover pointer service connection point object. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,6 +173,9 @@ Accept wildcard characters: False ``` ### -SourceForestCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceForestCredential parameter specifies the credentials to use when connecting to the source forest. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -168,7 +184,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,6 +193,9 @@ Accept wildcard characters: False ``` ### -TargetForestCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetForestCredential parameter specifies the credentials to use to connect to the target forest. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -186,7 +204,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,13 +213,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-ContentExplorerData.md b/exchange/exchange-ps/ExchangePowerShell/Export-ContentExplorerData.md similarity index 95% rename from exchange/exchange-ps/exchange/Export-ContentExplorerData.md rename to exchange/exchange-ps/ExchangePowerShell/Export-ContentExplorerData.md index 547c01be2a..9f40d2f4b2 100644 --- a/exchange/exchange-ps/exchange/Export-ContentExplorerData.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-ContentExplorerData.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-contentexplorerdata applicable: Security & Compliance -title: Export-ContentExplorerData -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-contentexplorerdata +schema: 2.0.0 +title: Export-ContentExplorerData --- # Export-ContentExplorerData @@ -80,6 +81,9 @@ This example exports records for the specified sensitive info type for all workl ## PARAMETERS ### -TagType + +> Applicable: Security & Compliance + The TagType parameter specifies the type of label to export file details from. Valid values are: - Retention @@ -91,7 +95,6 @@ The TagType parameter specifies the type of label to export file details from. V Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 5 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Aggregate + +> Applicable: Security & Compliance + **Note:** This parameter is currently in Private Preview, isn't available in all organizations, and is subject to change. The Aggregate parameter switch returns the folder level aggregated numbers instead of returning details at the item level. You don't need to specify a value with this switch. @@ -117,7 +123,6 @@ When you use this switch with the TagName, TagType, and Workload parameters, the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -ConfidenceLevel + +> Applicable: Security & Compliance + The ConfidenceLevel parameter specifies the confidence level of the match for the file details to export. Valid values are: - low @@ -138,7 +146,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: high, medium, low -Applicable: Security & Compliance Required: False Position: 0 @@ -148,13 +155,15 @@ Accept wildcard characters: False ``` ### -PageCookie + +> Applicable: Security & Compliance + The PageCookie parameter specifies whether to get more data when the value of the MorePagesAvailable property in the command output is True. If you don't use the PageSize parameter, a maximum of 100 records are returned. If you use the PageSize parameter, a maximum of 10000 records can be returned. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Security & Compliance + The PageSize parameter specifies the maximum number of records to return in a single query. Valid input for this parameter is an integer between 1 and 10000. The default value is 100. **Note**: In empty folders or folders with few files, this parameter can cause the command to run for a long time as it tries to get the PageSize count of the results. To prevent this issue, the command returns data from 5 folders or the number of records specified by the PageSize parameter, whichever completes first. For example, if there are 10 folders with 1 record each, the command returns 5 records of the top 5 folders. In the next execution using page cookie, it returns 5 records from the remaining 5 folders, even if the PageSize value is 10. @@ -172,7 +184,6 @@ The PageSize parameter specifies the maximum number of records to return in a si Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 2 @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -SiteUrl + +> Applicable: Security & Compliance + The SiteUrl parameter specifies the site URL to export file details from. You use this parameter for SharePoint and OneDrive workloads. @@ -190,7 +204,6 @@ You use this parameter for SharePoint and OneDrive workloads. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 3 @@ -200,13 +213,15 @@ Accept wildcard characters: False ``` ### -TagName + +> Applicable: Security & Compliance + The TagName parameter specifies the name of the label to export file details from. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 4 @@ -216,6 +231,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Security & Compliance + The UserPrincipalName parameter specifies the user account in UPN format to export message details from. An example UPN value is erika@contoso.onmicrosoft.com. You use this parameter for Exchange and Microsoft Teams workloads. @@ -224,7 +242,6 @@ You use this parameter for Exchange and Microsoft Teams workloads. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 6 @@ -234,6 +251,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Security & Compliance + The Workload parameter specifies the location to export file details from. Valid values are: - EXO or Exchange @@ -245,7 +265,6 @@ The Workload parameter specifies the location to export file details from. Valid Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 7 diff --git a/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md b/exchange/exchange-ps/ExchangePowerShell/Export-DlpPolicyCollection.md similarity index 91% rename from exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Export-DlpPolicyCollection.md index 0c2de21c86..fd15f00128 100644 --- a/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-DlpPolicyCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-dlppolicycollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Export-DlpPolicyCollection -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-dlppolicycollection +schema: 2.0.0 +title: Export-DlpPolicyCollection --- # Export-DlpPolicyCollection @@ -49,13 +50,15 @@ This example exports all the elements of the existing DLP policies to the file C ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the DLP policy you want to export. You can use any value that uniquely identifies the DLP policy. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy. ```yaml Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Export-ExchangeCertificate.md similarity index 93% rename from exchange/exchange-ps/exchange/Export-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Export-ExchangeCertificate.md index ec431d5516..0d42ee0899 100644 --- a/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-ExchangeCertificate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-exchangecertificate +schema: 2.0.0 +title: Export-ExchangeCertificate --- # Export-ExchangeCertificate @@ -108,6 +109,9 @@ This example exports the same pending certificate request from Example 3. This m ## PARAMETERS ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Thumbprint parameter specifies the certificate or certificate request that you want to export. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. @@ -116,7 +120,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: String Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -126,6 +129,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the certificate or certificate request that you want to export. Valid values are: - `ServerNameOrFQDN\Thumbprint` @@ -141,7 +147,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: ExchangeCertificateIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -151,6 +156,9 @@ Accept wildcard characters: False ``` ### -BinaryEncoded + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BinaryEncoded switch encodes the exported certificate or certificate request file by using Distinguished Encoding Rules (DER). You don't need to specify a value with this switch. Typically, you use this switch when you export a certificate, because you can store the certificate and its private key or chain of trust in a single binary file when you also use the Password parameter. If you don't use this switch, the exported certificate file is Base64 encoded, and you'll need to export any intermediate or root certificates in the chain of trust separately. @@ -159,7 +167,6 @@ Typically, you use this switch when you export a certificate, because you can st Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,6 +176,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -178,7 +188,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +197,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -196,7 +208,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,6 +217,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Exchange Server 2013 + **Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To export the certificate or certificate request to a file without using the FileName parameter, use the methods described in Example 2 and Example 4. This parameter is available only in Exchange 2013. @@ -216,7 +230,6 @@ The FileName parameter specifies the name and path of the exported certificate o Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -226,6 +239,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Password parameter specifies the password for the private key or chain of trust in the exported certificate file. To import the exported certificate file on another server, you need to know the password. You can use the following methods as a value for this parameter: @@ -238,7 +254,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,6 +263,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -263,7 +281,6 @@ You can't use this parameter with the Identity parameter, but you can use it wit Type: ServerIdParameter Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,13 +290,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-FilePlanProperty.md b/exchange/exchange-ps/ExchangePowerShell/Export-FilePlanProperty.md similarity index 93% rename from exchange/exchange-ps/exchange/Export-FilePlanProperty.md rename to exchange/exchange-ps/ExchangePowerShell/Export-FilePlanProperty.md index 91b4a41f26..597a7de70f 100644 --- a/exchange/exchange-ps/exchange/Export-FilePlanProperty.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-FilePlanProperty.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-fileplanproperty applicable: Security & Compliance -title: Export-FilePlanProperty +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-fileplanproperty schema: 2.0.0 +title: Export-FilePlanProperty --- # Export-FilePlanProperty @@ -36,6 +38,9 @@ The example exports the file plan properties. ## PARAMETERS ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -45,7 +50,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -55,13 +59,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -71,13 +77,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Export-JournalRuleCollection.md similarity index 91% rename from exchange/exchange-ps/exchange/Export-JournalRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Export-JournalRuleCollection.md index 0b68ce68f7..88844ce4ba 100644 --- a/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-JournalRuleCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-journalrulecollection applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-JournalRuleCollection -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-journalrulecollection +schema: 2.0.0 +title: Export-JournalRuleCollection --- # Export-JournalRuleCollection @@ -57,13 +58,15 @@ In Exchange Server 2010, this example exports legacy journal rules that were cre ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of a journal rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -ExportLegacyRules + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ExportLegacyRules switch specifies whether to export Exchange 2007 journal rules. You don't need to specify a value with this switch. @@ -116,7 +126,6 @@ The ExportLegacyRules switch specifies whether to export Exchange 2007 journal r Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md b/exchange/exchange-ps/ExchangePowerShell/Export-MailboxDiagnosticLogs.md similarity index 89% rename from exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md rename to exchange/exchange-ps/ExchangePowerShell/Export-MailboxDiagnosticLogs.md index dada5fa300..fac4b1dd30 100644 --- a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-MailboxDiagnosticLogs.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-mailboxdiagnosticlogs applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Export-MailboxDiagnosticLogs -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-mailboxdiagnosticlogs +schema: 2.0.0 +title: Export-MailboxDiagnosticLogs --- # Export-MailboxDiagnosticLogs @@ -71,6 +72,9 @@ This example retrieves the calendar permissions diagnostic log for the mailbox n ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies that mailbox that contains the diagnostics logs that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -88,7 +92,6 @@ The Identity parameter specifies that mailbox that contains the diagnostics logs Type: GeneralMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -ComponentName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ComponentName parameter specifies the component that you want to retrieve the diagnostic logs for. Valid values depend on the type and location of the mailbox (on-premises Exchange or Exchange Online). Valid values include: - AcceptCalendarSharingInvite @@ -127,7 +133,6 @@ The ComponentName parameter specifies the component that you want to retrieve th Type: String Parameter Sets: MailboxLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -137,13 +142,15 @@ Accept wildcard characters: False ``` ### -ExtendedProperties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExtendedProperties switch specifies whether to retrieve all of the well-known properties from the mailbox table that are useful for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ExtendedProperties Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -153,6 +160,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Archive switch retrieves the diagnostics logs of the archive mailbox instead of the primary mailbox. You don't need to specify a value with this switch. @@ -161,7 +171,6 @@ The Archive switch retrieves the diagnostics logs of the archive mailbox instead Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +180,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -180,7 +192,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -190,6 +201,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -200,7 +214,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +223,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -218,7 +234,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +243,9 @@ Accept wildcard characters: False ``` ### -IncludeInactiveMailboxes + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeInactiveMailboxes switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch. @@ -238,7 +256,6 @@ An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Ho Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,6 +265,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -260,7 +280,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,13 +289,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -286,13 +307,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-Message.md b/exchange/exchange-ps/ExchangePowerShell/Export-Message.md similarity index 93% rename from exchange/exchange-ps/exchange/Export-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Export-Message.md index 28b6f435c6..4046ba538f 100644 --- a/exchange/exchange-ps/exchange/Export-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-message applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-Message -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-message +schema: 2.0.0 +title: Export-Message --- # Export-Message @@ -63,13 +64,15 @@ This example retrieves all messages from the specified queue. The query results ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-MigrationReport.md b/exchange/exchange-ps/ExchangePowerShell/Export-MigrationReport.md similarity index 88% rename from exchange/exchange-ps/exchange/Export-MigrationReport.md rename to exchange/exchange-ps/ExchangePowerShell/Export-MigrationReport.md index 4610a82482..98abe6ceae 100644 --- a/exchange/exchange-ps/exchange/Export-MigrationReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-MigrationReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-migrationreport applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Export-MigrationReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-migrationreport +schema: 2.0.0 +title: Export-MigrationReport --- # Export-MigrationReport @@ -55,13 +56,15 @@ There are no examples for using this cmdlet because the values used for the requ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: MigrationReportIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -CsvStream + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Stream Parameter Sets: StreamBased Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -RowCount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: Paged Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -StartingRowIndex + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: Paged Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -128,7 +140,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -146,7 +160,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +169,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -164,7 +180,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/ExchangePowerShell/Export-QuarantineMessage.md similarity index 89% rename from exchange/exchange-ps/exchange/Export-QuarantineMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Export-QuarantineMessage.md index f20bb9e7c2..e18eff76d6 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-QuarantineMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-quarantinemessage applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Export-QuarantineMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-quarantinemessage +schema: 2.0.0 +title: Export-QuarantineMessage --- # Export-QuarantineMessage @@ -88,6 +89,9 @@ This example exports the specified message with attachments that was quarantined ## PARAMETERS ### -Identities + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2...valueN`. Each value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. @@ -98,7 +102,6 @@ When you use this parameter, the Identity parameter is required, but the value i Type: QuarantineMessageIdentity[] Parameter Sets: Identities Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -108,15 +111,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the quarantined message that you want to export. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. ```yaml Type: QuarantineMessageIdentity -Parameter Sets: Identities +Parameter Sets: Identities, IdentityOnly Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -125,20 +130,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: IdentityOnly -Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection +### -CompressOutput -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Security & Compliance, Exchange Online Protection -### -CompressOutput The CompressOutput switch exports the message as a compressed .zip file. You don't need to specify a value with this switch. For exported messages, including messages with attachments, the .zip file contains a folder that's named after the first GUID value in the Identity. The folder contains the .eml message that's named after the second GUID value in the Identity. @@ -147,7 +142,6 @@ For exported messages, including messages with attachments, the .zip file contai Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -157,6 +151,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -168,7 +165,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -178,6 +174,9 @@ Accept wildcard characters: False ``` ### -ForceConversionToMime + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ForceConversionToMime switch converts exported plain text messages to MIME formatting. You don't need to specify a value with this switch. This switch has no effect if the message is already encoded as Base64. @@ -186,7 +185,6 @@ This switch has no effect if the message is already encoded as Base64. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -196,6 +194,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Password parameter specifies the password that's required to open the exported message. You can use the following methods as a value for this parameter: @@ -210,7 +211,6 @@ To enter the password in plain text, use the PasswordV2 parameter. Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -220,13 +220,15 @@ Accept wildcard characters: False ``` ### -PasswordV2 + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The PasswordV2 parameter specifies the plain text value of the password that's required to open the exported message. Enclose the value in quotation marks (for example, `''`). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -236,13 +238,15 @@ Accept wildcard characters: False ``` ### -ReasonForExport + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ReasonForExport parameter specifies why the message was exported. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -252,13 +256,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md b/exchange/exchange-ps/ExchangePowerShell/Export-RecipientDataProperty.md similarity index 89% rename from exchange/exchange-ps/exchange/Export-RecipientDataProperty.md rename to exchange/exchange-ps/ExchangePowerShell/Export-RecipientDataProperty.md index 79ca27c8bb..be24b3e0be 100644 --- a/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-RecipientDataProperty.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-recipientdataproperty applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Export-RecipientDataProperty -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-recipientdataproperty +schema: 2.0.0 +title: Export-RecipientDataProperty --- # Export-RecipientDataProperty @@ -66,6 +67,9 @@ This example exports Ayla Kol's picture file to the local computer. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox or mail contact from which you want to export the recipient data. You can use any value that uniquely identifies the user. For example: - Name @@ -79,7 +83,6 @@ The Identity parameter specifies the mailbox or mail contact from which you want Type: MailboxUserContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -Picture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Picture switch specifies that you're exporting the user's picture. You don't need to specify a value with this switch. The user's picture is exported as a JPEG file. @@ -134,7 +144,6 @@ You can't use this switch with the SpokenName switch. Type: SwitchParameter Parameter Sets: ExportPicture Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -SpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SpokenName switch specifies that you're exporting the user's spoken name. You don't need to specify a value with this switch. The user's spoken name is exported as a WMA 9 file. @@ -154,7 +166,6 @@ You can't use this switch with the Picture switch. Type: SwitchParameter Parameter Sets: ExportSpokenName Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Export-TransportRuleCollection.md similarity index 90% rename from exchange/exchange-ps/exchange/Export-TransportRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Export-TransportRuleCollection.md index 1996ade66b..18d538f220 100644 --- a/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-TransportRuleCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-transportrulecollection applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Export-TransportRuleCollection -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-transportrulecollection +schema: 2.0.0 +title: Export-TransportRuleCollection --- # Export-TransportRuleCollection @@ -64,6 +65,9 @@ You need to run these commands in this example on an Exchange 2010 Hub Transport ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in Exchange Server 2010. The Identity parameter specifies the transport rule that you want to export. You can use any value that uniquely identifies the rule. For example: @@ -76,7 +80,6 @@ The Identity parameter specifies the transport rule that you want to export. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -95,7 +101,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -115,7 +123,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -ExportLegacyRules + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ExportLegacyRules switch is required to export transport rules from Exchange 2007. You don't need to specify a value with this switch. @@ -133,7 +143,6 @@ The ExportLegacyRules switch is required to export transport rules from Exchange Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -Format + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Format parameter specifics the format of the exported transport rule collection. Valid values are: @@ -155,7 +167,6 @@ The Format parameter specifics the format of the exported transport rule collect Type: RuleCollectionFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -165,13 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md b/exchange/exchange-ps/ExchangePowerShell/Export-UMCallDataRecord.md similarity index 90% rename from exchange/exchange-ps/exchange/Export-UMCallDataRecord.md rename to exchange/exchange-ps/ExchangePowerShell/Export-UMCallDataRecord.md index 29e7f3790d..0b1bb2fb95 100644 --- a/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-UMCallDataRecord.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-umcalldatarecord applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Export-UMCallDataRecord -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-umcalldatarecord +schema: 2.0.0 +title: Export-UMCallDataRecord --- # Export-UMCallDataRecord @@ -56,13 +57,15 @@ This example exports all Unified Messaging call data records for February 1, 201 ## PARAMETERS ### -ClientStream + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ClientStream parameter specifies the .NET stream to use to output for the Unified Messaging call data records. ```yaml Type: Stream Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Date + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Date parameter specifies the date of Unified Messaging call data records to retrieve. If there are no call records for the date specified, the report will be empty. ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan to export statistics for. If you don't specify a UM dial plan, statistics include all UM dial plans in the organization. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -139,13 +150,15 @@ Accept wildcard characters: False ``` ### -UMIPGateway + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMIPGateway parameter specifies the UM IP gateway to export statistics for. If you don't specify a gateway, statistics include all UM IP gateways in the selected UM dial plan, or if a UM dial plan isn't selected, statistics include all UM IP gateways in the organization. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-UMPrompt.md b/exchange/exchange-ps/ExchangePowerShell/Export-UMPrompt.md similarity index 91% rename from exchange/exchange-ps/exchange/Export-UMPrompt.md rename to exchange/exchange-ps/ExchangePowerShell/Export-UMPrompt.md index 02e8841d44..99782c9c33 100644 --- a/exchange/exchange-ps/exchange/Export-UMPrompt.md +++ b/exchange/exchange-ps/ExchangePowerShell/Export-UMPrompt.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/export-umprompt applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Export-UMPrompt -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/export-umprompt +schema: 2.0.0 +title: Export-UMPrompt --- # Export-UMPrompt @@ -68,13 +69,15 @@ This example exports a custom greeting for the UM auto attendant MyUMAutoAttenda ## PARAMETERS ### -PromptFileName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PromptFileName parameter specifies the name of the custom prompt to export. ```yaml Type: String Parameter Sets: AACustomGreeting, DPCustomGreeting Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -UMAutoAttendant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMAutoAttendant parameter specifies the UM auto attendant ID. This parameter specifies the directory object identifier for the UM auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: AACustomGreeting Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan. ```yaml Type: UMDialPlanIdParameter Parameter Sets: DPCustomGreeting Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -125,7 +135,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ADPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-ADPermission.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ADPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ADPermission.md index 773f0467b4..d946553a7a 100644 --- a/exchange/exchange-ps/exchange/Get-ADPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ADPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ADPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adpermission +schema: 2.0.0 +title: Get-ADPermission --- # Get-ADPermission @@ -60,13 +61,15 @@ This example returns the permissions that have been granted to the user Chris on ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the object for which you're retrieving permissions. You can retrieve the permissions for any Active Directory object using its distinguished name (DN). If the object is an Exchange object, you might be able to use the object's name. If the DN or the object's name contains spaces, enclose the value in quotation marks ("). ```yaml Type: ADRawEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -84,7 +90,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Owner switch returns the owner of the Active Directory object. You don't need to specify a value with this switch. You can't use this switch with the User parameter. @@ -102,7 +110,6 @@ You can't use this switch with the User parameter. Type: SwitchParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The user parameter filters the results who has permissions on the Active Directory object. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -142,7 +152,6 @@ You can't use this parameter with the Owner parameter. Type: SecurityPrincipalIdParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ADServerSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-ADServerSettings.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-ADServerSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ADServerSettings.md index e44f8bd977..60f17efd20 100644 --- a/exchange/exchange-ps/exchange/Get-ADServerSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ADServerSettings.md @@ -1,27 +1,28 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adserversettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ADServerSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adserversettings +schema: 2.0.0 +title: Get-ADServerSettings --- -# Get-AdServerSettings +# Get-ADServerSettings ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-AdServerSettings cmdlet to view the Active Directory Domain Services (AD DS) environment settings in the current Exchange Management Shell session. The Get-AdServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. +Use the Get-ADServerSettings cmdlet to view the Active Directory Domain Services (AD DS) environment settings in the current Exchange Management Shell session. The Get-ADServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-AdServerSettings [] +Get-ADServerSettings [] ``` ## DESCRIPTION @@ -31,7 +32,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Get-AdServerSettings | Format-List +Get-ADServerSettings | Format-List ``` This example displays the session settings for the current session. diff --git a/exchange/exchange-ps/exchange/Get-ADSite.md b/exchange/exchange-ps/ExchangePowerShell/Get-ADSite.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-ADSite.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ADSite.md index 507afd4a61..fd05d2e031 100644 --- a/exchange/exchange-ps/exchange/Get-ADSite.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ADSite.md @@ -1,27 +1,28 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adsite applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ADSite -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adsite +schema: 2.0.0 +title: Get-ADSite --- -# Get-AdSite +# Get-ADSite ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-AdSite cmdlet to display configuration information about one or more Active Directory sites. +Use the Get-ADSite cmdlet to display configuration information about one or more Active Directory sites. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-AdSite [[-Identity] ] +Get-ADSite [[-Identity] ] [-DomainController ] [] ``` @@ -35,7 +36,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Get-AdSite Default-First-Site-Name +Get-ADSite Default-First-Site-Name ``` This example displays the configuration details for the Active Directory site named Default-First-Site-Name. @@ -43,13 +44,15 @@ This example displays the configuration details for the Active Directory site na ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the Active Directory site for which you want to view configuration details. The identity can be expressed as a GUID or the Active Directory site name. If the Active Directory site name includes spaces, enclose the name in quotation marks ("). ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -67,7 +73,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ATPBuiltInProtectionRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ATPBuiltInProtectionRule.md index 714d4981eb..1ff7c3140b 100644 --- a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ATPBuiltInProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-atpbuiltinprotectionrule applicable: Exchange Online -title: Get-ATPBuiltInProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-atpbuiltinprotectionrule +schema: 2.0.0 +title: Get-ATPBuiltInProtectionRule --- # Get-ATPBuiltInProtectionRule @@ -41,6 +42,9 @@ This example shows the rule for the Built-in protection preset security policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -53,7 +57,6 @@ The name of the only rule is ATP Built-In Protection Rule. Type: DehydrateableRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by the state of the rule. Valid values are: - Disabled @@ -75,7 +81,6 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ATPProtectionPolicyRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ATPProtectionPolicyRule.md index f0a24d140f..1463a2e760 100644 --- a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-atpprotectionpolicyrule applicable: Exchange Online -title: Get-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-atpprotectionpolicyrule +schema: 2.0.0 +title: Get-ATPProtectionPolicyRule --- # Get-ATPProtectionPolicyRule @@ -50,6 +51,9 @@ This example returns detailed information about the rule named Strict Preset Sec ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -62,7 +66,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by the state of the rule. Valid values are: - Enabled @@ -82,7 +88,6 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-ATPTotalTrafficReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ATPTotalTrafficReport.md index 754759eea3..75b267a41d 100644 --- a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ATPTotalTrafficReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-atptotaltrafficreport applicable: Exchange Online, Exchange Online Protection -title: Get-ATPTotalTrafficReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-atptotaltrafficreport +schema: 2.0.0 +title: Get-ATPTotalTrafficReport --- # Get-ATPTotalTrafficReport @@ -69,6 +70,9 @@ This example returns data for the last 5 days. ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -77,7 +81,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Exchange Online Protection + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -114,7 +122,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -148,7 +160,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -158,13 +169,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -190,13 +205,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -214,7 +234,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -224,6 +243,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online, Exchange Online Protection + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. For this cmdlet, valid values are: @@ -239,7 +261,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-AcceptedDomain.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-AcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AcceptedDomain.md index 7a46a55884..9ba5ea4926 100644 --- a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AcceptedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-accepteddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AcceptedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-accepteddomain +schema: 2.0.0 +title: Get-AcceptedDomain --- # Get-AcceptedDomain @@ -49,13 +50,15 @@ This example lists all the authoritative accepted domains in your organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies a string value for the accepted domain. Enter either the GUID or the name of the accepted domain. ```yaml Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -75,7 +81,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -93,7 +101,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-AccessToCustomerDataRequest.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AccessToCustomerDataRequest.md index c42017f450..b2043007fa 100644 --- a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AccessToCustomerDataRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-accesstocustomerdatarequest applicable: Exchange Online, Exchange Online Protection -title: Get-AccessToCustomerDataRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-accesstocustomerdatarequest +schema: 2.0.0 +title: Get-AccessToCustomerDataRequest --- # Get-AccessToCustomerDataRequest @@ -58,6 +59,9 @@ This example returns detailed information the Customer Lockbox request EXSR12345 ## PARAMETERS ### -ApprovalStatus + +> Applicable: Exchange Online, Exchange Online Protection + The ApprovalStatus parameter filters the results by approval status. Valid values are: - Approved @@ -69,7 +73,6 @@ The ApprovalStatus parameter filters the results by approval status. Valid value Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -CreatedAfter + +> Applicable: Exchange Online, Exchange Online Protection + The CreatedAfter parameter filters the results by the creation date in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -90,7 +96,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -RequestId + +> Applicable: Exchange Online, Exchange Online Protection + The RequestId parameter filters the results by reference number (for example, EXSR123456). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDevice.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDevice.md index 76afb95c32..ddefef7cd4 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDevice.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdevice applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDevice -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncdevice +schema: 2.0.0 +title: Get-ActiveSyncDevice --- # Get-ActiveSyncDevice @@ -77,6 +78,9 @@ This example returns the owner names of all Outlook Mobile apps that synch via H ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the ActiveSync device that you want to view. You can use any value that uniquely identifies the device. For example: - GUID @@ -87,7 +91,6 @@ The Identity parameter specifies the ActiveSync device that you want to view. Yo Type: ActiveSyncDeviceIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that has the associated ActiveSync device that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -114,7 +120,6 @@ The Mailbox parameter specifies the mailbox that has the associated ActiveSync d Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -132,7 +140,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -178,7 +188,6 @@ You can filter by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,6 +197,9 @@ Accept wildcard characters: False ``` ### -Monitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch. @@ -198,7 +210,6 @@ Monitoring mailboxes are associated with managed availability and the Exchange H Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,6 +219,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -219,7 +233,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -229,13 +242,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -245,6 +260,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -271,7 +289,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAccessRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAccessRule.md index d3a5a05c35..d5102b012a 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdeviceaccessrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDeviceAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncdeviceaccessrule +schema: 2.0.0 +title: Get-ActiveSyncDeviceAccessRule --- # Get-ActiveSyncDeviceAccessRule @@ -50,13 +51,15 @@ This example lists all device access rules set up on the server. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the unique identifier for the device access rule. ```yaml Type: ActiveSyncDeviceAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAutoblockThreshold.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAutoblockThreshold.md index 0bb8724eba..bee07e3451 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAutoblockThreshold.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceAutoblockThreshold.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdeviceautoblockthreshold applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ActiveSyncDeviceAutoblockThreshold -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncdeviceautoblockthreshold +schema: 2.0.0 +title: Get-ActiveSyncDeviceAutoblockThreshold --- # Get-ActiveSyncDeviceAutoblockThreshold @@ -43,13 +44,15 @@ This example retrieves the threshold settings for the Autoblock threshold rule f ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the Autoblock threshold rule. ```yaml Type: ActiveSyncDeviceAutoblockThresholdIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceClass.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceClass.md index 56664b5b8c..6a373b8d58 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceClass.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdeviceclass applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDeviceClass -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncdeviceclass +schema: 2.0.0 +title: Get-ActiveSyncDeviceClass --- # Get-ActiveSyncDeviceClass @@ -52,6 +53,9 @@ This example lists all device types within the organization along with a count o ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the ActiveSync device class that you want to view. You can use any value that uniquely identifies the ActiveSync device class. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the ActiveSync device class that you want to vi Type: ActiveSyncDeviceClassIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -80,7 +86,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -111,7 +119,6 @@ You can filter by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -135,7 +145,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceStatistics.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceStatistics.md index df60827dd4..c79c8576e2 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncDeviceStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdevicestatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncDeviceStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncdevicestatistics +schema: 2.0.0 +title: Get-ActiveSyncDeviceStatistics --- # Get-ActiveSyncDeviceStatistics @@ -77,13 +78,15 @@ This example retrieves the statistics for the mobile phone configured to synchro ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the user's device ID. If the Mailbox parameter is specified, the Identity parameter is disabled. ```yaml Type: ActiveSyncDeviceIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the user mailbox for which you want to retrieve the mobile phone statistics. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -110,7 +116,6 @@ The Mailbox parameter specifies the user mailbox for which you want to retrieve Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -128,7 +136,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -GetMailboxLog + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The GetMailboxLog switch specifies whether to send the mobile device statistics to the email addresses that are specified by the NotificationEmailAddresses parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NotificationEmailAddresses parameter specifies a comma-separated list of email addresses to receive the mobile device statistics when you use the GetMailboxLog switch. This parameter is meaningful only if you also use the GetMailboxLog switch in the same command. @@ -162,7 +174,6 @@ This parameter is meaningful only if you also use the GetMailboxLog switch in th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -ShowRecoveryPassword + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowRecoveryPassword parameter specifies whether to return the recovery password for the mobile phone as one of the displayed statistics. If this parameter is set to $true, the command returns the recovery password for the mobile phone as one of the displayed statistics. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncMailboxPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncMailboxPolicy.md index c43f7a04a7..13cdaabfc9 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncmailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncmailboxpolicy +schema: 2.0.0 +title: Get-ActiveSyncMailboxPolicy --- # Get-ActiveSyncMailboxPolicy @@ -59,13 +60,15 @@ This example returns the policy settings for the Mobile Device mailbox policy na ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the policy name. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -83,7 +89,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncOrganizationSettings.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncOrganizationSettings.md index 554ac124b7..c6cd6f96fa 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncOrganizationSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncorganizationsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ActiveSyncOrganizationSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncorganizationsettings +schema: 2.0.0 +title: Get-ActiveSyncOrganizationSettings --- # Get-ActiveSyncOrganizationSettings @@ -41,13 +42,15 @@ This example retrieves the ActiveSync organization settings. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the ActiveSync organization settings object that you want to view. The default name of this object is Mobile Mailbox Settings. ```yaml Type: ActiveSyncOrganizationSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -65,7 +71,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncVirtualDirectory.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncVirtualDirectory.md index 84a7bede86..e86d0275ad 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ActiveSyncVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ActiveSyncVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-activesyncvirtualdirectory +schema: 2.0.0 +title: Get-ActiveSyncVirtualDirectory --- # Get-ActiveSyncVirtualDirectory @@ -69,6 +70,9 @@ This example returns a summary list of all Exchange ActiveSync virtual directori ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the ActiveSync virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -83,7 +87,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -106,7 +112,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -124,7 +132,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -160,7 +172,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AdSiteLink.md b/exchange/exchange-ps/ExchangePowerShell/Get-AdSiteLink.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-AdSiteLink.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AdSiteLink.md index 11565da45f..ed22b0467f 100644 --- a/exchange/exchange-ps/exchange/Get-AdSiteLink.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AdSiteLink.md @@ -1,27 +1,28 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adsitelink applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AdSiteLink -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adsitelink +schema: 2.0.0 +title: Get-ADSiteLink --- -# Get-AdSiteLink +# Get-ADSiteLink ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-AdSiteLink cmdlet to view configuration information about an Active Directory IP site link. +Use the Get-ADSiteLink cmdlet to view configuration information about an Active Directory IP site link. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-AdSiteLink [[-Identity] ] +Get-ADSiteLink [[-Identity] ] [-DomainController ] [] ``` @@ -40,7 +41,7 @@ This example returns a list of all IP site links in your organization. ### Example 2 ```powershell -Get-AdSiteLink | Where {$_.ExchangeCost -ne $null} +Get-ADSiteLink | Where {$_.ExchangeCost -ne $null} ``` This example returns a list of all IP site links in your organization that have a specific Exchange cost assigned. @@ -48,13 +49,15 @@ This example returns a list of all IP site links in your organization that have ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name or GUID of the IP site link for which you want to view configuration information. ```yaml Type: AdSiteLinkIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -72,7 +78,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AdaptiveScope.md b/exchange/exchange-ps/ExchangePowerShell/Get-AdaptiveScope.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-AdaptiveScope.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AdaptiveScope.md index 1444986464..1be2c8f35f 100644 --- a/exchange/exchange-ps/exchange/Get-AdaptiveScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AdaptiveScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adaptivescope applicable: Exchange Online, Security & Compliance -title: Get-AdaptiveScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adaptivescope +schema: 2.0.0 +title: Get-AdaptiveScope --- # Get-AdaptiveScope @@ -48,6 +49,9 @@ This example returns detailed information about the adaptive scope named Project ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the adaptive scope that you want to view. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the adaptive scope that you want to view. You c Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 0 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -AdministrativeUnits + +> Applicable: Exchange Online, Security & Compliance + {{ Fill AdministrativeUnits Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -LocationTypes + +> Applicable: Exchange Online, Security & Compliance + {{ Fill LocationTypes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-AddressBookPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-AddressBookPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AddressBookPolicy.md index 83e1de7f90..48627a19bd 100644 --- a/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AddressBookPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-addressbookpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AddressBookPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-addressbookpolicy +schema: 2.0.0 +title: Get-AddressBookPolicy --- # Get-AddressBookPolicy @@ -57,13 +58,15 @@ This example returns information about all address book policies for which the o ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the address book policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -81,7 +87,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/Get-AddressList.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AddressList.md index cf62cd285e..7eacd33705 100644 --- a/exchange/exchange-ps/exchange/Get-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-addresslist +schema: 2.0.0 +title: Get-AddressList --- # Get-AddressList @@ -67,6 +68,9 @@ This example returns detailed information for the address list named building4th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the address list that you want to view. You can use any value that uniquely identifies the address list. For example: - Name @@ -80,7 +84,6 @@ You can't use this parameter with the Container or SearchText parameters. Type: AddressListIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -Container + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Container parameter filters the results based on the location of the address list. Only address lists under the specified path are returned. Valid input for this parameter is the root "\\" (also known as All Address Lists) or an existing address list. You can use any value that uniquely identifies the address list. For example: - Name @@ -103,7 +109,6 @@ You can't use this parameter with the Identity or SearchText parameters. Type: AddressListIdParameter Parameter Sets: Container Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -121,7 +129,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -SearchText + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SearchText parameter filters the results based on the name and display name of the address list. Only address lists whose names or display names that contain the specified text string are returned. If the value contains spaces, enclose the value in quotation marks ("). You can't use this parameter with the Container or Identity parameters. @@ -139,7 +149,6 @@ You can't use this parameter with the Container or Identity parameters. Type: String Parameter Sets: SearchSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md b/exchange/exchange-ps/ExchangePowerShell/Get-AddressRewriteEntry.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AddressRewriteEntry.md index 7faa2b133d..c4273ec8f9 100644 --- a/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AddressRewriteEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-addressrewriteentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AddressRewriteEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-addressrewriteentry +schema: 2.0.0 +title: Get-AddressRewriteEntry --- # Get-AddressRewriteEntry @@ -48,13 +49,15 @@ This example returns the detailed configuration of a single address rewrite entr ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the address rewrite entry to be retrieved. The Identity parameter accepts a GUID or the unique address rewrite name. You can omit the Identity parameter label. ```yaml Type: AddressRewriteEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -72,7 +78,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-AdminAuditLogConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AdminAuditLogConfig.md index e9159a5432..98e1a44545 100644 --- a/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AdminAuditLogConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-adminauditlogconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-AdminAuditLogConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-adminauditlogconfig +schema: 2.0.0 +title: Get-AdminAuditLogConfig --- # Get-AdminAuditLogConfig @@ -45,6 +46,9 @@ This example displays the administrator audit logging settings. The output of th ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -53,7 +57,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md b/exchange/exchange-ps/ExchangePowerShell/Get-AdministrativeUnit.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-AdministrativeUnit.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AdministrativeUnit.md index 6a2753ab2d..d1db51fb3f 100644 --- a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AdministrativeUnit.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-administrativeunit applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AdministrativeUnit -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-administrativeunit +schema: 2.0.0 +title: Get-AdministrativeUnit --- # Get-AdministrativeUnit @@ -52,6 +53,9 @@ This example returns detailed information about the administrative unit with the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the administrative unit that you want to view. You can use any value that uniquely identifies the administrative unit. For example: - Display name (this value is the same in Microsoft Graph PowerShell) @@ -64,7 +68,6 @@ The Identity parameter specifies the administrative unit that you want to view. Type: AdministrativeUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -101,7 +109,6 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,13 +118,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AgentLog.md b/exchange/exchange-ps/ExchangePowerShell/Get-AgentLog.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-AgentLog.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AgentLog.md index 90b89266d4..7cc4bd9fa0 100644 --- a/exchange/exchange-ps/exchange/Get-AgentLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AgentLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-agentlog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AgentLog -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-agentlog +schema: 2.0.0 +title: Get-AgentLog --- # Get-AgentLog @@ -43,6 +44,9 @@ This example returns a report that has statistics collected between 09:00 (9 A.M ## PARAMETERS ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -51,7 +55,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -Location + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Location parameter specifies the directory that contains the log files that you can use to build usage reports. The default path is %ExchangeInstallPath%TransportRoles\\Logs\\AgentLog. You need to enclose the file path in quotation marks ("). ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -77,6 +82,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -85,7 +93,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,6 +102,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -107,7 +117,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AggregateZapReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-AggregateZapReport.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-AggregateZapReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AggregateZapReport.md index fd62052590..fe08151188 100644 --- a/exchange/exchange-ps/exchange/Get-AggregateZapReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AggregateZapReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-aggregatezapreport applicable: Exchange Online -title: Get-AggregateZapReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-aggregatezapreport +schema: 2.0.0 +title: Get-AggregateZapReport --- # Get-AggregateZapReport @@ -57,6 +58,9 @@ This example retrieves information for the specified date range. ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". @@ -67,7 +71,6 @@ If you use the EndDate parameter, you also need to use the StartDate parameter. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 3 @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". @@ -119,7 +129,6 @@ If you use this parameter, you also need to use the StartDate parameter. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 4 diff --git a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishPolicy.md index 332d193a34..86ea27c33c 100644 --- a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-antiphishpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-AntiPhishPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-antiphishpolicy +schema: 2.0.0 +title: Get-AntiPhishPolicy --- # Get-AntiPhishPolicy @@ -50,6 +51,9 @@ This example shows detailed information about the antiphish policy named Office ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the antiphish policy that you want to view. You Type: AntiPhishPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Advanced + +> Applicable: Exchange Online + The Advanced switch filters the properties that are returned to the advanced settings in the policy. For example: - PhishThresholdLevel @@ -83,7 +89,6 @@ Advanced settings are available only in anti-phishing policies in Microsoft Defe Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Impersonation + +> Applicable: Exchange Online + The Impersonation switch filters the properties that are returned to the impersonation settings in the policy. For example: - EnableMailboxIntelligence @@ -123,7 +131,6 @@ Impersonation settings are available only in anti-phishing policies in Microsoft Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -Spoof + +> Applicable: Exchange Online, Exchange Online Protection + The Spoof switch filters the properties that are returned to the spoof settings in the policy. For example: - EnableAntiSpoofEnforcement @@ -144,7 +154,6 @@ You don't need to specify a value with this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishRule.md index 9593dd004c..d21b4063d9 100644 --- a/exchange/exchange-ps/exchange/Get-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: Get-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-antiphishrule +schema: 2.0.0 +title: Get-AntiPhishRule --- # Get-AntiPhishRule @@ -48,6 +49,9 @@ This example returns detailed information about the antiphish rule named Researc ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the antiphish rule that you want to view. You c Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online, Exchange Online Protection + The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-App.md b/exchange/exchange-ps/ExchangePowerShell/Get-App.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-App.md rename to exchange/exchange-ps/ExchangePowerShell/Get-App.md index 4d63102688..a1ade6001f 100644 --- a/exchange/exchange-ps/exchange/Get-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-App.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-App -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-app +schema: 2.0.0 +title: Get-App --- # Get-App @@ -60,13 +61,15 @@ This example displays the summary list of apps installed by administrators for t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID of the app that you want to view. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. ```yaml Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -84,7 +90,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the identity of the mailbox where the apps are installed. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -115,7 +123,6 @@ You can't use this parameter with the Identity parameter. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -OrganizationApp + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OrganizationApp switch includes apps that are installed for the organization (not bound to a specific user) in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -141,6 +150,9 @@ Accept wildcard characters: False ``` ### -PrivateCatalog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PrivateCatalog switch includes private catalog add-ins in the results. You don't need to specify a value with this switch. You need to use this switch with the OrganizationApp switch. @@ -149,7 +161,6 @@ You need to use this switch with the OrganizationApp switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionCompliancePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionCompliancePolicy.md index 1feb6b2100..a945fa35af 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-appretentioncompliancepolicy applicable: Security & Compliance -title: Get-AppRetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-appretentioncompliancepolicy +schema: 2.0.0 +title: Get-AppRetentionCompliancePolicy --- # Get-AppRetentionCompliancePolicy @@ -52,6 +53,9 @@ This example returns detailed information for the app retention compliance polic ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the app retention compliance policy that you wa Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -ErrorPolicyOnly + +> Applicable: Security & Compliance + {{ Fill ErrorPolicyOnly Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -RetentionRuleTypes + +> Applicable: Security & Compliance + The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch. To see the RetentionRuleTypes property, you need to pipe the command to a formatting cmdlet. For example, `Get-AppRetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes`. If you don't use the RetentionRuleTypes switch, the value appears blank. @@ -112,7 +122,6 @@ To see the RetentionRuleTypes property, you need to pipe the command to a format Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionComplianceRule.md index b61fb71ac0..ceca879adc 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AppRetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-appretentioncompliancerule applicable: Security & Compliance -title: Get-AppRetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-appretentioncompliancerule +schema: 2.0.0 +title: Get-AppRetentionComplianceRule --- # Get-AppRetentionComplianceRule @@ -46,6 +47,9 @@ This example returns detailed information for the app retention compliance rule ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance rule that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the app retention compliance rule that you want Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter filters the app retention compliance rule results by the associated app retention compliance policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -76,7 +82,6 @@ The Policy parameter filters the app retention compliance rule results by the as Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ApplicationAccessPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ApplicationAccessPolicy.md index 60e3070aa4..83a5b541f3 100644 --- a/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ApplicationAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection -title: Get-ApplicationAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-applicationaccesspolicy +schema: 2.0.0 +title: Get-ApplicationAccessPolicy --- # Get-ApplicationAccessPolicy @@ -49,13 +50,15 @@ This example returns detailed information for the specified application access p ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the application access policy that you want to view. To find the Identity value for the policy, run the command Get-ApplicationAccessPolicy | Format-List Identity,Description,ScopeName,AccessRight,AppID. ```yaml Type: ApplicationAccessPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-ArcConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-ArcConfig.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-ArcConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ArcConfig.md index 84df4c911e..49101ba1b4 100644 --- a/exchange/exchange-ps/exchange/Get-ArcConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ArcConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-arcconfig applicable: Exchange Online -title: Get-ArcConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-arcconfig +schema: 2.0.0 +title: Get-ArcConfig --- # Get-ArcConfig diff --git a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md b/exchange/exchange-ps/ExchangePowerShell/Get-AtpPolicyForO365.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AtpPolicyForO365.md index 31818f3779..6af619e308 100644 --- a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AtpPolicyForO365.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-atppolicyforo365 applicable: Exchange Online -title: Get-AtpPolicyForO365 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-atppolicyforo365 +schema: 2.0.0 +title: Get-AtpPolicyForO365 --- # Get-AtpPolicyForO365 @@ -50,13 +51,15 @@ This example returns detailed information about the default policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the policy that you want to modify. There's only one policy named Default. ```yaml Type: AtpPolicyForO365IdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md b/exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterEntry.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterEntry.md index f9144d58cd..eef7c64274 100644 --- a/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-attachmentfilterentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AttachmentFilterEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-attachmentfilterentry +schema: 2.0.0 +title: Get-AttachmentFilterEntry --- # Get-AttachmentFilterEntry @@ -27,7 +28,7 @@ Get-AttachmentFilterEntry [[-Identity] ] ``` ## DESCRIPTION -On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchangepowershell/set-attachmentfilterlistconfig). On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. @@ -57,6 +58,9 @@ This example returns only the attachment filter entries that filter attachments ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies which attachment filter entry the command retrieves. The Identity parameter accepts values in the format Type:Name, where Type is one of the following values: - ContentType: This value matches the attachment filter entry against the MIME content type. @@ -66,7 +70,6 @@ The Identity parameter specifies which attachment filter entry the command retri Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -84,7 +90,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterListConfig.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterListConfig.md index f05c82c01c..f58a7b6e34 100644 --- a/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AttachmentFilterListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-attachmentfilterlistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AttachmentFilterListConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-attachmentfilterlistconfig +schema: 2.0.0 +title: Get-AttachmentFilterListConfig --- # Get-AttachmentFilterListConfig @@ -42,6 +43,9 @@ This example returns detailed information about the Attachment Filtering agent c ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -50,7 +54,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuditConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuditConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-AuditConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuditConfig.md index 65476171dc..764e429abb 100644 --- a/exchange/exchange-ps/exchange/Get-AuditConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuditConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-auditconfig applicable: Security & Compliance -title: Get-AuditConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-auditconfig +schema: 2.0.0 +title: Get-AuditConfig --- # Get-AuditConfig @@ -40,13 +41,15 @@ This example shows the auditing configuration in the Microsoft Purview complianc ## PARAMETERS ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuditLogSearch.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuditLogSearch.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-AuditLogSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuditLogSearch.md index a77201fca0..eb76ab1d68 100644 --- a/exchange/exchange-ps/exchange/Get-AuditLogSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuditLogSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-auditlogsearch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AuditLogSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-auditlogsearch +schema: 2.0.0 +title: Get-AuditLogSearch --- # Get-AuditLogSearch @@ -53,13 +54,15 @@ This example returns a list of current administrator audit log searches. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID for an audit log search. You can run the command Get-AuditLogSearch | Format-List Identity to display the GUIDs for all current audit log searches. ```yaml Type: AuditLogSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -CreatedAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CreatedAfter parameter filters the results to audit log searches that were created after the specified date. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -77,7 +83,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -CreatedBefore + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CreatedBefore parameter filters the results to audit log searches that were created before the specified date. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -95,7 +103,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Type parameter specifies the type of audit log searches to return. Use the value Admin to return administrator audit log searches or use mailbox to return mailbox audit log searches. If the Type parameter isn't used, the cmdlet returns both administrator and mailbox audit log searches. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuthConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuthConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-AuthConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuthConfig.md index 7acbfbce8c..0274db23b5 100644 --- a/exchange/exchange-ps/exchange/Get-AuthConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuthConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-authconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AuthConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-authconfig +schema: 2.0.0 +title: Get-AuthConfig --- # Get-AuthConfig @@ -40,13 +41,15 @@ This example retrieves the authorization configuration for the Exchange organiza ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuthRedirect.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuthRedirect.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-AuthRedirect.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuthRedirect.md index a1e538e22c..51703adc07 100644 --- a/exchange/exchange-ps/exchange/Get-AuthRedirect.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuthRedirect.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-authredirect applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AuthRedirect -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-authredirect +schema: 2.0.0 +title: Get-AuthRedirect --- # Get-AuthRedirect @@ -50,13 +51,15 @@ This example shows detailed information about the OAuth redirection object named ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the existing OAuth redirection object that you want to view. The object name uses the syntax `AuthRedirect-Bearer-GUID`. ```yaml Type: AuthRedirectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuthServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuthServer.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-AuthServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuthServer.md index ecf577d5a2..169457a4a0 100644 --- a/exchange/exchange-ps/exchange/Get-AuthServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuthServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-authserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AuthServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-authserver +schema: 2.0.0 +title: Get-AuthServer --- # Get-AuthServer @@ -50,6 +51,9 @@ This example retrieves detailed information for the authorization server named W ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the authorization server object that you want to view. You can use any value that uniquely identifies the authorization server. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the authorization server object that you want t Type: AuthServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -78,7 +84,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-AuthenticationPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AuthenticationPolicy.md index b79c7d9b3c..3de4c64a22 100644 --- a/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AuthenticationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-authenticationpolicy applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AuthenticationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-authenticationpolicy +schema: 2.0.0 +title: Get-AuthenticationPolicy --- # Get-AuthenticationPolicy @@ -55,6 +56,9 @@ In Exchange Online, this example specifies whether legacy Exchange tokens for Ou ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the authentication policy you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the authentication policy you want to view. You Type: AuthPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyExchangeTokens + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowLegacyExchangeTokens switch specifies whether legacy Exchange tokens are allowed for Outlook add-ins in your organization. You don't need to specify a value with this switch. @@ -90,7 +96,6 @@ Legacy Exchange tokens include Exchange user identity and callback tokens. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill TenantId Description }} @@ -108,7 +116,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelPolicy.md index b60b6db4da..5f3b883571 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-autosensitivitylabelpolicy applicable: Security & Compliance -title: Get-AutoSensitivityLabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-autosensitivitylabelpolicy +schema: 2.0.0 +title: Get-AutoSensitivityLabelPolicy --- # Get-AutoSensitivityLabelPolicy @@ -44,6 +45,9 @@ This example returns detailed information about the autosensitivity label policy ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the auto-labeling policy that you want to view. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -ForceValidate + +> Applicable: Security & Compliance + The ForceValidate parameter specifies whether to include details related to the AdminUnits of users, groups, or sites in the policy. Valid values are: - $true: Various properties in the policy include details of the AdminUnits that are associated with current set of selected users, groups, or sites. @@ -89,7 +97,6 @@ The ForceValidate parameter specifies whether to include details related to the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -IncludeProgressFeedback + +> Applicable: Security & Compliance + IncludeProgressFeedback specifies whether to include the labeling progress of files in SharePoint or OneDrive. You don't need to specify a value with this switch. If you use this switch, the command shows the progress of files to be labeled, files labeled in the last 7 days, and total files labeled for enabled auto-labeling policies. @@ -107,7 +117,6 @@ If you use this switch, the command shows the progress of files to be labeled, f Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,6 +126,9 @@ Accept wildcard characters: False ``` ### -IncludeTestModeResults + +> Applicable: Security & Compliance + The IncludeTestModeResults parameter specifies whether to include the status of test mode in the policy details. Valid values are: - $true: Include the status of test mode in the policy details. @@ -126,7 +138,6 @@ The IncludeTestModeResults parameter specifies whether to include the status of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelRule.md index ebaea6d9d6..1c816823d5 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AutoSensitivityLabelRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-autosensitivitylabelrule applicable: Security & Compliance -title: Get-AutoSensitivityLabelRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-autosensitivitylabelrule +schema: 2.0.0 +title: Get-AutoSensitivityLabelRule --- # Get-AutoSensitivityLabelRule @@ -46,6 +47,9 @@ This example displays summary information for all autolabeling rules in the Micr ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the auto-labeling policy rule that you want to Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceValidate + +> Applicable: Security & Compliance + {{ Fill ForceValidate Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -IncludeExecutionRuleGuids + +> Applicable: Security & Compliance + The IncludeExecutionRuleGuids parameter specifies whether to include the execution rule GUID in the rule details. Valid values are: - $true: Include the execution rule GUID in the rule details. @@ -107,7 +117,6 @@ The IncludeExecutionRuleGuids parameter specifies whether to include the executi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,6 +126,9 @@ Accept wildcard characters: False ``` ### -IncludeExecutionRuleInformation + +> Applicable: Security & Compliance + The IncludeExecutionRuleInformation parameter specifies whether to include the execution rule information in the rule details. Valid values are: - $true: Include the execution rule information in the rule details. @@ -126,7 +138,6 @@ The IncludeExecutionRuleInformation parameter specifies whether to include the e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -136,6 +147,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter filters the auto-labeling policy rule results by the associated auto-labeling policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -146,7 +160,6 @@ The Policy parameter filters the auto-labeling policy rule results by the associ Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -156,13 +169,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-AutodiscoverVirtualDirectory.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AutodiscoverVirtualDirectory.md index e8c693c9bf..e37a13db48 100644 --- a/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AutodiscoverVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-autodiscovervirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-AutodiscoverVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-autodiscovervirtualdirectory +schema: 2.0.0 +title: Get-AutodiscoverVirtualDirectory --- # Get-AutodiscoverVirtualDirectory @@ -67,6 +68,9 @@ This example returns a summary list of all Autodiscover virtual directories in t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Autodiscover virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -81,7 +85,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -104,7 +110,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -122,7 +130,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -158,7 +170,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityAddressSpace.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityAddressSpace.md index bfde6fcc4c..ee7c097c2e 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityAddressSpace.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-availabilityaddressspace applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-AvailabilityAddressSpace -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-availabilityaddressspace +schema: 2.0.0 +title: Get-AvailabilityAddressSpace --- # Get-AvailabilityAddressSpace @@ -50,6 +51,9 @@ This example returns details information for the availability address space obje ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the availability address space that you want to view. You can use any value that uniquely identifies the object. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the availability address space that you want to Type: AvailabilityAddressSpaceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -78,7 +84,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-AvailabilityConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityConfig.md index 7932aaed30..92f1bd5067 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-availabilityconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-AvailabilityConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-availabilityconfig +schema: 2.0.0 +title: Get-AvailabilityConfig --- # Get-AvailabilityConfig @@ -46,13 +47,15 @@ In Exchange Online, this examples returns the tenant IDs that free/busy informat ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the availability configuration that you want to view. You don't need to use this parameter, because there's only one availability configuration object named Availability Configuration in any organization. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -70,7 +76,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityReportOutage.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md rename to exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityReportOutage.md index b73d3f29f3..3bcdbbc750 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-AvailabilityReportOutage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-availabilityreportoutage applicable: Exchange Server 2010 -title: Get-AvailabilityReportOutage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-availabilityreportoutage +schema: 2.0.0 +title: Get-AvailabilityReportOutage --- # Get-AvailabilityReportOutage @@ -50,13 +51,15 @@ This example returns all outages reported for Microsoft Outlook services at all ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the outage. ```yaml Type: AvailabilityReportOutageIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -ReportDate + +> Applicable: Exchange Server 2010 + The ReportDate parameter specifies the date to query for the outage report. ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ReportingDatabase + +> Applicable: Exchange Server 2010 + The ReportingDatabase specifies the name of the database on the reporting server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -ReportingServer + +> Applicable: Exchange Server 2010 + The ReportingServer parameter specifies the name of the reporting database server to connect to. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-BlockedConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-BlockedConnector.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-BlockedConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-BlockedConnector.md index c6701d3230..9004e6d029 100644 --- a/exchange/exchange-ps/exchange/Get-BlockedConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-BlockedConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-blockedconnector applicable: Exchange Online, Exchange Online Protection -title: Get-BlockedConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-blockedconnector +schema: 2.0.0 +title: Get-BlockedConnector --- # Get-BlockedConnector @@ -46,13 +47,15 @@ This example returns detailed information for the specified blocked connector. ## PARAMETERS ### -ConnectorId + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorId parameter specifies the blocked connector that you want to view. The value is a GUID (for example, 159eb7c4-75d7-43e2-95fe-ced44b3e0a56). ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md b/exchange/exchange-ps/ExchangePowerShell/Get-BlockedSenderAddress.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md rename to exchange/exchange-ps/ExchangePowerShell/Get-BlockedSenderAddress.md index 4a14ad443b..92c889fdec 100644 --- a/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-BlockedSenderAddress.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-blockedsenderaddress applicable: Exchange Online, Exchange Online Protection -title: Get-BlockedSenderAddress -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-blockedsenderaddress +schema: 2.0.0 +title: Get-BlockedSenderAddress --- # Get-BlockedSenderAddress @@ -47,13 +48,15 @@ This example returns information about the blocked sender laura@contoso.com. ## PARAMETERS ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the email address of the blocked user. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CASMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-CASMailbox.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-CASMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CASMailbox.md index 00439ed122..a742383485 100644 --- a/exchange/exchange-ps/exchange/Get-CASMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CASMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-casmailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-CASMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-casmailbox +schema: 2.0.0 +title: Get-CASMailbox --- # Get-CASMailbox @@ -106,6 +107,9 @@ In Exchange Online, this example filters the cmdlet output to only include share ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -123,7 +127,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -133,6 +136,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncDebugLogging + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActiveSyncDebugLogging switch shows the actual value of the ActiveSyncDebugLogging property for the mailbox. You don't need to specify a value with this switch. If you don't use this switch, the value always appears as $false. @@ -143,7 +149,6 @@ To see this value, you need to use a formatting cmdlet. For example, `Get-CasMai Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -153,13 +158,15 @@ Accept wildcard characters: False ``` ### -ActiveSyncSuppressReadReceipt + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -169,6 +176,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -181,7 +191,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -191,6 +200,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -199,7 +211,6 @@ This parameter requires the creation and passing of a credential object. This cr Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,6 +220,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -217,7 +231,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,6 +240,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -242,7 +258,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -252,6 +267,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -263,7 +281,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -273,6 +290,9 @@ Accept wildcard characters: False ``` ### -Monitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch. @@ -283,7 +303,6 @@ Monitoring mailboxes are associated with managed availability and the Exchange H Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +312,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -304,7 +326,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -314,6 +335,9 @@ Accept wildcard characters: False ``` ### -ProtocolSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings: - ExternalImapSettings @@ -331,7 +355,6 @@ To see these values, you need to use a formatting cmdlet. For example, `Get-CasM Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -341,6 +364,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -353,7 +379,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -363,13 +388,15 @@ Accept wildcard characters: False ``` ### -ReadIsOptimizedForAccessibility + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReadIsOptimizedForAccessibility switch specifies whether to read the value of the IsOptimizedForAccessibility property on the mailbox (whether the mailbox is configured to use the light version of Outlook on the web). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -379,6 +406,9 @@ Accept wildcard characters: False ``` ### -RecalculateHasActiveSyncDevicePartnership + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecalculateHasActiveSyncDevicePartnership switch recalculates the value of the HasActiveSyncDevicePartnership property on the mailbox. You don't need to specify a value with this switch. The value is automatically updated if it's found to be incorrect. @@ -387,7 +417,6 @@ The value is automatically updated if it's found to be incorrect. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -397,6 +426,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are: @@ -418,7 +450,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -428,13 +459,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -444,6 +477,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -458,7 +494,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md b/exchange/exchange-ps/ExchangePowerShell/Get-CASMailboxPlan.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-CASMailboxPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CASMailboxPlan.md index c825898743..6f9a965d48 100644 --- a/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CASMailboxPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-casmailboxplan applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CASMailboxPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-casmailboxplan +schema: 2.0.0 +title: Get-CASMailboxPlan --- # Get-CASMailboxPlan @@ -55,6 +56,9 @@ This example returns detailed information about the specified CAS mailbox plan. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the CAS mailbox plan that you want to view. You can use any value that uniquely identifies the CAS mailbox plan. For example: - Name @@ -67,7 +71,6 @@ The display name and name of the CAS mailbox plan is the same as the correspondi Type: MailboxPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -85,7 +91,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -126,7 +136,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -144,7 +156,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,6 +183,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -185,7 +201,6 @@ The results are sorted in ascending order. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticAnalysis.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticAnalysis.md index 497c465e12..ed3b0dc62d 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticAnalysis.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CalendarDiagnosticAnalysis -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendardiagnosticanalysis +schema: 2.0.0 +title: Get-CalendarDiagnosticAnalysis --- # Get-CalendarDiagnosticAnalysis @@ -99,6 +100,9 @@ For basic analysis of the items, don't include the DetailLevel parameter, or use ## PARAMETERS ### -CalendarLogs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CalendarLogs parameter specifies the calendar item that you want to analyze. You identify the calendar item by storing the output of the Get-CalendarDiagnosticLog cmdlet to a variable and using that variable for the value of this parameter. For example, to analyze the meeting with the subject "November Budget Meeting" in Shannon Steele's mailbox, run the command `$Budget = Get-CalendarDiagnosticLog -Identity "Shannon Steele" -Subject "November Budget Meeting" -ExactMatch` and then use the value `$Budget` for this parameter. @@ -111,7 +115,6 @@ You can't use this parameter with the LogLocation parameter. Type: CalendarLog[] Parameter Sets: DefaultSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -121,6 +124,9 @@ Accept wildcard characters: False ``` ### -LogLocation + +> Applicable: Exchange Server 2013, Exchange Online + **Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To specify the calendar items to analyze, use the CalendarLogs parameter. This parameter is functional only in Exchange 2013. @@ -135,7 +141,6 @@ You can't use this parameter with the CalendarLogs parameter. Type: String[] Parameter Sets: LocationSet Aliases: -Applicable: Exchange Server 2013, Exchange Online Required: True Position: Named @@ -145,6 +150,9 @@ Accept wildcard characters: False ``` ### -DetailLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DetailLevel parameter specifies the level of detail you want to see in the analysis output. Valid values are: - Basic: This is the default value. The calendar item properties that are returned are listed in the Detailed Description. @@ -154,7 +162,6 @@ The DetailLevel parameter specifies the level of detail you want to see in the a Type: AnalysisDetailLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,6 +171,9 @@ Accept wildcard characters: False ``` ### -GlobalObjectId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The GlobalObjectId parameter specifies the identity of the calendar item you want to analyze. In Exchange 2013, you can use this parameter with the LogLocation parameter to specify the calendar item if the location contains multiple exported .msg files. The GlobalObjectId property of the meeting uses the same format as the CleanGlobalObjectId property (for example, 040000008200E00074C5B7101A82E008000000009421DCCD5046CD0100000000000000001000000010B0349F6B17454685E17D9F9512E71F) and the value of the two properties is likely the same. However, the value of GlobalObjectId might not stay the same for all instances of the same meeting in multiple calendars (for example, different attendees invited to different instances of the same recurring meeting). @@ -172,7 +182,6 @@ The GlobalObjectId property of the meeting uses the same format as the CleanGlob Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,6 +191,9 @@ Accept wildcard characters: False ``` ### -OutputAs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OutputAs parameter specifies the output format of the command. Valid values are: - CSV (This is the default value) @@ -192,7 +204,6 @@ The OutputAs parameter specifies the output format of the command. Valid values Type: OutputType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticLog.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticLog.md index 38b63df96c..5de9699698 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticlog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CalendarDiagnosticLog -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendardiagnosticlog +schema: 2.0.0 +title: Get-CalendarDiagnosticLog --- # Get-CalendarDiagnosticLog @@ -70,7 +71,7 @@ The output of this cmdlet contains the following information: - NormalizedSubject: The Subject field of the calendar item. - CleanGlobalObjectId: The identifier that's constant throughout the lifetime of the calendar item. For example, 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. -After you run the Get-CalendarDiagnosticLog cmdlet, you can analyze the calendar data using the Get-CalendarDiagnosticAnalysis cmdlet. For more information, see [Get-CalendarDiagnosticAnalysis](https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis). +After you run the Get-CalendarDiagnosticLog cmdlet, you can analyze the calendar data using the Get-CalendarDiagnosticAnalysis cmdlet. For more information, see [Get-CalendarDiagnosticAnalysis](https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendardiagnosticanalysis). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -113,6 +114,9 @@ In **Exchange 2013**, this example exports all calendar items in the Calendar Di ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that contains the calendar items. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -130,7 +134,6 @@ The Identity parameter specifies the mailbox that contains the calendar items. Y Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -140,6 +143,9 @@ Accept wildcard characters: False ``` ### -LogLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Online + **Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. Usage of this cmdlet is now restricted to the local server. This parameter is functional only in Exchange 2010 and Exchange 2013. @@ -154,9 +160,8 @@ In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAna ```yaml Type: String -Parameter Sets: ExportToMsg +Parameter Sets: ExportToMsg, MeetingId, MeetingSubject Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Online Required: True Position: Named @@ -165,20 +170,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: MeetingId, MeetingSubject -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Online +### -MeetingID -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -MeetingID The MeetingID parameter filters the results by the globally unique identifier of the calendar item. The value is the CleanGlobalObjectId property of the calendar item that's available in the output of this cmdlet, or by using other MAPI examination tools. An example value is 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. This value is constant throughout the lifetime of the calendar item. To find this value, it's easiest to first search for the calendar item by using the Subject, StartDate and EndDate parameters. After you find the calendar item that you want, you can use its CleanGlobalObjectId value for the MeetingID parameter in future commands. @@ -187,9 +182,8 @@ Don't use this parameter with the Subject parameter, because the value of the Me ```yaml Type: String -Parameter Sets: MeetingId +Parameter Sets: MeetingId, ExportToMsg Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -198,29 +192,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ExportToMsg -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Subject -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -Subject The Subject parameter identifies the calendar items by the specified text in the Subject field. The text values that you specify aren't case sensitive. If the value contains spaces, enclose the value in quotation marks ("). You can control whether to use exact matching by using the ExactMatch parameter. Don't use this parameter with the MeetingID parameter, because the value of the MeetingID parameter takes precedence. ```yaml Type: String -Parameter Sets: MeetingSubject +Parameter Sets: MeetingSubject, ExportToMsg Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -229,20 +212,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ExportToMsg -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Credential -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Credential This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -253,7 +226,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,6 +235,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -271,7 +246,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,6 +255,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -289,7 +266,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -299,13 +275,15 @@ Accept wildcard characters: False ``` ### -EntryId + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The EntryId parameter filters the results by entry ID. You can specify multiple values separated by commas. ```yaml Type: String Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -315,6 +293,9 @@ Accept wildcard characters: False ``` ### -ExactMatch + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExactMatch parameter specifies whether to use an exact match or a partial match for text values that you specify for the Subject parameter. Valid values are: - $true: The subject search uses an exact match and searches all calendar items in the mailbox. For example, if you search for "budget", the search looks for items that have "budget" anywhere in the subject, but not "budgeting". @@ -330,7 +311,6 @@ The value of this parameter is ignored when you use the MeetingId parameter. Type: Boolean Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -340,6 +320,9 @@ Accept wildcard characters: False ``` ### -ItemClass + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ItemClass parameter filters the results by the specified MessageClass property value of the calendar item (for example, IPM.Appointment). You can specify multiple values separated by commas. You can only use this parameter with the MeetingID parameter. @@ -348,7 +331,6 @@ You can only use this parameter with the MeetingID parameter. Type: String[] Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -358,13 +340,15 @@ Accept wildcard characters: False ``` ### -ItemIds + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ItemIds parameter filters the results by item ID. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -374,13 +358,15 @@ Accept wildcard characters: False ``` ### -Latest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Latest switch specifies whether to return calendar log data for only the most recent calendar item. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -390,6 +376,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -402,7 +391,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -412,13 +400,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter determines the number of results returned by the cmdlet. The maximum value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -428,6 +418,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -436,7 +429,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticObjects.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticObjects.md index e01ded63d5..27ba38654a 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarDiagnosticObjects.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticobjects applicable: Exchange Online -title: Get-CalendarDiagnosticObjects -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendardiagnosticobjects +schema: 2.0.0 +title: Get-CalendarDiagnosticObjects --- # Get-CalendarDiagnosticObjects @@ -93,6 +94,9 @@ This example returns diagnostic information for meetings with the subject Team L ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox or Microsoft 365 Group whose calendar you want to view. You can use any value that uniquely identifies the mailbox or Microsoft 365 Group. For example: - Name @@ -110,7 +114,6 @@ The Identity parameter specifies the mailbox or Microsoft 365 Group whose calend Type: UnifiedGroupOrUserMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -120,13 +123,15 @@ Accept wildcard characters: False ``` ### -AnalyzeExceptionWithOriginalStartDate + +> Applicable: Exchange Online + {{ Fill AnalyzeExceptionWithOriginalStartDate Description }} ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -136,13 +141,15 @@ Accept wildcard characters: False ``` ### -AutoRequeryOnMeetingId + +> Applicable: Exchange Online + {{ Fill AutoRequeryOnMeetingId Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -152,13 +159,15 @@ Accept wildcard characters: False ``` ### -ConfigurationName + +> Applicable: Exchange Online + {{ Fill ConfigurationName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -168,6 +177,9 @@ Accept wildcard characters: False ``` ### -CustomPropertyNames + +> Applicable: Exchange Online + The CustomPropertyNames parameter returns the specified calendar item custom property in the results. For valid values, see [Values for the CustomPropertyNames parameter in Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/values-for-custompropertynames-parameter). You can specify multiple values separated by commas. @@ -176,7 +188,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range for the OriginalLastModifiedTime property (when the meeting was last modified, not created). Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -194,7 +208,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -204,13 +217,15 @@ Accept wildcard characters: False ``` ### -EntryId + +> Applicable: Exchange Online + The EntryID parameter filters the results by the specified EntryID property value, which corresponds to the MAPI property PR\_ENTRYID. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -220,13 +235,15 @@ Accept wildcard characters: False ``` ### -EwsId + +> Applicable: Exchange Online + {{ Fill EwsId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -ExactMatch + +> Applicable: Exchange Online + The ExactMatch parameter specifies whether to use an exact match or a partial match for text values that you specify for the Subject parameter. Valid values are: - $true: The subject search uses an exact match and searches all calendar items in the mailbox. For example, if you search for "budget", the search looks for items that have "budget" anywhere in the subject, but not "budgeting". @@ -251,7 +271,6 @@ The value of this parameter is ignored when you use the MeetingId parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -261,13 +280,15 @@ Accept wildcard characters: False ``` ### -ItemClass + +> Applicable: Exchange Online + The ItemClass parameter filters the results by the specified MessageClass property value of the calendar item (for example, IPM.Appointment). You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -277,13 +298,15 @@ Accept wildcard characters: False ``` ### -ItemIds + +> Applicable: Exchange Online + The ItemIds parameter filters the results by item ID. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -293,13 +316,15 @@ Accept wildcard characters: False ``` ### -MaxResults + +> Applicable: Exchange Online + {{ Fill MaxResults Description }} ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -309,13 +334,15 @@ Accept wildcard characters: False ``` ### -MeetingId + +> Applicable: Exchange Online + The MeetingId parameter filters the results by the globally unique identifier of the calendar item. The value is the CleanGlobalObjectId property of the calendar item that's available in the output of this cmdlet, or by using other MAPI examination tools. An example value is 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. This value is constant throughout the lifetime of the calendar item. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -325,13 +352,15 @@ Accept wildcard characters: False ``` ### -ODataId + +> Applicable: Exchange Online + {{ Fill ODataId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -341,13 +370,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter determines the number of results returned by the cmdlet. The maximum value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -357,6 +388,9 @@ Accept wildcard characters: False ``` ### -ShouldBindToItem + +> Applicable: Exchange Online + The ShouldBindToItem parameter specifies whether to truncate large streamable property values (for example, AppointmentRecurrenceBlob). Valid values are: - $true: The values of large streamable properties aren't truncated, so the full value is returned. @@ -366,7 +400,6 @@ The ShouldBindToItem parameter specifies whether to truncate large streamable pr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -376,13 +409,15 @@ Accept wildcard characters: False ``` ### -ShouldDecodeEnums + +> Applicable: Exchange Online + {{ Fill ShouldDecodeEnums Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -392,13 +427,15 @@ Accept wildcard characters: False ``` ### -ShouldFetchAttendeeCollection + +> Applicable: Exchange Online + {{ Fill ShouldFetchAttendeeCollection Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -408,6 +445,9 @@ Accept wildcard characters: False ``` ### -ShouldFetchRecurrenceExceptions + +> Applicable: Exchange Online + The ShouldFetchRecurrenceExceptions parameter specifies whether to include exceptions to recurring meetings. Valid values are: - $true: Include exceptions to recurring meetings. When you use this value, you also need to use the ItemIds parameter. @@ -417,7 +457,6 @@ The ShouldFetchRecurrenceExceptions parameter specifies whether to include excep Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -427,6 +466,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range for the OriginalLastModifiedTime property (when the meeting was last modified, not created). Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -435,7 +477,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -445,13 +486,15 @@ Accept wildcard characters: False ``` ### -Subject + +> Applicable: Exchange Online + The Subject parameter identifies the calendar items by the specified text in the Subject field. The text values that you specify aren't case sensitive. If the value contains spaces, enclose the value in quotation marks. You can control whether to use exact matching by using the ExactMatch parameter ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CalendarNotification.md b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarNotification.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-CalendarNotification.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CalendarNotification.md index 014d7e719e..1f56a01412 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarNotification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarNotification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-calendarnotification applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-CalendarNotification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendarnotification +schema: 2.0.0 +title: Get-CalendarNotification --- # Get-CalendarNotification @@ -48,6 +49,9 @@ This example returns the calendar text message notification settings for Tony's ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -83,7 +89,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -119,7 +129,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CalendarProcessing.md b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarProcessing.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-CalendarProcessing.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CalendarProcessing.md index a38f7b7958..87199882e2 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarProcessing.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CalendarProcessing.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-calendarprocessing applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-CalendarProcessing -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-calendarprocessing +schema: 2.0.0 +title: Get-CalendarProcessing --- # Get-CalendarProcessing @@ -29,7 +30,7 @@ Get-CalendarProcessing [-Identity] ``` ## DESCRIPTION -For details about the properties that are returned in the output of this cmdlet, see [Set-CalendarProcessing](https://learn.microsoft.com/powershell/module/exchange/set-calendarprocessing). +For details about the properties that are returned in the output of this cmdlet, see [Set-CalendarProcessing](https://learn.microsoft.com/powershell/module/exchangepowershell/set-calendarprocessing). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -45,6 +46,9 @@ This example shows the calendar processing options for the resource mailbox Room ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the resource mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the resource mailbox that you want to view. You Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -80,7 +86,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -102,7 +110,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldPolicy.md index 54654c842b..6f2f8b1488 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy applicable: Security & Compliance -title: Get-CaseHoldPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-caseholdpolicy +schema: 2.0.0 +title: Get-CaseHoldPolicy --- # Get-CaseHoldPolicy @@ -51,6 +52,9 @@ This example displays detailed information for the policy named "Regulation 123 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the case hold policy that you want to view. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the case hold policy that you want to view by using the eDiscovery case that's associated with the policy. You can use the following values to identify the eDiscovery case: - Name @@ -82,7 +88,6 @@ You can find these values by running the command: Get-ComplianceCase | Format-Ta Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information on the case hold policy. You don't need to specify a value with this switch. If you don't use this switch, the command won't return information about the current deployment status, and the DistributionStatus property will only show as "Pending". @@ -109,7 +117,6 @@ The following properties are affected by this switch: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -IncludeBindings + +> Applicable: Security & Compliance + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -IncludeBindingsOnly + +> Applicable: Security & Compliance + {{ Fill IncludeBindingsOnly Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-CaseHoldRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldRule.md index 632e20fe65..4a8be64d10 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CaseHoldRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-caseholdrule applicable: Security & Compliance -title: Get-CaseHoldRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-caseholdrule +schema: 2.0.0 +title: Get-CaseHoldRule --- # Get-CaseHoldRule @@ -45,6 +46,9 @@ This example displays detailed information for the case hold rule named "30 Day ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold rule you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the case hold rule you want to view. You can us Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter filters the case hold rule results by the associated case hold policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -77,7 +83,6 @@ You can use this parameter with the Identity parameter in the same command. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Get-ClassificationRuleCollection.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ClassificationRuleCollection.md index b246435ac5..eb41942aba 100644 --- a/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ClassificationRuleCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-classificationrulecollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ClassificationRuleCollection -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-classificationrulecollection +schema: 2.0.0 +title: Get-ClassificationRuleCollection --- # Get-ClassificationRuleCollection @@ -50,13 +51,15 @@ This example returns detailed information about the classification rule collecti ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the classification rule collection you want to view. You can use any value that uniquely identifies the classification rule collection. For example, you can specify the name, rule collection name or distinguished name (DN) of the classification rule collection. ```yaml Type: ClassificationRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessArray.md b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessArray.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ClientAccessArray.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessArray.md index c879bde532..61d0861444 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessArray.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessArray.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-clientaccessarray applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ClientAccessArray -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-clientaccessarray +schema: 2.0.0 +title: Get-ClientAccessArray --- # Get-ClientAccessArray @@ -56,6 +57,9 @@ This example returns detailed information for the Client Access array named CASA ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Client Access array that you want to view. You can use these values: - Name (if the value doesn't contain spaces) @@ -68,7 +72,6 @@ The Identity parameter specifies the Client Access array that you want to view. Type: ClientAccessArrayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Site parameter filters the results by Active Directory site. You can use any value that uniquely identifies the site. For example: - Name @@ -105,7 +113,6 @@ The Site parameter filters the results by Active Directory site. You can use any Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-ClientAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessRule.md index 0e40aa0d98..ce2deaa5e2 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-clientaccessrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-ClientAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-clientaccessrule +schema: 2.0.0 +title: Get-ClientAccessRule --- # Get-ClientAccessRule @@ -55,6 +56,9 @@ This example retrieves details about the client access rule named "Block Client ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the client access rule that you want to view. You can use any value that uniquely identifies the client access rule. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the client access rule that you want to view. Y Type: ClientAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -84,7 +90,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -102,7 +110,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessServer.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-ClientAccessServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessServer.md index c3cb98eccc..ae619fa9f7 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-clientaccessserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ClientAccessServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-clientaccessserver +schema: 2.0.0 +title: Get-ClientAccessServer --- # Get-ClientAccessServer @@ -52,6 +53,9 @@ This example returns detailed information for the server mail.contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server with the Client Access server role installed that you want to view. You can use any value that uniquely identifies the server. For example: @@ -65,7 +69,6 @@ You can use any value that uniquely identifies the server. For example: Type: ClientAccessServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -IncludeAlternateServiceAccountCredentialPassword + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeAlternateServiceAccountCredentialPassword switch specifies whether to include the password of the alternate service account in the results. You don't need to specify a value with this switch. The password is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessServer | Format-List AlternateServiceAccountConfiguration`. @@ -99,7 +107,6 @@ The password is visible in the AlternateServiceAccountConfiguration property. To Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -IncludeAlternateServiceAccountCredentialStatus + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeAlternateServiceAccountCredentialStatus parameter specifies whether to include the status of the alternate service account in the results. You don't need to specify a value with this switch. The status is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessServer | Format-List AlternateServiceAccountConfiguration`. @@ -117,7 +127,6 @@ The status is visible in the AlternateServiceAccountConfiguration property. To s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessService.md b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessService.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ClientAccessService.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessService.md index 1f3d8c72e4..75380355de 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ClientAccessService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-clientaccessservice applicable: Exchange Server 2016, Exchange Server 2019 -title: Get-ClientAccessService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-clientaccessservice +schema: 2.0.0 +title: Get-ClientAccessService --- # Get-ClientAccessService @@ -50,6 +51,9 @@ This example returns detailed information for the server mail.contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server with the Client Access server role installed that you want to view. You can use any value that uniquely identifies the server. For example: @@ -63,7 +67,6 @@ You can use any value that uniquely identifies the server. For example: Type: ClientAccessServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -IncludeAlternateServiceAccountCredentialPassword + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The IncludeAlternateServiceAccountCredentialPassword switch specifies whether to include the password of the alternate service account in the results. You don't need to specify a value with this switch. The password is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessService | Format-List AlternateServiceAccountConfiguration`. @@ -97,7 +105,6 @@ The password is visible in the AlternateServiceAccountConfiguration property. To Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -IncludeAlternateServiceAccountCredentialStatus + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The IncludeAlternateServiceAccountCredentialStatus parameter specifies whether to include the status of the alternate service account in the results. You don't need to specify a value with this switch. The status is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessService | Format-List AlternateServiceAccountConfiguration`. @@ -115,7 +125,6 @@ The status is visible in the AlternateServiceAccountConfiguration property. To s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Clutter.md b/exchange/exchange-ps/ExchangePowerShell/Get-Clutter.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-Clutter.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Clutter.md index abd9f70458..7ecfb68037 100644 --- a/exchange/exchange-ps/exchange/Get-Clutter.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Clutter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-clutter applicable: Exchange Online, Exchange Online Protection -title: Get-Clutter -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-clutter +schema: 2.0.0 +title: Get-Clutter --- # Get-Clutter @@ -41,6 +42,9 @@ This example returns the Clutter settings for the user Constancia Pena. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill UseCustomRouting Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md b/exchange/exchange-ps/ExchangePowerShell/Get-CmdletExtensionAgent.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CmdletExtensionAgent.md index b863d66f12..bf76f861a0 100644 --- a/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CmdletExtensionAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-cmdletextensionagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-CmdletExtensionAgent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-cmdletextensionagent +schema: 2.0.0 +title: Get-CmdletExtensionAgent --- # Get-CmdletExtensionAgent @@ -59,6 +60,9 @@ This example displays detailed information for the Exchange cmdlet extension age ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the cmdlet extension agent that you want to view. You can use any value that uniquely identifies the agent. For example: - Name @@ -69,7 +73,6 @@ The Identity parameter specifies the name of the cmdlet extension agent that you Type: CmdletExtensionAgentIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -Assembly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Assembly parameter filters the results by the specified Assembly property value. The value for the built-in Exchange cmdlet extension agents is Microsoft.Exchange.ProvisioningAgent.dll. ```yaml Type: String Parameter Sets: Filters Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter filters the results by enabled or disabled cmdlet extension agents. Valid values are: - $true: Only enabled agents are included in the results. @@ -122,7 +132,6 @@ If you don't use this parameter, enabled and disabled agents are included in the Type: Boolean Parameter Sets: Filters Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCase.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCase.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-ComplianceCase.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCase.md index 74d35075bf..d0e22b0d1d 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancecase applicable: Security & Compliance -title: Get-ComplianceCase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancecase +schema: 2.0.0 +title: Get-ComplianceCase --- # Get-ComplianceCase @@ -65,6 +66,9 @@ This example returns a summary list of all DSR cases that the custom role group ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the compliance case that you want to view. You can use any value that uniquely identifies the case. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the compliance case that you want to view. You Type: ComplianceCaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -CaseType + +> Applicable: Security & Compliance + The CaseType parameter specifies the type of compliance case that you want to view. Valid values are: - AdvancedEdiscovery: eDiscovery Premium cases are used to manage legal or other types of investigations. In the Microsoft Purview compliance portal, eDiscovery Premium cases are displayed under **eDiscovery** \> **Premium**. @@ -100,7 +106,6 @@ The CaseType parameter specifies the type of compliance case that you want to vi Type: ComplianceCaseType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -RecentOnly + +> Applicable: Security & Compliance + The RecentOnly switch returns a list of the most recently modified cases of the specified case type. You don't need to specify a value with this switch. This switch is used to display data in the "Recent cases" widget in the Microsoft Purview compliance portal for some features that use compliance case objects. @@ -134,7 +144,6 @@ This switch is used to display data in the "Recent cases" widget in the Microsof Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -RoleGroup + +> Applicable: Security & Compliance + The RoleGroup parameter returns a list of compliance cases that the specified role group is a member of. If you don't include the CaseType parameter, the cmdlet returns a list of eDiscovery Standard cases that the role group is a member of. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCaseMember.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCaseMember.md index 5588971c20..b99c26448e 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceCaseMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancecasemember applicable: Security & Compliance -title: Get-ComplianceCaseMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancecasemember +schema: 2.0.0 +title: Get-ComplianceCaseMember --- # Get-ComplianceCaseMember @@ -52,13 +53,15 @@ This examples shows the members of the eDiscovery case named Fabrikam Litigation ## PARAMETERS ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the name of the eDiscovery case that you want to view. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Security & Compliance + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -ShowCaseAdmin + +> Applicable: Security & Compliance + The ShowCaseAdmin switch specifies whether to return the eDiscovery case admin in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEvent.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEvent.md index 4688db4274..06939dc393 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEvent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentionevent applicable: Security & Compliance -title: Get-ComplianceRetentionEvent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-complianceretentionevent +schema: 2.0.0 +title: Get-ComplianceRetentionEvent --- # Get-ComplianceRetentionEvent @@ -51,6 +52,9 @@ This example returns detailed information about the compliance retention event n ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the compliance retention event that you want to view. You can use any value that uniquely identifies the event. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the compliance retention event that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -BeginDateTime + +> Applicable: Security & Compliance + {{ Fill BeginDateTime Description }} ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -EndDateTime + +> Applicable: Security & Compliance + {{ Fill EndDateTime Description }} ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -PreviewOnly + +> Applicable: Security & Compliance + {{ Fill PreviewOnly Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEventType.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEventType.md index 413b3c7aa3..eaa1c7f19c 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceRetentionEventType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentioneventtype applicable: Security & Compliance -title: Get-ComplianceRetentionEventType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-complianceretentioneventtype +schema: 2.0.0 +title: Get-ComplianceRetentionEventType --- # Get-ComplianceRetentionEventType @@ -48,6 +49,9 @@ This example returns detailed information for the retention event type named Fab ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention event type that you want to view. You can use any value that uniquely identifies the retention event type. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the retention event type that you want to view. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -LoadTag + +> Applicable: Security & Compliance + The LoadTag switch specifies whether to show the compliance tags that are associated with the retention event types. You don't need to specify a value with this switch. If you don't use this switch, the ComplianceTag property will always appear empty in the results. @@ -76,7 +82,6 @@ If you don't use this switch, the ComplianceTag property will always appear empt Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearch.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearch.md index 95ca1983f2..92d5c4ff7f 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancesearch applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Get-ComplianceSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancesearch +schema: 2.0.0 +title: Get-ComplianceSearch --- # Get-ComplianceSearch @@ -54,6 +55,9 @@ This examples show details of the compliance search named Case 1234. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Identity parameter specifies the compliance search that you want to view. You can use any value that uniquely identifies the compliance search. For example: @@ -81,7 +85,6 @@ To view these properties, you need to use the Identity parameter in the command. Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -Case + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The Case parameter filters the results by the name of an eDiscovery Standard case that the compliance search is associated with. If the value contains spaces, enclose the value in quotation marks. @@ -101,7 +107,6 @@ You can't use this parameter to view compliance searches associated with eDiscov Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -119,7 +127,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +136,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearchAction.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearchAction.md index a0ca0a62b5..bb1a32696a 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSearchAction.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancesearchaction applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Get-ComplianceSearchAction -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancesearchaction +schema: 2.0.0 +title: Get-ComplianceSearchAction --- # Get-ComplianceSearchAction @@ -96,6 +97,9 @@ This example shows details about the compliance search action named "Case 1234_P ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Identity parameter specifies the compliance search action that you want to view. You can use any value that uniquely identifies the compliance search action. For example: - Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"`. For example, `"Case 1234_Preview"`. @@ -115,7 +119,6 @@ When you use the Identity parameter, more details are returned in the results. F Type: ComplianceSearchActionIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: 1 @@ -125,6 +128,9 @@ Accept wildcard characters: False ``` ### -Case + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The Case parameter filters the results by the name of the specified case. If the value contains spaces, enclose the value in quotation marks. @@ -133,7 +139,6 @@ The Case parameter filters the results by the name of the specified case. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -143,13 +148,15 @@ Accept wildcard characters: False ``` ### -Details + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Details switch specifies whether to include detailed information in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -159,6 +166,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -167,7 +177,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -177,6 +186,9 @@ Accept wildcard characters: False ``` ### -Export + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). The Export switch filters the results by Export compliance search actions. You don't need to specify a value with this switch. @@ -187,7 +199,6 @@ You can't use this switch with the Identity, Preview, or Purge parameters. Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -197,13 +208,15 @@ Accept wildcard characters: False ``` ### -IncludeCredential + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The IncludeCredential switch specifies whether to include the credential in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -213,6 +226,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -221,7 +237,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -Preview + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Preview switch filters the results by Preview compliance search actions. You don't need to specify a value with this switch. You can't use this switch with the Export, Identity, or Purge parameters. @@ -239,7 +257,6 @@ You can't use this switch with the Export, Identity, or Purge parameters. Type: SwitchParameter Parameter Sets: Preview Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -249,6 +266,9 @@ Accept wildcard characters: False ``` ### -Purge + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. The Purge switch filters the results by Purge compliance search actions. You don't need to specify a value with this switch. @@ -259,7 +279,6 @@ You can't use this switch with the Export, Identity, or Preview parameters. Type: SwitchParameter Parameter Sets: Purge Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -269,13 +288,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSecurityFilter.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSecurityFilter.md index 0c3ff1f88a..1bf2a33a12 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceSecurityFilter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancesecurityfilter applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Get-ComplianceSecurityFilter -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancesecurityfilter +schema: 2.0.0 +title: Get-ComplianceSecurityFilter --- # Get-ComplianceSecurityFilter @@ -53,6 +54,9 @@ This example returns detailed information about the compliance security filter n ## PARAMETERS ### -Action + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Action parameter filters the results by the type of search action that a filter is applied to. Valid values are: - Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. @@ -65,7 +69,6 @@ The Action parameter filters the results by the type of search action that a fil Type: ComplianceSecurityFilterActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -84,7 +90,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -FilterName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The FilterName parameter specifies the name of the compliance security filter that you want to view. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The User parameter filters the results by the user who gets a filter applied to their searches. Valid values are: - The alias or email address of a user. @@ -120,7 +130,6 @@ The User parameter filters the results by the user who gets a filter applied to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceTag.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTag.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ComplianceTag.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTag.md index 2c704b8488..6f58f8329b 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancetag applicable: Exchange Online, Security & Compliance -title: Get-ComplianceTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancetag +schema: 2.0.0 +title: Get-ComplianceTag --- # Get-ComplianceTag @@ -49,6 +50,9 @@ This example returns detailed information about the label named HR Content. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the label that you want to view. You can use any value that uniquely identifies the tag. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the label that you want to view. You can use an Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -IncludingLabelState + +> Applicable: Exchange Online, Security & Compliance + {{ Fill IncludingLabelState Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTagStorage.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTagStorage.md index c3aa8eaca3..668ad3eb8a 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ComplianceTagStorage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancetagstorage applicable: Exchange Online, Security & Compliance -title: Get-ComplianceTagStorage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compliancetagstorage +schema: 2.0.0 +title: Get-ComplianceTagStorage --- # Get-ComplianceTagStorage @@ -41,6 +42,9 @@ This example confirms that you've created the label policy in your organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the label policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name (GUID value) @@ -53,7 +57,6 @@ However, there can be only one label policy in your organization. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserAggregateReport.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserAggregateReport.md index d26e9e5e0d..5f7e8ed48b 100644 --- a/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserAggregateReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compromiseduseraggregatereport applicable: Exchange Online, Exchange Online Protection -title: Get-CompromisedUserAggregateReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compromiseduseraggregatereport +schema: 2.0.0 +title: Get-CompromisedUserAggregateReport --- # Get-CompromisedUserAggregateReport @@ -51,6 +52,9 @@ This example returns all restricted user accounts for the specified date range. ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the results by the compromised user status. Valid values are: - Restricted @@ -62,7 +66,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -80,7 +86,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -130,7 +142,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserDetailReport.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserDetailReport.md index 07d5d63148..5b8fba0918 100644 --- a/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-CompromisedUserDetailReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-compromiseduserdetailreport applicable: Exchange Online, Exchange Online Protection -title: Get-CompromisedUserDetailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-compromiseduserdetailreport +schema: 2.0.0 +title: Get-CompromisedUserDetailReport --- # Get-CompromisedUserDetailReport @@ -51,6 +52,9 @@ This example returns all suspicious user accounts for the specified date range. ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the results by the compromised user status. Valid values are: - Restricted @@ -62,7 +66,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -80,7 +86,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -132,7 +144,6 @@ A value for this parameter can't be older than 30 days. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md b/exchange/exchange-ps/ExchangePowerShell/Get-ConfigAnalyzerPolicyRecommendation.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ConfigAnalyzerPolicyRecommendation.md index ff118bc38d..3d946278f6 100644 --- a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ConfigAnalyzerPolicyRecommendation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-configanalyzerpolicyrecommendation applicable: Exchange Online -title: Get-ConfigAnalyzerPolicyRecommendation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-configanalyzerpolicyrecommendation +schema: 2.0.0 +title: Get-ConfigAnalyzerPolicyRecommendation --- # Get-ConfigAnalyzerPolicyRecommendation @@ -62,13 +63,15 @@ This example runs a comparison using the Strict preset security policy settings ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: ConfigAnalyzerPolicyRecommendationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online + The RecommendedPolicyType parameter specifies the preset security policy that you want to use as a baseline. Valid values are: - Standard @@ -87,7 +93,6 @@ The RecommendedPolicyType parameter specifies the preset security policy that yo Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -IsAppliedToDisabled + +> Applicable: Exchange Online + The IsAppliedToDisabled switch filters the results by policies that aren't applied to anyone (the AppliedTo property is blank). You don't need to specify a value with this switch. If you don't use this switch, the results include policies that are applied to users and policies that aren't applied to anyone. @@ -105,7 +113,6 @@ If you don't use this switch, the results include policies that are applied to u Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md b/exchange/exchange-ps/ExchangePowerShell/Get-ConnectionInformation.md similarity index 97% rename from exchange/exchange-ps/exchange/Get-ConnectionInformation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ConnectionInformation.md index 97f9d3efd2..0f80193cf7 100644 --- a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ConnectionInformation.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.ExoPowershellGalleryModule.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-connectioninformation applicable: Exchange Online -title: Get-ConnectionInformation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.ExoPowershellGalleryModule.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-connectioninformation +schema: 2.0.0 +title: Get-ConnectionInformation --- # Get-ConnectionInformation @@ -87,6 +87,9 @@ This example returns a list of active REST-based connections that are using the ## PARAMETERS ### -ConnectionId + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.2.0 or later of the module. The ConnectionId parameter filters the connections by ConnectionId. ConnectionId is a GUID value in the output of the Get-ConnectionInformation cmdlet that uniquely identifies a connection, even if you have multiple connections open. You can specify multiple ConnectionId values separated by commas. @@ -97,7 +100,6 @@ Don't use this parameter with the ModulePrefix parameter. Type: String[] Parameter Sets: ConnectionId Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -107,6 +109,9 @@ Accept wildcard characters: False ``` ### -ModulePrefix + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.2.0 or later of the module. The ModulePrefix parameter filters the connections by ModulePrefix. When you use the Prefix parameter with the Connect-ExchangeOnline cmdlet, the specified text is added to the names of all Exchange Online cmdlets (for example, Get-InboundConnector becomes Get-ContosoInboundConnector). The ModulePrefix value is visible in the output of the Get-ConnectionInformation cmdlet. You can specify multiple ModulePrefix values separated by commas. @@ -119,7 +124,6 @@ Don't use this parameter with the ConnectionId parameter. Type: String[] Parameter Sets: ModulePrefix Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Contact.md b/exchange/exchange-ps/ExchangePowerShell/Get-Contact.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-Contact.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Contact.md index 389fa44712..1fc5354a8a 100644 --- a/exchange/exchange-ps/exchange/Get-Contact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Contact.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-contact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-Contact -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-contact +schema: 2.0.0 +title: Get-Contact --- # Get-Contact @@ -79,6 +80,9 @@ This example uses the Anr parameter to retrieve all mail-enabled contacts whose ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the contact that you want to view. You can use any value that uniquely identifies the contact. For example: - Name @@ -90,7 +94,6 @@ The Identity parameter specifies the contact that you want to view. You can use Type: ContactIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -112,7 +118,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -132,7 +140,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -150,7 +160,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -175,7 +187,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -185,6 +196,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -198,7 +212,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,6 +221,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -219,7 +235,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -229,6 +244,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -241,7 +259,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified contact subtype. Valid values are: - Contact @@ -263,7 +283,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -273,13 +292,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -289,6 +310,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -306,7 +330,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ContentFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterConfig.md index 8de0cb720d..6a8e1dbce8 100644 --- a/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-contentfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ContentFilterConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-contentfilterconfig +schema: 2.0.0 +title: Get-ContentFilterConfig --- # Get-ContentFilterConfig @@ -40,6 +41,9 @@ This example returns detailed information about the content filter configuration ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -48,7 +52,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md b/exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterPhrase.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterPhrase.md index 1b1f47b29b..9b20ec8f22 100644 --- a/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ContentFilterPhrase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-contentfilterphrase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ContentFilterPhrase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-contentfilterphrase +schema: 2.0.0 +title: Get-ContentFilterPhrase --- # Get-ContentFilterPhrase @@ -63,6 +64,9 @@ This example returns all custom words and phrases that contain the words free of ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies a custom word or phrase to display. You must enclose the value of the Identity parameter in quotation marks ("). The Identity and Phrase parameters are interchangeable. @@ -71,7 +75,6 @@ The Identity and Phrase parameters are interchangeable. Type: ContentFilterPhraseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -89,7 +95,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Phrase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Phrase parameter specifies a custom word or phrase to display. You must enclose the value of the Phrase parameter in quotation marks ("). The Phrase and Identity parameters are interchangeable. @@ -107,7 +115,6 @@ The Phrase and Identity parameters are interchangeable. Type: ContentFilterPhraseIdParameter Parameter Sets: Phrase Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoAggregateReport.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoAggregateReport.md index 2c884d0e2f..0769430b82 100644 --- a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoAggregateReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdoaggregatereport applicable: Exchange Online -title: Get-ContentMalwareMdoAggregateReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-contentmalwaremdoaggregatereport +schema: 2.0.0 +title: Get-ContentMalwareMdoAggregateReport --- # Get-ContentMalwareMdoAggregateReport @@ -55,6 +56,9 @@ This example returns the results for OneDrive detections for the specified date ## PARAMETERS ### -DetectionTechnology + +> Applicable: Exchange Online + The DetectionTechnology parameter filters the results by what classified the file as malware. Valid values are: - AntiMalware @@ -67,7 +71,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. @@ -85,7 +91,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -111,13 +118,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -127,6 +136,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The EndDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. @@ -135,7 +147,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -145,6 +156,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Exchange Online + The Workload parameter filters the results by where the detected file is located. Valid values are: - OneDriveForBusiness @@ -157,7 +171,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoDetailReport.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoDetailReport.md index eb99b53c05..ce69c30ab3 100644 --- a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ContentMalwareMdoDetailReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdodetailreport applicable: Exchange Online -title: Get-ContentMalwareMdoDetailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-contentmalwaremdodetailreport +schema: 2.0.0 +title: Get-ContentMalwareMdoDetailReport --- # Get-ContentMalwareMdoDetailReport @@ -57,6 +58,9 @@ This example returns the results for detections by Safe Attachments for SharePoi ## PARAMETERS ### -DetectionTechnology + +> Applicable: Exchange Online + The DetectionTechnology parameter filters the results by what classified the file as malware. Valid values are: - AntiMalware @@ -69,7 +73,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. @@ -87,7 +93,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The EndDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. @@ -137,7 +149,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -147,6 +158,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Exchange Online + The Workload parameter filters the results by where the detected file is located. Valid values are: - OneDriveForBusiness @@ -159,7 +173,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DataClassification.md b/exchange/exchange-ps/ExchangePowerShell/Get-DataClassification.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-DataClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DataClassification.md index 9bfe9cc832..271b48a173 100644 --- a/exchange/exchange-ps/exchange/Get-DataClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DataClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dataclassification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-DataClassification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dataclassification +schema: 2.0.0 +title: Get-DataClassification --- # Get-DataClassification @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [Get-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. +In Exchange Online, this cmdlet has been replaced by the [Get-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the Get-DataClassification cmdlet to view the data classification rules in your organization. This cmdlet shows built-in data classification rules and rules that you created that use document fingerprints. @@ -67,13 +68,15 @@ This example returns details of the built-in data classification rule named SWIF ## PARAMETERS ### -ClassificationRuleCollectionIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ClassificationRuleCollectionIdentity parameter filters the results by the name of the data classification rule collection. The data classification rule collection that contains the built-in data classification rules is named Microsoft Rule Package. The data classification that contains new data classification rules that you create that use document fingerprints is named Fingerprint Classification Collection. ```yaml Type: ClassificationRuleCollectionIdParameter Parameter Sets: RuleCollectionIdentity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the data classification rule that you want to view. You can use any value that uniquely identifies the data classification rule. For example: - Name @@ -93,7 +99,6 @@ The Identity parameter specifies the data classification rule that you want to v Type: DataClassificationIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-DataClassificationConfig.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-DataClassificationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DataClassificationConfig.md index 03342c3e31..39e8fca684 100644 --- a/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DataClassificationConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dataclassificationconfig applicable: Exchange Online -title: Get-DataClassificationConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dataclassificationconfig +schema: 2.0.0 +title: Get-DataClassificationConfig --- # Get-DataClassificationConfig diff --git a/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DataEncryptionPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DataEncryptionPolicy.md index b58632caa0..e21fd13b90 100644 --- a/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DataEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dataencryptionpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-DataEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dataencryptionpolicy +schema: 2.0.0 +title: Get-DataEncryptionPolicy --- # Get-DataEncryptionPolicy @@ -54,6 +55,9 @@ The example returns detailed information for the data encryption policy named Eu ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the data encryption policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the data encryption policy that you want to vie Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DataRetentionReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-DataRetentionReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DataRetentionReport.md index 1f38d8c687..00ddff31db 100644 --- a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DataRetentionReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dataretentionreport applicable: Exchange Online, Security & Compliance -title: Get-DataRetentionReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dataretentionreport +schema: 2.0.0 +title: Get-DataRetentionReport --- # Get-DataRetentionReport @@ -52,6 +53,9 @@ This example lists the data detections for April, 2018. ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -60,7 +64,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -112,7 +122,6 @@ The StartDate value can't be older than 92 days from today. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroup.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroup.md index 6f519626b5..4077072041 100644 --- a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DatabaseAvailabilityGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-databaseavailabilitygroup +schema: 2.0.0 +title: Get-DatabaseAvailabilityGroup --- # Get-DatabaseAvailabilityGroup @@ -59,13 +60,15 @@ This example displays the properties of the DAG DAG2. Because it includes the St ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the DAG to query. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Status parameter instructs the command to query Active Directory for additional information and to include real-time status information in the output. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroupNetwork.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroupNetwork.md index deb02d5a8e..20964115f3 100644 --- a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DatabaseAvailabilityGroupNetwork.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-databaseavailabilitygroupnetwork applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DatabaseAvailabilityGroupNetwork -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-databaseavailabilitygroupnetwork +schema: 2.0.0 +title: Get-DatabaseAvailabilityGroupNetwork --- # Get-DatabaseAvailabilityGroupNetwork @@ -75,13 +76,15 @@ This example gets complete configuration and status information for the network ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of a DAG or a DAG network. ```yaml Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -91,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Mailbox server in the DAG to retrieve health information for the DAG network from. You can use any value that uniquely identifies the server. For example: - Name @@ -118,7 +126,6 @@ The Server parameter specifies the Mailbox server in the DAG to retrieve health Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantBriefingConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantBriefingConfig.md index 13ed2a7226..a10b574eb4 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantBriefingConfig.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig applicable: Exchange Online -title: Get-DefaultTenantBriefingConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-defaulttenantbriefingconfig +schema: 2.0.0 +title: Get-DefaultTenantBriefingConfig --- # Get-DefaultTenantBriefingConfig @@ -55,13 +55,15 @@ This example returns the default Briefing email configuration for the organizati ## PARAMETERS ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantMyAnalyticsFeatureConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantMyAnalyticsFeatureConfig.md index 76bb40fd28..7e45af76f7 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig applicable: Exchange Online -title: Get-DefaultTenantMyAnalyticsFeatureConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-defaulttenantmyanalyticsfeatureconfig +schema: 2.0.0 +title: Get-DefaultTenantMyAnalyticsFeatureConfig --- # Get-DefaultTenantMyAnalyticsFeatureConfig @@ -51,13 +51,15 @@ This example returns the default opt-in or opt-out information for the various V ## PARAMETERS ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeliveryAgentConnector.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeliveryAgentConnector.md index 363d35c76f..5fe36fb545 100644 --- a/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeliveryAgentConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-deliveryagentconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DeliveryAgentConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-deliveryagentconnector +schema: 2.0.0 +title: Get-DeliveryAgentConnector --- # Get-DeliveryAgentConnector @@ -50,13 +51,15 @@ This example retrieves a list of all delivery agent connectors in your organizat ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the GUID or name of the delivery agent connector. ```yaml Type: DeliveryAgentConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -74,7 +80,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DetailZapReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DetailZapReport.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DetailZapReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DetailZapReport.md index e2332bf377..0c93ed0d8a 100644 --- a/exchange/exchange-ps/exchange/Get-DetailZapReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DetailZapReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-detailzapreport applicable: Exchange Online -title: Get-DetailZapReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-detailzapreport +schema: 2.0.0 +title: Get-DetailZapReport --- # Get-DetailZapReport @@ -68,6 +69,9 @@ This example retrieves information for the specified date range. ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". @@ -78,7 +82,6 @@ If you use this parameter, you also need to use the StartDate parameter. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 3 @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". @@ -130,7 +140,6 @@ If you use this parameter, you also need to use the StartDate parameter. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 4 diff --git a/exchange/exchange-ps/exchange/Get-DetailsTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Get-DetailsTemplate.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-DetailsTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DetailsTemplate.md index 71900617a9..f04bcdd675 100644 --- a/exchange/exchange-ps/exchange/Get-DetailsTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DetailsTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-detailstemplate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DetailsTemplate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-detailstemplate +schema: 2.0.0 +title: Get-DetailsTemplate --- # Get-DetailsTemplate @@ -59,6 +60,9 @@ This example retrieves all attributes for all User details template types in all ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the GUID of the details template or specifies the details template type and language separated by a backslash, for example, en-us\\User. Details template types are: - User @@ -72,7 +76,6 @@ The Identity parameter specifies the GUID of the details template or specifies t Type: DetailsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -91,7 +97,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessPolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessPolicy.md index a79926c166..1992dc68e8 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconditionalaccesspolicy applicable: Exchange Online, Security & Compliance -title: Get-DeviceConditionalAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-deviceconditionalaccesspolicy +schema: 2.0.0 +title: Get-DeviceConditionalAccessPolicy --- # Get-DeviceConditionalAccessPolicy @@ -56,6 +57,9 @@ This example shows details about the mobile device conditional access policy nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the mobile device conditional access policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the mobile device conditional access policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessRule.md index 65fe845674..292589b539 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConditionalAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconditionalaccessrule applicable: Exchange Online, Security & Compliance -title: Get-DeviceConditionalAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-deviceconditionalaccessrule +schema: 2.0.0 +title: Get-DeviceConditionalAccessRule --- # Get-DeviceConditionalAccessRule @@ -58,13 +59,15 @@ This example shows details for the mobile device conditional access rule named S ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the mobile device conditional access rule that you want to view. The name of the rule uses the syntax `{}`. For example, `Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}`. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -CompareToWorkload + +> Applicable: Security & Compliance + The CompareToWorkload switch specifies whether to compare the mobile device conditional access rule to Intune rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationPolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationPolicy.md index 34e6dc1ae0..506cbd4331 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconfigurationpolicy applicable: Exchange Online, Security & Compliance -title: Get-DeviceConfigurationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-deviceconfigurationpolicy +schema: 2.0.0 +title: Get-DeviceConfigurationPolicy --- # Get-DeviceConfigurationPolicy @@ -56,6 +57,9 @@ This example shows details about the mobile device configuration policy named En ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the mobile device configuration policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the mobile device configuration policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationRule.md index 84afa08d75..a0fadfef90 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceConfigurationRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconfigurationrule applicable: Exchange Online, Security & Compliance -title: Get-DeviceConfigurationRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-deviceconfigurationrule +schema: 2.0.0 +title: Get-DeviceConfigurationRule --- # Get-DeviceConfigurationRule @@ -58,13 +59,15 @@ This example shows details about the mobile device configuration rule named Lega ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the mobile device configuration rule that you want to view. The name of the rule uses the syntax `{}`. For example, `Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}`. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -CompareToWorkload + +> Applicable: Security & Compliance + The CompareToWorkload switch specifies whether to compare the mobile device configuration rule to Intune rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DevicePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DevicePolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-DevicePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DevicePolicy.md index f7cb5c1dce..147936b675 100644 --- a/exchange/exchange-ps/exchange/Get-DevicePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DevicePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-devicepolicy applicable: Exchange Online, Security & Compliance -title: Get-DevicePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-devicepolicy +schema: 2.0.0 +title: Get-DevicePolicy --- # Get-DevicePolicy @@ -56,6 +57,9 @@ This example shows details about the mobile device policy named Engineering Grou ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the mobile device policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the mobile device policy that you want to view. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantPolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantPolicy.md index ce5c1c516e..cadb9db2ee 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-devicetenantpolicy applicable: Exchange Online, Security & Compliance -title: Get-DeviceTenantPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-devicetenantpolicy +schema: 2.0.0 +title: Get-DeviceTenantPolicy --- # Get-DeviceTenantPolicy @@ -49,13 +50,15 @@ This example shows information for your organization's mobile device tenant poli ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the name of the mobile device tenant policy that you want to view, but there's only one in your organization. The name of the policy is a GUID value. For example, a6958701-c82c-4064-ac11-64e40e7f4032. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DeviceTenantRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantRule.md index 3d61488bdc..e97fbba444 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DeviceTenantRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-devicetenantrule applicable: Exchange Online, Security & Compliance -title: Get-DeviceTenantRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-devicetenantrule +schema: 2.0.0 +title: Get-DeviceTenantRule --- # Get-DeviceTenantRule @@ -50,13 +51,15 @@ This example shows information for your organization's mobile device tenant rule ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the name of the mobile device tenant rule that you want to view, but there's only one in your organization. The name of the rule is a GUID value. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroup.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroup.md index d91f0fd648..5603596725 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-DistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-distributiongroup +schema: 2.0.0 +title: Get-DistributionGroup --- # Get-DistributionGroup @@ -112,6 +113,9 @@ This example returns all distribution groups and mail-enabled security groups wh ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group that you want to view. You can use any values that uniquely identifies the group. For example: - Name @@ -125,7 +129,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -135,6 +138,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -147,7 +153,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -157,6 +162,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -165,7 +173,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -175,6 +182,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -183,7 +193,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +202,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -208,7 +220,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -218,6 +229,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -231,7 +245,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +254,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromDLMembers recipients in the AcceptMessagesOnlyFromDLMembersWithDisplayNames property. You don't need to specify a value with this switch. @@ -251,7 +267,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -261,6 +276,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromSendersOrMembers recipients in the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. @@ -271,7 +289,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -281,6 +298,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeAcceptMessagesOnlyFromWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFrom recipients in the AcceptMessagesOnlyFromWithDisplayNames property. You don't need to specify a value with this switch. @@ -291,7 +311,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -301,6 +320,9 @@ Accept wildcard characters: False ``` ### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeBypassModerationFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of BypassModerationFromSendersOrMembers recipients in the BypassModerationFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. @@ -311,7 +333,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -321,6 +342,9 @@ Accept wildcard characters: False ``` ### -IncludeGrantSendOnBehalfToWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeGrantSendOnBehalfToWithDisplayNames switch specifies whether to return the SMTP addresses and display names of GrantSendOnBehalfTo recipients in the GrantSendOnBehalfToWithDisplayNames property. You don't need to specify a value with this switch. @@ -331,7 +355,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -341,6 +364,9 @@ Accept wildcard characters: False ``` ### -IncludeManagedByWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeManagedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of group owners in the ManagedByWithDisplayNames property. You don't need to specify a value with this switch. @@ -351,7 +377,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -361,6 +386,9 @@ Accept wildcard characters: False ``` ### -IncludeModeratedByWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. @@ -371,7 +399,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -381,6 +408,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ManagedBy parameter filters the results by the owner of the group. You can use any value that uniquely identifies the owner. For example: - Name @@ -394,7 +424,6 @@ The ManagedBy parameter filters the results by the owner of the group. You can u Type: GeneralRecipientIdParameter Parameter Sets: ManagedBySet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -404,6 +433,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -415,7 +447,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -425,6 +456,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -437,7 +471,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -447,6 +480,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified distribution group subtype. Valid values are: - MailNonUniversalGroup @@ -460,7 +496,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -470,13 +505,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -486,6 +523,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -505,7 +545,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroupMember.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-DistributionGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroupMember.md index 3113e769e2..1d9b8bb4fd 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DistributionGroupMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-distributiongroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-DistributionGroupMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-distributiongroupmember +schema: 2.0.0 +title: Get-DistributionGroupMember --- # Get-DistributionGroupMember @@ -74,6 +75,9 @@ In the cloud-based service, this example downloads a comma-separated value (CSV) ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group. You can use any value that uniquely identifies the group. For example: - Name @@ -87,7 +91,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupMemberIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -105,7 +111,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -123,7 +131,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -146,7 +156,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +165,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedObjects + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The IncludeSoftDeletedGroups switch specifies whether to include soft-deleted group members in the results. You don't need to specify a value with this switch. @@ -166,7 +178,6 @@ Soft-deleted group members are deleted Microsoft 365 Groups or mailboxes that ar Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -188,7 +202,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,13 +211,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-DkimSigningConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DkimSigningConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DkimSigningConfig.md index 9fe8d4bfd8..f26a3f5385 100644 --- a/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DkimSigningConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection -title: Get-DkimSigningConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dkimsigningconfig +schema: 2.0.0 +title: Get-DkimSigningConfig --- # Get-DkimSigningConfig @@ -49,6 +50,9 @@ This example shows detailed information for the DKIM signing policy for contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the DKIM signing policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name: The domain name (for example, contoso.com). @@ -59,7 +63,6 @@ The Identity parameter specifies the DKIM signing policy that you want to view. Type: DkimSigningConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpCompliancePolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpCompliancePolicy.md index f5a379ed1b..50f80e0531 100644 --- a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpcompliancepolicy applicable: Security & Compliance -title: Get-DlpCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpcompliancepolicy +schema: 2.0.0 +title: Get-DlpCompliancePolicy --- # Get-DlpCompliancePolicy @@ -69,6 +70,9 @@ This example gets all of the DLP policies in an environment and displays the dis ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -80,7 +84,6 @@ The Identity parameter specifies the DLP policy that you want to view. You can u Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -90,13 +93,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + {{ Fill DisplayName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. **Tip**: The DistributionResults property is unreliable and prone to errors. @@ -114,7 +122,6 @@ The DistributionDetail switch returns detailed policy distribution information i Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -ForceValidate + +> Applicable: Security & Compliance + {{ Fill ForceValidate Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -IncludeExtendedProperties + +> Applicable: Security & Compliance + {{ Fill IncludeExtendedProperties Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -156,13 +167,15 @@ Accept wildcard characters: False ``` ### -IncludeRulesMetadata + +> Applicable: Security & Compliance + {{ Fill IncludeRulesMetadata Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -IRMUserRiskConfiguredAnyRule + +> Applicable: Security & Compliance + {{ Fill IRMUserRiskConfiguredAnyRule Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -IncludeSimulationResults + +> Applicable: Security & Compliance + {{ Fill IncludeSimulationResults Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -Summary + +> Applicable: Security & Compliance + {{ Fill Summary Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpComplianceRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-DlpComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpComplianceRule.md index 3ec06ed550..0903acec7c 100644 --- a/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpcompliancerule applicable: Security & Compliance -title: Get-DlpComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpcompliancerule +schema: 2.0.0 +title: Get-DlpComplianceRule --- # Get-DlpComplianceRule @@ -57,6 +58,9 @@ This example lists all the rules included in the DLP compliance policy named "PI ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the DLP rule that you want to view. You can use Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + {{ Fill DisplayName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -IncludeExecutionRuleGuids + +> Applicable: Security & Compliance + {{ Fill IncludeExecutionRuleGuids Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the DLP policy that contains the rules. Using this parameter returns all rules that are assigned to the specified policy. Valid input for this parameter is any value that uniquely identifies the policy. For example - Name @@ -121,7 +131,6 @@ The Policy parameter specifies the DLP policy that contains the rules. Using thi Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpDetailReport.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-DlpDetailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpDetailReport.md index ec4460246a..9b5a04d968 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpDetailReport.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpdetailreport applicable: Exchange Online, Security & Compliance -title: Get-DlpDetailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpdetailreport +schema: 2.0.0 +title: Get-DlpDetailReport --- # Get-DlpDetailReport ## SYNOPSIS -**Note**: This cmdlet has been retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. +**Note**: This cmdlet has been retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchangepowershell/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. This cmdlet is available only in the cloud-based service. @@ -58,7 +59,7 @@ The Get-DlpDetailReport cmdlet returns detailed information about specific DLP r - Recipients - AttachmentNames -To see DLP detection data that's aggregated per day, use the [Get-DlpDetectionsReport](https://learn.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport) cmdlet. +To see DLP detection data that's aggregated per day, use the [Get-DlpDetectionsReport](https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpdetectionsreport) cmdlet. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -74,6 +75,9 @@ The following example lists the details of all the DLP policy activities defined ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Security & Compliance + The Action parameter filters the report by the action taken by DLP policies. Valid values are: - BlockAccess @@ -86,7 +90,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Actor + +> Applicable: Exchange Online, Security & Compliance + The Actor parameter filters the report by the user who last modified the item. You can enter multiple users separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -104,7 +110,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -DlpCompliancePolicy + +> Applicable: Exchange Online, Security & Compliance + The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -122,7 +130,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -DlpComplianceRule + +> Applicable: Exchange Online, Security & Compliance + The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -140,7 +150,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -158,7 +170,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -168,6 +179,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Security & Compliance + The EventType parameter filters the report by the event type. Valid values are: - DLPActionHits @@ -186,7 +200,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -196,13 +209,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -212,13 +227,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -Source + +> Applicable: Exchange Online, Security & Compliance + The Source parameter filters the report by workload. Valid values are: - EXCH: Exchange Online @@ -240,7 +260,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -250,6 +269,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -258,7 +280,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpDetectionsReport.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpDetectionsReport.md index be1c5ba605..2668fc6b73 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpDetectionsReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport applicable: Exchange Online, Security & Compliance -title: Get-DlpDetectionsReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpdetectionsreport +schema: 2.0.0 +title: Get-DlpDetectionsReport --- # Get-DlpDetectionsReport @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchangepowershell/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. Use the Get-DlpDetectionsReport cmdlet to list a summary of data loss prevention (DLP) rule matches for Exchange Online, SharePoint and OneDrive in your cloud-based organization for the last 30 days. @@ -66,6 +67,9 @@ This example lists the DLP activities for November, 2018. ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Security & Compliance + The Action parameter filters the report by the action taken by DLP policies. Valid values are: - BlockAccess @@ -78,7 +82,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Security & Compliance + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -DlpCompliancePolicy + +> Applicable: Exchange Online, Security & Compliance + The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -112,7 +120,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -122,6 +129,9 @@ Accept wildcard characters: False ``` ### -DlpComplianceRule + +> Applicable: Exchange Online, Security & Compliance + The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -130,7 +140,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -148,7 +160,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -158,6 +169,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Security & Compliance + The EventType parameter filters the report by the event type. Valid values are: - DataRetentions @@ -183,7 +197,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -Expression + +> Applicable: Security & Compliance + This parameter is available only in Security & Compliance PowerShell This parameter is reserved for internal Microsoft use. @@ -201,7 +217,6 @@ This parameter is reserved for internal Microsoft use. Type: Expression Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -211,13 +226,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -227,13 +244,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -Source + +> Applicable: Exchange Online, Security & Compliance + The Source parameter filters the report by workload. Valid values are: - EXCH: Exchange Online @@ -255,7 +277,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -273,7 +297,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -283,6 +306,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online, Security & Compliance + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. For this cmdlet, valid values are: @@ -297,7 +323,6 @@ You can specify multiple values separated by commas. The values that you specify Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpEdmSchema.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DlpEdmSchema.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpEdmSchema.md index d9052762b8..874113548b 100644 --- a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpEdmSchema.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpedmschema applicable: Security & Compliance -title: Get-DlpEdmSchema -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpedmschema +schema: 2.0.0 +title: Get-DlpEdmSchema --- # Get-DlpEdmSchema @@ -47,6 +48,9 @@ This example returns detailed information for the DLP EDM schema named Schema fo ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP EDM schema that you want to view. You can use any value that uniquely identifies the schema. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the DLP EDM schema that you want to view. You c Type: EdmStorageIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpIncidentDetailReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpIncidentDetailReport.md index 59707c5464..b5aa6eac36 100644 --- a/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpIncidentDetailReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpincidentdetailsreport applicable: Exchange Online, Security & Compliance -title: Get-DlpIncidentDetailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpincidentdetailsreport +schema: 2.0.0 +title: Get-DlpIncidentDetailReport --- # Get-DlpIncidentDetailReport @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) instead. +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchangepowershell/export-activityexplorerdata) instead. Use the Get-DlpIncidentDetailReport cmdlet to view the details of incidents that happened in the last 30 days. @@ -79,6 +80,9 @@ This example lists the details of the all incidents that occurred between the da ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Security & Compliance + The Action parameter filters the report by the action taken by DLP policies. Valid values are: - BlockAccess @@ -91,7 +95,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Actor + +> Applicable: Exchange Online, Security & Compliance + The Actor parameter filters the report by the user who last modified the item. You can enter multiple users separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -109,7 +115,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -DlpCompliancePolicy + +> Applicable: Exchange Online, Security & Compliance + The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -127,7 +135,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -DlpComplianceRule + +> Applicable: Exchange Online, Security & Compliance + The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -145,7 +155,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -155,6 +164,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -163,7 +175,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Security & Compliance + The EventType parameter filters the report by the event type. Valid values are: - DLPByIncidentIdActionHits @@ -190,7 +204,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -200,13 +213,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -216,13 +231,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -232,6 +249,9 @@ Accept wildcard characters: False ``` ### -Source + +> Applicable: Exchange Online, Security & Compliance + The Source parameter filters the report by workload. Valid values are: - EXCH: Exchange Online @@ -245,7 +265,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -255,6 +274,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -263,7 +285,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpKeywordDictionary.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpKeywordDictionary.md index cf21bb85d5..3158241804 100644 --- a/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpKeywordDictionary.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpkeyworddictionary applicable: Exchange Online, Security & Compliance -title: Get-DlpKeywordDictionary -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpkeyworddictionary +schema: 2.0.0 +title: Get-DlpKeywordDictionary --- # Get-DlpKeywordDictionary @@ -47,13 +48,15 @@ This example returns detailed information about the DLP keyword dictionary named ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Security & Compliance + The Name parameter specifies the name of the DLP keyword dictionary that you want to view. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-DlpPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicy.md index ef75ad1628..d8452dfc15 100644 --- a/exchange/exchange-ps/exchange/Get-DlpPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlppolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-DlpPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlppolicy +schema: 2.0.0 +title: Get-DlpPolicy --- # Get-DlpPolicy @@ -50,6 +51,9 @@ This example returns detailed information about the DLP policy named Employee Nu ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the DLP policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the DLP policy that you want to view. You can u Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicyTemplate.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicyTemplate.md index bafb90d765..c43bb97aac 100644 --- a/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpPolicyTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlppolicytemplate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-DlpPolicyTemplate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlppolicytemplate +schema: 2.0.0 +title: Get-DlpPolicyTemplate --- # Get-DlpPolicyTemplate @@ -50,13 +51,15 @@ This example returns detailed information about the DLP policy template named GL ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the DLP policy template you want to view. You can use any value that uniquely identifies the DLP policy template. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy template. ```yaml Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationType.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationType.md index 99d0a14db7..601dfddd45 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype applicable: Exchange Online, Security & Compliance -title: Get-DlpSensitiveInformationType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpsensitiveinformationtype +schema: 2.0.0 +title: Get-DlpSensitiveInformationType --- # Get-DlpSensitiveInformationType @@ -53,6 +54,9 @@ This example lists all the properties of the sensitive information type named "C ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitive information type that you want to view. Valid values are: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the sensitive information type that you want to Type: SensitiveInformationTypeIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Capability + +> Applicable: Security & Compliance + {{ Fill Capability Description }} ```yaml Type: ClassificationCapabilityType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -IncludeDetails + +> Applicable: Security & Compliance + {{ Fill IncludeDetails Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -IncludeElements + +> Applicable: Security & Compliance + {{ Fill IncludeElements Description }} ```yaml Type: ClassificationPrimitiveElementType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationTypeRulePackage.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationTypeRulePackage.md index 322925e01f..4cce370d02 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSensitiveInformationTypeRulePackage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtyperulepackage applicable: Exchange Online, Security & Compliance -title: Get-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpsensitiveinformationtyperulepackage +schema: 2.0.0 +title: Get-DlpSensitiveInformationTypeRulePackage --- # Get-DlpSensitiveInformationTypeRulePackage @@ -50,6 +51,9 @@ This example returns detailed information for the sensitive information type rul ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the sensitive information type rule package that you want to view. You can use any value that uniquely identifies the rule package. For example: - RuleCollectionName @@ -60,7 +64,6 @@ The Identity parameter specifies the sensitive information type rule package tha Type: SensitiveInformationTypeRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Capability + +> Applicable: Exchange Online, Security & Compliance + {{ Fill Capability Description }} ```yaml Type: ClassificationCapabilityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSiDetectionsReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DlpSiDetectionsReport.md index b89d2416f2..f66ffd8c70 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DlpSiDetectionsReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpsidetectionsreport applicable: Exchange Online, Security & Compliance -title: Get-DlpSiDetectionsReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dlpsidetectionsreport +schema: 2.0.0 +title: Get-DlpSiDetectionsReport --- # Get-DlpSiDetectionsReport @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchangepowershell/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. Use the Get-DlpSiDetectionsReport cmdlet to view information about data loss prevention (DLP) sensitive information type detections in the Microsoft Purview compliance portal for the last 90 days. @@ -59,6 +60,9 @@ This example returns detections for the sensitive information type 0e9b3178-9678 ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -67,7 +71,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -SensitiveType + +> Applicable: Exchange Online, Security & Compliance + The SensitiveType parameter filters the results by the specified sensitive information type. A valid value is the GUID of the sensitive information type (for example, 0e9b3178-9678-47dd-a509-37222ca96b42). To find the GUID value of a sensitive information type, run this command: Get-DlpSensitiveInformationType. You can enter multiple values separated by commas: `"Value1","Value2",..."ValueN"`. @@ -85,7 +91,6 @@ You can enter multiple values separated by commas: `"Value1","Value2",..."ValueN Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-DnssecStatusForVerifiedDomain.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DnssecStatusForVerifiedDomain.md index 05ddacb11c..36ca1bd7a8 100644 --- a/exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DnssecStatusForVerifiedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dnssecstatusforverifieddomain applicable: Exchange Online -title: Get-DnssecStatusForVerifiedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dnssecstatusforverifieddomain +schema: 2.0.0 +title: Get-DnssecStatusForVerifiedDomain --- # Get-DnssecStatusForVerifiedDomain @@ -97,13 +98,15 @@ This example contains the output from Example 1 and readable values for the DnsV ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to view information about DNSSEC (for example, contoso.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -113,13 +116,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -129,13 +134,15 @@ Accept wildcard characters: False ``` ### -SkipDnsValidation + +> Applicable: Exchange Online + The SkipDnsValidation switch specifies whether to skip the check for the DNSSEC-secured MX record in the domain. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -145,13 +152,15 @@ Accept wildcard characters: False ``` ### -SkipMtaStsValidation + +> Applicable: Exchange Online + The SkipMtaStsValidation switch specifies whether to skip the check for the DNSSEC-secured mail host in the MTA-STS Policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -161,13 +170,15 @@ Accept wildcard characters: False ``` ### -SkipMxValidation + +> Applicable: Exchange Online + The SkipMxValidation switch specifies whether to skip the check for the priority value 10 in the DNSSEC-secured MX record. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -177,13 +188,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DomainController.md b/exchange/exchange-ps/ExchangePowerShell/Get-DomainController.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-DomainController.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DomainController.md index b36194819e..7a52528003 100644 --- a/exchange/exchange-ps/exchange/Get-DomainController.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DomainController.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-domaincontroller applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-DomainController -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-domaincontroller +schema: 2.0.0 +title: Get-DomainController --- # Get-DomainController @@ -59,13 +60,15 @@ For more information about pipelining and the Format-Table cmdlet, see [About Pi ## PARAMETERS ### -GlobalCatalog + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GlobalCatalog switch specifies whether the command should return a list of global catalog servers. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: GlobalCatalog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -85,7 +91,6 @@ If you use the Forest parameter, the credentials are used to access the forest. Type: NetworkCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainName parameter specifies the fully qualified domain name (FQDN) of the domain for which you want to return a list of domain controllers. ```yaml Type: Fqdn Parameter Sets: DomainController Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,13 +118,15 @@ Accept wildcard characters: False ``` ### -Forest + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Forest parameter specifies the FQDN of the root domain of the forest for which you want to return a list of domain controllers. ```yaml Type: Fqdn Parameter Sets: GlobalCatalog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroup.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroup.md index 4dfc211e99..87c60a02f3 100644 --- a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-DynamicDistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dynamicdistributiongroup +schema: 2.0.0 +title: Get-DynamicDistributionGroup --- # Get-DynamicDistributionGroup @@ -126,6 +127,9 @@ This example returns the members for the dynamic distribution group named Full T ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the dynamic distribution group that you want to view. You can use any value that uniquely identifies the dynamic distribution group. For example: - Name @@ -139,7 +143,6 @@ The Identity parameter specifies the dynamic distribution group that you want to Type: DynamicGroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -149,6 +152,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -161,7 +167,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -171,6 +176,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -179,7 +187,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -189,6 +196,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -197,7 +207,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +216,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -222,7 +234,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -232,6 +243,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -245,7 +259,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +268,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromDLMembers recipients in the AcceptMessagesOnlyFromDLMembersWithDisplayNames property. You don't need to specify a value with this switch. @@ -265,7 +281,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -275,6 +290,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromSendersOrMembers recipients in the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. @@ -285,7 +303,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -295,6 +312,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeAcceptMessagesOnlyFromWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFrom recipients in the AcceptMessagesOnlyFromWithDisplayNames property. You don't need to specify a value with this switch. @@ -305,7 +325,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -315,6 +334,9 @@ Accept wildcard characters: False ``` ### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeBypassModerationFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of BypassModerationFromSendersOrMembers recipients in the BypassModerationFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. @@ -325,7 +347,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -335,6 +356,9 @@ Accept wildcard characters: False ``` ### -IncludeGrantSendOnBehalfToWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeGrantSendOnBehalfToWithDisplayNames switch specifies whether to return the SMTP addresses and display names of GrantSendOnBehalfTo recipients in the GrantSendOnBehalfToWithDisplayNames property. You don't need to specify a value with this switch. @@ -345,7 +369,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -355,6 +378,9 @@ Accept wildcard characters: False ``` ### -IncludeManagedByWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeManagedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of group owners in the ManagedByWithDisplayNames property. You don't need to specify a value with this switch. @@ -365,7 +391,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -375,6 +400,9 @@ Accept wildcard characters: False ``` ### -IncludeModeratedByWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. @@ -385,7 +413,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -395,6 +422,9 @@ Accept wildcard characters: False ``` ### -IncludeSystemObjects + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -403,7 +433,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -413,6 +442,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ManagedBy parameter filters the results by the owner of the group. You can use any value that uniquely identifies the owner. For example: - Name @@ -426,7 +458,6 @@ The ManagedBy parameter filters the results by the owner of the group. You can u Type: GeneralRecipientIdParameter Parameter Sets: ManagedBySet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -436,6 +467,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -447,7 +481,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -457,6 +490,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -469,7 +505,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -479,13 +514,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -495,6 +532,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -509,7 +549,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroupMember.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroupMember.md index d93483e17c..0f7bc5f3fe 100644 --- a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-DynamicDistributionGroupMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroupmember applicable: Exchange Online, Exchange Online Protection -title: Get-DynamicDistributionGroupMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-dynamicdistributiongroupmember +schema: 2.0.0 +title: Get-DynamicDistributionGroupMember --- # Get-DynamicDistributionGroupMember @@ -45,6 +46,9 @@ This example returns the existing members for the dynamic distribution group nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the dynamic distribution group. You can use any value that uniquely identifies the group. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the dynamic distribution group. You can use any Type: DynamicDistributionGroupMemberIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Online, Exchange Online Protection + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -76,7 +82,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedObjects + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeSoftDeletedGroups switch specifies whether to include soft-deleted group members in the results. You don't need to specify a value with this switch. Soft-deleted group members are deleted Microsoft 365 Groups or mailboxes that are still recoverable. @@ -94,7 +102,6 @@ Soft-deleted group members are deleted Microsoft 365 Groups or mailboxes that ar Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-EOPProtectionPolicyRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EOPProtectionPolicyRule.md index b10e5bcf46..ca0f1e8085 100644 --- a/exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: Get-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-eopprotectionpolicyrule +schema: 2.0.0 +title: Get-EOPProtectionPolicyRule --- # Get-EOPProtectionPolicyRule @@ -50,6 +51,9 @@ This example returns detailed information about the rule named Strict Preset Sec ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -62,7 +66,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online, Exchange Online Protection + The State parameter filters the results by the state of the rule. Valid values are: - Enabled @@ -82,7 +88,6 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOCasMailbox.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-EXOCasMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOCasMailbox.md index 72e7aca6f2..173797cbcd 100644 --- a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOCasMailbox.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exocasmailbox applicable: Exchange Online -title: Get-EXOCasMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exocasmailbox +schema: 2.0.0 +title: Get-EXOCasMailbox --- # Get-EXOCasMailbox @@ -83,6 +83,9 @@ This example returns the values of the following client access settings for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values: - User ID or user principal name (UPN) @@ -104,7 +107,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmt Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -114,6 +116,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -128,7 +133,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, Prima Type: String Parameter Sets: Anr Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,13 +142,15 @@ Accept wildcard characters: False ``` ### -ActiveSyncDebugLogging + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -154,6 +160,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -162,7 +171,6 @@ You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or User Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -172,6 +180,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -187,7 +198,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -197,13 +207,15 @@ Accept wildcard characters: False ``` ### -GetImapProtocolLog + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -213,13 +225,15 @@ Accept wildcard characters: False ``` ### -GetPopProtocolLog + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -229,13 +243,15 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -245,6 +261,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -256,7 +275,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -266,6 +284,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -274,7 +295,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -284,6 +304,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Online + The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. For more information about the available properties, see [Get-EXOCasMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets). @@ -292,7 +315,6 @@ For more information about the available properties, see [Get-EXOCasMailbox prop Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -302,6 +324,9 @@ Accept wildcard characters: False ``` ### -PropertySets + +> Applicable: Exchange Online + The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are: - Minimum (this is the default value) @@ -321,7 +346,6 @@ For more information about the properties that are included in each property set Type: PropertySet[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -331,6 +355,9 @@ Accept wildcard characters: False ``` ### -ProtocolSettings + +> Applicable: Exchange Online + The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings: - ExternalImapSettings @@ -348,7 +375,6 @@ To see these values, you need to use a formatting cmdlet. For example, `Get-CasM Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -358,13 +384,15 @@ Accept wildcard characters: False ``` ### -ReadIsOptimizedForAccessibility + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -374,13 +402,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -390,13 +420,15 @@ Accept wildcard characters: False ``` ### -SendLogsTo + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -406,6 +438,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or PrimarySmtpAddress parameters. @@ -414,7 +449,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity o Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailbox.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-EXOMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMailbox.md index 29b21ed26e..73afabf04d 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailbox.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailbox applicable: Exchange Online -title: Get-EXOMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailbox +schema: 2.0.0 +title: Get-EXOMailbox --- # Get-EXOMailbox @@ -105,6 +105,9 @@ This example returns the specified properties for the mailbox John@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values: - User ID or user principal name (UPN) @@ -126,7 +129,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmt Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -136,6 +138,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -150,7 +155,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, Prima Type: String Parameter Sets: Anr Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -160,13 +164,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Online + The Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -176,13 +182,15 @@ Accept wildcard characters: False ``` ### -Async + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -192,6 +200,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -200,7 +211,6 @@ You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or User Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -210,6 +220,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -225,7 +238,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -235,13 +247,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -251,6 +265,9 @@ Accept wildcard characters: False ``` ### -InactiveMailboxOnly + +> Applicable: Exchange Online + The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch. An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. @@ -261,7 +278,6 @@ To return both active mailboxes and inactive mailboxes in the results, don't use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -271,6 +287,9 @@ Accept wildcard characters: False ``` ### -IncludeInactiveMailbox + +> Applicable: Exchange Online + The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch. An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. @@ -281,7 +300,6 @@ To return only inactive mailboxes in the results, don't use this switch. Instead Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -291,6 +309,9 @@ Accept wildcard characters: False ``` ### -MailboxPlan + +> Applicable: Exchange Online + The MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example: - Name @@ -305,7 +326,6 @@ A mailbox plan specifies the permissions and features available to a mailbox use Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -315,13 +335,15 @@ Accept wildcard characters: False ``` ### -Migration + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -331,6 +353,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -342,7 +367,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -352,6 +376,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -360,7 +387,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -370,6 +396,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Online + The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. For more information about the available properties, see [Get-EXOMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). @@ -378,7 +407,6 @@ For more information about the available properties, see [Get-EXOMailbox propert Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -388,6 +416,9 @@ Accept wildcard characters: False ``` ### -PropertySets + +> Applicable: Exchange Online + The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are: - All @@ -417,7 +448,6 @@ For more information about the properties that are included in each property set Type: PropertySet[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -427,13 +457,15 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -443,6 +475,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Online + The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are: - DiscoveryMailbox @@ -462,7 +497,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -472,13 +506,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -488,6 +524,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Online + The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch. Soft-deleted mailboxes are deleted mailboxes that are still recoverable. @@ -496,7 +535,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -506,6 +544,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or PrimarySmtpAddress parameters. @@ -514,7 +555,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity o Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderPermission.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderPermission.md index d15ff5ab3c..5cbf8ec31b 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderPermission.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission applicable: Exchange Online -title: Get-EXOMailboxFolderPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderpermission +schema: 2.0.0 +title: Get-EXOMailboxFolderPermission --- # Get-EXOMailboxFolderPermission @@ -53,6 +53,9 @@ This example returns the permissions for the same folder in John's mailbox, but ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: `:\`. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox. Otherwise, you can use any value that uniquely identifies the mailbox. For example: @@ -70,7 +73,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -80,6 +82,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -88,7 +93,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -98,13 +102,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -114,6 +120,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -122,7 +131,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,6 +140,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example: - Name @@ -147,7 +158,6 @@ The User parameter filters the results by the specified mailbox, mail user, or m Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +167,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -165,7 +178,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Pr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -185,10 +197,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderpermission) -[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxfolderpermission) -[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxfolderpermission) -[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderStatistics.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderStatistics.md index b6d21cf8d8..62cc044bb4 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxFolderStatistics.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderstatistics applicable: Exchange Online -title: Get-EXOMailboxFolderStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderstatistics +schema: 2.0.0 +title: Get-EXOMailboxFolderStatistics --- # Get-EXOMailboxFolderStatistics @@ -67,6 +67,9 @@ This example uses the FolderScope parameter to view Inbox folder statistics for ## PARAMETERS ### -Archive + +> Applicable: Exchange Online + The Archive switch specifies whether to return the usage statistics of the archive mailbox that's associated with the mailbox or mail user. You don't need to specify a value with this switch. If you use this switch on a mailbox that doesn't have archiving enabled, an error is returned. @@ -75,7 +78,6 @@ If you use this switch on a mailbox that doesn't have archiving enabled, an erro Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -85,13 +87,15 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -109,7 +116,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -119,6 +125,9 @@ Accept wildcard characters: False ``` ### -Folderscope + +> Applicable: Exchange Online + The FolderScope parameter specifies the scope of the search by folder type. Valid values include: - All @@ -148,7 +157,6 @@ The FolderScope parameter specifies the scope of the search by folder type. Vali Type: ElcFolderType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -158,6 +166,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox. Otherwise, you can use any value that uniquely identifies the mailbox or mail user. For example: @@ -174,7 +185,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -184,13 +194,15 @@ Accept wildcard characters: False ``` ### -IncludeAnalysis + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -200,13 +212,15 @@ Accept wildcard characters: False ``` ### -IncludeOldestAndNewestItems + +> Applicable: Exchange Online + The IncludeOldestAndNewestItems switch specifies whether to return the dates of the oldest and newest items in each folder. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,6 +230,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Online + The IncludeSoftDeletedRecipients switch specifies whether to include soft-deleted mailboxes in the results. You don't need to specify a value with this switch. Soft-deleted mailboxes are mailboxes that have been deleted, but are still recoverable. @@ -224,7 +241,6 @@ Soft-deleted mailboxes are mailboxes that have been deleted, but are still recov Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -234,6 +250,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -242,7 +261,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -252,6 +270,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -260,7 +281,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Pr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxPermission.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxPermission.md index d008aa8f24..d52f055125 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxPermission.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxpermission applicable: Exchange Online -title: Get-EXOMailboxPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxpermission +schema: 2.0.0 +title: Get-EXOMailboxPermission --- # Get-EXOMailboxPermission @@ -72,6 +72,9 @@ This example return the permission the user has on mailboxes ## PARAMETERS ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -80,7 +83,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -90,6 +92,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox. Otherwise, you can use any value that uniquely identifies the mailbox. For example: @@ -106,7 +111,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddr Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -116,13 +120,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Online + The Owner switch returns the owner information for the mailbox that's specified by the Identity parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,6 +138,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -140,7 +149,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -150,13 +158,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,6 +176,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Online + The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch. Soft-deleted mailboxes are deleted mailboxes that are still recoverable. @@ -174,7 +187,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -184,6 +196,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + The User parameter returns information about the user who has permissions to the mailbox specified by the Identity parameter. The user that you specify for this parameter must be a user or security group (a security principal that can have permissions assigned). You can use any value that uniquely identifies the user. For example: @@ -199,7 +214,6 @@ The user that you specify for this parameter must be a user or security group (a Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -209,6 +223,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -217,7 +234,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Pr Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxStatistics.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxStatistics.md index cbe03cc816..4840704c43 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMailboxStatistics.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxstatistics applicable: Exchange Online -title: Get-EXOMailboxStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxstatistics +schema: 2.0.0 +title: Get-EXOMailboxStatistics --- # Get-EXOMailboxStatistics @@ -61,13 +61,15 @@ This example retrieves the minimum set of properties and the specified propertie ## PARAMETERS ### -Archive + +> Applicable: Exchange Online + The Archive switch specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -77,13 +79,15 @@ Accept wildcard characters: False ``` ### -DatabaseGuid + +> Applicable: Exchange Online + The DatabaseGuid parameter filters the results by the GUID of mailbox database that hosts the Mailbox. You can find this property value by using the Get-EXOMailbox cmdlet with the Properties parameter value DatabaseGuid. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,13 +97,15 @@ Accept wildcard characters: False ``` ### -ExchangeGuid + +> Applicable: Exchange Online + The ExchangeGuid parameter filters the results by the GUID of mailbox (aso known as the Mailbox GUID). You can find this property value by using the Get-EXOMailbox cmdlet with Properties filter set to ExchangeGuid. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -109,6 +115,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox. Otherwise, you can use any value that uniquely identifies the mailbox. For example: @@ -127,7 +136,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -137,13 +145,15 @@ Accept wildcard characters: False ``` ### -IncludeMoveHistory + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -153,13 +163,15 @@ Accept wildcard characters: False ``` ### -IncludeMoveReport + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -169,6 +181,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Online + The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. Soft-deleted recipients are deleted recipients that are still recoverable. @@ -177,7 +192,6 @@ Soft-deleted recipients are deleted recipients that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -187,6 +201,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -195,7 +212,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -205,6 +221,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Online + The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. For more information about the available properties, see [Get-EXOMailboxStatistics property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets). @@ -213,7 +232,6 @@ For more information about the available properties, see [Get-EXOMailboxStatisti Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -223,6 +241,9 @@ Accept wildcard characters: False ``` ### -PropertySets + +> Applicable: Exchange Online + The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are: - Minimum (this is the default value) @@ -236,7 +257,6 @@ For more information about the properties that are included in each property set Type: PropertySet[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -246,6 +266,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -254,7 +277,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Pr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMobileDeviceStatistics.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXOMobileDeviceStatistics.md index 91b5ebab64..ac4e8c62b0 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXOMobileDeviceStatistics.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exomobiledevicestatistics applicable: Exchange Online -title: Get-EXOMobileDeviceStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomobiledevicestatistics +schema: 2.0.0 +title: Get-EXOMobileDeviceStatistics --- # Get-EXOMobileDeviceStatistics @@ -72,6 +72,9 @@ This example returns the statistics for active sync devices linked to user with ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mobile device that you want to view. You can use any value that uniquely identifies the mobile device. For example: - GUID @@ -83,7 +86,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, Primar Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,6 +95,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Online + The Mailbox parameter filters the results by the user mailbox that's associated with the mobile device. You can use any value that uniquely identifies the mailbox. For example: - GUID @@ -104,7 +109,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: String Parameter Sets: MobileDeviceIdentity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -114,13 +118,15 @@ Accept wildcard characters: False ``` ### -ActiveSync + +> Applicable: Exchange Online + The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,6 +136,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -138,7 +147,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -148,13 +156,15 @@ Accept wildcard characters: False ``` ### -GetMailboxLog + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -164,13 +174,15 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -180,13 +192,15 @@ Accept wildcard characters: False ``` ### -OWAforDevices + +> Applicable: Exchange Online + The OWAforDevices switch filters the results by devices where Outlook on the web for devices is enabled. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -196,6 +210,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -204,7 +221,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -214,13 +230,15 @@ Accept wildcard characters: False ``` ### -RestApi + +> Applicable: Exchange Online + The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -230,13 +248,15 @@ Accept wildcard characters: False ``` ### -ShowRecoveryPassword + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -246,13 +266,15 @@ Accept wildcard characters: False ``` ### -UniversalOutlook + +> Applicable: Exchange Online + The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -262,6 +284,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, Identity, or PrimarySmtpAddress parameters. @@ -270,7 +295,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Mailbox, Identi Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXORecipient.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXORecipient.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-EXORecipient.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXORecipient.md index fd34b10f9d..eac17545ab 100644 --- a/exchange/exchange-ps/exchange/Get-EXORecipient.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXORecipient.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exorecipient applicable: Exchange Online -title: Get-EXORecipient -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exorecipient +schema: 2.0.0 +title: Get-EXORecipient --- # Get-EXORecipient @@ -76,6 +76,9 @@ This example returns the recipient attribute details for the user john@contoso.c ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the recipient object that you want to view. For the best performance, we recommend using the following values to identify the recipient: - User ID or user principal name (UPN) @@ -97,7 +100,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmt Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -107,6 +109,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -121,7 +126,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, Prima Type: String Parameter Sets: Anr Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -131,6 +135,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -139,7 +146,6 @@ You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or User Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -149,6 +155,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -164,7 +173,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,6 +182,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Online + The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. Soft-deleted recipients are deleted recipients that are still recoverable. @@ -182,7 +193,6 @@ Soft-deleted recipients are deleted recipients that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -192,6 +202,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -203,7 +216,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -213,6 +225,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the recipient that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or UserPrincipalName parameters. @@ -221,7 +236,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity o Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -231,6 +245,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Online + The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. For more information about the available properties, see [Get-EXORecipient property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets). @@ -239,7 +256,6 @@ For more information about the available properties, see [Get-EXORecipient prope Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -249,6 +265,9 @@ Accept wildcard characters: False ``` ### -PropertySets + +> Applicable: Exchange Online + The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are: - Minimum (this is the default value) @@ -263,7 +282,6 @@ For more information about the properties that are included in each property set Type: PropertySet[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -273,13 +291,15 @@ Accept wildcard characters: False ``` ### -RecipientPreviewFilter + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -289,6 +309,9 @@ Accept wildcard characters: False ``` ### -RecipientType + +> Applicable: Exchange Online + The RecipientType parameter filters the results by the specified recipient type. Valid values are: - DynamicDistributionGroup @@ -306,7 +329,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -316,6 +338,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Online + The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are: - DiscoveryMailbox @@ -355,7 +380,6 @@ The value of the RecipientType parameter affects the values that you can use for Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -365,13 +389,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -381,6 +407,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the recipient that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -389,7 +418,6 @@ You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-EXORecipientPermission.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-EXORecipientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EXORecipientPermission.md index 3ec37b7a9d..41c27a1675 100644 --- a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EXORecipientPermission.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-exorecipientpermission applicable: Exchange Online -title: Get-EXORecipientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exorecipientpermission +schema: 2.0.0 +title: Get-EXORecipientPermission --- # Get-EXORecipientPermission @@ -56,6 +56,9 @@ Above example returns recipient permission for first 100 mailbox users in the na ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter identifies the recipient that you want to view. The user or group specified by the Trustee parameter has Send As permissions on this recipient. You can specify any type of recipient, for example: - Mailboxes @@ -85,7 +88,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddr Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -95,13 +97,15 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Online + The AccessRights parameter filters the results by permission. The only valid value for this parameter is SendAs. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -111,6 +115,9 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId + +> Applicable: Exchange Online + The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -119,7 +126,6 @@ You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrinc Type: Guid Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -129,6 +135,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online + The PrimarySmtpAddress identifies the recipient that you want to view by primary SMTP email address (for example, navin@contoso.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. @@ -137,7 +146,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -147,13 +155,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -163,6 +173,9 @@ Accept wildcard characters: False ``` ### -Trustee + +> Applicable: Exchange Online + The Trustee parameter filters the results by the user or group who has Send As permissions. You can specify the following types of users or groups: - Mailbox users @@ -185,7 +198,6 @@ You need to use this parameter with the Identity, PrimarySmtpAddress, UserPrinci Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -195,6 +207,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Online + The UserPrincipalName parameter identifies the recipient that you want to view by UPN (for example, navin@contoso.onmicrosoft.com). You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters. @@ -203,7 +218,6 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Pr Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-EcpVirtualDirectory.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EcpVirtualDirectory.md index 1235c14ba1..250dab85ba 100644 --- a/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EcpVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ecpvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EcpVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ecpvirtualdirectory +schema: 2.0.0 +title: Get-EcpVirtualDirectory --- # Get-EcpVirtualDirectory @@ -69,6 +70,9 @@ This example returns a summary list of all Exchange Control Panel virtual direct ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the ECP virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -83,7 +87,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -106,7 +112,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -124,7 +132,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -160,7 +172,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EdgeSubscription.md b/exchange/exchange-ps/ExchangePowerShell/Get-EdgeSubscription.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-EdgeSubscription.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EdgeSubscription.md index 4e288d9293..75362938ad 100644 --- a/exchange/exchange-ps/exchange/Get-EdgeSubscription.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EdgeSubscription.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-edgesubscription applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EdgeSubscription -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-edgesubscription +schema: 2.0.0 +title: Get-EdgeSubscription --- # Get-EdgeSubscription @@ -50,13 +51,15 @@ This example retrieves the Edge Subscription information for the Edge Transport ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the Edge Transport server for which you want to retrieve Edge Subscription information. The identity is expressed as the host name of the Edge Transport server. If no identity is specified, all Edge Subscriptions are returned. ```yaml Type: TransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -74,7 +80,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-EdgeSyncServiceConfig.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EdgeSyncServiceConfig.md index fa33987f4c..0f9ce42282 100644 --- a/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EdgeSyncServiceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-edgesyncserviceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EdgeSyncServiceConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-edgesyncserviceconfig +schema: 2.0.0 +title: Get-EdgeSyncServiceConfig --- # Get-EdgeSyncServiceConfig @@ -42,13 +43,15 @@ This example reads the configuration of the Microsoft Exchange EdgeSync service ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the Microsoft Exchange EdgeSync service configuration you want to view. ```yaml Type: EdgeSyncServiceConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -58,13 +61,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -74,13 +79,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Site parameter specifies the Active Directory site that EdgeSync connects to for synchronizing configuration and recipient data. ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md b/exchange/exchange-ps/ExchangePowerShell/Get-EligibleDistributionGroupForMigration.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EligibleDistributionGroupForMigration.md index fe9c386e7f..dabfa9610d 100644 --- a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EligibleDistributionGroupForMigration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-eligibledistributiongroupformigration applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-EligibleDistributionGroupForMigration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-eligibledistributiongroupformigration +schema: 2.0.0 +title: Get-EligibleDistributionGroupForMigration --- # Get-EligibleDistributionGroupForMigration @@ -51,6 +52,9 @@ This example returns a summary list of all distribution groups that can be upgra ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter filters the results by the email address of the specified distribution group. If no results are returned for the specified email address, the group can't be upgraded to a Microsoft 365 Group. You can't use this parameter with the ManagedBy parameter. @@ -59,7 +63,6 @@ You can't use this parameter with the ManagedBy parameter. Type: DistributionGroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ManagedBy parameter filters the results by the manager of the distribution group (the ManagedBy property). You can use any value that uniquely identifies the distribution group manager. For example: - Name @@ -84,7 +90,6 @@ You can't use this parameter with the Identity parameter. Type: GeneralRecipientIdParameter Parameter Sets: ManagedBy Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -105,7 +113,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-EmailAddressPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EmailAddressPolicy.md index 1cb8b5a7a3..ccc466c3b6 100644 --- a/exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EmailAddressPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-emailaddresspolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-EmailAddressPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-emailaddresspolicy +schema: 2.0.0 +title: Get-EmailAddressPolicy --- # Get-EmailAddressPolicy @@ -49,6 +50,9 @@ This example returns detailed information for the email address policy named Con ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the email address policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the email address policy that you want to view. Type: EmailAddressPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -77,7 +83,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -IncludeMailboxSettingOnlyPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The IncludeMailboxSettingOnlyPolicy switch retrieves Microsoft Exchange Server 2003 address policies that contain only mailbox management configuration. You don't need to specify a value with this switch. @@ -99,7 +107,6 @@ The attributes of address policies that contain only mailbox management configur Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-EmailTenantSettings.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-EmailTenantSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EmailTenantSettings.md index 025fdca73a..8fa56a3fe5 100644 --- a/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EmailTenantSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-emailtenantsettings applicable: Exchange Online -title: Get-EmailTenantSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-emailtenantsettings +schema: 2.0.0 +title: Get-EmailTenantSettings --- # Get-EmailTenantSettings @@ -39,13 +40,15 @@ This example shows whether priority account protection is enabled or disabled in ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the settings object that you want to view. The only settings object in the organization is named Default. ```yaml Type: EmailTenantSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-EtrLimits.md b/exchange/exchange-ps/ExchangePowerShell/Get-EtrLimits.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-EtrLimits.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EtrLimits.md index 759a8d045c..ddcf5e44e4 100644 --- a/exchange/exchange-ps/exchange/Get-EtrLimits.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EtrLimits.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-etrlimits applicable: Exchange Online, Exchange Online Protection -title: Get-EtrLimits -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-etrlimits +schema: 2.0.0 +title: Get-EtrLimits --- # Get-EtrLimits diff --git a/exchange/exchange-ps/exchange/Get-EventLogLevel.md b/exchange/exchange-ps/ExchangePowerShell/Get-EventLogLevel.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-EventLogLevel.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EventLogLevel.md index cc925f4f3d..e44116bb97 100644 --- a/exchange/exchange-ps/exchange/Get-EventLogLevel.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EventLogLevel.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-eventloglevel applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-EventLogLevel -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-eventloglevel +schema: 2.0.0 +title: Get-EventLogLevel --- # Get-EventLogLevel @@ -49,6 +50,9 @@ This example displays the event categories and log levels for the server Exchang ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter filters the results by the name of the event category. To see the available event categories, run the following command: Get-EventLogLevel. You can't use this parameter with the Server parameter. @@ -57,7 +61,6 @@ You can't use this parameter with the Server parameter. Type: ECIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -80,7 +86,6 @@ You can't use this parameter with the Identity parameter. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -98,7 +106,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-EventsFromEmailConfiguration.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-EventsFromEmailConfiguration.md index 30df67b8a5..739c0aca33 100644 --- a/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-EventsFromEmailConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-eventsfromemailconfiguration applicable: Exchange Online -title: Get-EventsFromEmailConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-eventsfromemailconfiguration +schema: 2.0.0 +title: Get-EventsFromEmailConfiguration --- # Get-EventsFromEmailConfiguration @@ -42,13 +43,15 @@ This example retrieves all events from email settings for peter@contoso.com's ma ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox that you want to view. You identify the mailbox by email address. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeAssistanceConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeAssistanceConfig.md index d2853de47a..6935ba187f 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeAssistanceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeassistanceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeAssistanceConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangeassistanceconfig +schema: 2.0.0 +title: Get-ExchangeAssistanceConfig --- # Get-ExchangeAssistanceConfig @@ -48,13 +49,15 @@ This example shows the configuration information for all organizations and forma ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the organization. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -72,7 +78,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeCertificate.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeCertificate.md index eec9e123ff..fea0c58a77 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeCertificate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangecertificate +schema: 2.0.0 +title: Get-ExchangeCertificate --- # Get-ExchangeCertificate @@ -126,6 +127,9 @@ This example shows which certificate Exchange will select for the domain name ma ## PARAMETERS ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Thumbprint parameter specifies the thumbprint value of the certificate that you want to view. The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. @@ -134,7 +138,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: String Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -144,6 +147,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the certificate that you want to view. Valid values are: - `ServerNameOrFQDN\Thumbprint` @@ -157,7 +163,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: ExchangeCertificateIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -167,6 +172,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -175,7 +183,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,13 +192,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainName parameter filters the results by the fully qualified domain name (FQDN) or server name values in the Subject Name or the Subject Alternative Name fields. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,13 +210,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: X509Certificate2 Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,6 +228,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -232,7 +246,6 @@ You can't use this parameter with the Identity parameter, but you can use it wit Type: ServerIdParameter Parameter Sets: Instance, Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeDiagnosticInfo.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeDiagnosticInfo.md index ca36c14478..26ef51e172 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeDiagnosticInfo.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangediagnosticinfo applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeDiagnosticInfo -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangediagnosticinfo +schema: 2.0.0 +title: Get-ExchangeDiagnosticInfo --- # Get-ExchangeDiagnosticInfo @@ -53,6 +54,9 @@ This example display the XML output of the command in format that's easier to re ## PARAMETERS ### -Argument + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Argument parameter specifies a valid argument to use with the specified Component value. Common Argument values that you can use with virtually Component value are Help and Verbose. @@ -63,7 +67,6 @@ To see the Argument values that are available for a given Component value, run t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Component + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Component parameter returns detailed information for the specified Component of the given Process value. To see the Component values that are available for a given Process value, run the command `Get-ExchangeDiagnosticInfo -Process ProcessName -Argument Help`. @@ -81,7 +87,6 @@ To see the Component values that are available for a given Process value, run th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Process + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Process parameter provides details for the specified Exchange process. Valid values are the name of the process (for example, MSExchangeTransport or Microsoft.Exchange.Directory.TopologyService). To see the list of available Exchange processes, run the command Get-ExchangeDiagnosticInfo. @@ -99,7 +107,6 @@ To see the list of available Exchange processes, run the command Get-ExchangeDia Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -122,7 +132,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -Unlimited + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Unlimited switch tells the command to return all available information. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExchangeFeature.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeFeature.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ExchangeFeature.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeFeature.md index 6bf6bb29bf..124cbe2406 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeFeature.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeFeature.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangefeature applicable: Exchange Server 2019 -title: Get-ExchangeFeature -schema: 2.0.0 author: lusassl-msft +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: lusassl ms.reviewer: srvar +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangefeature +schema: 2.0.0 +title: Get-ExchangeFeature --- # Get-ExchangeFeature @@ -50,6 +52,9 @@ This example returns information about the feature with the feature id PING.1.0. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019 + The Identity parameter specifies the Exchange server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -63,7 +68,6 @@ If you don't use this parameter, the command returns information for all Exchang Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: 0 @@ -73,13 +77,15 @@ Accept wildcard characters: False ``` ### -FeatureID + +> Applicable: Exchange Server 2019 + The FeatureID parameter specifies the feature you want to query information about. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -89,13 +95,15 @@ Accept wildcard characters: False ``` ### -RingLevel + +> Applicable: Exchange Server 2019 + The RingLevel parameter specifies the ring level you want to query information about. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -105,13 +113,15 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2019 + The Status parameter specifies the status you want to query information about. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServer.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-ExchangeServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServer.md index 4331ccbb63..5bbf2d4944 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangeserver +schema: 2.0.0 +title: Get-ExchangeServer --- # Get-ExchangeServer @@ -62,6 +63,9 @@ This example returns detailed information about the Exchange server named Mailbo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Exchange server that you want to view. You can use any value that uniquely identifies the Exchange server. For example: - Name @@ -75,7 +79,6 @@ You can't use this parameter with the Domain parameter. Type: ServerIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Domain parameter filters the results by the fully qualified domain name (FQDN) of the domain (for example, contoso.com). You can't use this parameter with the Identity parameter. @@ -93,7 +99,6 @@ You can't use this parameter with the Identity parameter. Type: Fqdn Parameter Sets: Domain Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -111,7 +119,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Status switch specifies whether to include additional property values in the results, for example, the Watson state, StaticDomainControllers, and runtime domain controller usage. You don't need to specify a value with this switch. To see the additional values, you need to pipe the output to a formatting cmdlet, for example, the Format-List cmdlet. @@ -129,7 +139,6 @@ To see the additional values, you need to pipe the output to a formatting cmdlet Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicense.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicense.md index 4d95f68bfd..1663316338 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicense.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeserveraccesslicense applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeServerAccessLicense -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangeserveraccesslicense +schema: 2.0.0 +title: Get-ExchangeServerAccessLicense --- # Get-ExchangeServerAccessLicense diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicenseUser.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicenseUser.md index 4c62c163e4..4c452c27b0 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeServerAccessLicenseUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeserveraccesslicenseuser applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeServerAccessLicenseUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangeserveraccesslicenseuser +schema: 2.0.0 +title: Get-ExchangeServerAccessLicenseUser --- # Get-ExchangeServerAccessLicenseUser @@ -42,6 +43,9 @@ This example returns the unique users for the license named Exchange Server 2016 ## PARAMETERS ### -LicenseName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LicenseName parameter specifies the license type that you want to view. You can find the available license type values by running the Get-ExchangeServerAccessLicense cmdlet. Valid values are: - `Exchange Server Standard CAL` @@ -55,7 +59,6 @@ The `` value is 2013, 2016, or 2019. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExchangeSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeSettings.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-ExchangeSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExchangeSettings.md index 9088353301..23cefad71d 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExchangeSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangesettings applicable: Exchange Server 2016, Exchange Server 2019 -title: Get-ExchangeSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exchangesettings +schema: 2.0.0 +title: Get-ExchangeSettings --- # Get-ExchangeSettings @@ -60,6 +61,9 @@ This example returns a summary list of all Exchange setting objects. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the Exchange setting object. You can use any value that uniquely identifies the object. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the name of the Exchange setting object. You ca Type: ExchangeSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -ConfigName + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ConfigName parameter filter the results by the specified property name. The value you specify is visible in the EffectiveSetting property. The available values are determined by the schema of the Exchange setting object. @@ -88,7 +94,6 @@ The available values are determined by the schema of the Exchange setting object Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Database parameter filters the results by mailbox database. You can use any value that uniquely identifies the database. For example: - Name @@ -109,7 +117,6 @@ The Database parameter filters the results by mailbox database. You can use any Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. The detailed information is visible in the DiagnosticInfo property. @@ -129,7 +139,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,13 +148,15 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -179,7 +195,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,13 +204,15 @@ Accept wildcard characters: False ``` ### -GenericScopeName + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The GenericScopeName parameter filters the results by the scope. The available values are determined by the schema of the Exchange setting object. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -205,13 +222,15 @@ Accept wildcard characters: False ``` ### -GenericScopes + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The GenericScopes parameter filters the results by the scope. The available values are determined by the schema of the Exchange setting object. This parameter uses the syntax `"key1=value1","key2=value2", "keyN=valueN`. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -221,13 +240,15 @@ Accept wildcard characters: False ``` ### -GenericScopeValue + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The GenericScopeValue parameter filters the results by the value of the scope specified by the GenericScopeName parameter. The available values are determined by the schema of the Exchange setting object. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,13 +258,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,13 +276,15 @@ Accept wildcard characters: False ``` ### -Process + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Process parameter filters the results by the specified process. The available values are determined by the schema of the Exchange setting object. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -269,6 +294,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Server parameter filters the results by Exchange server. You can use any value that uniquely identifies the server. For example: - Name @@ -280,7 +308,6 @@ The Server parameter filters the results by Exchange server. You can use any val Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -290,13 +317,15 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The User parameter filters the results by user. You identify the user by their GUID value (for example, 87246450-1b19-4c81-93dc-1a4200eff66c). To find the GUID for a user, run the following command: `Get-User | Format-List Name,GUID`. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierPolicy.md index 08f6210738..593507275d 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierpolicy applicable: Exchange Online -title: Get-ExoInformationBarrierPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exoinformationbarrierpolicy +schema: 2.0.0 +title: Get-ExoInformationBarrierPolicy --- # Get-ExoInformationBarrierPolicy @@ -46,6 +47,9 @@ This example shows detailed information for the specified Exchange Online inform ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Exchange Online information barrier policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the Exchange Online information barrier policy Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -ShowFriendlyValues + +> Applicable: Exchange Online + The ShowFriendlyValues switch specifies whether to show friendly values in the output of the command. You don't need to specify a value with this switch. When you use this switch, the following property values are shown: @@ -78,7 +84,6 @@ When you use this switch, the following property values are shown: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierRelationship.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierRelationship.md index 8e1ddb9d25..a21fb872a1 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierRelationship.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierrelationship applicable: Exchange Online -title: Get-ExoInformationBarrierRelationship -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exoinformationbarrierrelationship +schema: 2.0.0 +title: Get-ExoInformationBarrierRelationship --- # Get-ExoInformationBarrierRelationship @@ -40,6 +41,9 @@ This example shows the Exchange Online information barrier relationship between ## PARAMETERS ### -RecipientId1 + +> Applicable: Exchange Online + The RecipientId1 parameter specifies the first recipient in the Exchange Online barrier relationship. You can use any value that uniquely identifies the recipient. For example: - Name @@ -53,7 +57,6 @@ The RecipientId1 parameter specifies the first recipient in the Exchange Online Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -RecipientId2 + +> Applicable: Exchange Online + The RecipientId2 parameter specifies the second recipient in the Exchange Online barrier relationship. You can use any value that uniquely identifies the recipient. For example: - Name @@ -76,7 +82,6 @@ The RecipientId2 parameter specifies the second recipient in the Exchange Online Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierSegment.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierSegment.md index b0caf1efcb..2133d84497 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExoInformationBarrierSegment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarriersegment applicable: Exchange Online -title: Get-ExoInformationBarrierSegment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exoinformationbarriersegment +schema: 2.0.0 +title: Get-ExoInformationBarrierSegment --- # Get-ExoInformationBarrierSegment @@ -46,6 +47,9 @@ This example shows detailed information for the specified Exchange Online inform ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Exchange Online information barrier segment that you want to view. You can use any value that uniquely identifies the segment. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the Exchange Online information barrier segment Type: InformationBarrierSegmentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -ShowFriendlyValues + +> Applicable: Exchange Online + The ShowFriendlyValues switch specifies whether to show friendly values in the output of the command. You don't need to specify a value with this switch. When you use this switch, the FriendlyMembershipFilter property value is shown. @@ -75,7 +81,6 @@ When you use this switch, the FriendlyMembershipFilter property value is shown. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExoPhishSimOverrideRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExoPhishSimOverrideRule.md index f909f50138..3b747b043e 100644 --- a/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExoPhishSimOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exophishsimoverriderule applicable: Exchange Online -title: Get-ExoPhishSimOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exophishsimoverriderule +schema: 2.0.0 +title: Get-ExoPhishSimOverrideRule --- # Get-ExoPhishSimOverrideRule @@ -53,6 +54,9 @@ Although the previous command should return only one rule, a rule that's pending ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ The name of the rule uses the following syntax: `_Exe:PhishSimOverr:` \[s Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Exchange Online + The Policy parameter filters the results by phishing simulator override policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -119,7 +129,6 @@ The Policy parameter filters the results by phishing simulator override policy. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExoSecOpsOverrideRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExoSecOpsOverrideRule.md index 8fd400e919..6a7a7b3409 100644 --- a/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExoSecOpsOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exosecopsoverriderule applicable: Exchange Online -title: Get-ExoSecOpsOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exosecopsoverriderule +schema: 2.0.0 +title: Get-ExoSecOpsOverrideRule --- # Get-ExoSecOpsOverrideRule @@ -53,6 +54,9 @@ Although the previous command should return only one rule, a rule that's pending ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ The name of the rule uses the following syntax: `_Exe:SecOpsOverrid:` \[s Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Exchange Online + The Policy parameter filters the results by SecOps mailbox override policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -119,7 +129,6 @@ The Policy parameter filters the results by SecOps mailbox override policy. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md b/exchange/exchange-ps/ExchangePowerShell/Get-ExternalInOutlook.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ExternalInOutlook.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ExternalInOutlook.md index 451de0b213..8da1e93597 100644 --- a/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ExternalInOutlook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-externalinoutlook applicable: Exchange Online, Exchange Online Protection -title: Get-ExternalInOutlook -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-externalinoutlook +schema: 2.0.0 +title: Get-ExternalInOutlook --- # Get-ExternalInOutlook @@ -44,13 +45,15 @@ This example returns the settings of the external sender identification feature ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID of the external sender identification object that you want to view. Although this parameter is available, you don't need to use it. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md b/exchange/exchange-ps/ExchangePowerShell/Get-FailedContentIndexDocuments.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FailedContentIndexDocuments.md index 14df25198f..509c2fe2d2 100644 --- a/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FailedContentIndexDocuments.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-failedcontentindexdocuments applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-FailedContentIndexDocuments -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-failedcontentindexdocuments +schema: 2.0.0 +title: Get-FailedContentIndexDocuments --- # Get-FailedContentIndexDocuments @@ -91,6 +92,9 @@ This example retrieves a list of items that couldn't be indexed by Exchange Sear ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -108,7 +112,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -MailboxDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDatabase parameter specifies the database from which to get the mailbox. You can use any value that uniquely identifies the database. For example: - Name @@ -128,7 +134,6 @@ The MailboxDatabase parameter specifies the database from which to get the mailb Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies a Mailbox server. You can use the following values: - Name @@ -148,7 +156,6 @@ The Server parameter specifies a Mailbox server. You can use the following value Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -158,6 +165,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -167,7 +177,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -177,13 +186,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +204,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Archive switch restricts the scope of the cmdlet to the user's archive. You don't need to specify a value with this switch. When using the Archive switch, you must also specify the Identity parameter. @@ -201,7 +215,6 @@ When using the Archive switch, you must also specify the Identity parameter. Type: SwitchParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -211,6 +224,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -219,7 +235,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -229,13 +244,15 @@ Accept wildcard characters: False ``` ### -ErrorCode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ErrorCode parameter allows you to retrieve documents that failed indexing with a specific error code. You can use the cmdlet without this parameter to list all failed documents for a mailbox, a mailbox database or a Mailbox server. The output includes the error codes and reason for failure. If required, you can then restrict the output to a specific error code from the results. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -245,6 +262,9 @@ Accept wildcard characters: False ``` ### -FailureMode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FailureMode parameter specifies the type of error. Use the following values. - Transient: Returns items that couldn't be indexed due to transient errors. Exchange Search attempts to index these items again. @@ -255,7 +275,6 @@ The FailureMode parameter specifies the type of error. Use the following values. Type: FailureMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -265,13 +284,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -281,6 +302,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -289,7 +313,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -299,13 +322,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-FeatureConfiguration.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-FeatureConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FeatureConfiguration.md index 87063ff596..ae9ba0feae 100644 --- a/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FeatureConfiguration.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-featureconfiguration applicable: Security & Compliance -title: Get-FeatureConfiguration +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-featureconfiguration schema: 2.0.0 +title: Get-FeatureConfiguration --- # Get-FeatureConfiguration @@ -52,6 +54,9 @@ This example returns detailed information about the specified collection policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity policy specifies the feature configuration that you want to view. You can use any value that uniquely identifies the configuration. For example: - Name @@ -62,7 +67,6 @@ The Identity policy specifies the feature configuration that you want to view. Y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -72,6 +76,9 @@ Accept wildcard characters: False ``` ### -FeatureScenario + +> Applicable: Security & Compliance + The FeatureScenario parameter specifies the scenario for the feature configuration. Currently, the only valid values are: - `KnowYourData` for collection policies - `TrustContainer` for Endpoint DLP trust container @@ -80,7 +87,6 @@ The FeatureScenario parameter specifies the scenario for the feature configurati Type: PolicyScenario Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -90,13 +96,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -106,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md b/exchange/exchange-ps/ExchangePowerShell/Get-FederatedDomainProof.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-FederatedDomainProof.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FederatedDomainProof.md index 498c943b79..6e8cafa070 100644 --- a/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FederatedDomainProof.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-federateddomainproof applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-FederatedDomainProof -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-federateddomainproof +schema: 2.0.0 +title: Get-FederatedDomainProof --- # Get-FederatedDomainProof @@ -51,13 +52,15 @@ This example uses a specific certificate for the domain contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainName parameter specifies the domain name for which the cryptographically secure string is generated. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Thumbprint parameter specifies the thumbprint of an existing certificate. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md b/exchange/exchange-ps/ExchangePowerShell/Get-FederatedOrganizationIdentifier.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FederatedOrganizationIdentifier.md index 141f7f644a..9e34d46c14 100644 --- a/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FederatedOrganizationIdentifier.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-federatedorganizationidentifier applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-FederatedOrganizationIdentifier -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-federatedorganizationidentifier +schema: 2.0.0 +title: Get-FederatedOrganizationIdentifier --- # Get-FederatedOrganizationIdentifier @@ -51,13 +52,15 @@ This example retrieves the Exchange organization's federated organization identi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the organization ID. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -75,7 +81,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -IncludeExtendedDomainInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The IncludeExtendedDomainInfo switch specifies that the command query Microsoft Federation Gateway for the status of each accepted domain that's federated. You don't need to specify a value with this switch. The status is returned with each domain in the Domains property. @@ -93,7 +101,6 @@ The status is returned with each domain in the Domains property. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FederationInformation.md b/exchange/exchange-ps/ExchangePowerShell/Get-FederationInformation.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-FederationInformation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FederationInformation.md index bcd6a357a3..3d86985c9a 100644 --- a/exchange/exchange-ps/exchange/Get-FederationInformation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FederationInformation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-federationinformation applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-FederationInformation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-federationinformation +schema: 2.0.0 +title: Get-FederationInformation --- # Get-FederationInformation @@ -48,13 +49,15 @@ This example gets federation information from the domain contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DomainName parameter specifies the domain name for which federation information is to be retrieved. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -BypassAdditionalDomainValidation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassAdditionalDomainValidation switch specifies that the command skip validation of domains from the external Exchange organization. You don't need to specify a value with this switch. We recommend that you only use this switch to retrieve federation information in a hybrid deployment between on-premises and Exchange Online organizations. Don't use this switch to retrieve federation information for on-premises Exchange organizations in a cross-organization arrangement. @@ -72,7 +78,6 @@ We recommend that you only use this switch to retrieve federation information in Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the host name in the Autodiscover endpoint of the domain doesn't match the Secure Sockets Layer (SSL) certificate presented by the endpoint and the host name isn't specified in the TrustedHostnames parameter. @@ -90,7 +98,6 @@ A confirmation prompt warns you if the host name in the Autodiscover endpoint of Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -TrustedHostnames + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TrustedHostnames parameter specifies the fully qualified domain name (FQDN) of federation endpoints. Federation endpoints are the client access (frontend) services on Mailbox servers in an organization with federation enabled. Explicitly specifying the TrustedHostnames parameter allows the cmdlet to bypass prompting if the certificate presented by the endpoint doesn't match the domain name specified in the DomainName parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FederationTrust.md b/exchange/exchange-ps/ExchangePowerShell/Get-FederationTrust.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-FederationTrust.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FederationTrust.md index 98175c1a29..e4bb95f38d 100644 --- a/exchange/exchange-ps/exchange/Get-FederationTrust.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FederationTrust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-federationtrust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-FederationTrust -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-federationtrust +schema: 2.0.0 +title: Get-FederationTrust --- # Get-FederationTrust @@ -41,13 +42,15 @@ This example retrieves properties of the federation trust configured for the Exc ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies a federation trust ID. If not specified, the cmdlet returns all federation trusts configured for the Exchange organization. ```yaml Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -65,7 +71,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyAuthority.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyAuthority.md index 023b70021a..057baf0d1d 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyAuthority.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertyauthority applicable: Security & Compliance -title: Get-FilePlanPropertyAuthority +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertyauthority schema: 2.0.0 +title: Get-FilePlanPropertyAuthority --- # Get-FilePlanPropertyAuthority @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property au ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property authority that you want to view. You can use any value that uniquely identifies the authority. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property authority that yo Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCategory.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCategory.md index c7b0bab4ef..f3a73dbc1b 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertycategory applicable: Security & Compliance -title: Get-FilePlanPropertyCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +https: //learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertycategory +Locale: en-US +Module Name: ExchangePowerShell schema: 2.0.0 +title: Get-FilePlanPropertyCategory --- # Get-FilePlanPropertyCategory @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property ca ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property category that you want to view. You can use any value that uniquely identifies the category. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property category that you Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCitation.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCitation.md index 9080e6137a..ade6daa96e 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyCitation.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertycitation applicable: Security & Compliance -title: Get-FilePlanPropertyCitation +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertycitation schema: 2.0.0 +title: Get-FilePlanPropertyCitation --- # Get-FilePlanPropertyCitation @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property ci ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property citation that you want to view. You can use any value that uniquely identifies the citation. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property citation that you Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyDepartment.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyDepartment.md index 58fc2c7f5e..2a66acd2ef 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyDepartment.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertydepartment applicable: Security & Compliance -title: Get-FilePlanPropertyDepartment +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertydepartment schema: 2.0.0 +title: Get-FilePlanPropertyDepartment --- # Get-FilePlanPropertyDepartment @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property de ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property department that you want to view. You can use any value that uniquely identifies the department. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property department that y Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyReferenceId.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyReferenceId.md index c1ec2f310a..b3fa5d4ebb 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyReferenceId.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertyreferenceid applicable: Security & Compliance -title: Get-FilePlanPropertyReferenceId +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertyreferenceid schema: 2.0.0 +title: Get-FilePlanPropertyReferenceId --- # Get-FilePlanPropertyReferenceId @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property re ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property reference ID that you want to view. You can use any value that uniquely identifies the reference ID. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property reference ID that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyStructure.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyStructure.md index f2e64f89a2..5c212bdc85 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertyStructure.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertystructure applicable: Security & Compliance -title: Get-FilePlanPropertyStructure +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertystructure schema: 2.0.0 +title: Get-FilePlanPropertyStructure --- # Get-FilePlanPropertyStructure @@ -36,13 +38,15 @@ This example returns the file plan property structure. ## PARAMETERS ### -IncludeAdditionalInfo + +> Applicable: Security & Compliance + The IncludeAdditionalInfo switch specifies whether to include additional information in the output of the cmdlet. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertySubCategory.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertySubCategory.md index ed2bc3113e..04407cdf4d 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FilePlanPropertySubCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertysubcategory applicable: Security & Compliance -title: Get-FilePlanPropertySubCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-fileplanpropertysubcategory schema: 2.0.0 +title: Get-FilePlanPropertySubCategory --- # Get-FilePlanPropertySubCategory @@ -43,6 +45,9 @@ This example returns detailed information about the custom file plan property su ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property subcategory that you want to view. You can use any value that uniquely identifies the subcategory. For example: - Name @@ -53,7 +58,6 @@ The Identity parameter specifies the custom file plan property subcategory that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-FocusedInbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-FocusedInbox.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-FocusedInbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FocusedInbox.md index c7b5967c67..5ffb9ea050 100644 --- a/exchange/exchange-ps/exchange/Get-FocusedInbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FocusedInbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-focusedinbox applicable: Exchange Online, Exchange Online Protection -title: Get-FocusedInbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-focusedinbox +schema: 2.0.0 +title: Get-FocusedInbox --- # Get-FocusedInbox @@ -43,6 +44,9 @@ This example returns the Focused Inbox configuration for the mailbox of julia@co ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill UseCustomRouting Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ForeignConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-ForeignConnector.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ForeignConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ForeignConnector.md index 1d19d0d26f..7abc2d7b28 100644 --- a/exchange/exchange-ps/exchange/Get-ForeignConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ForeignConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-foreignconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ForeignConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-foreignconnector +schema: 2.0.0 +title: Get-ForeignConnector --- # Get-ForeignConnector @@ -48,6 +49,9 @@ This example displays detailed configuration information for the Foreign connect ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Foreign connector that you want to examine. The Identity parameter can take any of the following values for the Foreign connector object: - GUID @@ -58,7 +62,6 @@ The Identity parameter specifies the Foreign connector that you want to examine. Type: ForeignConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -76,7 +82,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-FrontendTransportService.md b/exchange/exchange-ps/ExchangePowerShell/Get-FrontendTransportService.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-FrontendTransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Get-FrontendTransportService.md index e768cd1838..2c21f00765 100644 --- a/exchange/exchange-ps/exchange/Get-FrontendTransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-FrontendTransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-frontendtransportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-FrontendTransportService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-frontendtransportservice +schema: 2.0.0 +title: Get-FrontendTransportService --- # Get-FrontendTransportService @@ -50,6 +51,9 @@ This example retrieves the detailed configuration information for the Front End ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Exchange server with the Client Access server role installed that you want to view. You can use any value that uniquely identifies the server. For example: @@ -63,7 +67,6 @@ You can use any value that uniquely identifies the server. For example: Type: FrontendTransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-GlobalAddressList.md b/exchange/exchange-ps/ExchangePowerShell/Get-GlobalAddressList.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-GlobalAddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Get-GlobalAddressList.md index 0a3a6daa60..6725543d75 100644 --- a/exchange/exchange-ps/exchange/Get-GlobalAddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-GlobalAddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-globaladdresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-GlobalAddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-globaladdresslist +schema: 2.0.0 +title: Get-GlobalAddressList --- # Get-GlobalAddressList @@ -60,6 +61,9 @@ This example returns detailed information about the GAL named GAL\_AgencyB. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the global address list that you want to view. You can use any value that uniquely identifies the GAL. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the global address list that you want to view. Type: GlobalAddressListIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -DefaultOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultOnly switch filters the results so only the default GAL is returned. You don't need to use a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: DefaultOnly Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -104,7 +112,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Get-GlobalMonitoringOverride.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Get-GlobalMonitoringOverride.md index 24e4681b00..83d6144720 100644 --- a/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-GlobalMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-globalmonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-GlobalMonitoringOverride -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-globalmonitoringoverride +schema: 2.0.0 +title: Get-GlobalMonitoringOverride --- # Get-GlobalMonitoringOverride @@ -47,6 +48,9 @@ This example returns detailed information for the global monitoring overrides th ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -55,7 +59,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Group.md b/exchange/exchange-ps/ExchangePowerShell/Get-Group.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-Group.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Group.md index b940181519..dbaaa4b176 100644 --- a/exchange/exchange-ps/exchange/Get-Group.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Group.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-group applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-Group -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-group +schema: 2.0.0 +title: Get-Group --- # Get-Group @@ -81,6 +82,9 @@ This example uses the Anr parameter to return all groups that begin with "Mar". ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the group object that you want to view. You can use any value that uniquely identifies the group. For example: - Name @@ -92,7 +96,6 @@ The Identity parameter specifies the group object that you want to view. You can Type: GroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -114,7 +120,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -134,7 +142,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -154,7 +164,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -179,7 +191,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -189,6 +200,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -202,7 +216,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -223,7 +239,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +248,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -245,7 +263,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +272,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified group subtype. Valid values are: - MailNonUniversalGroup @@ -271,7 +291,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -281,13 +300,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -297,6 +318,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -310,7 +334,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HealthReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-HealthReport.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-HealthReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HealthReport.md index fb4ff840c9..e95ba742ac 100644 --- a/exchange/exchange-ps/exchange/Get-HealthReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HealthReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-healthreport applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-HealthReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-healthreport +schema: 2.0.0 +title: Get-HealthReport --- # Get-HealthReport @@ -54,6 +55,9 @@ This example retrieves health information for the server named Mailbox01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the Exchange server where you want to run this Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -GroupSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GroupSize parameter determines the size of the group to process against for a rollup. The default value is 12. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -HaImpactingOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The HaImpactingOnly switch filters the results to only the monitors that have HaImpacting set to True. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -HealthSet + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The HealthSet parameter filters the results by the specified health set. Monitors that are similar or are tied to a component's architecture are grouped to form a health set. You can determine the collection of monitors (and associated probes and responders) in a given health set by using the Get-MonitoringItemIdentity cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -MinimumOnlinePercent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MinimumOnlinePercent parameter specifies the number of members in the group to be functioning with rollup information Degraded instead of Unhealthy. The default value is 70 percent. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,13 +150,15 @@ Accept wildcard characters: False ``` ### -RollupGroup + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RollupGroup switch specifies that the health data is rolled up across servers with redundancy limits. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HistoricalSearch.md b/exchange/exchange-ps/ExchangePowerShell/Get-HistoricalSearch.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-HistoricalSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HistoricalSearch.md index 9aa5b5f171..27051147bd 100644 --- a/exchange/exchange-ps/exchange/Get-HistoricalSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HistoricalSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-historicalsearch applicable: Exchange Online, Exchange Online Protection -title: Get-HistoricalSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-historicalsearch +schema: 2.0.0 +title: Get-HistoricalSearch --- # Get-HistoricalSearch @@ -49,13 +50,15 @@ This example returns detailed information about the historical search that's in ## PARAMETERS ### -JobId + +> Applicable: Exchange Online, Exchange Online Protection + The JobId parameter specifies the GUID identifier of the historical search that you want to view. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-HoldCompliancePolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HoldCompliancePolicy.md index ec353acb7a..78c781ef0f 100644 --- a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HoldCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-holdcompliancepolicy applicable: Security & Compliance -title: Get-HoldCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-holdcompliancepolicy +schema: 2.0.0 +title: Get-HoldCompliancePolicy --- # Get-HoldCompliancePolicy @@ -57,6 +58,9 @@ This example displays detailed information for the policy named "Regulation 123 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -67,7 +71,6 @@ The Identity parameter specifies the preservation policy that you want to view. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-HoldComplianceRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-HoldComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HoldComplianceRule.md index 898c6c476a..6f68eb4b30 100644 --- a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HoldComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-holdcompliancerule applicable: Security & Compliance -title: Get-HoldComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-holdcompliancerule +schema: 2.0.0 +title: Get-HoldComplianceRule --- # Get-HoldComplianceRule @@ -57,6 +58,9 @@ This example displays detailed information for the preservation rule named "30 D ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation rule you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -67,7 +71,6 @@ The Identity parameter specifies the preservation rule you want to view. You can Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter filters the preservation rule results by the associated preservation policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -89,7 +95,6 @@ You can use this parameter with the Identity parameter in the same command. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-HostedConnectionFilterPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HostedConnectionFilterPolicy.md index 5c3c8cd5f4..3b9e5bdaac 100644 --- a/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HostedConnectionFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedconnectionfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-HostedConnectionFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hostedconnectionfilterpolicy +schema: 2.0.0 +title: Get-HostedConnectionFilterPolicy --- # Get-HostedConnectionFilterPolicy @@ -47,6 +48,9 @@ This example returns detailed information about the connection filter policy nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the connection filter policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -59,7 +63,6 @@ Typically, you only have one connection filter policy: the default policy named Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-HostedContentFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-HostedContentFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterPolicy.md index 855377d33a..3fd2f2b42b 100644 --- a/exchange/exchange-ps/exchange/Get-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedcontentfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-HostedContentFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hostedcontentfilterpolicy +schema: 2.0.0 +title: Get-HostedContentFilterPolicy --- # Get-HostedContentFilterPolicy @@ -56,6 +57,9 @@ This example shows the allowed and blocked senders and domains in all spam filte ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the spam filter policy that you want to view. Y Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterRule.md index 0531374eab..1f67787900 100644 --- a/exchange/exchange-ps/exchange/Get-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedcontentfilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hostedcontentfilterrule +schema: 2.0.0 +title: Get-HostedContentFilterRule --- # Get-HostedContentFilterRule @@ -49,6 +50,9 @@ This example retrieves details about the spam filter rule named Contoso Recipien ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the spam filter rule that you want to view. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The State parameter filters the results by the state of the rule. Valid values are: - Enabled: The command returns only enabled rules. @@ -94,7 +102,6 @@ The State parameter filters the results by the state of the rule. Valid values a Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterPolicy.md index 1e40b52a4d..20ca00576b 100644 --- a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-HostedOutboundSpamFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hostedoutboundspamfilterpolicy +schema: 2.0.0 +title: Get-HostedOutboundSpamFilterPolicy --- # Get-HostedOutboundSpamFilterPolicy @@ -47,6 +48,9 @@ This example returns detailed information about the outbound spam filter policy ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter policy you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the outbound spam filter policy you want to vie Type: HostedOutboundSpamFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterRule.md index 0a620cec54..2a1d5d73a1 100644 --- a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: Get-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hostedoutboundspamfilterrule +schema: 2.0.0 +title: Get-HostedOutboundSpamFilterRule --- # Get-HostedOutboundSpamFilterRule @@ -48,6 +49,9 @@ This example returns detailed information for the outbound spam filter rule name ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the outbound spam filter rule that you want to Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online, Exchange Online Protection + The State parameter filters the results by enabled or disabled rules. Valid values are: - Enabled: Only enabled rules are returned. @@ -77,7 +83,6 @@ The State parameter filters the results by enabled or disabled rules. Valid valu Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HybridConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-HybridConfiguration.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-HybridConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HybridConfiguration.md index 426766c54c..fd1ebea9b8 100644 --- a/exchange/exchange-ps/exchange/Get-HybridConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HybridConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hybridconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-HybridConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hybridconfiguration +schema: 2.0.0 +title: Get-HybridConfiguration --- # Get-HybridConfiguration @@ -40,13 +41,15 @@ This example returns detailed information about the hybrid deployment configurat ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md b/exchange/exchange-ps/ExchangePowerShell/Get-HybridMailflowDatacenterIPs.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md rename to exchange/exchange-ps/ExchangePowerShell/Get-HybridMailflowDatacenterIPs.md index 4f793be1a3..b9e16d25d2 100644 --- a/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-HybridMailflowDatacenterIPs.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-hybridmailflowdatacenterips applicable: Exchange Online -title: Get-HybridMailflowDatacenterIPs -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-hybridmailflowdatacenterips +schema: 2.0.0 +title: Get-HybridMailflowDatacenterIPs --- # Get-HybridMailflowDatacenterIPs diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListConfig.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-IPAllowListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListConfig.md index 0da96065e8..fa783a57cf 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipallowlistconfig +schema: 2.0.0 +title: Get-IPAllowListConfig --- # Get-IPAllowListConfig @@ -42,6 +43,9 @@ This example returns detailed information about the IP Allow list configuration ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -50,7 +54,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListEntry.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-IPAllowListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListEntry.md index 7221b9e90b..33954acbcb 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipallowlistentry +schema: 2.0.0 +title: Get-IPAllowListEntry --- # Get-IPAllowListEntry @@ -58,13 +59,15 @@ This example returns an IP Allow list entry in which the specified IP address is ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity integer value of the IP Allow list entry that you want to view. When you add an entry to the IP Allow list, the Identity value is automatically assigned. ```yaml Type: IPListEntryIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddress parameter specifies an IP address to view in the IP Allow list entry or entries. For example, if you have an IP Allow list entry that specifies a range of IP addresses from 192.168.0.1 through 192.168.0.20, enter any IP address in the IP Allow list IP address range to return the IP Allow list entry. ```yaml Type: IPAddress Parameter Sets: IPAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -121,7 +131,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvider.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-IPAllowListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvider.md index 1d17905936..7cc5d7d182 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipallowlistprovider +schema: 2.0.0 +title: Get-IPAllowListProvider --- # Get-IPAllowListProvider @@ -48,6 +49,9 @@ This example returns detailed information for the IP Allow list provider named C ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the IP Allow list provider that you want to view. You can use any value that uniquely identifies the IP Allow list provider. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the IP Allow list provider that you want to vie Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -76,7 +82,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvidersConfig.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvidersConfig.md index b56f559df4..33845fc425 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPAllowListProvidersConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistprovidersconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPAllowListProvidersConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipallowlistprovidersconfig +schema: 2.0.0 +title: Get-IPAllowListProvidersConfig --- # Get-IPAllowListProvidersConfig @@ -42,6 +43,9 @@ This example returns detailed information about the IP Allow list providers conf ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -50,7 +54,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListConfig.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-IPBlockListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListConfig.md index 517988a7ae..badc1fb114 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipblocklistconfig +schema: 2.0.0 +title: Get-IPBlockListConfig --- # Get-IPBlockListConfig @@ -42,6 +43,9 @@ This example returns detailed information about the IP Block list configuration ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -50,7 +54,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListEntry.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-IPBlockListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListEntry.md index d6a1d41ce8..ac6528eb90 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipblocklistentry +schema: 2.0.0 +title: Get-IPBlockListEntry --- # Get-IPBlockListEntry @@ -58,13 +59,15 @@ This example returns machine-generated entries in the IP Block list that are ins ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity integer value of the IP Block list entry that you want to view. When you add an entry to the IP Block list, the Identity value is automatically assigned. ```yaml Type: IPListEntryIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddress parameter specifies an IP address to view in the IP Block list entry or entries. For example, if you have an IP Block list entry that specifies a range of IP addresses from 192.168.0.1 through 192.168.0.20, enter any IP address in the IP Block list IP address range to return the IP Block list entry. ```yaml Type: IPAddress Parameter Sets: IPAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -121,7 +131,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvider.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-IPBlockListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvider.md index f8849f592d..a6befcee10 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipblocklistprovider +schema: 2.0.0 +title: Get-IPBlockListProvider --- # Get-IPBlockListProvider @@ -48,6 +49,9 @@ This example returns detailed information for the existing IP Block list provide ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the IP Block list provider that you want to view. You can use any value that uniquely identifies the IP Block list provider. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the IP Block list provider that you want to vie Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -76,7 +82,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvidersConfig.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvidersConfig.md index f7bcc606fa..f84def95bc 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPBlockListProvidersConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistprovidersconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-IPBlockListProvidersConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipblocklistprovidersconfig +schema: 2.0.0 +title: Get-IPBlockListProvidersConfig --- # Get-IPBlockListProvidersConfig @@ -42,6 +43,9 @@ This example returns detailed information about the IP Block list providers on t ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -50,7 +54,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-IPv6StatusForAcceptedDomain.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IPv6StatusForAcceptedDomain.md index e8d7109c9a..95b42a54fc 100644 --- a/exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IPv6StatusForAcceptedDomain.md @@ -1,12 +1,12 @@ --- -external help file: -online version: https://learn.microsoft.com/powershell/module/exchange/get-ipv6statusforaccepteddomain applicable: Exchange Online -title: Get-IPv6StatusForAcceptedDomain -schema: 2.0.0 author: chrisda +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ipv6statusforaccepteddomain +schema: 2.0.0 +title: Get-IPv6StatusForAcceptedDomain --- # Get-IPv6StatusForAcceptedDomain @@ -58,13 +58,15 @@ This example returns the status of IPv6 support for mail sent to contoso.com. ## PARAMETERS ### -Domain + +> Applicable: Exchange Online + The Domain parameter specifies the accepted domain that you want to view IPv6 status for. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -74,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -90,13 +94,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-IRMConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-IRMConfiguration.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-IRMConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IRMConfiguration.md index 377c44454f..dc6a295bf7 100644 --- a/exchange/exchange-ps/exchange/Get-IRMConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IRMConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-irmconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-IRMConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-irmconfiguration +schema: 2.0.0 +title: Get-IRMConfiguration --- # Get-IRMConfiguration @@ -42,6 +43,9 @@ This example retrieves the IRM configuration in your organization. ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -50,7 +54,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ImapSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-ImapSettings.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ImapSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ImapSettings.md index 78a0faa6d4..09f01eed05 100644 --- a/exchange/exchange-ps/exchange/Get-ImapSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ImapSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-imapsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ImapSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-imapsettings +schema: 2.0.0 +title: Get-ImapSettings --- # Get-ImapSettings @@ -41,13 +42,15 @@ This example displays the settings and values of the Microsoft Exchange IMAP4 se ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -70,7 +76,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-InboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-InboundConnector.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-InboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-InboundConnector.md index 2447b733ef..4b8f165f3a 100644 --- a/exchange/exchange-ps/exchange/Get-InboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-InboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-inboundconnector applicable: Exchange Online, Exchange Online Protection -title: Get-InboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-inboundconnector +schema: 2.0.0 +title: Get-InboundConnector --- # Get-InboundConnector @@ -50,13 +51,15 @@ This example lists all the Inbound connectors configured in your cloud-based org ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the name or GUID of the Inbound connector. If the Identity name contains spaces, enclose the name in quotation marks ("). You can omit the Identity parameter label. ```yaml Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-InboxRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-InboxRule.md index 5ed6b13784..59c768d5f7 100644 --- a/exchange/exchange-ps/exchange/Get-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-InboxRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-InboxRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-inboxrule +schema: 2.0.0 +title: Get-InboxRule --- # Get-InboxRule @@ -59,6 +60,9 @@ This example retrieves the Inbox rule ReceivedLastYear from the mailbox joe@cont ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Inbox rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the Inbox rule that you want to view. You can u Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -BypassScopeCheck + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -DescriptionTimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DescriptionTimeFormat parameter specifies the format for time values in the rule description. For example: MM/dd/yyyy, where MM is the 2-digit month, dd is the 2-digit day and yyyy is the 4-digit year. @@ -104,7 +112,6 @@ MM/dd/yyyy, where MM is the 2-digit month, dd is the 2-digit day and yyyy is the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -DescriptionTimeZone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DescriptionTimeZone parameter specifies time zone that's used for time values in the rule description. A valid value for this parameter is a supported time zone key name (for example, "Pacific Standard Time"). @@ -126,7 +136,6 @@ If the value contains spaces, enclose the value in quotation marks ("). The defa Type: ExTimeZoneValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -144,7 +156,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -IncludeHidden + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeHidden switch specifies whether to include hidden Inbox rules in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,6 +183,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -187,7 +203,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,6 +212,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -205,7 +223,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +232,9 @@ Accept wildcard characters: False ``` ### -SkipCount + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} @@ -223,7 +243,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -233,6 +252,9 @@ Accept wildcard characters: False ``` ### -SweepRules + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SweepRules switch specifies whether to return only Sweep rules in the results. You don't need to specify a value with this switch. @@ -243,7 +265,6 @@ Sweep rules run at regular intervals to help keep your Inbox clean. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,6 +274,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -261,7 +285,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPoliciesApplicationStatus.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md rename to exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPoliciesApplicationStatus.md index 4ba383b667..a7e9c553d8 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPoliciesApplicationStatus.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus applicable: Security & Compliance -title: Get-InformationBarrierPoliciesApplicationStatus -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-informationbarrierpoliciesapplicationstatus +schema: 2.0.0 +title: Get-InformationBarrierPoliciesApplicationStatus --- # Get-InformationBarrierPoliciesApplicationStatus @@ -57,13 +58,15 @@ This example returns all applications of information barrier policies by the Sta ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the information barrier policy application that you want to view. This value is a GUID that's displayed when you run the Start-InformationBarrierPoliciesApplication cmdlet (for example, a0551cee-db3d-4002-9fa0-94358035fdf2). You can also find the Identity value by running the command Get-InformationBarrierPoliciesApplicationStatus -All. ```yaml Type: PolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -All + +> Applicable: Security & Compliance + The All switch specifies whether to include all applications of information barrier policies in the results. You don't need to specify a value with this switch. If you don't use this switch, the command only returns the most recent policy application. @@ -81,7 +87,6 @@ If you don't use this switch, the command only returns the most recent policy ap Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPolicy.md index 32c2276297..8afc72a88e 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierpolicy applicable: Security & Compliance -title: Get-InformationBarrierPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-informationbarrierpolicy +schema: 2.0.0 +title: Get-InformationBarrierPolicy --- # Get-InformationBarrierPolicy @@ -57,6 +58,9 @@ This example displays detailed information for the information barrier policy na ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the information barrier policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -69,7 +73,6 @@ You can't use this parameter with the ExOPolicyId parameter. Type: PolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -ExoPolicyId + +> Applicable: Security & Compliance + The ExOPolicyId parameter specifies the information barrier policy that you want to view, but using the GUID part of the ExoPolicyId property value from the output of the Get-InformationBarrierRecipientStatus cmdlet. You can't use this parameter with the Identity parameter. @@ -87,7 +93,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -109,4 +114,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierRecipientStatus.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md rename to exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierRecipientStatus.md index 862519808e..2d332b51d7 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-InformationBarrierRecipientStatus.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierrecipientstatus applicable: Security & Compliance -title: Get-InformationBarrierRecipientStatus -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-informationbarrierrecipientstatus +schema: 2.0.0 +title: Get-InformationBarrierRecipientStatus --- # Get-InformationBarrierRecipientStatus @@ -56,6 +57,9 @@ This example returns the information barrier policy relationship for the users m ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the recipient that you want to view the segment and policy assignment information for. You can use any value that uniquely identifies the recipient. For example: - Name @@ -69,7 +73,6 @@ The Identity parameter specifies the recipient that you want to view the segment Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Identity2 + +> Applicable: Security & Compliance + The Identity2 parameter specifies an optional second recipient when you want to view the information barrier policy relationship to the first recipient specified by the Identity parameter. You can use any value that uniquely identifies the second recipient. For example: - Name @@ -96,7 +102,6 @@ You can only use this parameter with the Identity parameter; you can't use it by Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -120,4 +125,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConfiguration.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConfiguration.md index 3178fd949a..a0fff4f00b 100644 --- a/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-intraorganizationconfiguration applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-IntraOrganizationConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-intraorganizationconfiguration +schema: 2.0.0 +title: Get-IntraOrganizationConfiguration --- # Get-IntraOrganizationConfiguration @@ -44,6 +45,9 @@ This example returns the settings of the intra-organization configuration. ## PARAMETERS ### -OrganizationGuid + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OrganizationGuid parameter specifies the on-premises organization in a hybrid deployment that has multiple on-premises organizations defined. If you don't use the OrganizationGuid parameter for these types of hybrid deployments, the Get-IntraOrganizationConfiguration cmdlet will generate errors. To view the on-premises organization GUID values that are required for this parameter, use the Get-OnPremisesOrganization cmdlet. @@ -52,7 +56,6 @@ The OrganizationGuid parameter specifies the on-premises organization in a hybri Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 diff --git a/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConnector.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConnector.md index d07a069726..9b1bb44334 100644 --- a/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-IntraOrganizationConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-intraorganizationconnector applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-IntraOrganizationConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-intraorganizationconnector +schema: 2.0.0 +title: Get-IntraOrganizationConnector --- # Get-IntraOrganizationConnector @@ -50,6 +51,9 @@ This example returns details about the Intra-Organization connector named "MainC ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Intra-Organization connector that you want to view. You can use any value that uniquely identifies the connector. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the Intra-Organization connector that you want Type: IntraOrganizationConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -78,7 +84,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-JournalRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-JournalRule.md index 68b259f8f9..c1bc9f9203 100644 --- a/exchange/exchange-ps/exchange/Get-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-JournalRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-journalrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-JournalRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-journalrule +schema: 2.0.0 +title: Get-JournalRule --- # Get-JournalRule @@ -50,13 +51,15 @@ This example retrieves the specific journal rule Brokerage Communications and pi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the rule you want to view. Enter either the name or the GUID of the journal rule. You can omit the parameter label. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Label.md b/exchange/exchange-ps/ExchangePowerShell/Get-Label.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-Label.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Label.md index b2cf3b4226..7f2a6250ac 100644 --- a/exchange/exchange-ps/exchange/Get-Label.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Label.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-label applicable: Security & Compliance -title: Get-Label -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-label +schema: 2.0.0 +title: Get-Label --- # Get-Label @@ -50,6 +51,9 @@ This example returns detailed information for the sensitivity label named Engine ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitivity label that you want to view. You can use any value that uniquely identifies the label. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the sensitivity label that you want to view. Yo Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -IncludeDetailedLabelActions + +> Applicable: Security & Compliance + The IncludeDetailedLabelActions parameter specifies whether to expand label actions into properties for better readability. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -SkipValidations + +> Applicable: Security & Compliance + {{ Fill SkipValidations Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -ValidateContentTypeRemoval + +> Applicable: Security & Compliance + {{ Fill ValidateContentTypeRemoval Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-LabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-LabelPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-LabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-LabelPolicy.md index 7a90fbaa71..758f9dee87 100644 --- a/exchange/exchange-ps/exchange/Get-LabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-LabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-labelpolicy applicable: Security & Compliance -title: Get-LabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-labelpolicy +schema: 2.0.0 +title: Get-LabelPolicy --- # Get-LabelPolicy @@ -48,6 +49,9 @@ This example returns detailed information for the policy named Engineering Group ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitivity label policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the sensitivity label policy that you want to v Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -ForceValidate + +> Applicable: Security & Compliance + {{ Fill ForceValidate Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-LinkedUser.md b/exchange/exchange-ps/ExchangePowerShell/Get-LinkedUser.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-LinkedUser.md rename to exchange/exchange-ps/ExchangePowerShell/Get-LinkedUser.md index 7407a5f12b..a4e3fe0a73 100644 --- a/exchange/exchange-ps/exchange/Get-LinkedUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-LinkedUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-linkeduser applicable: Exchange Online -title: Get-LinkedUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-linkeduser +schema: 2.0.0 +title: Get-LinkedUser --- # Get-LinkedUser @@ -62,6 +63,9 @@ This example returns a detailed information for the linked for the user laura@co ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the linked user that you want to view. You can use any value that uniquely identifies the linked user. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the linked user that you want to view. You can Type: UserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -95,7 +101,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -120,7 +128,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -179,7 +193,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-LogonStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-LogonStatistics.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-LogonStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-LogonStatistics.md index bfdee00794..dc9385ddb7 100644 --- a/exchange/exchange-ps/exchange/Get-LogonStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-LogonStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-logonstatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-LogonStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-logonstatistics +schema: 2.0.0 +title: Get-LogonStatistics --- # Get-LogonStatistics @@ -60,6 +61,9 @@ This example returns logon statistics for all users connected to the server Serv ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox to get logon statistics from. You can use one of the following values to identify the mailbox: - GUID @@ -78,7 +82,6 @@ You can't use this parameter with the Database or Server parameters. Type: LogonableObjectIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Database parameter specifies the mailbox database to get logon statistics from (all mailboxes in the specified database). You can use any value that uniquely identifies the mailbox database. For example: - Name @@ -102,7 +108,6 @@ You can't use this parameter with the Identity or Server parameters. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Mailbox server to get logon statistics from (all mailboxes on all databases, including recovery databases, on the specified server). You can use one of the following values to identify the server: - Fully qualified domain name (FQDN) @@ -125,7 +133,6 @@ You can't use this parameter with the Database or Identity parameters. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -135,13 +142,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicy.md index c7992e4955..fa455671a6 100644 --- a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicy applicable: Exchange Online, Exchange Online Protection -title: Get-M365DataAtRestEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-m365dataatrestencryptionpolicy +schema: 2.0.0 +title: Get-M365DataAtRestEncryptionPolicy --- # Get-M365DataAtRestEncryptionPolicy @@ -54,6 +55,9 @@ This example returns detailed information about the policy named Contoso Corpora ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 data-at-rest encryption policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the Microsoft 365 data-at-rest encryption polic Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md b/exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicyAssignment.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicyAssignment.md index 486e093215..b096ce31ee 100644 --- a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-M365DataAtRestEncryptionPolicyAssignment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicyassignment applicable: Exchange Online -title: Get-M365DataAtRestEncryptionPolicyAssignment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-m365dataatrestencryptionpolicyassignment +schema: 2.0.0 +title: Get-M365DataAtRestEncryptionPolicyAssignment --- # Get-M365DataAtRestEncryptionPolicyAssignment @@ -45,6 +46,8 @@ Get-M365DataAtRestEncryptionPolicyAssignment | Format-List This example returns detailed information for all Microsoft 365 data-at-rest encryption policy assignments. +## PARAMETERS + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). diff --git a/exchange/exchange-ps/exchange/Get-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailContact.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailContact.md index aa00b27a06..ae2917a68a 100644 --- a/exchange/exchange-ps/exchange/Get-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailContact.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailcontact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-MailContact -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailcontact +schema: 2.0.0 +title: Get-MailContact --- # Get-MailContact @@ -74,6 +75,9 @@ This example retrieves detailed information for the mail contact named Arlene. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail contact that you want to view. You can use any value that uniquely identifies the mail contact. For example: - Name @@ -87,7 +91,6 @@ The Identity parameter specifies the mail contact that you want to view. You can Type: MailContactIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -ANR + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -109,7 +115,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -129,7 +137,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -147,7 +157,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -172,7 +184,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -195,7 +209,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -205,6 +218,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -216,7 +232,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,6 +241,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -238,7 +256,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,6 +265,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified mail contact subtype. Valid values are: - MailContact @@ -259,7 +279,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -269,13 +288,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -285,6 +306,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -299,7 +323,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailATPReport.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MailDetailATPReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailDetailATPReport.md index 2894c21ea7..0cd35bc4ee 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailATPReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailatpreport applicable: Exchange Online, Exchange Online Protection -title: Get-MailDetailATPReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-maildetailatpreport +schema: 2.0.0 +title: Get-MailDetailATPReport --- # Get-MailDetailATPReport @@ -78,13 +79,15 @@ This example returns the actions for the last 10 days in July, 2018. (Note: Cust ## PARAMETERS ### -DataSource + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill DataSource Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -106,7 +112,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -116,13 +121,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". @@ -140,7 +150,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - Advanced filter @@ -181,7 +193,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -MalwareName + +> Applicable: Exchange Online, Exchange Online Protection + The MalwareName parameter filters the results by malware payload. Valid values are: - Excel @@ -207,7 +221,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -217,13 +230,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +248,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). You can specify multiple values separated by commas. @@ -249,7 +267,6 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -259,13 +276,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,13 +294,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -291,13 +312,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,13 +330,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,13 +348,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -339,6 +366,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". @@ -347,7 +377,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailDlpPolicyReport.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailDetailDlpPolicyReport.md index 213354eae3..2043cdee62 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailDlpPolicyReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetaildlppolicyreport applicable: Exchange Online -title: Get-MailDetailDlpPolicyReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-maildetaildlppolicyreport +schema: 2.0.0 +title: Get-MailDetailDlpPolicyReport --- # Get-MailDetailDlpPolicyReport @@ -54,6 +55,9 @@ This example retrieves the details of messages sent by john@contoso.com that mat ## PARAMETERS ### -Action + +> Applicable: Exchange Online + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -62,7 +66,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -83,7 +89,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Online + The DlpPolicy parameter filters the report by the name of the DLP policy. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -133,7 +145,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online + The EventType parameter filters the report by the event type. Valid values are: - DLPActionHits @@ -159,7 +173,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -169,13 +182,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Online + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). You can specify multiple values separated by commas. @@ -201,7 +219,6 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -211,13 +228,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -227,13 +246,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -243,13 +264,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -259,13 +282,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -275,13 +300,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -291,6 +318,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -299,7 +329,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -309,13 +338,15 @@ Accept wildcard characters: False ``` ### -TransportRule + +> Applicable: Exchange Online + The TransportRule parameter filters the report by the name of the transport rule. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailEncryptionReport.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailDetailEncryptionReport.md index 62ff5f0f00..3f2175e653 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailEncryptionReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailencryptionreport applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-MailDetailEncryptionReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-maildetailencryptionreport +schema: 2.0.0 +title: Get-MailDetailEncryptionReport --- # Get-MailDetailEncryptionReport @@ -67,13 +68,15 @@ This example retrieves encryption details for messages between December 13, 2021 ## PARAMETERS ### -Organization + +> Applicable: Security & Compliance + {{ Fill Organization Description }} ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -83,13 +86,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -110,7 +118,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -144,7 +156,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - EncryptionManual @@ -167,7 +181,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -177,6 +190,9 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). You can specify multiple values separated by commas. @@ -185,7 +201,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -195,6 +210,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). You can specify multiple values separated by commas. @@ -211,7 +229,6 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -221,13 +238,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -237,13 +256,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -253,13 +274,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -269,6 +292,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -277,7 +303,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailTransportRuleReport.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailDetailTransportRuleReport.md index ca463e1112..7ca077624a 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailDetailTransportRuleReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailtransportrulereport applicable: Exchange Online, Exchange Online Protection -title: Get-MailDetailTransportRuleReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-maildetailtransportrulereport +schema: 2.0.0 +title: Get-MailDetailTransportRuleReport --- # Get-MailDetailTransportRuleReport @@ -53,6 +54,9 @@ This example retrieves the details of messages sent by john@contoso.com that mat ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -61,7 +65,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -82,7 +88,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -116,7 +126,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - EncryptionManual @@ -141,7 +153,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,6 +180,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). You can specify multiple values separated by commas. @@ -183,7 +199,6 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -193,13 +208,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -225,13 +244,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -241,13 +262,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,13 +280,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -273,6 +298,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -283,7 +311,6 @@ Although you can enter a date up to 30 days old, only data from the last 10 days Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -293,13 +320,15 @@ Accept wildcard characters: False ``` ### -TransportRule + +> Applicable: Exchange Online, Exchange Online Protection + The TransportRule parameter filters the report by the name of the transport rule. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailFilterListReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailFilterListReport.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MailFilterListReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailFilterListReport.md index 4fe3fbe363..fca22fa5d4 100644 --- a/exchange/exchange-ps/exchange/Get-MailFilterListReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailFilterListReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailfilterlistreport applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-MailFilterListReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailfilterlistreport +schema: 2.0.0 +title: Get-MailFilterListReport --- # Get-MailFilterListReport @@ -44,13 +45,15 @@ This example uses the Get-MailFilterListReport cmdlet to return information abou ## PARAMETERS ### -Domain + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Expression + +> Applicable: Security & Compliance + This parameter is available only in Security & Compliance PowerShell. This parameter is reserved for internal Microsoft use. @@ -68,7 +74,6 @@ This parameter is reserved for internal Microsoft use. Type: Expression Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -94,6 +101,9 @@ Accept wildcard characters: False ``` ### -SelectionTarget + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SelectionTarget parameter filters the report information by object type. Valid values are: - Actions @@ -108,7 +118,6 @@ The SelectionTarget parameter filters the report information by object type. Val Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailFlowStatusReport.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-MailflowStatusReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailFlowStatusReport.md index fef6949dce..c9ca311930 100644 --- a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailFlowStatusReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailflowstatusreport applicable: Exchange Online, Exchange Online Protection -title: Get-MailFlowStatusReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailflowstatusreport +schema: 2.0.0 +title: Get-MailFlowStatusReport --- # Get-MailFlowStatusReport @@ -55,6 +56,9 @@ This example returns inbound and outbound messages were classified as GoodMail o ## PARAMETERS ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by the direction of the message. Valid values are: - Inbound @@ -67,7 +71,6 @@ You can specify multiple value separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -101,7 +109,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - EdgeBlockSpam @@ -126,7 +136,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -184,6 +199,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -192,7 +210,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailPublicFolder.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-MailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailPublicFolder.md index eea8f2f7e7..0ff82748fe 100644 --- a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailPublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailpublicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailPublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailpublicfolder +schema: 2.0.0 +title: Get-MailPublicFolder --- # Get-MailPublicFolder @@ -77,6 +78,9 @@ This example returns all mail-enabled public folders that begin with the word Ma ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -85,7 +89,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: MailPublicFolderIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -107,7 +113,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -125,7 +133,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -143,7 +153,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -168,7 +180,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -178,6 +189,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -189,7 +203,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -199,6 +212,9 @@ Accept wildcard characters: False ``` ### -IncludeGrantSendOnBehalfToWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} @@ -207,7 +223,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -217,6 +232,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -229,7 +247,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,13 +256,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -255,6 +274,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: @@ -268,7 +290,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -278,6 +299,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -293,7 +317,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficATPReport.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficATPReport.md index f846e08198..318fbbbe60 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficATPReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficatpreport applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficATPReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailtrafficatpreport +schema: 2.0.0 +title: Get-MailTrafficATPReport --- # Get-MailTrafficATPReport @@ -73,6 +74,9 @@ This example retrieves the statistics for outgoing messages on December 25, 2021 ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -81,7 +85,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -91,13 +94,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Exchange Online Protection + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -119,7 +127,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -129,13 +136,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end of the date range in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -158,7 +170,6 @@ If you use this parameter, you also need to use the StartDate parameter. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,6 +179,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - Advanced filter @@ -199,7 +213,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -209,13 +222,15 @@ Accept wildcard characters: False ``` ### -NumberOfRows + +> Applicable: Exchange Online, Exchange Online Protection + The NumberOfRows parameter specifies the number of rows to return in the report. The maximum value is 10000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -225,13 +240,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -241,13 +258,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,13 +276,15 @@ Accept wildcard characters: False ``` ### -PivotBy + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill PivotBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -273,13 +294,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -289,6 +312,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start of the date range in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -302,7 +328,6 @@ If you use this parameter, you also need to use the EndDate parameter. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -312,6 +337,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online, Exchange Online Protection + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. For this cmdlet, valid values are: @@ -327,7 +355,6 @@ You can specify multiple values separated by commas. When you specify the values Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,13 +364,15 @@ Accept wildcard characters: False ``` ### -ThreatClassification + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill ThreatClassification Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficEncryptionReport.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficEncryptionReport.md index 8fe274f754..e864108d17 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficEncryptionReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficencryptionreport applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-MailTrafficEncryptionReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailtrafficencryptionreport +schema: 2.0.0 +title: Get-MailTrafficEncryptionReport --- # Get-MailTrafficEncryptionReport @@ -60,6 +61,9 @@ This example retrieves encryption information for incoming messages between Dece ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -68,7 +72,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -105,7 +113,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -139,7 +151,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - EncryptionManual @@ -162,7 +176,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -220,6 +239,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -228,7 +250,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -238,6 +259,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. For this cmdlet, valid values are: @@ -252,7 +276,6 @@ You can specify multiple values separated by commas. When you specify the values Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficPolicyReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficPolicyReport.md index f1ab603a7f..78abc412a0 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficPolicyReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficpolicyreport applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficPolicyReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailtrafficpolicyreport +schema: 2.0.0 +title: Get-MailTrafficPolicyReport --- # Get-MailTrafficPolicyReport @@ -76,6 +77,9 @@ This example is similar to the previous example, but now the results are summari ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -84,7 +88,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,13 +97,15 @@ Accept wildcard characters: False ``` ### -AggregateBy + +> Applicable: Exchange Online, Exchange Online Protection + The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -121,7 +129,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The DlpPolicy parameter filters the report by the name of the DLP policy. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -171,7 +185,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,6 +194,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. Valid values are: - DLPActionHits @@ -199,7 +215,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -225,13 +242,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -241,13 +260,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,6 +278,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -265,7 +289,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,6 +298,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online, Exchange Online Protection + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. For this cmdlet, valid values are: @@ -292,7 +318,6 @@ You can specify multiple values separated by commas. When you specify the values Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -302,13 +327,15 @@ Accept wildcard characters: False ``` ### -TransportRule + +> Applicable: Exchange Online, Exchange Online Protection + The TransportRule parameter filters the report by the name of the transport rule. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficSummaryReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficSummaryReport.md index 5ef4d9692a..05ad814da1 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailTrafficSummaryReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficsummaryreport applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficSummaryReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailtrafficsummaryreport +schema: 2.0.0 +title: Get-MailTrafficSummaryReport --- # Get-MailTrafficSummaryReport @@ -54,6 +55,9 @@ This example shows the top spam recipient statistics between June 13, 2015 and J ## PARAMETERS ### -Category + +> Applicable: Exchange Online, Exchange Online Protection + The Category parameter filters the report by category. Valid values are: - InboundDLPHits @@ -84,7 +88,6 @@ The Category parameter filters the report by category. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,13 +97,15 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The DlpPolicy parameter filters the report by the name of the data loss prevention (DLP) policy. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -134,7 +144,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -176,13 +189,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -192,6 +207,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -200,7 +218,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,13 +227,15 @@ Accept wildcard characters: False ``` ### -TransportRule + +> Applicable: Exchange Online, Exchange Online Protection + The TransportRule parameter filters the report by the name of the transport rule. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailUser.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailUser.md index 82f050e5ea..7e8cd7aefb 100644 --- a/exchange/exchange-ps/exchange/Get-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-MailUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailuser +schema: 2.0.0 +title: Get-MailUser --- # Get-MailUser @@ -99,6 +100,9 @@ This example returns detailed information for the mail user named Ed. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail user that you want to view. You can use any value that uniquely identifies the mail user. For example: - Name @@ -112,7 +116,6 @@ The Identity parameter specifies the mail user that you want to view. You can us Type: MailUserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -122,6 +125,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -134,7 +140,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -154,7 +162,6 @@ This parameter requires the creation and passing of a credential object. This cr Type: PSCredential Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,6 +171,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -172,7 +182,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,6 +191,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -197,7 +209,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -207,6 +218,9 @@ Accept wildcard characters: False ``` ### -HVEAccount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The HVEAccount switch specifies that this mail user account is specifically used for the [High volume email service](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365). You don't need to specify a value with this switch. @@ -215,7 +229,6 @@ The HVEAccount switch specifies that this mail user account is specifically used Type: SwitchParameter Parameter Sets: HVEAccount Aliases: -Applicable: Exchange Online, Exchange Online Protection Position: Named Default value: None @@ -225,6 +238,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -238,7 +254,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,6 +263,9 @@ Accept wildcard characters: False ``` ### -LOBAppAccount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -256,7 +274,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: LOBAppAccount Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -266,6 +283,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -277,7 +297,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -287,6 +306,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -299,7 +321,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,13 +330,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -325,6 +348,9 @@ Accept wildcard characters: False ``` ### -SharedWithMailUser + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill SharedWithMailUser Description }} @@ -333,7 +359,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -343,6 +368,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -358,7 +386,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -368,6 +395,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailUser + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The SoftDeletedMailUser switch specifies whether to include soft-deleted mail users in the results. You don't need to specify a value with this switch. @@ -378,7 +408,6 @@ Soft-deleted mail users are deleted mail users that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-Mailbox.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Mailbox.md index cae3773fe1..1d1068f22f 100644 --- a/exchange/exchange-ps/exchange/Get-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-Mailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailbox +schema: 2.0.0 +title: Get-Mailbox --- # Get-Mailbox @@ -209,6 +210,9 @@ This example returns information about the remote archive mailbox for the user e ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -228,7 +232,6 @@ You can't use this parameter with the Anr, Database, MailboxPlan or Server param Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -238,6 +241,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -250,7 +256,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -260,6 +265,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Arbitration switch specifies whether to return only arbitration mailboxes in the results. You don't need to specify a value with this switch. @@ -272,7 +280,6 @@ To return arbitration mailboxes that are used to store audit log settings or dat Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -282,13 +289,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Archive switch specifies whether to return only mailboxes that have an archive enabled in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -298,6 +307,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuditLog switch specifies whether to return only audit log mailboxes in the results. You don't need to specify a value with this switch. @@ -310,7 +322,6 @@ To return other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -320,6 +331,9 @@ Accept wildcard characters: False ``` ### -AuxAuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuxAuditLog switch specifies whether to return only auxiliary audit log mailboxes in the results. You don't need to specify a value with this switch. @@ -332,7 +346,6 @@ To return other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -342,6 +355,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -352,7 +368,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -362,6 +377,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Database parameter filters the results by mailbox database. When you use this parameter, only mailboxes on the specified database are included in the results. You can any value that uniquely identifies the database. For example: @@ -376,7 +394,6 @@ You can't use this parameter with the Anr, Identity, or Server parameters. Type: DatabaseIdParameter Parameter Sets: DatabaseSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -386,6 +403,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -394,7 +414,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -404,6 +423,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -419,7 +441,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -429,13 +450,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The GroupMailbox switch specifies whether to return only Microsoft 365 Groups in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -445,6 +468,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -458,7 +484,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,6 +493,9 @@ Accept wildcard characters: False ``` ### -InactiveMailboxOnly + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch. @@ -480,7 +508,6 @@ To include active and inactive mailboxes in the results, don't use this switch. Type: SwitchParameter Parameter Sets: AnrSet, Identity, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -490,6 +517,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames Description }} @@ -498,7 +528,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -508,6 +537,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames Description }} @@ -516,7 +548,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -526,6 +557,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeAcceptMessagesOnlyFromWithDisplayNames Description }} @@ -534,7 +568,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -544,6 +577,9 @@ Accept wildcard characters: False ``` ### -IncludeEmailAddressDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeEmailAddressDisplayNames Description }} @@ -552,7 +588,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -562,6 +597,9 @@ Accept wildcard characters: False ``` ### -IncludeForwardingAddressWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeForwardingAddressWithDisplayNames Description }} @@ -570,7 +608,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -580,6 +617,9 @@ Accept wildcard characters: False ``` ### -IncludeGrantSendOnBehalfToWithDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} @@ -588,7 +628,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -598,6 +637,9 @@ Accept wildcard characters: False ``` ### -IncludeInactiveMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch. @@ -610,7 +652,6 @@ To return only inactive mailboxes in the results, don't use this switch. Instead Type: SwitchParameter Parameter Sets: AnrSet, Identity, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -620,6 +661,9 @@ Accept wildcard characters: False ``` ### -MailboxPlan + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example: @@ -638,7 +682,6 @@ You can't use this parameter with the Anr or Identity parameters. Type: MailboxPlanIdParameter Parameter Sets: MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -648,13 +691,15 @@ Accept wildcard characters: False ``` ### -Migration + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Migration switch specifies whether to return only migration mailboxes in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -664,6 +709,9 @@ Accept wildcard characters: False ``` ### -Monitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Monitoring switch specifies whether to return only monitoring mailboxes in the results. You don't need to specify a value with this switch. @@ -674,7 +722,6 @@ Monitoring mailboxes are associated with managed availability and the Exchange H Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -684,6 +731,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -695,7 +745,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -705,6 +754,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublicFolder switch specifies whether to return only public folder mailboxes in the results. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -713,7 +765,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -723,6 +774,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -735,7 +789,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -745,6 +798,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are: - DiscoveryMailbox @@ -765,7 +821,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -775,6 +830,9 @@ Accept wildcard characters: False ``` ### -RemoteArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoteArchive switch specifies whether to return only remote archive mailboxes in the results. You don't need to specify a value with this switch. @@ -785,7 +843,6 @@ Remote archive mailboxes are archive mailboxes in the cloud-based service that a Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -795,13 +852,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -811,6 +870,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Server parameter filters the results by Exchange server. When you use this parameter, only mailboxes on the specified Exchange server are included in the results. @@ -832,7 +894,6 @@ The ServerName and ServerLegacyDN properties for a mailbox may not be updated im Type: ServerIdParameter Parameter Sets: ServerSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -842,6 +903,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SoftDeletedMailbox switch specifies whether to return only soft-deleted mailboxes in the results. You don't need to specify a value with this switch. @@ -852,7 +916,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: AnrSet, Identity, MailboxPlanSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -862,6 +925,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -878,7 +944,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -888,6 +953,9 @@ Accept wildcard characters: False ``` ### -SupervisoryReviewPolicy + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -896,7 +964,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: AnrSet, DatabaseSet, Identity, ServerSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxAuditBypassAssociation.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxAuditBypassAssociation.md index 52e699b66f..6085bdb0ae 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxAuditBypassAssociation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxauditbypassassociation applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxAuditBypassAssociation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxauditbypassassociation +schema: 2.0.0 +title: Get-MailboxAuditBypassAssociation --- # Get-MailboxAuditBypassAssociation @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Get-MailboxAuditBypassAssociation cmdlet to retrieve information about the AuditBypassEnabled property value for user accounts (on-premises Exchange and the cloud) and computer accounts (on-premises Exchange only). You use the [Set-MailboxAuditBypassAssociation](https://learn.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation) cmdlet to enable this property to bypass mailbox audit logging. +Use the Get-MailboxAuditBypassAssociation cmdlet to retrieve information about the AuditBypassEnabled property value for user accounts (on-premises Exchange and the cloud) and computer accounts (on-premises Exchange only). You use the [Set-MailboxAuditBypassAssociation](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxauditbypassassociation) cmdlet to enable this property to bypass mailbox audit logging. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -60,13 +61,15 @@ This example returns all accounts that are configured for mailbox audit logging ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the user account or computer account where you want to view the value of the AuditBypassEnabled property. ```yaml Type: MailboxAuditBypassAssociationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -84,7 +90,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxAutoReplyConfiguration.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxAutoReplyConfiguration.md index 2eaf391e3c..cee567d5c3 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxAutoReplyConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxautoreplyconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxAutoReplyConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxautoreplyconfiguration +schema: 2.0.0 +title: Get-MailboxAutoReplyConfiguration --- # Get-MailboxAutoReplyConfiguration @@ -60,6 +61,9 @@ This example retrieves Automatic Replies settings for Tony's mailbox at contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -77,7 +81,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -95,7 +101,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -113,7 +121,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -133,7 +143,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,13 +152,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of settings to return. If you want to return all settings that match the command, use unlimited for the value of this parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -159,6 +170,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -167,7 +181,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarConfiguration.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarConfiguration.md index d8966ce18e..bb084b22b9 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxcalendarconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxCalendarConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxcalendarconfiguration +schema: 2.0.0 +title: Get-MailboxCalendarConfiguration --- # Get-MailboxCalendarConfiguration @@ -80,6 +81,9 @@ This example requests that the domain controller DC1 retrieves calendar settings ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -95,9 +99,8 @@ The Identity parameter specifies the mailbox that you want to view. You can use ```yaml Type: MailboxIdParameter -Parameter Sets: Default +Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -106,20 +109,10 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -DomainController -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -DomainController This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -128,7 +121,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +130,9 @@ Accept wildcard characters: False ``` ### -MailboxLocation + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MailboxLocation Description }} @@ -146,7 +141,6 @@ This parameter is available only in the cloud-based service. Type: MailboxLocationIdParameter Parameter Sets: MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarFolder.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarFolder.md index 075437cc2c..39190a3f18 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxCalendarFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxcalendarfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxCalendarFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxcalendarfolder +schema: 2.0.0 +title: Get-MailboxCalendarFolder --- # Get-MailboxCalendarFolder @@ -58,6 +59,9 @@ This example returns all provided publishing information for the specified calen ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the calendar folder that you want to view. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -79,7 +83,6 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Cal Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -97,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -115,7 +123,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabase.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabase.md index 82286a48e4..d0c9fca722 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxdatabase +schema: 2.0.0 +title: Get-MailboxDatabase --- # Get-MailboxDatabase @@ -73,6 +74,9 @@ This example returns detailed information about the mailbox database named Mailb ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox database that you want to view. You can use any value that uniquely identifies the database. For example: - Name @@ -85,7 +89,6 @@ If you have multiple databases with the same name, the command retrieves all dat Type: DatabaseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter filters the results by the specified Mailbox server. You can use any value that uniquely identifies the server. For example: - Name @@ -108,7 +114,6 @@ You can't use this parameter with the Identity parameter. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -118,13 +123,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -DumpsterStatistics + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DumpsterStatistics switch specifies that transport dumpster statistics be returned with the database status. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -IncludeCorrupted + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -IncludePreExchange2010 + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IncludePreExchange2010 switch specifies whether to return information about Exchange 2007 ore earlier mailbox databases. You don't need to specify a value with this switch. @@ -174,7 +188,6 @@ The IncludePreExchange2010 switch specifies whether to return information about Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -184,13 +197,15 @@ Accept wildcard characters: False ``` ### -IncludePreExchange2013 + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludePreExchange2013 switch specifies whether to return information about Exchange 2010 or earlier mailbox databases. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Status switch specifies whether to retrieve the available free space in the database root and information about the following attributes: - BackupInProgress @@ -214,7 +232,6 @@ If you specify this switch, you should format the output in such a way that you Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabaseCopyStatus.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabaseCopyStatus.md index d58b4dc67d..90105c739e 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxDatabaseCopyStatus.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxdatabasecopystatus applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxDatabaseCopyStatus -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxdatabasecopystatus +schema: 2.0.0 +title: Get-MailboxDatabaseCopyStatus --- # Get-MailboxDatabaseCopyStatus @@ -74,13 +75,15 @@ This example returns the status for the copy of database DB1 on the Mailbox serv ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the database copy for which the command should gather information. The Identity parameter can be specified in the form of `\`. Specifying just `` returns information for all copies of the database. This parameter can't be combined with the Server parameter. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -90,13 +93,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies that a Mailbox server returns status information for all of its mailbox database copies. This parameter can't be combined with the Identity parameter. ```yaml Type: MailboxServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -Active + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Active switch specifies whether to return mailbox database copy status for the active mailbox database copy only. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -ConnectionStatus + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Local switch specifies whether to return mailbox database copy status information from only the local Mailbox server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -ExtendedErrorInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedErrorInfo switch specifies whether to return an output object containing any exception details. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -UseServerCache + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UseServerCache switch specifies whether to enable a server-side remote procedure call (RPC) caching of status information for 5 seconds. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequest.md index 106407e8e1..15d115b5e7 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxExportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxexportrequest +schema: 2.0.0 +title: Get-MailboxExportRequest --- # Get-MailboxExportRequest @@ -98,6 +99,9 @@ This example returns all export requests that have the name DB01toPST where the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). If you specified a name for the export request when the request was created using the New-MailboxExportRequest cmdlet, use the following syntax: `Alias\Name`. Exchange automatically precedes the request with the mailbox's alias. This parameter can't be with the following parameters: @@ -113,7 +117,6 @@ This parameter can't be with the following parameters: Type: MailboxExportRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -123,6 +126,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BatchName parameter specifies the name given to a batch export request. You can't use this parameter with the Identity parameter. @@ -131,7 +137,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,6 +146,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Database parameter specifies the database in which the user's mailbox or archive resides. You can use any value that uniquely identifies the database. For example: @@ -155,7 +163,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -165,13 +172,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: - $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. @@ -192,7 +204,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013 + The Mailbox parameter filters the results by the source mailbox where the contents are being exported from. In Exchange 2016 CU7 or later, this parameter is the type MailboxLocationIdParameter, so the easiest value that you can use to identify the mailbox is the Alias value. @@ -223,9 +237,8 @@ You can't use this parameter with the Identity parameter. ```yaml Type: MailboxOrMailUserIdParameter -Parameter Sets: MailboxFiltering +Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -234,20 +247,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: MailboxLocationFiltering -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -Name -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Name The Name parameter specifies that export requests that have the specified name are returned. Use this parameter to search on the name that you provided when you created the export request. @@ -260,7 +263,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,13 +272,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -286,6 +290,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -307,7 +314,6 @@ CompletionInProgress and AutoSuspended don't apply to export requests and won't Type: RequestStatus Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,6 +323,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -325,7 +334,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -335,6 +343,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -347,7 +358,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequestStatistics.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequestStatistics.md index 27ef9ad06f..d5f0ed8fe8 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxExportRequestStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxexportrequeststatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxExportRequestStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxexportrequeststatistics +schema: 2.0.0 +title: Get-MailboxExportRequestStatistics --- # Get-MailboxExportRequestStatistics @@ -106,6 +107,9 @@ This example returns additional information for all the export requests that hav ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). If you specified a name for the export request when it was created by using the New-MailboxExportRequest cmdlet, use the following syntax: `Alias\Name`. This parameter can't be used with the RequestGuid or RequestQueue parameters. @@ -114,7 +118,6 @@ This parameter can't be used with the RequestGuid or RequestQueue parameters. Type: MailboxExportRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -MRSInstance + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSInstance parameter specifies the fully qualified domain name (FQDN) of the Client Access server on which the Microsoft Exchange Mailbox Replication service (MRS) resides. When using this parameter, all records are returned for this instance of MRS. @@ -134,7 +140,6 @@ You can't use this parameter with the Identity or RequestQueue parameters. Type: Fqdn Parameter Sets: MRSInstance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is for debugging purposes only. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -158,7 +166,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -168,6 +175,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -176,7 +186,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: Identity, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +195,15 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: String Parameter Sets: Identity, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -210,7 +224,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -220,13 +233,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,13 +251,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,13 +269,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -268,13 +287,15 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequestGuid parameter specifies the unique identifier for the export request. To find the export request GUID, use the Get-MailboxExportRequest cmdlet. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter. You can't use this parameter with the Identity parameter. ```yaml Type: Guid Parameter Sets: MRSInstance, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolder.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolder.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailboxFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolder.md index 3e9a4e5383..4f0450521d 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolder +schema: 2.0.0 +title: Get-MailboxFolder --- # Get-MailboxFolder @@ -85,6 +86,9 @@ This example returns a summary list of all levels of folders under Inbox in your ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox folder that you want to view. The syntax is `[MailboxID]:[\ParentFolder][\SubFolder]`. You can only run this cmdlet on your own mailbox, so you don't need to (or can't) specify a `MailboxID` value. @@ -110,7 +114,6 @@ Example values for this parameter are `john@contoso.com:`, `John:\Inbox`. Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -GetChildren + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The GetChildren switch specifies whether to return only the first level of subfolders under the specified parent folder. You don't need to specify a value with this switch. You can't use this switch with the Recurse switch. @@ -128,7 +134,6 @@ You can't use this switch with the Recurse switch. Type: SwitchParameter Parameter Sets: GetChildren Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -Recurse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Recurse switch specifies whether to return the specified parent folder and all of its subfolders. You don't need to specify a value with this switch. You can't use this switch with the GetChildren switch. @@ -146,7 +154,6 @@ You can't use this switch with the GetChildren switch. Type: SwitchParameter Parameter Sets: Recurse Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -156,6 +163,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -164,7 +174,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -174,13 +183,15 @@ Accept wildcard characters: False ``` ### -MailFolderOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailFolderOnly switch specifies whether to return only the mail folders in the specified mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -190,13 +201,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderPermission.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderPermission.md index 1873b6abc7..45768bf0e7 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxFolderPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderpermission +schema: 2.0.0 +title: Get-MailboxFolderPermission --- # Get-MailboxFolderPermission @@ -62,6 +63,9 @@ This example returns the permissions for the Calendar folder in John's mailbox, ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox folder that you want to view. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -83,7 +87,6 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Inb Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -101,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,13 +116,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -135,7 +145,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -SkipCount + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} @@ -153,7 +165,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -171,7 +185,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -181,6 +194,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. For the best results, we recommend using the following values: @@ -201,7 +217,6 @@ Otherwise, you can use any value that uniquely identifies the user or group. For Type: MailboxFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -227,10 +242,10 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxfolderpermission) -[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxfolderpermission) -[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderStatistics.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderStatistics.md index 8b201910e4..51eb753990 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxFolderStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderstatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxFolderStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderstatistics +schema: 2.0.0 +title: Get-MailboxFolderStatistics --- # Get-MailboxFolderStatistics @@ -115,6 +116,9 @@ This example uses the FolderScope parameter to view inbox folders statistics for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use any value that uniquely identifies the mailbox or mail user. For example: - Name @@ -130,9 +134,8 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c ```yaml Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: Identity +Parameter Sets: Identity, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -141,20 +144,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: AuditLog -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -Database -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -Database This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -163,7 +156,6 @@ This parameter is reserved for internal Microsoft use. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -173,6 +165,9 @@ Accept wildcard characters: False ``` ### -StoreMailboxIdentity + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -181,7 +176,6 @@ This parameter is reserved for internal Microsoft use. Type: StoreMailboxIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -191,13 +185,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Archive switch specifies whether to return the usage statistics of the archive associated with the mailbox or mail user. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -207,6 +203,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -215,7 +214,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: AuditLog Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +223,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -233,7 +234,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -243,6 +243,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -251,7 +254,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Identity, AuditLog Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,6 +263,9 @@ Accept wildcard characters: False ``` ### -FolderScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FolderScope parameter specifies the scope of the search by folder type. Valid parameter values include: - All @@ -289,7 +294,6 @@ The FolderScope parameter specifies the scope of the search by folder type. Vali Type: ElcFolderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -299,6 +303,9 @@ Accept wildcard characters: False ``` ### -IncludeAnalysis + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeAnalysis switch specifies whether to scan all items within a folder and return statistics related to the folder and item size. You don't need to specify a value with this switch. You should use this switch for troubleshooting purposes, because the command might take a long time to complete. @@ -307,7 +314,6 @@ You should use this switch for troubleshooting purposes, because the command mig Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -317,13 +323,15 @@ Accept wildcard characters: False ``` ### -IncludeOldestAndNewestItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeOldestAndNewestItems switch specifies whether to return the dates of the oldest and newest items in each folder. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -333,6 +341,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted mailboxes in the results. You don't need to specify a value with this switch. @@ -343,7 +354,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -353,6 +363,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -361,7 +374,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -371,6 +383,9 @@ Accept wildcard characters: False ``` ### -SkipCount + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} @@ -379,7 +394,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -389,6 +403,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -397,7 +414,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxIRMAccess.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxIRMAccess.md index ca07bcdfd7..5988155a36 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxIRMAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxirmaccess applicable: Exchange Online -title: Get-MailboxIRMAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxirmaccess +schema: 2.0.0 +title: Get-MailboxIRMAccess --- # Get-MailboxIRMAccess @@ -56,6 +57,9 @@ This example returns information about delegate Chris' access to IRM-protected m ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox where you want to view delegate access to IRM-protected messages. You can use any value that uniquely identifies the mailbox. For example - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the mailbox where you want to view delegate acc Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + The User parameter filters the results in the mailbox by the specified delegate. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: - Name @@ -100,7 +106,6 @@ The User parameter filters the results in the mailbox by the specified delegate. Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequest.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequest.md index 63f31df6ff..26a0c1dd9f 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxImportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboximportrequest +schema: 2.0.0 +title: Get-MailboxImportRequest --- # Get-MailboxImportRequest @@ -100,6 +101,9 @@ This example returns all import requests that have the name Recovered where the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specify a name for the import request, use the following syntax: `Alias\Name`. Microsoft Exchange automatically precedes the request with the mailbox's alias. You can't use this parameter with the following parameters: @@ -115,7 +119,6 @@ You can't use this parameter with the following parameters: Type: MailboxImportRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -125,6 +128,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter specifies the name given to a batch import request. You can't use this parameter with the Identity parameter. @@ -133,7 +139,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,6 +148,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Database parameter specifies the database in which the user's mailbox or archive resides. You can use any value that uniquely identifies the database. For example: @@ -157,7 +165,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -167,6 +174,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -175,7 +185,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,6 +194,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: @@ -198,7 +210,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,6 +219,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is functional only in on-premises Exchange. The Mailbox parameter filters the results by the destination mailbox where the content is being imported to. @@ -231,9 +245,8 @@ You can't use this parameter with the Identity parameter. ```yaml Type: MailboxOrMailUserIdParameter -Parameter Sets: MailboxFiltering +Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -242,20 +255,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: MailboxLocationFiltering -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Name -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -Name The Name parameter specifies that import requests that have the specified name are returned. Use this parameter to search on the name that you provided when you created the import request. If you didn't specify a name when the request was created, the default name is MailboxImportX (where X = 0-9). @@ -266,7 +269,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -276,13 +278,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -292,6 +296,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -313,7 +320,6 @@ CompletionInProgress and AutoSuspended don't apply to import requests and won't Type: RequestStatus Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -323,6 +329,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -331,7 +340,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -341,6 +349,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -355,7 +366,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MailboxFiltering, MailboxLocationFiltering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequestStatistics.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequestStatistics.md index 5803c36890..f2b4d0172b 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxImportRequestStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboximportrequeststatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxImportRequestStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboximportrequeststatistics +schema: 2.0.0 +title: Get-MailboxImportRequestStatistics --- # Get-MailboxImportRequestStatistics @@ -108,6 +109,9 @@ This example returns additional information for all the import requests that hav ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specified a name when you created the import request, use the following syntax: `Alias\Name`. **Note**: In Exchange Online, the alias of a soft-deleted mailbox might match the alias of an active mailbox. To ensure uniqueness, use the RequestGuid value from the output of the Get-MailboxImportRequest cmdlet for the value of this parameter. @@ -116,7 +120,6 @@ The Identity parameter specifies the identity of the import request. By default, Type: MailboxImportRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -126,6 +129,9 @@ Accept wildcard characters: False ``` ### -MRSInstance + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSInstance parameter specifies the fully qualified domain name (FQDN) of the Client Access server on which the Microsoft Exchange Mailbox Replication service (MRS) resides. When using this parameter, all records are returned for this instance of MRS. @@ -136,7 +142,6 @@ You can't use this parameter with the Identity or RequestQueue parameters. Type: Fqdn Parameter Sets: MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -146,6 +151,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is for debugging purposes only. @@ -162,7 +170,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -172,6 +179,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -182,7 +192,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,6 +201,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -200,7 +212,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +221,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -218,7 +232,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -228,6 +241,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -236,7 +252,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: IdentityOnPremises, MigrationRequestQueue, MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,13 +261,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,6 +279,9 @@ Accept wildcard characters: False ``` ### -IncludeSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeSkippedItems Description }} @@ -270,7 +290,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -280,6 +299,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestGuid parameter (together with the RequestQueue parameter) specifies the unique identifier for the import request. To find the import request GUID, use the Get-MailboxImportRequest cmdlet. @@ -290,7 +312,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationMRSInstance, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,13 +321,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxJunkEmailConfiguration.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxJunkEmailConfiguration.md index 4f8fe4884f..2d93050ad9 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxJunkEmailConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxjunkemailconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxJunkEmailConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxjunkemailconfiguration +schema: 2.0.0 +title: Get-MailboxJunkEmailConfiguration --- # Get-MailboxJunkEmailConfiguration @@ -67,6 +68,9 @@ To return all mailboxes where the junk email rule is enabled, change the value $ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -86,7 +90,6 @@ You can use the wildcard character (\*) to identify multiple mailboxes. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -96,6 +99,9 @@ Accept wildcard characters: True ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -104,7 +110,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -122,7 +130,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -142,7 +152,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,13 +161,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxLocation.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxLocation.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MailboxLocation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxLocation.md index ea42b8a024..49f45baaaf 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxLocation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxLocation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxlocation applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxLocation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxlocation +schema: 2.0.0 +title: Get-MailboxLocation --- # Get-MailboxLocation @@ -73,6 +74,9 @@ In Exchange Server or Exchange Online, this example returns the mailbox location ## PARAMETERS ### -Database + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Database parameter returns the mailbox location information for all mailboxes on the specified mailbox database. You can use any value that uniquely identifies the database. For example: @@ -87,7 +91,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: DatabaseSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox location object that you want to view. The value uses the either of the following formats: - TenantGUID\\MailboxGUID @@ -112,7 +118,6 @@ You can't use this parameter with the User parameter. Type: MailboxLocationIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The User parameter specifies the user whose mailbox location you want to view. You can use any value that uniquely identifies the user. For example: @@ -137,7 +145,6 @@ You can't use this parameter with the Identity parameter. Type: UserIdParameter Parameter Sets: User Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -156,7 +166,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -IncludePreviousPrimary + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludePreviousPrimary switch specifies whether to include the previous primary mailbox in the results. You don't need to specify a value with this switch. @@ -176,7 +188,6 @@ You can only use this switch with the User parameter. Type: SwitchParameter Parameter Sets: User Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -MailboxLocationType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailboxLocationType filters the results by the type of mailbox. Valid values are: - Aggregated @@ -200,7 +214,6 @@ The MailboxLocationType filters the results by the type of mailbox. Valid values Type: MailboxLocationType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -210,13 +223,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -226,13 +241,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxMessageConfiguration.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxMessageConfiguration.md index fff93d6e2a..973de8d9f7 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxMessageConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxmessageconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxMessageConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxmessageconfiguration +schema: 2.0.0 +title: Get-MailboxMessageConfiguration --- # Get-MailboxMessageConfiguration @@ -58,6 +59,9 @@ This example returns the Outlook on the web settings for Tony's mailbox and spec ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -75,7 +79,6 @@ The Identity parameter specifies the mailbox. You can use any value that uniquel Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credential parameter specifies the username and password to use to access the mailbox. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -93,7 +99,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -111,7 +119,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -131,7 +141,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -141,13 +150,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -SignatureName + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SignatureName Description }} @@ -165,7 +179,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -175,6 +188,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -183,7 +199,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxPermission.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MailboxPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxPermission.md index 80fc4e6f73..46b2722ed2 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxpermission +schema: 2.0.0 +title: Get-MailboxPermission --- # Get-MailboxPermission @@ -97,6 +98,9 @@ This example returns the owner information for the resource mailbox Room222. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -114,7 +118,6 @@ The Identity parameter specifies the mailbox you want to view. You can use any v Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -132,7 +138,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +147,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -150,7 +158,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,6 +167,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. @@ -168,7 +178,6 @@ The GroupMailbox switch is required to return Microsoft 365 Groups in the result Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -178,6 +187,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedUserPermissions + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeSoftDeletedUserPermissions switch returns permissions from soft-deleted mailbox users in the results. You don't need to specify a value with this switch. @@ -188,7 +200,6 @@ Soft-deleted mailboxes are mailboxes that have been deleted, but are still recov Type: SwitchParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -198,6 +209,9 @@ Accept wildcard characters: False ``` ### -IncludeUnresolvedPermissions + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeUnresolvedPermissions switch returns unresolved permissions in the results. You don't need to specify a value with this switch. @@ -206,7 +220,6 @@ The IncludeUnresolvedPermissions switch returns unresolved permissions in the re Type: SwitchParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,6 +229,9 @@ Accept wildcard characters: False ``` ### -IncludeUserWithDisplayName + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeUserWithDisplayName Description }} @@ -224,7 +240,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -234,6 +249,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Owner switch returns the owner information for the mailbox that's specified by the Identity parameter. You don't need to specify a value with this switch. You can't use this switch with the User parameter. @@ -242,7 +260,6 @@ You can't use this switch with the User parameter. Type: SwitchParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -252,6 +269,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -262,7 +282,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -272,13 +291,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -288,6 +309,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch. @@ -298,7 +322,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -308,6 +331,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -316,7 +342,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -326,6 +351,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The User parameter filters the results by who has permissions to the mailbox that's specified by the Identity parameter. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -356,7 +384,6 @@ You can't use this parameter with the Owner switch. Type: SecurityPrincipalIdParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxPlan.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxPlan.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-MailboxPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxPlan.md index c1a6bb560a..76da58ae59 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxplan applicable: Exchange Online -title: Get-MailboxPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxplan +schema: 2.0.0 +title: Get-MailboxPlan --- # Get-MailboxPlan @@ -55,6 +56,9 @@ This example returns detailed information for the mailbox plan that has the disp ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox plan that you want to view. You can use any value that uniquely identifies the mailbox plan. For example: - Name @@ -67,7 +71,6 @@ The Identity parameter specifies the mailbox plan that you want to view. You can Type: MailboxPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AllMailboxPlanReleases + +> Applicable: Exchange Online + The AllMailboxPlanReleases switch specifies whether to include mailbox plans that were used in previous versions of the service in the results. You don't need to specify a value with this switch. If you don't use this switch, the command returns only mailbox plans that are used in the current version of the service. This parameter has meaning only for organizations that were enrolled in previous versions of the service. @@ -85,7 +91,6 @@ If you don't use this switch, the command returns only mailbox plans that are us Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -103,7 +111,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -128,7 +138,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -170,6 +183,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -184,7 +200,6 @@ You can sort by the following attributes: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRegionalConfiguration.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxRegionalConfiguration.md index 0915467f52..a44a8b5da5 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRegionalConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxregionalconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxRegionalConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxregionalconfiguration +schema: 2.0.0 +title: Get-MailboxRegionalConfiguration --- # Get-MailboxRegionalConfiguration @@ -42,7 +43,7 @@ Get-MailboxRegionalConfiguration [-MailboxLocation ] ``` ## DESCRIPTION -To modify the regional settings of a mailbox, use the [Set-MailboxRegionalConfiguration](https://learn.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration) cmdlet. +To modify the regional settings of a mailbox, use the [Set-MailboxRegionalConfiguration](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxregionalconfiguration) cmdlet. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -72,6 +73,9 @@ This example returns the regional settings for Alice Jakobsen's mailbox and also ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -87,9 +91,8 @@ The Identity parameter specifies the mailbox that you want to view. You can use ```yaml Type: MailboxIdParameter -Parameter Sets: (All) +Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -98,20 +101,10 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Archive -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -Archive This parameter is available only in the cloud-based service. {{ Fill Archive Description }} @@ -120,7 +113,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,6 +122,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -138,7 +133,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +142,9 @@ Accept wildcard characters: False ``` ### -MailboxLocation + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MailboxLocation Description }} @@ -156,7 +153,6 @@ This parameter is available only in the cloud-based service. Type: MailboxLocationIdParameter Parameter Sets: MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,6 +162,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -174,7 +173,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -184,6 +182,9 @@ Accept wildcard characters: False ``` ### -VerifyDefaultFolderNameLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The VerifyDefaultFolderNameLanguage switch verifies that the default folder names are localized in the language that's specified for the mailbox (the Language property value). You don't need to specify a value with this switch. The results are displayed in the DefaultFolderNameMatchingUserLanguage property. To see this property, you need to pipeline the results of the command to the Format-List or Format-Table cmdlets. For example: @@ -200,7 +201,6 @@ If you view the DefaultFolderNameMatchingUserLanguage property without using the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRepairRequest.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxRepairRequest.md index d247baf12a..d9224ee757 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRepairRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxrepairrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxRepairRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxrepairrequest +schema: 2.0.0 +title: Get-MailboxRepairRequest --- # Get-MailboxRepairRequest @@ -83,6 +84,9 @@ This example uses the Database and StoreMailbox parameters to display the Identi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox repair request to display information about. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is `DatabaseGuid\RequestGuid\JobGuid`. You can't use this parameter with the Database or Mailbox parameters. @@ -91,7 +95,6 @@ You can't use this parameter with the Database or Mailbox parameters. Type: StoreIntegrityCheckJobIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Database parameter returns mailbox repair requests for all mailboxes on the specified database. You can use any value that uniquely identifies the database. For example: - Name @@ -113,7 +119,6 @@ You can't use this parameter with the Identity or Mailbox parameters. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Mailbox parameter specifies the mailbox that you want to get mailbox repair request information about. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -142,7 +150,6 @@ You can't use this parameter with the Database or Identity parameters. Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -152,6 +159,9 @@ Accept wildcard characters: False ``` ### -StoreMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The StoreMailbox parameter specifies the mailbox GUID of the mailbox that you want to get mailbox repair request information about. Use this parameter with the Database parameter. Use the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. @@ -160,7 +170,6 @@ Use the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. Type: StoreMailboxIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 2 @@ -170,6 +179,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Archive switch displays information about the associated archive mailbox if the archive mailbox was included when the mailbox repair request was created. You don't need to specify a value with this switch. If you don't use this switch, only information about the primary mailbox is returned. @@ -180,7 +192,6 @@ You can't use this switch with the Database parameter. Type: SwitchParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,13 +201,15 @@ Accept wildcard characters: False ``` ### -Detailed + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + Use the Detailed parameter to display mailbox-level repair tasks associated with the repair request. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +219,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequest.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequest.md index 307c4af120..91a54258e6 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxRestoreRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxrestorerequest +schema: 2.0.0 +title: Get-MailboxRestoreRequest --- # Get-MailboxRestoreRequest @@ -80,6 +81,9 @@ This example returns all restore requests that have the name RestoreToMBD01 wher ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -90,7 +94,6 @@ You can't use this parameter with the Name parameter. Type: MailboxRestoreRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter specifies the name given to a batch of restore requests. You can't use this parameter with the Identity parameter. @@ -108,7 +114,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -126,7 +134,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: - $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. @@ -147,7 +157,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies that any restore request that has the specified name is returned. Use this parameter to search on the name you provided when you created the restore request. @@ -169,7 +181,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -179,6 +190,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -193,7 +207,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,13 +216,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SourceDatabase parameter specifies that the cmdlet should only return restore requests for mailboxes that are being restored from the specified source database. You can use any value that uniquely identifies the database. For example: @@ -233,7 +251,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,6 +260,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -262,7 +282,6 @@ You can't use this parameter with the Identity parameter. Type: RequestStatus Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -272,6 +291,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -280,7 +302,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -290,6 +311,9 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The TargetDatabase parameter specifies that the cmdlet should only return restore requests for mailboxes that reside on the target database. You can use any value that uniquely identifies the database. For example: @@ -304,7 +328,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -314,6 +337,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetMailbox parameter specifies the identity of the target mailbox. You can use the following values: - GUID @@ -330,7 +356,6 @@ You can't use this parameter with the Identity parameter. Type: MailboxOrMailUserIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequestStatistics.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequestStatistics.md index 08a0693b85..cf05e6387b 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxRestoreRequestStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxrestorerequeststatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxRestoreRequestStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxrestorerequeststatistics +schema: 2.0.0 +title: Get-MailboxRestoreRequestStatistics --- # Get-MailboxRestoreRequestStatistics @@ -104,6 +105,9 @@ This example returns additional information for all the restore requests that ha ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -114,7 +118,6 @@ You can't use this parameter with the MRSInstance or RequestQueue parameters. Type: MailboxRestoreRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -MRSInstance + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSInstance parameter specifies the fully qualified domain name (FQDN) of the Client Access server on which the Microsoft Exchange Mailbox Replication service (MRS) resides. When using this parameter, all records are returned for this instance of MRS. @@ -134,7 +140,6 @@ You can't use this parameter with the Identity or RequestQueue parameters. Type: Fqdn Parameter Sets: MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is for debugging purposes only. @@ -160,7 +168,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -170,13 +177,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +195,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestGuid parameter specifies the unique identifier for the restore request. To find the GUID, use the Get-MailboxRestoreRequest cmdlet. @@ -194,7 +206,6 @@ The RequestGuid parameter specifies the unique identifier for the restore reques Type: Guid Parameter Sets: MigrationMRSInstance, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,6 +215,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -214,7 +228,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,6 +237,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -232,7 +248,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -242,6 +257,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -250,7 +268,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -260,6 +277,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -268,7 +288,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: IdentityOnPremises, MigrationMRSInstance, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -278,6 +297,9 @@ Accept wildcard characters: False ``` ### -IncludeSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeSkippedItems Description }} @@ -286,7 +308,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -296,13 +317,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSearch.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxSearch.md index 3051b480ef..607711b6f8 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxsearch +schema: 2.0.0 +title: Get-MailboxSearch --- # Get-MailboxSearch @@ -83,6 +84,9 @@ This example retrieves the In-Place Holds that a user is placed on. The first co ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the search query. If a name isn't provided, all mailbox search queries are returned. To improve the performance of this cmdlet in Exchange Online, some mailbox search properties aren't returned if you don't specify the name of a mailbox search. These properties are: @@ -98,9 +102,8 @@ To view these properties, you have to provide the name of a mailbox search. ```yaml Type: SearchObjectIdParameter -Parameter Sets: EwsStoreObjectIdentity +Parameter Sets: EwsStoreObjectIdentity, SearchObjectIdentity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -109,27 +112,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: SearchObjectIdParameter -Parameter Sets: SearchObjectIdentity -Aliases: -Applicable: Exchange Server 2010 +### -InPlaceHoldIdentity -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -InPlaceHoldIdentity The InPlaceHoldIdentity parameter specifies the GUID of an In-Place Hold. Use this parameter to search for an In-Place Hold that a user is placed on. GUIDs of all In-Place Holds that a user is placed on are added to the user's InPlaceHolds property. You can retrieve the property by using the Get-Mailbox cmdlet. ```yaml Type: String Parameter Sets: InPlaceHoldIdentity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -139,6 +131,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -147,7 +142,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +151,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -173,13 +169,15 @@ Accept wildcard characters: False ``` ### -ShowDeletionInProgressSearches + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: EwsStoreObjectIdentity, InPlaceHoldIdentity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSentItemsConfiguration.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxSentItemsConfiguration.md index 0db5f4e4f3..847a41ef34 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSentItemsConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxsentitemsconfiguration applicable: Exchange Server 2010 -title: Get-MailboxSentItemsConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxsentitemsconfiguration +schema: 2.0.0 +title: Get-MailboxSentItemsConfiguration --- # Get-MailboxSentItemsConfiguration @@ -43,13 +44,15 @@ This example returns the Sent Items configuration for the shared mailbox named " ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the mailbox whose Sent Items configuration you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -76,7 +82,6 @@ The Identity parameter specifies the mailbox whose Sent Items configuration you Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxServer.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MailboxServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxServer.md index 7b2886ee8a..6be71ce89d 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxserver +schema: 2.0.0 +title: Get-MailboxServer --- # Get-MailboxServer @@ -51,6 +52,9 @@ This example returns detailed information about the Mailbox server named Server1 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Mailbox server that you want to view. You can use any value that uniquely identifies the Mailbox server. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the Mailbox server that you want to view. You c Type: MailboxServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Status switch specifies whether to include additional property values in the results, for example, the Locale value. You don't need to specify a value with this switch. To see the additional values, you need to pipe the output to a formatting cmdlet, for example, the Format-List cmdlet. @@ -95,7 +103,6 @@ To see the additional values, you need to pipe the output to a formatting cmdlet Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSpellingConfiguration.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxSpellingConfiguration.md index 711e199b87..d132b4950f 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxSpellingConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxspellingconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxSpellingConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxspellingconfiguration +schema: 2.0.0 +title: Get-MailboxSpellingConfiguration --- # Get-MailboxSpellingConfiguration @@ -62,6 +63,9 @@ This example returns the Outlook on the web spelling checker options for Tony's ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -79,7 +83,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -97,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxStatistics.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MailboxStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxStatistics.md index 364729d637..53dfbc6753 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxstatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxstatistics +schema: 2.0.0 +title: Get-MailboxStatistics --- # Get-MailboxStatistics @@ -148,6 +149,9 @@ This example returns the detailed move history and a verbose detailed move repor ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to return statistics for. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -165,7 +169,6 @@ The Identity parameter specifies the mailbox that you want to return statistics Type: GeneralMailboxOrMailUserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -175,6 +178,9 @@ Accept wildcard characters: False ``` ### -StoreMailboxIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The StoreMailboxIdentity parameter specifies the mailbox identity when used with the Database parameter to return statistics for a single mailbox on the specified database. You can use one of the following values: @@ -188,7 +194,6 @@ Use this syntax to retrieve information about disconnected mailboxes, which don' Type: StoreMailboxIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -198,13 +203,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Archive switch specifies whether to return mailbox statistics for the archive mailbox that's associated with the mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -214,6 +221,9 @@ Accept wildcard characters: False ``` ### -CopyOnServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CopyOnServer parameter is used to retrieve statistics from a specific database copy on the specified server. @@ -231,7 +241,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: Database, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +250,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Database parameter returns statistics for all mailboxes on the specified database. You can use any value that uniquely identifies the database. For example: @@ -255,7 +267,6 @@ This parameter accepts pipeline input from the Get-MailboxDatabase cmdlet. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -265,6 +276,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -273,7 +287,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -283,6 +296,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. @@ -302,7 +318,6 @@ For example, to display all disconnected mailboxes on a specific mailbox databas Type: String Parameter Sets: Database, Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -312,13 +327,15 @@ Accept wildcard characters: False ``` ### -IncludeMoveHistory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeMoveHistory switch specifies whether to return additional information about the mailbox that includes the history of a completed move request, such as status, flags, target database, bad items, start times, end times, duration that the move request was in various stages, and failure codes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -328,6 +345,9 @@ Accept wildcard characters: False ``` ### -IncludeMoveReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeMoveReport switch specifies whether to return a verbose detailed move report for a completed move request, such as server connections and move stages. You don't need to specify a value with this switch. Because the output of this command is verbose, you should send the output to a .CSV file for easier analysis. @@ -336,7 +356,6 @@ Because the output of this command is verbose, you should send the output to a . Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -346,6 +365,9 @@ Accept wildcard characters: False ``` ### -IncludePassive + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IncludePassive switch specifies whether to return statistics from all active and passive database copies. You don't need to specify a value with this switch. @@ -356,7 +378,6 @@ If you don't use this switch, the command retrieves statistics from active datab Type: SwitchParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -366,6 +387,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted mailboxes in the results. You don't need to specify a value with this switch. @@ -376,7 +400,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -386,6 +409,9 @@ Accept wildcard characters: False ``` ### -IncludeQuarantineDetails + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IncludeQuarantineDetails switch specifies whether to return additional quarantine details about the mailbox that aren't otherwise included in the results. You can use these details to determine when and why the mailbox was quarantined. You don't need to specify a value with this switch. @@ -396,7 +422,6 @@ Specifically, this switch returns the values of the QuarantineDescription, Quara Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,6 +431,9 @@ Accept wildcard characters: False ``` ### -NoADLookup + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The NoADLookup switch specifies that information is retrieved from the mailbox database, and not from Active Directory. You don't need to specify a value with this switch. @@ -416,7 +444,6 @@ This switch helps improve cmdlet performance when querying a mailbox database th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -426,6 +453,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Server parameter specifies the server from which you want to obtain mailbox statistics. You can use one of the following values: @@ -439,7 +469,6 @@ When you specify a value for the Server parameter, the command returns statistic Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -449,6 +478,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -457,7 +489,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxTransportService.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxTransportService.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-MailboxTransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxTransportService.md index 4e4beb49a3..25cb4369a6 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxTransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxTransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxtransportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MailboxTransportService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxtransportservice +schema: 2.0.0 +title: Get-MailboxTransportService --- # Get-MailboxTransportService @@ -50,13 +51,15 @@ This example retrieves the detailed transport configuration information for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server that you want to view. ```yaml Type: MailboxTransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxUserConfiguration.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MailboxUserConfiguration.md index 6487e6dc0e..961975f2db 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MailboxUserConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxuserconfiguration applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MailboxUserConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxuserconfiguration +schema: 2.0.0 +title: Get-MailboxUserConfiguration --- # Get-MailboxUserConfiguration @@ -50,6 +51,9 @@ This example returns detailed information for the specified user configuration i ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the user configuration item that you want to view. This parameter uses the syntax MailboxFolder\ItemName: - Valid values for MailboxFolder are folder names (for example, Inbox or Calendar), the value Configuration, or the value Root. Wildcards (\*) aren't supported. @@ -59,7 +63,6 @@ The Identity parameter specifies the user configuration item that you want to vi Type: MailboxUserConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the user configuration items you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -86,7 +92,6 @@ The Mailbox parameter specifies the mailbox that contains the user configuration Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -120,7 +130,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterPolicy.md index 077860de6f..5d133ef2fb 100644 --- a/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-malwarefilterpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-MalwareFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-malwarefilterpolicy +schema: 2.0.0 +title: Get-MalwareFilterPolicy --- # Get-MalwareFilterPolicy @@ -50,13 +51,15 @@ This example retrieves detailed configuration information for the malware filter ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter policy that you want to view. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the malware filter policy. ```yaml Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterRule.md index d8b421d6ef..9dece05188 100644 --- a/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-MalwareFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-malwarefilterrule +schema: 2.0.0 +title: Get-MalwareFilterRule --- # Get-MalwareFilterRule @@ -49,13 +50,15 @@ This example retrieves detailed configuration information for the malware filter ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -73,7 +79,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The State parameter filters the results by enabled or disabled malware filter rules. Valid input for this parameter is Enabled or Disabled. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilteringServer.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilteringServer.md index 11a67a8298..7cdc96ccc4 100644 --- a/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MalwareFilteringServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-malwarefilteringserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MalwareFilteringServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-malwarefilteringserver +schema: 2.0.0 +title: Get-MalwareFilteringServer --- # Get-MalwareFilteringServer @@ -48,6 +49,9 @@ This example returns the detailed Exchange Malware agent settings on a Mailbox s ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server where you want to view the anti-malware settings. You can use any value that uniquely identifies the server. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the server where you want to view the anti-malw Type: MalwareFilteringServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -77,7 +83,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedContentSettings.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-ManagedContentSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagedContentSettings.md index 543f807e2a..38de7eef3b 100644 --- a/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedContentSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managedcontentsettings applicable: Exchange Server 2010 -title: Get-ManagedContentSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managedcontentsettings +schema: 2.0.0 +title: Get-ManagedContentSettings --- # Get-ManagedContentSettings @@ -67,6 +68,9 @@ This example retrieves the managed content settings for the managed folder Inbox ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the set of managed content settings. When used, this command retrieves the folder content settings and all associated attributes. This parameter can't be used with the FolderName parameter. @@ -75,7 +79,6 @@ This parameter can't be used with the FolderName parameter. Type: ELCContentSettingsIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -FolderName + +> Applicable: Exchange Server 2010 + The FolderName parameter specifies the name or GUID of the managed folder to which the managed content settings apply. When used, this command retrieves all the policies that apply to that folder. This parameter can't be used with the Identity parameter. @@ -109,7 +117,6 @@ This parameter can't be used with the Identity parameter. Type: ELCFolderIdParameter Parameter Sets: FolderName Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagedFolder.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolder.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-ManagedFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolder.md index f7a6302c2b..a3984883b9 100644 --- a/exchange/exchange-ps/exchange/Get-ManagedFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managedfolder applicable: Exchange Server 2010 -title: Get-ManagedFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managedfolder +schema: 2.0.0 +title: Get-ManagedFolder --- # Get-ManagedFolder @@ -57,13 +58,15 @@ This example retrieves information about the managed folder MyManagedFolder. The ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder. ```yaml Type: ELCFolderIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010 + The Mailbox parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -108,7 +116,6 @@ This cmdlet retrieves all the folders that apply to the specified mailbox. Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolderMailboxPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolderMailboxPolicy.md index 773b53f264..012ba3077b 100644 --- a/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagedFolderMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managedfoldermailboxpolicy applicable: Exchange Server 2010 -title: Get-ManagedFolderMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managedfoldermailboxpolicy +schema: 2.0.0 +title: Get-ManagedFolderMailboxPolicy --- # Get-ManagedFolderMailboxPolicy @@ -45,13 +46,15 @@ The Identity parameter is a positional parameter. Positional parameters can be u ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagementRole.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRole.md similarity index 83% rename from exchange/exchange-ps/exchange/Get-ManagementRole.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagementRole.md index 72a4c467e8..fc7a39e6d1 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRole.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managementrole applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-ManagementRole -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managementrole +schema: 2.0.0 +title: Get-ManagementRole --- # Get-ManagementRole @@ -112,13 +113,15 @@ This example lists the immediate children of the Mail Recipients role. Only the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role you want to view. If the role you want to view contains spaces, enclose the name in quotation marks ("). You can use the wildcard character (\*) and a partial role name to match multiple roles. ```yaml Type: RoleIdParameter -Parameter Sets: GetChildren, Recurse +Parameter Sets: GetChildren, Recurse, Identity, Script Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -127,20 +130,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: RoleIdParameter -Parameter Sets: Identity, Script -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection +### -GetChildren -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -### -GetChildren The GetChildren parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. You don't need to specify a value with this switch. Only the immediate child roles of the parent role are included in the results. @@ -151,7 +144,6 @@ You can use this switch only with the Identity and RoleType parameters. Type: SwitchParameter Parameter Sets: GetChildren Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -161,6 +153,9 @@ Accept wildcard characters: False ``` ### -Recurse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Recurse parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. You don't need to specify a value with this switch. The role specified in the Identity parameter, its child roles, and their children are returned. @@ -171,7 +166,6 @@ You can use this switch only with the Identity and RoleType parameters. Type: SwitchParameter Parameter Sets: Recurse Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -181,13 +175,15 @@ Accept wildcard characters: False ``` ### -Cmdlet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Cmdlet parameter returns a list of all roles that include the specified cmdlet. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -197,13 +193,15 @@ Accept wildcard characters: False ``` ### -CmdletParameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The CmdletParameters parameter returns a list of all roles that include the specified parameter or parameters. You can specify more than one parameter by separating each parameter with a comma. If you specify multiple parameters, only the roles that include all of the specified parameters are returned. ```yaml Type: String[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -213,6 +211,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -221,7 +222,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -231,13 +231,15 @@ Accept wildcard characters: False ``` ### -RoleType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). ```yaml Type: RoleType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -247,13 +249,15 @@ Accept wildcard characters: False ``` ### -Script + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Script parameter returns a list of all roles that include the specified script. ```yaml Type: String Parameter Sets: Script Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -263,13 +267,15 @@ Accept wildcard characters: False ``` ### -ScriptParameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ScriptParameters parameter returns a list of all roles that include the specified parameter or parameters. You can specify more than one parameter by separating each parameter with a comma. If you specify multiple parameters, only the roles that include all of the specified parameters are returned. ```yaml Type: String[] Parameter Sets: Script Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleAssignment.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleAssignment.md index 574baae033..31e8e41432 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleAssignment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managementroleassignment applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-ManagementRoleAssignment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managementroleassignment +schema: 2.0.0 +title: Get-ManagementRoleAssignment --- # Get-ManagementRoleAssignment @@ -131,13 +132,15 @@ This example retrieves all the role assignments that can modify the database Con ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the role assignment to retrieve. If the name of the role assignment contains spaces, enclose it in quotation marks ("). If the RoleAssignee parameter is used, you can't use the Identity parameter. ```yaml Type: RoleAssignmentIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -147,6 +150,9 @@ Accept wildcard characters: False ``` ### -AssignmentMethod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AssignmentMethod parameter specifies the type of role assignment to include in the results returned by the cmdlet. You can specify one or more of the following values: - Direct @@ -162,7 +168,6 @@ You must specify a value with the RoleAssignee parameter if you use the Assignme Type: AssignmentMethod[] Parameter Sets: RoleAssignee Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,13 +177,15 @@ Accept wildcard characters: False ``` ### -ConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConfigWriteScope parameter specifies the type of management configuration scope to include in the results returned by the cmdlet. The valid values are None, OrganizationConfig, CustomConfigScope, and ExclusiveConfigScope. ```yaml Type: ConfigWriteScopeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -188,6 +195,9 @@ Accept wildcard characters: False ``` ### -CustomConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CustomConfigWriteScope parameter returns only the regular role assignments that include the specified configuration-based regular scope. @@ -200,7 +210,6 @@ If the scope name contains spaces, enclose it in quotation marks ("). Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +219,9 @@ Accept wildcard characters: False ``` ### -CustomRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomRecipientWriteScope parameter returns only the regular role assignments that include the specified recipient-based regular scope. This parameter can only be used to retrieve regular recipient-based scopes. To retrieve a list of exclusive recipient-based scopes, use the ExclusiveRecipientWriteScope parameter instead. @@ -220,7 +232,6 @@ If the scope name contains spaces, enclose it in quotation marks ("). Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -230,6 +241,9 @@ Accept wildcard characters: False ``` ### -Delegating + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Delegating parameter specifies whether delegating or regular role assignments should be returned. By default, both delegating and regular scopes are returned. To return only delegating role assignments, specify a value of $true. To return only regular role assignments, specify a value of $false. @@ -238,7 +252,6 @@ By default, both delegating and regular scopes are returned. To return only dele Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,6 +261,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -256,7 +272,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -266,13 +281,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether enabled or disabled role assignments should be returned. To return enabled role assignments, specify a value of $true. To return disabled role assignments, specify a value of $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -282,6 +299,9 @@ Accept wildcard characters: False ``` ### -Exclusive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Exclusive parameter specifies whether exclusive or regular role assignments should be returned. By default, both exclusive and regular scopes are returned. To return only exclusive role assignments, specify a value of $true. To return only regular role assignments, specify a value of $false. @@ -290,7 +310,6 @@ By default, both exclusive and regular scopes are returned. To return only exclu Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,6 +319,9 @@ Accept wildcard characters: False ``` ### -ExclusiveConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ExclusiveConfigWriteScope parameter returns only the exclusive role assignments that include the specified configuration-based exclusive scope. @@ -312,7 +334,6 @@ If the scope name contains spaces, enclose it in quotation marks ("). Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,6 +343,9 @@ Accept wildcard characters: False ``` ### -ExclusiveRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExclusiveRecipientWriteScope parameter returns only the exclusive role assignments that include the specified recipient-based exclusive scope. This parameter can only be used to retrieve exclusive recipient-based scopes. To retrieve a list of regular recipient-based scopes, use the CustomRecipientWriteScope parameter instead. @@ -332,7 +356,6 @@ If the scope name contains spaces, enclose it in quotation marks ("). Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -342,6 +365,9 @@ Accept wildcard characters: False ``` ### -GetEffectiveUsers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The GetEffectiveUsers switch specifies that the command should show the list of users in the role groups, role assignment policies, or USGs that are associated with the role assignment. You don't need to specify a value with this switch. Effectively, users are associated with the role assignment through their role group, role assignment policy, or USG memberships. @@ -350,7 +376,6 @@ Effectively, users are associated with the role assignment through their role gr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -360,6 +385,9 @@ Accept wildcard characters: False ``` ### -RecipientAdministrativeUnitScope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The RecipientAdministrativeUnitScope parameter returns only the role assignments that include the specified administrative unit. @@ -370,7 +398,6 @@ Administrative units are Microsoft Entra containers of resources. You can view t Type: AdministrativeUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -380,6 +407,9 @@ Accept wildcard characters: False ``` ### -RecipientGroupScope + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecipientGroupScope parameter returns only the role assignments that are scoped to groups. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, DisplayName. @@ -388,7 +418,6 @@ The RecipientGroupScope parameter returns only the role assignments that are sco Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -398,13 +427,15 @@ Accept wildcard characters: False ``` ### -RecipientOrganizationalUnitScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientOrganizationalUnitScope parameter returns only the role assignments that include the specified organizational unit (OU). If the OU tree contains spaces, enclose it in quotation marks ("). ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -414,13 +445,15 @@ Accept wildcard characters: False ``` ### -RecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientWriteScope parameter returns only the role assignments associated with the recipient scope restriction type specified. The valid values are None, MyGAL, Self, OU, CustomRecipientScope, MyDistributionGroups and ExclusiveRecipientScope. ```yaml Type: RecipientWriteScopeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -430,13 +463,15 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Role parameter returns only the role assignments associated with the specified management role. If the name of the role contains spaces, enclose it in quotation marks ("). ```yaml Type: RoleIdParameter Parameter Sets: RoleAssignee Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -446,6 +481,9 @@ Accept wildcard characters: False ``` ### -RoleAssignee + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RoleAssignee parameter specifies the role group, assignment policy, user, or universal security group (USG) for which you want to view role assignments. If the RoleAssignee parameter is used, you can't use the Identity parameter. By default, the command returns both direct role assignments to the role assignee and indirect role assignments granted to a role assignee through role groups or assignment policies. @@ -456,7 +494,6 @@ If the name of the user or USG contains spaces, enclose it in quotation marks (" Type: RoleAssigneeIdParameter Parameter Sets: RoleAssignee Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -466,13 +503,15 @@ Accept wildcard characters: False ``` ### -RoleAssigneeType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RoleAssigneeType parameter specifies the type of role assignee to return. The valid values are User, SecurityGroup, RoleAssignmentPolicy, ForeignSecurityPrincipal, RoleGroup, LinkedRoleGroup and Computer. ```yaml Type: RoleAssigneeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -482,6 +521,9 @@ Accept wildcard characters: False ``` ### -WritableDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The WritableDatabase parameter specifies the database object you want to test to determine which role assignments allow it to be modified. The command takes into account the roles and scopes associated with each role assignment. You can use any value that uniquely identifies the database. For example: @@ -496,7 +538,6 @@ If you use this parameter with the GetEffectiveUsers switch, all the users who c Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -506,6 +547,9 @@ Accept wildcard characters: False ``` ### -WritableRecipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WritableRecipient parameter specifies the recipient object you want to test to determine which role assignments allow it to be modified. The command takes into account the roles and scopes associated with each role assignment. If the recipient name contains spaces, enclose it in quotation marks ("). If this parameter is used with the GetEffectiveUsers switch, all of the users who can modify the recipient object indirectly through role groups and USGs are also returned. Without the GetEffectiveUsers switch, only the role groups, users and USGs directly assigned the role assignment are returned. @@ -514,7 +558,6 @@ If this parameter is used with the GetEffectiveUsers switch, all of the users wh Type: GeneralRecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -524,6 +567,9 @@ Accept wildcard characters: False ``` ### -WritableServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The WritableServer parameter specifies the server object you want to test to determine which role assignments allow it to be modified. The command takes into account the roles and scopes associated with each role assignment. @@ -541,7 +587,6 @@ If this parameter is used with the GetEffectiveUsers switch, all of the users wh Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleEntry.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleEntry.md index 8ba8cccb05..7c88254dd8 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementRoleEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managementroleentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-ManagementRoleEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managementroleentry +schema: 2.0.0 +title: Get-ManagementRoleEntry --- # Get-ManagementRoleEntry @@ -63,6 +64,9 @@ This example retrieves the Tier 2 Help Desk\\Set-Mailbox role entry and pipes th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the role entry that you want to view. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). @@ -75,7 +79,6 @@ If the role entry name contains spaces, enclose the name in quotation marks ("). Type: RoleEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -93,7 +99,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Parameters parameter includes only the role entries that contain the parameters specified. You can specify multiple parameters, separated by commas. You can use the wildcard character (\*) with partial parameter names to retrieve all parameters that match the value you specify. This parameter is useful when you use the wildcard character (\*) with the value you specify in the Identity parameter. @@ -111,7 +119,6 @@ This parameter is useful when you use the wildcard character (\*) with the value Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -PSSnapinName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PSSnapinName parameter specifies the Windows PowerShell snap-in that contains the role entry to return. Use the Get-PSSnapin cmdlet to retrieve a list of available Windows PowerShell snap-ins. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -145,7 +157,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Type parameter specifies the type of role entry to return. The valid values for the Type parameter are any combination of the following parameters, separated by commas: Cmdlet, Script and ApplicationPermission. ```yaml Type: ManagementRoleEntryType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ManagementScope.md b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementScope.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-ManagementScope.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ManagementScope.md index 38673e7eda..cc67cda634 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ManagementScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-managementscope applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-ManagementScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-managementscope +schema: 2.0.0 +title: Get-ManagementScope --- # Get-ManagementScope @@ -68,13 +69,15 @@ This example retrieves a list of exclusive scopes. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the management scope to return. If the management scope name contains spaces, enclose it in quotation marks ("). ```yaml Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -92,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -Exclusive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Exclusive parameter specifies whether exclusive scopes should be returned. If the Exclusive parameter isn't specified, regular scopes and exclusive scopes are returned. If the Exclusive parameter is set to $True, only exclusive scopes are returned. If the Exclusive parameter is set to $False, only regular scopes are returned. The valid values are $True and $False. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -Orphan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Orphan switch specifies whether to return only management scopes that aren't associated with role assignments. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-MapiVirtualDirectory.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MapiVirtualDirectory.md index 77a025f2c7..72586d4075 100644 --- a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MapiVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mapivirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MapiVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mapivirtualdirectory +schema: 2.0.0 +title: Get-MapiVirtualDirectory --- # Get-MapiVirtualDirectory @@ -71,6 +72,9 @@ This example returns a summary list of all MAPI virtual directories in the clien ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the MAPI virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -85,7 +89,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -108,7 +114,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -126,7 +134,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +143,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. @@ -164,7 +176,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Message.md b/exchange/exchange-ps/ExchangePowerShell/Get-Message.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Message.md index 634425d077..f9c313b9b5 100644 --- a/exchange/exchange-ps/exchange/Get-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-message applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-Message -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-message +schema: 2.0.0 +title: Get-Message --- # Get-Message @@ -97,13 +98,15 @@ This example displays all messages queued on the server named Server01. The resu ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -113,13 +116,15 @@ Accept wildcard characters: False ``` ### -BookmarkIndex + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BookmarkIndex parameter specifies the position in the result set where the displayed results start. The value of this parameter is a 1-based index in the total result set. The BookmarkIndex parameter can't be used with the BookmarkObject parameter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +134,15 @@ Accept wildcard characters: False ``` ### -BookmarkObject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BookmarkObject parameter specifies the object in the result set where the displayed results start. The BookmarkObject parameter can't be used with the BookmarkIndex parameter. ```yaml Type: ExtensibleMessageInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +152,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -153,7 +163,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,13 +172,15 @@ Accept wildcard characters: False ``` ### -IncludeBookmark + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeBookmark parameter specifies whether to include the bookmark object when the query results are displayed. The IncludeBookmark parameter is valid when it's used with the BookmarkObject or BookmarkIndex parameters. If you don't specify a value for the IncludeBookmark parameter, the default value of $true is used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -179,6 +190,9 @@ Accept wildcard characters: False ``` ### -IncludeComponentLatencyInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeComponentLatencyInfo switch specifies whether the information about component latency is included in the message properties. You don't need to specify a value with this switch. If you include this switch, the message objects returned will include latency measurements for each Transport component that has contributed to the local server latency for each queued message. @@ -187,7 +201,6 @@ If you include this switch, the message objects returned will include latency me Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,6 +210,9 @@ Accept wildcard characters: False ``` ### -IncludeRecipientInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeRecipientInfo switch specifies whether to display the message recipients in the Recipients field. You don't need to specify a value with this switch. If you don't include the IncludeRecipientInfo switch, the Recipients field is blank. @@ -217,7 +233,6 @@ To display the extended recipient properties that are now stored in the $x varia Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,6 +242,9 @@ Accept wildcard characters: False ``` ### -Queue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Queue parameter specifies the identity of the queue that contains the messages that you want to display. Valid input for this parameter uses the syntax `\` or ``, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). If you use the Queue parameter, you can't use the Identity, Filter or Server parameters. @@ -235,7 +253,6 @@ If you use the Queue parameter, you can't use the Identity, Filter or Server par Type: QueueIdentity Parameter Sets: Queue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,13 +262,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,13 +280,15 @@ Accept wildcard characters: False ``` ### -ReturnPageInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReturnPageInfo parameter is a hidden parameter. Use it to return information about the total number of results and the index of the first object of the current page. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,13 +298,15 @@ Accept wildcard characters: False ``` ### -SearchForward + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SearchForward parameter specifies whether to search forward or backward in the result set. The default value is $true. This value causes the result page to be calculated forward from either the start of the result set or forward from a bookmark if specified. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +316,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -308,7 +334,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -318,6 +343,9 @@ Accept wildcard characters: False ``` ### -SortOrder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SortOrder parameter specifies an array of message properties used to control the sort order of the result set. Separate each property by using a comma. Prepend a plus sign (+) symbol to the beginning of the property name to display the results in ascending order. Prepend a minus sign (-) symbol to the beginning of the property name to display the results in descending order. If you don't specify a sort order, the result set is displayed in ascending order by MessageIdentity integer. @@ -326,7 +354,6 @@ If you don't specify a sort order, the result set is displayed in ascending orde Type: QueueViewerSortOrderEntry[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageCategory.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageCategory.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-MessageCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageCategory.md index 6cebfc35f4..b459f539f4 100644 --- a/exchange/exchange-ps/exchange/Get-MessageCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageCategory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagecategory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MessageCategory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagecategory +schema: 2.0.0 +title: Get-MessageCategory --- # Get-MessageCategory @@ -44,13 +45,15 @@ This example retrieves message categories from the mailbox User1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the message category to be retrieved. ```yaml Type: MessageCategoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -68,7 +74,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -95,7 +103,6 @@ The Mailbox parameter specifies the mailbox that you want to view. You can use a Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageClassification.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageClassification.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-MessageClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageClassification.md index bfb6750a16..c2c3594d87 100644 --- a/exchange/exchange-ps/exchange/Get-MessageClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messageclassification applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MessageClassification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messageclassification +schema: 2.0.0 +title: Get-MessageClassification --- # Get-MessageClassification @@ -42,6 +43,9 @@ This example lists all message classifications in your organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the message classification that you want to view. You can use any value that uniquely identifies the message classification. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the message classification that you want to vie Type: MessageClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -72,7 +78,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -IncludeLocales + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeLocales switch specifies whether to return message classification locale information in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageTrace.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrace.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MessageTrace.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageTrace.md index fa030fd3a1..a364e80569 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrace.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrace.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetrace applicable: Exchange Online, Exchange Online Protection -title: Get-MessageTrace -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetrace +schema: 2.0.0 +title: Get-MessageTrace --- # Get-MessageTrace @@ -15,7 +16,7 @@ ms.reviewer: This cmdlet is available only in the cloud-based service. > [!NOTE] -> This cmdlet is replaced by the [Get-MessageTraceV2](https://learn.microsoft.com/powershell/module/exchange/get-messagetracev2) cmdlet and will eventually be deprecated. +> This cmdlet is replaced by the [Get-MessageTraceV2](https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetracev2) cmdlet and will eventually be deprecated. Use the Get-MessageTrace cmdlet to trace messages as they pass through the cloud-based organization. @@ -65,6 +66,9 @@ This example retrieves message trace information for messages sent by john@conto ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -73,7 +77,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,13 +86,15 @@ Accept wildcard characters: False ``` ### -FromIP + +> Applicable: Exchange Online, Exchange Online Protection + The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). The MessageTraceId value is also available in the output of the following cmdlets: @@ -129,7 +139,6 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -139,13 +148,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,13 +202,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,13 +220,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -227,7 +249,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -237,6 +258,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Online, Exchange Online Protection + The Status parameter filters the results by the delivery status of the message. Valid values for this parameter are: - None: The message has no delivery status because it was rejected or redirected to a different recipient. @@ -252,7 +276,6 @@ The Status parameter filters the results by the delivery status of the message. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -262,13 +285,15 @@ Accept wildcard characters: False ``` ### -ToIP + +> Applicable: Exchange Online, Exchange Online Protection + The ToIP parameter filters the results by the destination IP address. For outgoing messages, the value of ToIP is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetail.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MessageTraceDetail.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetail.md index 2053d79a67..86ce5348b6 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetail.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetail applicable: Exchange Online, Exchange Online Protection -title: Get-MessageTraceDetail -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetracedetail +schema: 2.0.0 +title: Get-MessageTraceDetail --- # Get-MessageTraceDetail @@ -15,7 +16,7 @@ ms.reviewer: This cmdlet is available only in the cloud-based service. > [!NOTE] -> This cmdlet is replaced by the [Get-MessageTraceDetailV2](https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetailv2) cmdlet and will eventually be deprecated. +> This cmdlet is replaced by the [Get-MessageTraceDetailV2](https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetracedetailv2) cmdlet and will eventually be deprecated. Use the Get-MessageTraceDetail cmdlet to view the message trace event details for a specific message. Note that these detailed results are returned less quickly than the Get-MessageTrace results. @@ -63,6 +64,9 @@ This example uses the Get-MessageTrace cmdlet to retrieve message trace informat ## PARAMETERS ### -MessageTraceId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). The MessageTraceId value is also available in the output of the following cmdlets: @@ -77,7 +81,6 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -111,7 +119,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -131,7 +141,6 @@ If don't use the StartDate and EndDate parameters, only data from the last 48 ho Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -141,6 +150,9 @@ Accept wildcard characters: False ``` ### -Event + +> Applicable: Exchange Online, Exchange Online Protection + The Event parameter filters the report by the message event. The following are examples of common events: - RECEIVE: The message was received by the service. @@ -157,7 +169,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Online, Exchange Online Protection + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,13 +196,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,13 +232,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -231,13 +250,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -247,6 +268,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -257,7 +281,6 @@ If don't use the StartDate and EndDate parameters, only data from the last 48 ho Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetailV2.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetailV2.md index 78e1a37969..0c9ae55a19 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceDetailV2.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetailv2 applicable: Exchange Online -title: Get-MessageTraceDetailV2 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetracedetailv2 +schema: 2.0.0 +title: Get-MessageTraceDetailV2 --- # Get-MessageTraceDetailV2 @@ -52,13 +53,15 @@ This example uses the Get-MessageTraceV2 cmdlet to retrieve message trace inform ## PARAMETERS ### -MessageTraceId + +> Applicable: Exchange Online + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 5 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online + The RecipientAddress parameter filters the results by the recipient's email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 6 @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -92,7 +100,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". @@ -112,7 +122,6 @@ If don't use the StartDate and EndDate parameters, only data from the last 48 ho Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Event + +> Applicable: Exchange Online + The Event parameter filters the report by the message event. The following are examples of common events: - RECEIVE: The message was received by the service. @@ -138,7 +150,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 3 @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Online + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 4 @@ -164,13 +177,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 7 @@ -180,6 +195,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". @@ -190,7 +208,6 @@ If don't use the StartDate and EndDate parameters, only data from the last 48 ho Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 8 diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceV2.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceV2.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-MessageTraceV2.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceV2.md index f356876da6..066f328ae0 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTraceV2.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTraceV2.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracev2 applicable: Exchange Online -title: Get-MessageTraceV2 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetracev2 +schema: 2.0.0 +title: Get-MessageTraceV2 --- # Get-MessageTraceV2 @@ -69,6 +70,9 @@ This example retrieves message trace information for messages sent by `john@cont ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". @@ -77,7 +81,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -FromIP + +> Applicable: Exchange Online + The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 2 @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Online + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 3 @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -MessageTraceId + +> Applicable: Exchange Online + The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). The MessageTraceId value is also available in the output of the following cmdlets: @@ -133,7 +143,6 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 4 @@ -143,13 +152,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 5 @@ -159,6 +170,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + The ResultSize parameter specifies the maximum number of results to return. A valid value is from 1 to 5000. The default value is 1000. **Note**: This parameter replaces the PageSize parameter that was available on the Get-MessageTrace cmdlet. @@ -167,7 +181,6 @@ The ResultSize parameter specifies the maximum number of results to return. A va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 6 @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 7 @@ -193,6 +208,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". @@ -201,7 +219,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 8 @@ -211,13 +228,15 @@ Accept wildcard characters: False ``` ### -StartingRecipientAddress + +> Applicable: Exchange Online + The StartingRecipientAddress parameter is used with the EndDate parameter to query subsequent data for partial results while avoiding duplication. Query subsequent data by taking the **Recipient address** and **Received Time** values of the last record of the partial results and using them as the values for the StartingRecipientAddress and EndDate parameters respectively in the next query. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 9 @@ -227,6 +246,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Online + The Status parameter filters the results by the delivery status of the message. Valid values are: - Delivered: The message was delivered to its destination. @@ -244,7 +266,6 @@ You can separate multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 10 @@ -254,6 +275,9 @@ Accept wildcard characters: False ``` ### -Subject + +> Applicable: Exchange Online + The Subject parameter filters the results by the subject of the message. If the value contains spaces, enclose the value in quotation marks ("). You specify how the value is evaluated in the message subject by using the SubjectFilterType parameter. @@ -262,7 +286,6 @@ You specify how the value is evaluated in the message subject by using the Subje Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 11 @@ -272,6 +295,9 @@ Accept wildcard characters: False ``` ### -SubjectFilterType + +> Applicable: Exchange Online + The SubjectFilterType parameter specifies how the value of the Subject parameter is evaluated. Valid values are: - Contains @@ -284,7 +310,6 @@ We recommend using StartsWith or EndsWith instead of Contains whenever possible. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 12 @@ -294,13 +319,15 @@ Accept wildcard characters: False ``` ### -ToIP + +> Applicable: Exchange Online + The ToIP parameter filters the results by the destination IP address. For outgoing messages, the value of ToIP is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 13 diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingLog.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MessageTrackingLog.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingLog.md index 877d2fd0a3..b31a70814c 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetrackinglog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MessageTrackingLog -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetrackinglog +schema: 2.0.0 +title: Get-MessageTrackingLog --- # Get-MessageTrackingLog @@ -74,6 +75,9 @@ This example searches the message tracking logs on the Mailbox server named Mail ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -82,7 +86,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -End + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The End parameter specifies the end date and time of the date range. Message delivery information is returned up to, but not including, the specified date and time. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -100,7 +106,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -EventId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EventId parameter filters the message tracking log entries by the value of the EventId field. The EventId value classifies each message event. Example values include DSN, Defer, Deliver, Send, or Receive. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -InternalMessageId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalMessageId parameter filters the message tracking log entries by the value of the InternalMessageId field. The InternalMessageId value is a message identifier that's assigned by the Exchange server that's currently processing the message. The value of the internal-message-id for a specific message is different in the message tracking log of every Exchange server that's involved in the delivery of the message. @@ -134,7 +144,6 @@ The value of the internal-message-id for a specific message is different in the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageId parameter filters the message tracking log entries by the value of the MessageId field. The value of MessageId corresponds to the value of the Message-Id: header field in the message. If the Message-ID header field is blank or doesn't exist, an arbitrary value is assigned. Be sure to include the full MessageId string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -MessageSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageSubject parameter filters the message tracking log entries by the value of the message subject. The value of the MessageSubject parameter automatically supports partial matches without using wildcards or special characters. For example, if you specify the MessageSubject value sea, the results include messages with Seattle in the subject. By default, message subjects are stored in the message tracking logs. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -176,13 +189,15 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Recipients parameter filters the message tracking log entries by the SMTP email address of the message recipients. Multiple recipients in a single message are logged in a single message tracking log entry. Unexpanded distribution group recipients are logged by using the group's SMTP email address. You can specify multiple recipients using an array of email addresses. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,13 +207,15 @@ Accept wildcard characters: False ``` ### -Reference + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Reference parameter filters the message tracking log entries by the value of the Reference field. The Reference field contains additional information for specific types of events. For example, the Reference field value for a DSN message tracking entry contains the InternalMessageId value of the message that caused the DSN. For many types of events, the value of Reference is blank. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,13 +225,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,13 +243,15 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Sender parameter filters the message tracking log entries by the sender's SMTP email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -240,6 +261,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -253,7 +277,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,6 +286,9 @@ Accept wildcard characters: False ``` ### -Start + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Start parameter specifies the start date and time of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -271,7 +297,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,13 +306,15 @@ Accept wildcard characters: False ``` ### -NetworkMessageId + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The NetworkMessageId parameter filters the message tracking log entries by the value of the NetworkMessageId field. This field contains a unique message ID value that persists across copies of the message that may be created due to bifurcation or distribution group expansion. An example value is 1341ac7b13fb42ab4d4408cf7f55890f. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,13 +324,15 @@ Accept wildcard characters: False ``` ### -Source + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Source parameter filters the message tracking log entries by the value of the Source field. These values indicate the transport component that's responsible for the message tracking event. For more information, see [Source values in the message tracking log](https://learn.microsoft.com/Exchange/mail-flow/transport-logs/message-tracking#source-values-in-the-message-tracking-log). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,13 +342,15 @@ Accept wildcard characters: False ``` ### -TransportTrafficType + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The TransportTrafficType parameter filters the message tracking log entries by the value of the TransportTrafficType field. However, this field isn't interesting for on-premises Exchange organizations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingReport.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-MessageTrackingReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingReport.md index fe0eb16c93..6ab8dab4b6 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MessageTrackingReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetrackingreport applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MessageTrackingReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetrackingreport +schema: 2.0.0 +title: Get-MessageTrackingReport --- # Get-MessageTrackingReport @@ -38,7 +39,7 @@ Get-MessageTrackingReport [-Identity] ``` ## DESCRIPTION -This cmdlet requires the ID for the message tracking report that you want to view. Therefore, first you need to use the Search-MessageTrackingReport cmdlet to find the message tracking report ID for a specific message, and then pass the results to this cmdlet. For more information, see [Search-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchange/search-messagetrackingreport). +This cmdlet requires the ID for the message tracking report that you want to view. Therefore, first you need to use the Search-MessageTrackingReport cmdlet to find the message tracking report ID for a specific message, and then pass the results to this cmdlet. For more information, see [Search-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchangepowershell/search-messagetrackingreport). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -67,6 +68,9 @@ This example searches the message tracking data for the specific message trackin ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the message tracking report ID that you want to view. You need to run the Search-MessageTrackingReport cmdlet to find the message tracking report ID for the specific message that you're tracking, and then pass the value of the MessageTrackingReportID field to this parameter. @@ -75,7 +79,6 @@ You need to run the Search-MessageTrackingReport cmdlet to find the message trac Type: MessageTrackingReportId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -BypassDelegateChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BypassDelegateChecking switch allows Help desk staff and administrators to retrieve message tracking reports for any user. You don't need to specify a value with this switch. By default, each user can only see the message tracking reports for messages that they send or receive from their own mailbox. When you use this switch, you can view the message tracking reports for message exchanges among other users. @@ -93,7 +99,6 @@ By default, each user can only see the message tracking reports for messages tha Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -DetailLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DetailLevel parameter specifies the amount of detail to return in the results. Valid values are: - Basic: Simple delivery report information is returned, which is more appropriate for users. @@ -112,7 +120,6 @@ The DetailLevel parameter specifies the amount of detail to return in the result Type: MessageTrackingDetailLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -DoNotResolve + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DoNotResolve switch specifies whether to prevent the resolution of email addresses to display names. You don't need to specify a value with this switch. Using this switch improves performance, but the lack of display names might make the results more difficult to interpret. @@ -146,7 +158,6 @@ Using this switch improves performance, but the lack of display names might make Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -156,13 +167,15 @@ Accept wildcard characters: False ``` ### -RecipientPathFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientPathFilter parameter specifies the email address of the recipient when you use the ReportTemplate parameter with the value RecipientPath. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Recipients parameter specifies the email addresses of the recipients when you use the ReportTemplate parameter with the value Summary. You can specify multiple email addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,6 +203,9 @@ Accept wildcard characters: False ``` ### -ReportTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReportTemplate parameter specifies a predefined format for the output. Valid values are: - RecipientPath: Returns a detailed tracking report for one recipient of the message. You specify the recipient by using the RecipientPathFilter parameter. @@ -197,7 +215,6 @@ The ReportTemplate parameter specifies a predefined format for the output. Valid Type: ReportTemplate Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -207,13 +224,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -223,6 +242,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Status parameter filters the results by the specified delivery status codes. Valid values are: - Delivered @@ -235,7 +257,6 @@ The Status parameter filters the results by the specified delivery status codes. Type: _DeliveryStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -245,6 +266,9 @@ Accept wildcard characters: False ``` ### -TraceLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -257,7 +281,6 @@ You only need to use this parameter for troubleshooting message tracking issues. Type: TraceLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationBatch.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationBatch.md index ecc0d0aa97..0739a81f91 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationBatch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationBatch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationbatch +schema: 2.0.0 +title: Get-MigrationBatch --- # Get-MigrationBatch @@ -100,6 +101,9 @@ This example displays information about all migration batches associated with th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter identifies the name of the current migration batch. The value for this parameter is specified by the Name parameter of the New-MigrationBatch cmdlet. If you use this parameter, you can't include the Endpoint parameter. @@ -108,7 +112,6 @@ If you use this parameter, you can't include the Endpoint parameter. Type: MigrationBatchIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -128,7 +134,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: Identity, BatchesFromEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -146,7 +154,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: Identity, BatchesFromEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +163,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: @@ -184,7 +194,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -194,6 +203,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -202,7 +214,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Identity, BatchesFromEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +223,9 @@ Accept wildcard characters: False ``` ### -Endpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Endpoint parameter returns a list of migration batches associated with the specified migration endpoint. If you use this parameter, you can't include the Identity parameter. @@ -220,7 +234,6 @@ If you use this parameter, you can't include the Identity parameter. Type: MigrationEndpointIdParameter Parameter Sets: BatchesFromEndpoint, BatchesByEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +243,9 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeReport switch returns additional information about the specified migration batch. You don't need to specify a value with this switch. This information is displayed in the Report field. @@ -238,7 +254,6 @@ This information is displayed in the Report field. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -248,6 +263,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -256,7 +274,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -266,6 +283,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -274,7 +294,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -284,6 +303,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Status parameter returns a list of migration batches that have the specified status state. Use one of the following values: - Completed @@ -306,7 +328,6 @@ The Status parameter returns a list of migration batches that have the specified Type: MMigrationBatchStatus Parameter Sets: Identity, BatchesFromEndpoint, BatchesByStatus Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MigrationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-MigrationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationConfig.md index 1d8997faf8..6129685733 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationconfig +schema: 2.0.0 +title: Get-MigrationConfig --- # Get-MigrationConfig @@ -55,6 +56,9 @@ This example retrieves the settings for the migration configuration. ## PARAMETERS ### -AllPartitions + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AllPartitions Description }} @@ -63,7 +67,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: AllPartitions Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -81,7 +87,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -IncludeSimplifiedGmailMigrationData + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeSimplifiedGmailMigrationData Description }} @@ -99,7 +107,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Partition, AllPartitions Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -117,7 +127,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: Partition Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationEndpoint.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MigrationEndpoint.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationEndpoint.md index 8f8f5dd3c9..44e621ed39 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationEndpoint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationendpoint applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationEndpoint -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationendpoint +schema: 2.0.0 +title: Get-MigrationEndpoint --- # Get-MigrationEndpoint @@ -80,13 +81,15 @@ This example retrieves the settings for the migration endpoint, OnboardingME01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the migration endpoint you want to retrieve settings for. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -ConnectionSettings + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConnectionSettings parameter specifies the configuration settings of source or target servers for which you want to find a matching endpoint. @@ -104,7 +110,6 @@ The ConnectionSettings parameter specifies the configuration settings of source Type: ExchangeConnectionSettings Parameter Sets: ConnectionSettingsFilter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -124,7 +132,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -142,7 +152,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: @@ -180,7 +192,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -190,6 +201,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -198,7 +212,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,6 +221,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -216,7 +232,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -226,6 +241,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Type parameter filters the results by the type of migration. Valid values for this parameter are: - ExchangeOutlookAnywhere: Cutover or staged Exchange migrations @@ -237,7 +255,6 @@ The Type parameter filters the results by the type of migration. Valid values fo Type: MigrationType Parameter Sets: TypeFilter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MigrationStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationStatistics.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MigrationStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationStatistics.md index c397c884ee..a039591098 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationstatistics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationstatistics +schema: 2.0.0 +title: Get-MigrationStatistics --- # Get-MigrationStatistics @@ -44,6 +45,9 @@ This example returns the default statistics for the migration batches. ## PARAMETERS ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -54,7 +58,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -72,7 +78,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: @@ -110,7 +118,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -128,7 +138,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -146,7 +158,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MigrationUser.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationUser.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-MigrationUser.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationUser.md index e379851050..3539caf558 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationuser applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationuser +schema: 2.0.0 +title: Get-MigrationUser --- # Get-MigrationUser @@ -96,13 +97,15 @@ This example retrieves more detailed information about any ongoing migration for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the particular ongoing migration that you want to retrieve information about. The Identity parameter is usually represented as an email address. ```yaml Type: MigrationUserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -112,13 +115,15 @@ Accept wildcard characters: False ``` ### -MailboxGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailboxGuid parameter specifies the GUID of a mailbox for which you want to view the migration information. ```yaml Type: Guid Parameter Sets: MailboxGuid Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -128,13 +133,15 @@ Accept wildcard characters: False ``` ### -BatchId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchId parameter specifies the name of the migration batch for which you want to return users. ```yaml Type: MigrationBatchIdParameter Parameter Sets: StatusAndBatchId Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -152,7 +162,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,13 +171,15 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Exchange Online + The EmailAddress parameter specifies the particular user that you want to retrieve information about. The EmailAddress parameter is represented as an email address. This parameter is available only in the cloud-based service. ```yaml Type: EmailAddress Parameter Sets: EmailAddress Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -178,6 +189,9 @@ Accept wildcard characters: False ``` ### -IncludeAssociatedUsers + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeAssociatedUsers Description }} @@ -186,7 +200,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -204,7 +220,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -214,13 +229,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +247,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Status parameter returns information about migration users that have the specified status state. Use one of the following values: - Completed @@ -258,7 +278,6 @@ The Status parameter returns information about migration users that have the spe Type: MigrationUserStatus Parameter Sets: StatusAndBatchId Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -268,6 +287,9 @@ Accept wildcard characters: False ``` ### -StatusSummary + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StatusSummary parameter returns abbreviated information about migration users that have the specified status value. Use one of the following values: - Active @@ -280,7 +302,6 @@ The StatusSummary parameter returns abbreviated information about migration user Type: MigrationUserStatusSummary Parameter Sets: StatusAndBatchId Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationUserStatistics.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MigrationUserStatistics.md index 5e64b3de72..98b51272c1 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MigrationUserStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationuserstatistics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MigrationUserStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-migrationuserstatistics +schema: 2.0.0 +title: Get-MigrationUserStatistics --- # Get-MigrationUserStatistics @@ -85,13 +86,15 @@ In on-premises Exchange, this example uses the Diagnostic parameter to display d ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the user that you want to retrieve migration information about. Use an email address as the value for this parameter. ```yaml Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -111,7 +117,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -129,7 +137,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -147,7 +157,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -165,7 +177,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -IncludeCopilotReport + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeCopilotReport Description }} @@ -183,7 +197,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -193,13 +206,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -IncludeSkippedItems + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeSkippedItems switch specifies whether to include skipped items for the user. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -225,13 +242,15 @@ Accept wildcard characters: False ``` ### -LimitSkippedItemsTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LimitSkippedItemsTo parameter specifies the maximum number of skipped items to display information about in the SkippedItems property in command output. For example, if this parameter is set to 5, the cmdlet returns information for up to five skipped items for the specified user, even if there are more than five skipped items. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -241,6 +260,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -249,7 +271,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -259,13 +280,15 @@ Accept wildcard characters: False ``` ### -SkipSubscription + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipSubscription switch specifies whether to skip loading the subscription for the user. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MobileDevice.md b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDevice.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-MobileDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MobileDevice.md index 7da6e04fbb..f0dcc63610 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDevice.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mobiledevice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MobileDevice -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mobiledevice +schema: 2.0.0 +title: Get-MobileDevice --- # Get-MobileDevice @@ -83,6 +84,9 @@ This example returns detailed information about the specified device on Lila's m ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mobile device that you want to view. You can use the following values that uniquely identifies the mobile device: - Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) @@ -93,7 +97,6 @@ The Identity parameter specifies the mobile device that you want to view. You ca Type: MobileDeviceIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter filters the results by mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -122,7 +128,6 @@ You can't use this parameter with the Identity parameter. Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -132,13 +137,15 @@ Accept wildcard characters: False ``` ### -ActiveSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -148,6 +155,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -156,7 +166,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -202,7 +214,6 @@ You can filter by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +223,9 @@ Accept wildcard characters: False ``` ### -Monitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch. @@ -222,7 +236,6 @@ Monitoring mailboxes are associated with managed availability and the Exchange H Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -232,6 +245,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -243,7 +259,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -253,13 +268,15 @@ Accept wildcard characters: False ``` ### -OWAforDevices + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAforDevices switch filters the results by whether Outlook on the web for devices is enabled for the device. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -269,13 +286,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -285,6 +304,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -311,7 +333,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -321,13 +342,15 @@ Accept wildcard characters: False ``` ### -RestApi + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -337,13 +360,15 @@ Accept wildcard characters: False ``` ### -UniversalOutlook + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceMailboxPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceMailboxPolicy.md index 5a1d4c078b..61bdb004a8 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mobiledevicemailboxpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MobileDeviceMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mobiledevicemailboxpolicy +schema: 2.0.0 +title: Get-MobileDeviceMailboxPolicy --- # Get-MobileDeviceMailboxPolicy @@ -50,13 +51,15 @@ This example returns the policy settings for the Mobile Device mailbox policy De ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the policy name. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -74,7 +80,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceStatistics.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceStatistics.md index d493f60367..9e800bcd46 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MobileDeviceStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mobiledevicestatistics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MobileDeviceStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mobiledevicestatistics +schema: 2.0.0 +title: Get-MobileDeviceStatistics --- # Get-MobileDeviceStatistics @@ -87,6 +88,9 @@ This example retrieves the statistics for the mobile phone that's configured to ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mobile device that you want to view. You can use the following values that uniquely identifies the mobile device: - Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) @@ -99,7 +103,6 @@ You can't use this parameter with the Mailbox parameter. Type: MobileDeviceIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter filters the results by the user mailbox that's associated with the mobile device. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -128,7 +134,6 @@ You can't use this parameter with the Identity parameter. Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -138,13 +143,15 @@ Accept wildcard characters: False ``` ### -ActiveSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,6 +161,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -162,7 +172,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +181,15 @@ Accept wildcard characters: False ``` ### -GetMailboxLog + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The GetMailboxLog switch specifies whether to send the mobile device statistics to the email addresses that are specified by the NotificationEmailAddresses parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,6 +199,9 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NotificationEmailAddresses parameter specifies a comma-separated list of email addresses to receive the mobile device statistics when you use the GetMailboxLog switch. This parameter is meaningful only if you also use the GetMailboxLog switch in the same command. @@ -196,7 +210,6 @@ This parameter is meaningful only if you also use the GetMailboxLog switch in th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -206,13 +219,15 @@ Accept wildcard characters: False ``` ### -OWAforDevices + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAforDevices switch filters the results by devices where Outlook on the web for devices is enabled. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -222,13 +237,15 @@ Accept wildcard characters: False ``` ### -ShowRecoveryPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowRecoveryPassword switch specifies whether to return the recovery password for the mobile device as one of the displayed statistics. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -238,13 +255,15 @@ Accept wildcard characters: False ``` ### -RestApi + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -254,13 +273,15 @@ Accept wildcard characters: False ``` ### -UniversalOutlook + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -270,6 +291,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -278,7 +302,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md b/exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemHelp.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemHelp.md index b720090806..d7d517597e 100644 --- a/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemHelp.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-monitoringitemhelp applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MonitoringItemHelp -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-monitoringitemhelp +schema: 2.0.0 +title: Get-MonitoringItemHelp --- # Get-MonitoringItemHelp @@ -40,13 +41,15 @@ This example retrieves health set information for a monitoring item on the serve ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the monitoring item. The parameter uses the syntax: `\[\]`. You can find the available values in the Identity property of the output of the Get-MonitoringItem cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -56,6 +59,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that contains the monitoring item. You can use any value that uniquely identifies the server. For example: - Name @@ -67,7 +73,6 @@ The Server parameter specifies the Exchange server that contains the monitoring Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md b/exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemIdentity.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemIdentity.md index 993413da94..ca5cfa71ed 100644 --- a/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MonitoringItemIdentity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-monitoringitemidentity applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-MonitoringItemIdentity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-monitoringitemidentity +schema: 2.0.0 +title: Get-MonitoringItemIdentity --- # Get-MonitoringItemIdentity @@ -40,13 +41,15 @@ This example returns information about the health set named OutlookMapiHttp.Prox ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the health set that you want to view. To see the list of available health sets, you can use the Get-ServerHealth or Get-HealthReport cmdlets. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -56,6 +59,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that contains the health set. You can use any value that uniquely identifies the server. For example: - Name @@ -67,7 +73,6 @@ The Server parameter specifies the Exchange server that contains the health set. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-MoveRequest.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MoveRequest.md index 9bd1b19333..b38430ed75 100644 --- a/exchange/exchange-ps/exchange/Get-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-moverequest +schema: 2.0.0 +title: Get-MoveRequest --- # Get-MoveRequest @@ -88,6 +89,9 @@ This example retrieves the status of move requests in the FromDB01ToDB02 batch t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the move request, which is the identity of the mailbox or mail user. You can use any value that uniquely identifies the mailbox or mail user. For example: - Name @@ -118,7 +122,6 @@ You can use this parameter with the following parameters: Type: MoveRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -128,6 +131,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter specifies the name that was given to a batch move request. You can't use this parameter with the Identity parameter. @@ -136,7 +142,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,6 +151,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -156,7 +164,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +173,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -174,7 +184,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +193,9 @@ Accept wildcard characters: False ``` ### -Flags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Flags parameter specifies the move type to retrieve information for. The following values may be used: - CrossOrg @@ -207,7 +219,6 @@ The Flags parameter specifies the move type to retrieve information for. The fol Type: RequestFlags Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -217,6 +228,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The HighPriority parameter specifies that the cmdlet returns requests that were created with the HighPriority flag. The HighPriority flag indicates that the request should be processed before other lower priority requests in the queue. @@ -227,7 +241,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,6 +250,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedObjects + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IncludeSoftDeletedObjects parameter specifies whether to return mailboxes that have been soft deleted. This parameter accepts $true or $false. @@ -245,7 +261,6 @@ The IncludeSoftDeletedObjects parameter specifies whether to return mailboxes th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +270,9 @@ Accept wildcard characters: False ``` ### -MoveStatus + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MoveStatus parameter returns move requests in the specified status. You can use the following values: - AutoSuspended @@ -273,7 +291,6 @@ You can't use this parameter with the Identity parameter. Type: RequestStatus Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -283,6 +300,9 @@ Accept wildcard characters: False ``` ### -Offline + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Offline parameter specifies whether to return mailboxes that are being moved in offline mode. This parameter accepts $true or $false. You can't use this parameter with the Identity parameter. @@ -291,7 +311,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -301,6 +320,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -312,7 +334,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,6 +343,9 @@ Accept wildcard characters: False ``` ### -Protect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Protect parameter returns mailboxes being moved in protected mode. This parameter accepts $true or $false. @@ -332,7 +356,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -342,6 +365,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter filters the results by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -361,7 +387,6 @@ The ProxyToMailbox parameter filters the results by the location of the specifie Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -371,6 +396,9 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. You can't use this parameter with the Identity parameter. @@ -379,7 +407,6 @@ You can't use this parameter with the Identity parameter. Type: Fqdn Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -389,13 +416,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -405,6 +434,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -419,7 +451,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -429,6 +460,9 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SourceDatabase parameter returns all mailboxes that are being moved from the specified source mailbox database. You can use any value that uniquely identifies the database. For example: @@ -443,7 +477,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -453,6 +486,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Status parameter filters the results by status. Valid values are: @@ -473,7 +509,6 @@ The Status parameter filters the results by status. Valid values are: Type: RequestStatus Parameter Sets: Filtering Aliases: MoveStatus -Applicable: Exchange Online Required: False Position: Named @@ -483,6 +518,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Suspend parameter specifies whether to return mailboxes with moves that have been suspended. This parameter accepts $true or $false. You can't use this parameter with the Identity parameter. @@ -491,7 +529,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -501,6 +538,9 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendWhenReadytoComplete parameter specifies whether to return mailboxes that have been moved with the New-MoveRequest command and its SuspendWhenReadyToComplete switch. This parameter accepts $true or $false. You can't use this parameter with the Identity parameter. @@ -509,7 +549,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -519,6 +558,9 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The TargetDatabase parameter returns all mailboxes that are being moved to the specified target mailbox database. You can use any value that uniquely identifies the database. For example: @@ -533,7 +575,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-MoveRequestStatistics.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MoveRequestStatistics.md index 8f312cf0ae..68320eaf70 100644 --- a/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MoveRequestStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-moverequeststatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-MoveRequestStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-moverequeststatistics +schema: 2.0.0 +title: Get-MoveRequestStatistics --- # Get-MoveRequestStatistics @@ -115,6 +116,9 @@ This example exports the move request information so you can later import it int ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use one of the following values: - GUID @@ -131,7 +135,6 @@ You can use this parameter with the MoveRequestQueue or MailboxGuid parameters. Type: MoveRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -141,6 +144,9 @@ Accept wildcard characters: False ``` ### -MoveRequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is for debugging purposes only. @@ -157,7 +163,6 @@ You can't use this parameter with the Identity or MRSInstance parameters. Type: DatabaseIdParameter Parameter Sets: MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -167,6 +172,9 @@ Accept wildcard characters: False ``` ### -MRSInstance + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSInstance parameter specifies the fully qualified domain name (FQDN) of the Client Access server on which the Microsoft Exchange Mailbox Replication service (MRS) resides. When using this parameter, all records are returned for this instance of MRS. @@ -177,7 +185,6 @@ You can't use this parameter with the Identity or MoveRequestQueue parameters. Type: Fqdn Parameter Sets: MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -187,6 +194,9 @@ Accept wildcard characters: False ``` ### -Analysis + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Analysis Description }} @@ -195,7 +205,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -205,6 +214,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -215,7 +227,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +236,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -233,7 +247,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: IdentityOnPremises, MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,6 +256,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: @@ -255,7 +271,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -265,6 +280,9 @@ Accept wildcard characters: False ``` ### -DiagnosticOnly + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DiagnosticOnly Description }} @@ -273,7 +291,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -283,6 +300,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -291,7 +311,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: IdentityOnPremises, MigrationMoveRequestQueue, MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -301,13 +320,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -317,6 +338,9 @@ Accept wildcard characters: False ``` ### -MailboxGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MailboxGuid parameter specifies the GUID of a mailbox for which you want to view the move request statistics. @@ -327,7 +351,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationMoveRequestQueue, MigrationMRSInstance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -337,6 +360,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter filters the results by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -356,7 +382,6 @@ The ProxyToMailbox parameter filters the results by the location of the specifie Type: MailboxIdParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -366,13 +391,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: IdentityOnPremises, IdentityCloud, MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MxRecordReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-MxRecordReport.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-MxRecordReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MxRecordReport.md index 1600495130..381a4bd6ca 100644 --- a/exchange/exchange-ps/exchange/Get-MxRecordReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MxRecordReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mxrecordreport applicable: Exchange Online, Exchange Online Protection -title: Get-MxRecordReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-mxrecordreport +schema: 2.0.0 +title: Get-MxRecordReport --- # Get-MxRecordReport @@ -41,13 +42,15 @@ This example shows the MX record information for the contoso.com domain. ## PARAMETERS ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter specifies the domain you want to test. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -57,13 +60,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-MyAnalyticsFeatureConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-MyAnalyticsFeatureConfig.md index ad5461513b..9e84a9bb8b 100644 --- a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-MyAnalyticsFeatureConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-myanalyticsfeatureconfig applicable: Exchange Online -title: Get-MyAnalyticsFeatureConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-myanalyticsfeatureconfig +schema: 2.0.0 +title: Get-MyAnalyticsFeatureConfig --- # Get-MyAnalyticsFeatureConfig @@ -60,13 +61,15 @@ This example and the corresponding output shows the MyAnalytics configuration fo ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user you want to view. You identify the user by their email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md b/exchange/exchange-ps/ExchangePowerShell/Get-NetworkConnectionInfo.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md rename to exchange/exchange-ps/ExchangePowerShell/Get-NetworkConnectionInfo.md index 3b753febcb..f7b4de2bb8 100644 --- a/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-NetworkConnectionInfo.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-networkconnectioninfo applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-NetworkConnectionInfo -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-networkconnectioninfo +schema: 2.0.0 +title: Get-NetworkConnectionInfo --- # Get-NetworkConnectionInfo @@ -49,6 +50,9 @@ This example retrieves network configuration information for all network adapter ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server you want to query. You can use any value that uniquely identifies the server. For example: - Name @@ -62,7 +66,6 @@ If you don't use the Identity parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -80,7 +86,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Notification.md b/exchange/exchange-ps/ExchangePowerShell/Get-Notification.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-Notification.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Notification.md index a354e891db..56c6a50bb9 100644 --- a/exchange/exchange-ps/exchange/Get-Notification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Notification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-notification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-Notification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-notification +schema: 2.0.0 +title: Get-Notification --- # Get-Notification @@ -83,13 +84,15 @@ This example displays detailed information for the specified notification event. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the notification event that you want to view. You identify the notification event by its AlternativeID property value (a GUID). You can find this value by running the command Get-Notification | Format-List DisplayName,AlternateID,StartTime,Status,Type. ```yaml Type: EwsStoreObjectIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Settings + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Settings switch includes the ProcessType and NotificationEmail property values in the results. You don't need to specify a value with this switch. @@ -111,7 +117,6 @@ You can't use this switch with the Summary switch. Type: SwitchParameter Parameter Sets: Settings Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -129,7 +137,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -ProcessType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ProcessType parameter filters the results by the type of notification event. Valid values are: - CertExpiry @@ -149,9 +159,8 @@ The ProcessType parameter filters the results by the type of notification event. ```yaml Type: AsyncOperationType -Parameter Sets: Settings +Parameter Sets: Settings, Filter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -160,27 +169,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: AsyncOperationType -Parameter Sets: Filter -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -ResultSize -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -ResultSize The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -190,6 +188,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -198,7 +199,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,6 +208,9 @@ Accept wildcard characters: False ``` ### -Summary + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Summary switch includes only the ProcessType and Status property values in the results. You don't need to specify a value with this switch. You can't use this switch with the Settings switch. @@ -216,7 +219,6 @@ You can't use this switch with the Settings switch. Type: SwitchParameter Parameter Sets: Identity, Filter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OMEConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-OMEConfiguration.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-OMEConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OMEConfiguration.md index 801c20e7db..a949238598 100644 --- a/exchange/exchange-ps/exchange/Get-OMEConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OMEConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-omeconfiguration applicable: Exchange Online, Exchange Online Protection -title: Get-OMEConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-omeconfiguration +schema: 2.0.0 +title: Get-OMEConfiguration --- # Get-OMEConfiguration @@ -47,13 +48,15 @@ This example returns detailed information for all OME configurations in the orga ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the OME configuration that you want to get. The default OME configuration has the Identity value "OME Configuration". ```yaml Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md b/exchange/exchange-ps/ExchangePowerShell/Get-OMEMessageStatus.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-OMEMessageStatus.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OMEMessageStatus.md index 1162642bbb..336fa65242 100644 --- a/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OMEMessageStatus.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-omemessagestatus applicable: Exchange Online -title: Get-OMEMessageStatus -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-omemessagestatus +schema: 2.0.0 +title: Get-OMEMessageStatus --- # Get-OMEMessageStatus @@ -42,6 +43,9 @@ This example returns the encryption revocation status for the specified message. ## PARAMETERS ### -MessageId + +> Applicable: Exchange Online + The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft Purview compliance portal. @@ -50,7 +54,6 @@ You can find the Message ID for a message in Message Trace or the Message Encryp Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-OabVirtualDirectory.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OabVirtualDirectory.md index 274bd7b330..7833b1e3f6 100644 --- a/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OabVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-oabvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OabVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-oabvirtualdirectory +schema: 2.0.0 +title: Get-OabVirtualDirectory --- # Get-OabVirtualDirectory @@ -67,6 +68,9 @@ This example returns detailed information for the OAB virtual directory named "O ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the OAB virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -81,7 +85,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -104,7 +110,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -122,7 +130,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -158,7 +170,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/Get-OfflineAddressBook.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OfflineAddressBook.md index dbf02a696b..ff9c978f2a 100644 --- a/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OfflineAddressBook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OfflineAddressBook -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-offlineaddressbook +schema: 2.0.0 +title: Get-OfflineAddressBook --- # Get-OfflineAddressBook @@ -65,6 +66,9 @@ This example returns specific properties for all existing OABs, including the Ge ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the OAB that you want to view. You can use any value that uniquely identifies the OAB. For example: - Name or \\Name @@ -77,7 +81,6 @@ You can't use this parameter with the Server parameter. Type: OfflineAddressBookIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. **Note**: This parameter isn't relevant in Exchange 2013 or later. The Server property for an OAB is blank, because the OAB is generated by an arbitration mailbox. @@ -105,7 +111,6 @@ You can't use this parameter with the Identity parameter. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -123,7 +131,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md b/exchange/exchange-ps/ExchangePowerShell/Get-OnPremisesOrganization.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OnPremisesOrganization.md index 18d268514c..14db290342 100644 --- a/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OnPremisesOrganization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-onpremisesorganization applicable: Exchange Online, Exchange Online Protection -title: Get-OnPremisesOrganization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-onpremisesorganization +schema: 2.0.0 +title: Get-OnPremisesOrganization --- # Get-OnPremisesOrganization @@ -51,6 +52,9 @@ This example retrieves the on-premises organization settings by using the FQDN o ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - Canonical name @@ -61,7 +65,6 @@ The Identity parameter specifies the identity of the on-premises organization ob Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Get-OnlineMeetingConfiguration.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OnlineMeetingConfiguration.md index 57d2252911..7a988d46c5 100644 --- a/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OnlineMeetingConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-onlinemeetingconfiguration applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OnlineMeetingConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-onlinemeetingconfiguration +schema: 2.0.0 +title: Get-OnlineMeetingConfiguration --- # Get-OnlineMeetingConfiguration @@ -48,6 +49,9 @@ This example gets the Skype Meetings configuration for the specified mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OrganizationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-OrganizationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OrganizationConfig.md index 0d00218842..002af611d2 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-OrganizationConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-organizationconfig +schema: 2.0.0 +title: Get-OrganizationConfig --- # Get-OrganizationConfig @@ -60,6 +61,9 @@ If the value of EwsApplicationAccessPolicy is EnforceBlockList, all applications ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -70,7 +74,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationRelationship.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-OrganizationRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OrganizationRelationship.md index 0c2f80f334..3207111a9e 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationRelationship.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationrelationship applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-OrganizationRelationship -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-organizationrelationship +schema: 2.0.0 +title: Get-OrganizationRelationship --- # Get-OrganizationRelationship @@ -48,6 +49,9 @@ This example retrieves the organization relationship settings by using the FQDN ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the organizational relationship. You can use the following values: - Canonical name @@ -58,7 +62,6 @@ The Identity parameter specifies the identity of the organizational relationship Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -76,7 +82,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationSegment.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-OrganizationSegment.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OrganizationSegment.md index 12687a5a45..3d309fe6b7 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationSegment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationsegment applicable: Security & Compliance -title: Get-OrganizationSegment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-organizationsegment +schema: 2.0.0 +title: Get-OrganizationSegment --- # Get-OrganizationSegment @@ -55,6 +56,9 @@ This example returns detailed information about the organization segment named E ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the organization segment that you want to view. You can use a value that uniquely identifies the segment. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the organization segment that you want to view. Type: PolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -89,4 +92,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-OrganizationalUnit.md b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationalUnit.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-OrganizationalUnit.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OrganizationalUnit.md index 01e951b29f..b624cd2c69 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationalUnit.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OrganizationalUnit.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationalunit applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OrganizationalUnit -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-organizationalunit +schema: 2.0.0 +title: Get-OrganizationalUnit --- # Get-OrganizationalUnit @@ -67,6 +68,9 @@ For more information about pipelining and the Format-Table cmdlet, see [About Pi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the OU or domain that you want to view. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -80,7 +84,6 @@ You can use this parameter with the SearchText parameter. Type: ExtendedOrganizationalUnitIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +104,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -IncludeContainers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeContainers switch instructs the command to return containers in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -SingleNodeOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SingleNodeOnly switch instructs the command to return only the first level child OUs beneath the OU specified in the Identity parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -SearchText + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SearchText parameter enables you to search the names of all OUs in your organization for the specified string. Only the OUs that match the string you specify are returned. If the string you specify contains spaces, enclose it in quotation marks ("). You can't use this parameter with the Identity parameter. @@ -164,7 +178,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Search Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnector.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-OutboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnector.md index ef832c3069..49cbedd76e 100644 --- a/exchange/exchange-ps/exchange/Get-OutboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-outboundconnector applicable: Exchange Online, Exchange Online Protection -title: Get-OutboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-outboundconnector +schema: 2.0.0 +title: Get-OutboundConnector --- # Get-OutboundConnector @@ -45,6 +46,9 @@ This example displays detailed information about the Outbound connector named Co ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Outbound connector that you want to view. You can use any value that uniquely identifies the connector. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the Outbound connector that you want to view. Y Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -IncludeTestModeConnectors + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeTestModeConnectors parameter filters the results by Outbound connectors that are in test mode. Valid values are: - $true: Only Outbound connectors that are in test mode are returned in the results. @@ -76,7 +82,6 @@ You configure an Outbound connector in test mode by using the TestMode parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -IsTransportRuleScoped + +> Applicable: Exchange Online, Exchange Online Protection + The IsTransportRuleScoped parameter filters the results by Outbound connectors that are scoped to transport rules (also known as mail flow rules). Valid values are: - $true: Only Outbound connectors that are scoped to transport rules are returned in the results. @@ -97,7 +105,6 @@ You scope a transport rule to a specific Outbound connector by using the RouteMe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnectorReport.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnectorReport.md index a111c53994..17040b63b4 100644 --- a/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OutboundConnectorReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-outboundconnectorreport applicable: Exchange Online, Exchange Online Protection -title: Get-OutboundConnectorReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-outboundconnectorreport +schema: 2.0.0 +title: Get-OutboundConnectorReport --- # Get-OutboundConnectorReport @@ -41,13 +42,15 @@ This example shows the Outbound connector that's used to deliver mail to the con ## PARAMETERS ### -Domain + +> Applicable: Exchange Online, Exchange Online Protection + The Domain parameter specifies the domain you want to test. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -57,13 +60,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookAnywhere.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-OutlookAnywhere.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OutlookAnywhere.md index e2189d867d..28d5d37d26 100644 --- a/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookAnywhere.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-outlookanywhere applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OutlookAnywhere -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-outlookanywhere +schema: 2.0.0 +title: Get-OutlookAnywhere --- # Get-OutlookAnywhere @@ -60,6 +61,9 @@ This example returns information about the Outlook Anywhere virtual directory na ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Outlook Anywhere virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -74,7 +78,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -97,7 +103,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -115,7 +123,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,6 +150,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -151,7 +163,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookProtectionRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OutlookProtectionRule.md index ed2ad0aa94..30ab2649a2 100644 --- a/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OutlookProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-outlookprotectionrule +schema: 2.0.0 +title: Get-OutlookProtectionRule --- # Get-OutlookProtectionRule @@ -54,13 +55,15 @@ The Identity parameter is positional. When used after the cmdlet name, the param ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter identifies an Outlook protection rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -78,7 +84,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OutlookProvider.md b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookProvider.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-OutlookProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OutlookProvider.md index 72b2e977b7..e73ad25a0a 100644 --- a/exchange/exchange-ps/exchange/Get-OutlookProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OutlookProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-outlookprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OutlookProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-outlookprovider +schema: 2.0.0 +title: Get-OutlookProvider --- # Get-OutlookProvider @@ -50,6 +51,9 @@ This example returns detailed information for the Outlook provider named WEB. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the ADIDParameter value of the MAPI protocol that you want to view. Typical values are: - EXCH @@ -60,7 +64,6 @@ The Identity parameter specifies the ADIDParameter value of the MAPI protocol th Type: OutlookProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-OwaMailboxPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OwaMailboxPolicy.md index d3d81a63ed..b282c856fa 100644 --- a/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OwaMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-owamailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-OwaMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-owamailboxpolicy +schema: 2.0.0 +title: Get-OwaMailboxPolicy --- # Get-OwaMailboxPolicy @@ -55,6 +56,9 @@ This example retrieves the information for the mailbox policy named Corporate fo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the mailbox policy that you want to view. You c Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -83,7 +89,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-OwaVirtualDirectory.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-OwaVirtualDirectory.md index 6087a13fe7..255f7385df 100644 --- a/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-OwaVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-owavirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-OwaVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-owavirtualdirectory +schema: 2.0.0 +title: Get-OwaVirtualDirectory --- # Get-OwaVirtualDirectory @@ -71,6 +72,9 @@ This example returns a summary list of all Outlook on the web virtual directorie ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the OWA virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -85,7 +89,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -108,7 +114,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -126,7 +134,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +143,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -162,7 +174,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PartnerApplication.md b/exchange/exchange-ps/ExchangePowerShell/Get-PartnerApplication.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-PartnerApplication.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PartnerApplication.md index 1e1e76f5db..d445571b81 100644 --- a/exchange/exchange-ps/exchange/Get-PartnerApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PartnerApplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-partnerapplication applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PartnerApplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-partnerapplication +schema: 2.0.0 +title: Get-PartnerApplication --- # Get-PartnerApplication @@ -44,13 +45,15 @@ This example retrieves settings for all partner applications configured in Excha ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of a partner application. ```yaml Type: PartnerApplicationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -68,7 +74,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -86,7 +94,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md b/exchange/exchange-ps/ExchangePowerShell/Get-PendingDelicenseUser.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PendingDelicenseUser.md index ca13e8b6fa..dac9418166 100644 --- a/exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PendingDelicenseUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-pendingdelicenseuser applicable: Exchange Online, Exchange Online Protection -title: Get-PendingDelicenseUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-pendingdelicenseuser +schema: 2.0.0 +title: Get-PendingDelicenseUser --- # Get-PendingDelicenseUser @@ -61,6 +62,9 @@ This example returns a summary list of all mailboxes where the 30 day delay for ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox with a pending mailbox license removal request. You can use any value that uniquely identifies the mailbox. For example: @@ -79,7 +83,6 @@ You can't use this parameter with the ShowDueObjectsOnly switch. Type: RecipientIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: TenantLevelParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -ShowDueObjectsOnly + +> Applicable: Exchange Online, Exchange Online Protection + The ShowDueObjectsOnly switch filters the results by mailboxes where the 30 day delay for removing the license has ended, and the license can be removed from the mailbox at any time. You don't need to specify a value with this switch. You can't use this switch with the Identity parameter. @@ -113,7 +121,6 @@ You can't use this switch with the Identity parameter. Type: SwitchParameter Parameter Sets: TenantLevelParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-PendingFederatedDomain.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PendingFederatedDomain.md index e646d32251..67b746dcbc 100644 --- a/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PendingFederatedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-pendingfederateddomain applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PendingFederatedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-pendingfederateddomain +schema: 2.0.0 +title: Get-PendingFederatedDomain --- # Get-PendingFederatedDomain diff --git a/exchange/exchange-ps/exchange/Get-PerimeterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-PerimeterConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-PerimeterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PerimeterConfig.md index 0559a00b0d..84bfae4905 100644 --- a/exchange/exchange-ps/exchange/Get-PerimeterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PerimeterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-perimeterconfig applicable: Exchange Online -title: Get-PerimeterConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-perimeterconfig +schema: 2.0.0 +title: Get-PerimeterConfig --- # Get-PerimeterConfig @@ -40,13 +41,15 @@ This example returns the list of gateway servers and internal email servers in y ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-PhishSimOverridePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PhishSimOverridePolicy.md index 7e1d8bcf8e..c782ae2639 100644 --- a/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PhishSimOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-phishsimoverridepolicy applicable: Exchange Online -title: Get-PhishSimOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-phishsimoverridepolicy +schema: 2.0.0 +title: Get-PhishSimOverridePolicy --- # Get-PhishSimOverridePolicy @@ -39,6 +40,9 @@ This example returns detailed information about the one and only phishing simula ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -50,7 +54,6 @@ The Identity parameter specifies the phishing simulation override policy that yo Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Place.md b/exchange/exchange-ps/ExchangePowerShell/Get-Place.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-Place.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Place.md index c13137555b..0d99aef484 100644 --- a/exchange/exchange-ps/exchange/Get-Place.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Place.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-place applicable: Exchange Online -title: Get-Place -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-place +schema: 2.0.0 +title: Get-Place --- # Get-Place @@ -67,6 +68,9 @@ This example returns all room mailboxes. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the room mailbox that you want to view. You can use any value that uniquely identifies the room. For example: - Name @@ -82,7 +86,6 @@ You can't use this parameter with the Type parameter. Type: RecipientIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -92,13 +95,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Online + The Type parameter filters the results by the type of room mailbox. Valid values are: - Room @@ -136,7 +146,6 @@ You can't use this parameter with the Identity parameter. Type: GetPlaceType Parameter Sets: AllPlaces Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PolicyConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-PolicyConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-PolicyConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PolicyConfig.md index 7b985e28c4..56021327f8 100644 --- a/exchange/exchange-ps/exchange/Get-PolicyConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PolicyConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-policyconfig applicable: Security & Compliance -title: Get-PolicyConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-policyconfig +schema: 2.0.0 +title: Get-PolicyConfig --- # Get-PolicyConfig @@ -39,13 +40,15 @@ This example returns the endpoint restrictions that are available in the organiz ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-PolicyTipConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-PolicyTipConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PolicyTipConfig.md index 0704474cc3..0f66e454dd 100644 --- a/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PolicyTipConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-policytipconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PolicyTipConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-policytipconfig +schema: 2.0.0 +title: Get-PolicyTipConfig --- # Get-PolicyTipConfig @@ -65,6 +66,9 @@ This example returns details about the custom English Policy Tip for the action ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the custom Policy Tip you want to view. You can use any value that uniquely identifies the custom Policy Tip. For example: - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. @@ -78,7 +82,6 @@ You can't use the Identity parameter with the Action, Locale or Original paramet Type: PolicyTipConfigIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Action parameter filters the Policy Tips by action. Valid values for this parameter are: - NotifyOnly @@ -102,7 +108,6 @@ You can't use the Action parameter with the Identity parameter. Type: PolicyTipMessageConfigAction Parameter Sets: Parameters Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -120,7 +128,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Locale parameter specifies a locale-specific version of the Policy Tip. Valid values for this parameter are supported locale codes. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). @@ -140,7 +150,6 @@ You can't use the Locale parameter with the Identity parameter. Type: CultureInfo Parameter Sets: Parameters Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -Original + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Original switch specifies whether to include built-in Policy Tips in the results. You don't need to specify a value with this switch. You can't use the Original switch with the Identity parameter. @@ -158,7 +170,6 @@ You can't use the Original switch with the Identity parameter. Type: SwitchParameter Parameter Sets: Parameters Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PopSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-PopSettings.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-PopSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PopSettings.md index 4223b39960..fdf0c23826 100644 --- a/exchange/exchange-ps/exchange/Get-PopSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PopSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-popsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PopSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-popsettings +schema: 2.0.0 +title: Get-PopSettings --- # Get-PopSettings @@ -48,13 +49,15 @@ This example returns detailed information for the Microsoft Exchange POP3 servic ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -77,7 +83,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-PowerShellVirtualDirectory.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PowerShellVirtualDirectory.md index b46a6dbd1e..a5bc976d2e 100644 --- a/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PowerShellVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-powershellvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PowerShellVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-powershellvirtualdirectory +schema: 2.0.0 +title: Get-PowerShellVirtualDirectory --- # Get-PowerShellVirtualDirectory @@ -67,6 +68,9 @@ This example returns a summary list of all PowerShell virtual directories in the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the PowerShell virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -81,7 +85,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -104,7 +110,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -122,7 +130,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -158,7 +170,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md b/exchange/exchange-ps/ExchangePowerShell/Get-ProtectionAlert.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ProtectionAlert.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ProtectionAlert.md index 2e99bc420c..2085c02ebd 100644 --- a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ProtectionAlert.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-protectionalert applicable: Security & Compliance -title: Get-ProtectionAlert -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-protectionalert +schema: 2.0.0 +title: Get-ProtectionAlert --- # Get-ProtectionAlert @@ -48,6 +49,9 @@ This example returns detailed information about the specified alert policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the alert policy that you want to view. You can use any value that uniquely identifies the alert policy. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the alert policy that you want to view. You can Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -IncludeRuleXml + +> Applicable: Security & Compliance + {{ Fill IncludeRuleXml Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolder.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-PublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolder.md index 6236c3d432..299fc5a598 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolder +schema: 2.0.0 +title: Get-PublicFolder --- # Get-PublicFolder @@ -118,13 +119,15 @@ This example returns the public folders that reside in the public folder content ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name and path of the public folder you want to view. A valid value uses the syntax: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. ```yaml Type: PublicFolderIdParameter Parameter Sets: GetChildren, Recurse, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -134,6 +137,9 @@ Accept wildcard characters: False ``` ### -GetChildren + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The GetChildren switch specifies whether to return only the children of the folder specified by the Identity parameter. You don't need to specify a value with this switch. You can't use this switch with the Recurse or LostAndFound switches. @@ -142,7 +148,6 @@ You can't use this switch with the Recurse or LostAndFound switches. Type: SwitchParameter Parameter Sets: GetChildren Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -152,6 +157,9 @@ Accept wildcard characters: False ``` ### -Recurse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Recurse switch specifies whether to return the specified public folder and all its children. You don't need to specify a value with this switch. You can't use this switch with the GetChildren or LostAndFound switches. @@ -160,7 +168,6 @@ You can't use this switch with the GetChildren or LostAndFound switches. Type: SwitchParameter Parameter Sets: Recurse Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -170,6 +177,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -178,7 +188,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +197,9 @@ Accept wildcard characters: False ``` ### -LostAndFound + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The LostAndFound switch specifies whether to return only orphaned folders that are located in \\NON\_IPM\_SUBTREE\\LOST\_AND\_FOUND. You don't need to specify a value with this switch. The LOST\_AND\_FOUND folder holds missing folders that are recreated by the public folder hierarchy reconciliation process when the folder exists in a secondary public folder mailbox, but not in the primary. @@ -198,7 +210,6 @@ You can't use this switch with the Identity parameter or the Recurse or LostAndF Type: SwitchParameter Parameter Sets: LostAndFound Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -208,6 +219,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the identity of the hierarchy public folder mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -225,7 +239,6 @@ The Mailbox parameter specifies the identity of the hierarchy public folder mail Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -235,6 +248,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -243,7 +259,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,6 +268,9 @@ Accept wildcard characters: False ``` ### -ResidentFolders + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResidentFolders switch specifies whether to return public folders that reside in a specific content public folder mailbox. You don't need to specify a value with this switch. If you don't use this switch, the command will return only public folders whose contents reside in the primary hierarchy public folder mailbox. @@ -261,7 +279,6 @@ If you don't use this switch, the command will return only public folders whose Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -271,13 +288,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. The default maximum is 10,000. For no limit on the returned results, set this parameter to Unlimited. This parameter can only be passed in combination with the Recurse or GetChildren parameters. ```yaml Type: Unlimited Parameter Sets: GetChildren, Recurse, LostAndFound Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,6 +306,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: @@ -300,7 +322,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: GetChildren, Recurse, Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderAdministrativePermission.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderAdministrativePermission.md index 8827234280..841f2e7c5e 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderAdministrativePermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderadministrativepermission applicable: Exchange Server 2010 -title: Get-PublicFolderAdministrativePermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolderadministrativepermission +schema: 2.0.0 +title: Get-PublicFolderAdministrativePermission --- # Get-PublicFolderAdministrativePermission @@ -65,6 +66,9 @@ This example retrieves the owner of the public folder My Public Folder. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -73,7 +77,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -83,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Server 2010 + The Owner switch returns the owner of the public folder object. You don't need to specify a value with this switch. You can't use this switch with the User parameter. @@ -107,7 +115,6 @@ You can't use this switch with the User parameter. Type: SwitchParameter Parameter Sets: Owner Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: - Name @@ -128,7 +138,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010 + The User parameter filters the results by who has admin permissions on the specified public folder. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -163,7 +175,6 @@ You can't use this parameter with the Owner switch. Type: SecurityPrincipalIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderClientPermission.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderClientPermission.md index a78eb99b9f..e72bcbe253 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderClientPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderclientpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderClientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolderclientpermission +schema: 2.0.0 +title: Get-PublicFolderClientPermission --- # Get-PublicFolderClientPermission @@ -54,6 +55,9 @@ This example retrieves the permissions for the public folder My Public Folder, f ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -62,7 +66,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -80,7 +86,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -98,7 +106,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All)) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: @@ -121,7 +131,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The User parameter specifies the user for whom you want to view the permissions on the public folder. For the best results, we recommend using the following values: @@ -142,7 +154,6 @@ For the best results, we recommend using the following values: Type: PublicFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the public folder mailbox that you want to view the permissions for. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -171,7 +185,6 @@ By default, the permissions are returned from the primary public folder mailbox. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderDatabase.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderDatabase.md index 163d873ee4..9850b9ee99 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PublicFolderDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolderdatabase +schema: 2.0.0 +title: Get-PublicFolderDatabase --- # Get-PublicFolderDatabase @@ -73,6 +74,9 @@ This example returns information about all public folders on Server01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the public folder database that you want to view. You can use any value that uniquely identifies the database. For example: - Name @@ -87,7 +91,6 @@ If you have multiple databases with the same name, the cmdlet retrieves all data Type: DatabaseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: - Name @@ -110,7 +116,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -IncludePreExchange2010 + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IncludePreExchange2010 switch specifies whether to include information about Exchange 2003 or Exchange 2007 public folders in the results. You don't need to specify a value with this switch. @@ -146,7 +156,6 @@ This switch isn't useful in commands where you use the Server or Identity parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Status switch specifies whether to include additional backup and mount status information for servers running Exchange 2010. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -IncludeCorrupted + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderItemStatistics.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderItemStatistics.md index 7e8d13e1d4..291f4e40cc 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderItemStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderitemstatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderItemStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolderitemstatistics +schema: 2.0.0 +title: Get-PublicFolderItemStatistics --- # Get-PublicFolderItemStatistics @@ -64,13 +65,15 @@ This example exports the output of the Get-PublicFolderItemStatistics command to ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the following format: \\TopLevelPublicFolder\\PublicFolder ```yaml Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -88,7 +94,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the identity of the hierarchy public folder mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -115,7 +123,6 @@ The Mailbox parameter specifies the identity of the hierarchy public folder mail Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -133,7 +143,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All)) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: @@ -156,7 +168,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxDiagnostics.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxDiagnostics.md index d7b0c82238..066a6a5076 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxDiagnostics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermailboxdiagnostics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMailboxDiagnostics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermailboxdiagnostics +schema: 2.0.0 +title: Get-PublicFolderMailboxDiagnostics --- # Get-PublicFolderMailboxDiagnostics @@ -52,6 +53,9 @@ This example returns the diagnostic information for the public folder mailbox Sa ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the public folder mailbox. The public folder mailbox is where the content of the public folder resides. You can use any value that uniquely identifies the mailbox. For example: @@ -71,7 +75,6 @@ You can use any value that uniquely identifies the mailbox. For example: Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -90,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -108,7 +116,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -IncludeDumpsterInfo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeDumpsterInfo specifies whether to include diagnostic information for the \\NON\_IPM\_TREE\\DUMPSTER\_ROOT folder (the dumpster for public folder mailboxes is included in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -IncludeHierarchyInfo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeHierarchyInfo switch specifies whether to include folder hierarchy information in the results. You don't need to specify a value with this switch. Using this switch returns the following information: @@ -153,7 +165,6 @@ Using this switch returns the following information: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -163,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequest.md index 4fe2797ff4..ec4334625e 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMailboxMigrationRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequest +schema: 2.0.0 +title: Get-PublicFolderMailboxMigrationRequest --- # Get-PublicFolderMailboxMigrationRequest @@ -83,6 +84,9 @@ This example returns duplicate public folder migration requests (requests create ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the public folder mailbox migration request that you want to view. The value uses the syntax: `\PublicFolderMailboxMigration` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). You can't use this parameter with the following parameters: @@ -98,7 +102,6 @@ You can't use this parameter with the following parameters: Type: PublicFolderMailboxMigrationRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter filters the results by the friendly BatchName value that was assigned when the batch job was created. The format of this value is: `MigrationService:`. You can't use this parameter with the Identity parameter. @@ -116,7 +122,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -134,7 +142,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: @@ -157,7 +167,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,6 +176,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the public folder mailbox migration request. If the name was not specified at creation, the default value is `PublicFolderMailboxMigration` (for example, `PublicFolderMailboxMigration2ffdef13-01b9-4586-af2b-d5a5482010a8`). You can't use this parameter with the Identity parameter. @@ -175,7 +187,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -185,6 +196,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -199,7 +213,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +222,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -225,6 +240,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -244,7 +262,6 @@ You can't use this parameter with the Identity parameter. Type: RequestStatus Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -254,6 +271,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -262,7 +282,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequestStatistics.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequestStatistics.md index cb164285ad..a29a4656ab 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMailboxMigrationRequestStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequeststatistics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMailboxMigrationRequestStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermailboxmigrationrequeststatistics +schema: 2.0.0 +title: Get-PublicFolderMailboxMigrationRequestStatistics --- # Get-PublicFolderMailboxMigrationRequestStatistics @@ -75,6 +76,9 @@ This example uses the Identity parameter to return information about the specifi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the public folder mailbox migration request. The default identity value is `\PublicFolderMailboxMigration` (for example, `PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). You can't use this parameter with the RequestQueue and RequestGuid parameters. @@ -83,7 +87,6 @@ You can't use this parameter with the RequestQueue and RequestGuid parameters. Type: PublicFolderMailboxMigrationRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is for debugging purposes only. @@ -109,7 +115,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. @@ -129,7 +137,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -147,7 +157,6 @@ The DiagnosticArgument parameter modifies the results that are returned by using Type: String Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -165,7 +177,6 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Type: String Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -183,7 +197,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: IdentityOnPremises, MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,13 +206,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,6 +224,9 @@ Accept wildcard characters: False ``` ### -IncludeSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeSkippedItems Description }} @@ -217,7 +235,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: IdentityCloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -227,13 +244,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestGuid parameter specifies the unique RequestGuid identifier of the request that you want to view. To find the RequestGuid value, use the Get-PublicFolderMailboxMigrationRequest cmdlet. @@ -253,7 +275,6 @@ If you use this parameter, you also need to use the RequestQueue parameter. You Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequest.md index c001744a6d..14a3d3411d 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PublicFolderMigrationRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermigrationrequest +schema: 2.0.0 +title: Get-PublicFolderMigrationRequest --- # Get-PublicFolderMigrationRequest @@ -66,6 +67,9 @@ This example returns all migration requests that have the name PFMigrate10\_11\_ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the public folder migration request that you want to view. You can use the following values: - GUID @@ -77,7 +81,6 @@ You can't use this parameter with other filtering parameters (BatchName, HighPri Type: PublicFolderMigrationRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BatchName parameter specifies the name that was given to a batch migration request. You can't use this parameter with the Identity parameter. @@ -95,7 +101,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: - $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. @@ -132,7 +142,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter filters the results by the name of the public folder migration request. You can't use this parameter with the Identity parameter. @@ -150,7 +162,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -172,7 +186,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,13 +195,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -217,7 +235,6 @@ You can't use this parameter with the Identity parameter. Type: RequestStatus Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,6 +244,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -235,7 +255,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequestStatistics.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequestStatistics.md index 2ef492d5cb..3a70bb487b 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMigrationRequestStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermigrationrequeststatistics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-PublicFolderMigrationRequestStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermigrationrequeststatistics +schema: 2.0.0 +title: Get-PublicFolderMigrationRequestStatistics --- # Get-PublicFolderMigrationRequestStatistics @@ -68,6 +69,9 @@ This example returns additional information about the migration request and expo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the migration request that you want to view. You can use the following values: - Name @@ -79,7 +83,6 @@ You can't use this parameter with the RequestQueue or RequestGuid parameter. Type: PublicFolderMigrationRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is for debugging purposes only. The RequestQueue parameter filters the results by the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -103,7 +109,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -121,7 +129,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,13 +174,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -179,13 +192,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -195,6 +210,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequestGuid parameter specifies the GUID of a migration request. You can't use this parameter with the Identity parameter. @@ -203,7 +221,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequest.md index 5d234a047b..e1f09381b8 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermoverequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermoverequest +schema: 2.0.0 +title: Get-PublicFolderMoveRequest --- # Get-PublicFolderMoveRequest @@ -64,6 +65,9 @@ This example returns the status of in-progress and queued requests that are on t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the public folder move request. The default identity assigned to public folder move requests is \\PublicFolderMove. You can't use this parameter with the following parameters: @@ -79,7 +83,6 @@ You can't use this parameter with the following parameters: Type: PublicFolderMoveRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -AccountPartition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AccountPartition Description }} @@ -97,7 +103,6 @@ This parameter is available only in the cloud-based service. Type: AccountPartitionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter specifies the name that was given to a batch public folder move request. You can't use this parameter with the Identity parameter. @@ -115,7 +123,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -133,7 +143,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -HighPriority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here's how these values filter the results: - $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency. @@ -154,7 +166,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,6 +175,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the public folder move request. If you didn't specify a name when creating the move request, PublicFolderMove will be the default name assigned to the request. You can't use this parameter with the Identity parameter. @@ -172,7 +186,6 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,6 +195,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Organization Description }} @@ -190,7 +206,6 @@ This parameter is available only in the cloud-based service. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -212,7 +230,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -222,13 +239,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -238,6 +257,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Status parameter filters the results based on status. You can use the following values: - AutoSuspended @@ -257,7 +279,6 @@ You can't use this parameter with the Identity parameter. Type: RequestStatus Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -267,6 +288,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false. You can't use this parameter with the Identity parameter. @@ -275,7 +299,6 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequestStatistics.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequestStatistics.md index 475fc29578..bce7688ee7 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderMoveRequestStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermoverequeststatistics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderMoveRequestStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfoldermoverequeststatistics +schema: 2.0.0 +title: Get-PublicFolderMoveRequestStatistics --- # Get-PublicFolderMoveRequestStatistics @@ -68,6 +69,9 @@ This example returns the detailed statistics for the move request \\PublicFolder ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the public folder move request. The default public folder move request identity is \\PublicFolderMove. This parameter can't be used with the RequestQueue parameter. @@ -76,7 +80,6 @@ This parameter can't be used with the RequestQueue parameter. Type: PublicFolderMoveRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is for debugging purposes only. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -100,7 +106,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Diagnostic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. @@ -118,7 +126,6 @@ Typically, you use this switch only at the request of Microsoft Customer Service Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -DiagnosticArgument + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DiagnosticInfo Description }} @@ -152,7 +164,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -170,7 +184,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,13 +193,15 @@ Accept wildcard characters: False ``` ### -IncludeReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -196,6 +211,9 @@ Accept wildcard characters: False ``` ### -IncludeSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeSkippedItems Description }} @@ -204,7 +222,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -214,13 +231,15 @@ Accept wildcard characters: False ``` ### -ReportOnly + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +249,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestGuid parameter specifies the GUID of the public folder move request for which you want to view the request statistics. This parameter can't be used with the Identity parameter. @@ -238,7 +260,6 @@ This parameter can't be used with the Identity parameter. Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderStatistics.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderStatistics.md index 023a6d31c0..e7fb830203 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-PublicFolderStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderstatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-PublicFolderStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-publicfolderstatistics +schema: 2.0.0 +title: Get-PublicFolderStatistics --- # Get-PublicFolderStatistics @@ -44,6 +45,9 @@ This example retrieves statistics about the public folder Marketing\\2013\\Pamph ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -52,7 +56,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -70,7 +76,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the identity of the hierarchy public folder mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -97,7 +105,6 @@ The Mailbox parameter specifies the identity of the hierarchy public folder mail Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is available only in on-premises Exchange. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -115,7 +125,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter filters the results by the specified Exchange server. You can use any value that uniquely identifies the server. For example: @@ -138,7 +150,6 @@ The Server parameter filters the results by the specified Exchange server. You c Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessage.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-QuarantineMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessage.md index afa39b7a2e..06e5a73791 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinemessage applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-QuarantineMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-quarantinemessage +schema: 2.0.0 +title: Get-QuarantineMessage --- # Get-QuarantineMessage @@ -102,6 +103,9 @@ This example returns detailed information for the files protected by Safe Attach ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the quarantined message that you want to view. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). When you identify the quarantine message by using this parameter, the RecipientAddress, QuarantineUser, and ReleasedUser properties are available. To see these values, you need to use a formatting cmdlet. For example, `Get-QuarantineMessage -Identity | Format-List`. @@ -110,7 +114,6 @@ When you identify the quarantine message by using this parameter, the RecipientA Type: QuarantineMessageIdentity Parameter Sets: Details Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Direction parameter filters the results by incoming or outgoing messages. Valid values are: - Inbound @@ -131,7 +137,6 @@ You can specify multiple values separated by commas. Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageDirectionEnum Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -141,13 +146,15 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -157,6 +164,9 @@ Accept wildcard characters: False ``` ### -EndExpiresDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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". @@ -167,7 +177,6 @@ For example, if you specify the StartExpiresDate value of today's date and the E Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -177,6 +186,9 @@ Accept wildcard characters: False ``` ### -EndReceivedDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EndReceivedDate parameter specifies the latest messages to return in the results. Use this parameter with the StartReceivedDate parameter. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -185,7 +197,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -195,6 +206,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -206,7 +220,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -216,13 +229,15 @@ Accept wildcard characters: False ``` ### -IncludeMessagesFromBlockedSenderAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The IncludeMessagesFromBlockedSenderAddress switch specifies whether to include quarantined messages from blocked senders in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -232,13 +247,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, `""`). ```yaml Type: String Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -248,13 +265,15 @@ Accept wildcard characters: False ``` ### -MyItems + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The MyItems switch filters the results by messages where you (the user that's running the command) are the recipient. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -264,13 +283,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -280,13 +301,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 1000. The default value is 100. ```yaml Type: Int32 Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -296,6 +319,9 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The PolicyName parameter filters the results by the threat policy that quarantined the message (for example, an anti-malware policy or an anti-spam policy). You can use any value that uniquely identifies the policy. For example: - Name @@ -306,7 +332,6 @@ The PolicyName parameter filters the results by the threat policy that quarantin Type: String Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -316,6 +341,9 @@ Accept wildcard characters: False ``` ### -PolicyTypes + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The PolicyTypes parameter filters the results by the type of threat policy that quarantined the message. Valid values are: - AntiMalwarePolicy @@ -331,7 +359,6 @@ You can specify multiple values separated by commas. Type: QuarantinePolicyTypeEnum[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -341,6 +368,9 @@ Accept wildcard characters: False ``` ### -QuarantineTypes + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The QuarantineTypes parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk @@ -363,7 +393,6 @@ For files quarantined by Safe Attachments for SharePoint, OneDrive, and Microsof Type: QuarantineMessageTypeEnum[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -373,13 +402,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: All Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -389,6 +420,9 @@ Accept wildcard characters: False ``` ### -RecipientTag + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientTag parameter filters the results by the recipient's user tag value (for example, `Priority Account`). For more information about user tags, see [User tags in Defender for Office 365](https://learn.microsoft.com/defender-office-365/user-tags-about). You can specify multiple values separated by commas. @@ -397,7 +431,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -407,6 +440,9 @@ Accept wildcard characters: False ``` ### -ReleaseStatus + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ReleaseStatus parameter filters the results by the release status of the message. Valid values are: - Approved @@ -425,7 +461,6 @@ You can specify multiple values separated by commas. Type: ReleaseStatus[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -435,6 +470,9 @@ Accept wildcard characters: False ``` ### -Reported + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Reported parameter filters the results by messages that have already been reported as false positives. Valid values are: - $true: The command only returns quarantined messages that have already been reported as false positives. @@ -444,7 +482,6 @@ The Reported parameter filters the results by messages that have already been re Type: Boolean Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -454,13 +491,15 @@ Accept wildcard characters: False ``` ### -SenderAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -470,6 +509,9 @@ Accept wildcard characters: False ``` ### -StartExpiresDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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". @@ -480,7 +522,6 @@ For example, if you specify the StartExpiresDate value of today's date and the E Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -490,6 +531,9 @@ Accept wildcard characters: False ``` ### -StartReceivedDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The StartReceivedDate parameter specifies the earliest messages to return in the results. Use this parameter with the EndReceivedDate parameter. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -500,7 +544,6 @@ By default, if you don't use the StartReceivedDate and EndReceivedDate parameter Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -510,13 +553,15 @@ Accept wildcard characters: False ``` ### -Subject + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Subject parameter filters the results by the subject field of the message. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -526,6 +571,9 @@ Accept wildcard characters: False ``` ### -TeamsConversationTypes + +> Applicable: Security & Compliance + This parameter is available only in Security & Compliance PowerShell. The TeamsConversationTypes parameters filters the results by Microsoft Teams conversation types. Valid values are: @@ -539,7 +587,6 @@ You can specify multiple values separated by commas. Type: Microsoft.Exchange.Management.FfoQuarantine.TeamsConversationType[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -549,6 +596,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Type parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk @@ -568,7 +618,6 @@ For files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageTypeEnum Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessageHeader.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md rename to exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessageHeader.md index 9dac21f945..c7f2ec7c00 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantineMessageHeader.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinemessageheader applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-QuarantineMessageHeader -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-quarantinemessageheader +schema: 2.0.0 +title: Get-QuarantineMessageHeader --- # Get-QuarantineMessageHeader @@ -53,6 +54,9 @@ This example displays the message header of the first message that's returned by ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the quarantined message that you want to view the header for. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. @@ -61,7 +65,6 @@ You can find the Identity value for a quarantined message by using the Get-Quara Type: QuarantineMessageIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -82,7 +88,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantinePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-QuarantinePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-QuarantinePolicy.md index 93177a8f2a..b36d1fde0f 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-QuarantinePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinepolicy applicable: Exchange Online, Exchange Online Protection -title: Get-QuarantinePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-quarantinepolicy +schema: 2.0.0 +title: Get-QuarantinePolicy --- # Get-QuarantinePolicy @@ -57,6 +58,9 @@ This example returns detailed information about the default quarantine policy na ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the quarantine policy you want to view. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -67,7 +71,6 @@ The Identity parameter specifies the quarantine policy you want to view. You can Type: QuarantineTagIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -QuarantinePolicyType + +> Applicable: Exchange Online, Exchange Online Protection + The QuarantinePolicyType parameter filters the results by the specified quarantine policy type. Valid values are: - QuarantinePolicy: This is the default value, and returns built-in and custom quarantine policies. @@ -87,7 +93,6 @@ Type: QuarantinePolicyType Parameter Sets: (All) Aliases: Accepted values: QuarantinePolicy, GlobalQuarantinePolicy -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Queue.md b/exchange/exchange-ps/ExchangePowerShell/Get-Queue.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-Queue.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Queue.md index 1b83dcd4a3..a05d1686df 100644 --- a/exchange/exchange-ps/exchange/Get-Queue.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Queue.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-queue applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-Queue -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-queue +schema: 2.0.0 +title: Get-Queue --- # Get-Queue @@ -87,13 +88,15 @@ This example lists only the external queues. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -103,13 +106,15 @@ Accept wildcard characters: False ``` ### -BookmarkIndex + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BookmarkIndex parameter specifies the position in the result set where the displayed results start. The value of this parameter is a 1-based index in the total result set. The BookmarkIndex parameter can't be used with the BookmarkObject parameter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,13 +124,15 @@ Accept wildcard characters: False ``` ### -BookmarkObject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BookmarkObject parameter specifies the object in the result set where the displayed results start. The BookmarkObject parameter can't be used with the BookmarkIndex parameter. ```yaml Type: ExtensibleQueueInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -Exclude + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Exclude parameter specifies the types of queues you want to exclude from the results. Valid values for this parameter are: - Internal @@ -145,7 +155,6 @@ The Exclude parameter specifies the types of queues you want to exclude from the Type: QueueViewerIncludesAndExcludes Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,6 +164,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -163,7 +175,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -Include + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Include parameter specifies the types of queues you want to include the results. Valid values for this parameter are: - Internal @@ -183,7 +197,6 @@ The Include parameter specifies the types of queues you want to include the resu Type: QueueViewerIncludesAndExcludes Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,13 +206,15 @@ Accept wildcard characters: False ``` ### -IncludeBookmark + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeBookmark parameter specifies whether to include the bookmark object when the query results are displayed. The IncludeBookmark parameter is valid when it's used with the BookmarkObject or BookmarkIndex parameters. If you don't specify a value for the IncludeBookmark parameter, the default value of $true is used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +242,15 @@ Accept wildcard characters: False ``` ### -ReturnPageInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReturnPageInfo parameter is a hidden parameter. Use it to return information about the total number of results and the index of the first object of the current page. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,13 +260,15 @@ Accept wildcard characters: False ``` ### -SearchForward + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SearchForward parameter specifies whether to search forward or backward in the result set. The default value is $true. This value causes the result page to be calculated forward from either the start of the result set or forward from a bookmark if specified. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,6 +278,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -272,7 +296,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -282,6 +305,9 @@ Accept wildcard characters: False ``` ### -SortOrder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SortOrder parameter specifies an array of message properties used to control the sort order of the result set. Separate each property by using a comma. Prepend a plus sign (+) symbol to the beginning of the property name to display the results in ascending order. Prepend a minus sign (-) symbol to the beginning of the property name to display the results in descending order. If you don't specify a sort order, the result set is displayed in ascending order by QueueIdentity. @@ -290,7 +316,6 @@ If you don't specify a sort order, the result set is displayed in ascending orde Type: QueueViewerSortOrderEntry[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-QueueDigest.md b/exchange/exchange-ps/ExchangePowerShell/Get-QueueDigest.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-QueueDigest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-QueueDigest.md index a45a074bd3..c4277836aa 100644 --- a/exchange/exchange-ps/exchange/Get-QueueDigest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-QueueDigest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-queuedigest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-QueueDigest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-queuedigest +schema: 2.0.0 +title: Get-QueueDigest --- # Get-QueueDigest @@ -88,6 +89,9 @@ This example returns information about all queues in the DAG named DAG01. ## PARAMETERS ### -Dag + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Dag parameter filters the delivery queue results by DAG. You can specify any value that uniquely identifies the DAG. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). You can't use the Dag parameter with the Server, Site or Forest parameters. @@ -96,7 +100,6 @@ You can't use the Dag parameter with the Server, Site or Forest parameters. Type: MultiValuedProperty Parameter Sets: Dag Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -Forest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Forest switch filters the delivery queue results by Active Directory forest. You don't need to specify a value with the Forest switch. You can't use the Forest switch with the Server, Site or Dag parameters. @@ -114,7 +120,6 @@ You can't use the Forest switch with the Server, Site or Dag parameters. Type: SwitchParameter Parameter Sets: Forest Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter filters the delivery queue results by Exchange server. You can specify any value that uniquely identifies the server. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). You can't use the Server parameter with the Dag, Site or Forest parameters. @@ -132,7 +140,6 @@ You can't use the Server parameter with the Dag, Site or Forest parameters. Type: MultiValuedProperty Parameter Sets: Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Site parameter filters the delivery queue results by Active Directory site. You can specify any value that uniquely identifies the site. You can specify multiple sites separated by commas. You can't use the Site parameter with the Server, Dag or Forest parameters. @@ -150,7 +160,6 @@ You can't use the Site parameter with the Server, Dag or Forest parameters. Type: MultiValuedProperty Parameter Sets: Site Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -160,13 +169,15 @@ Accept wildcard characters: False ``` ### -DetailsLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DetailsLevel parameter specifies the level of detail to display in the results. Valid values for this parameter are None, Normal and Verbose. The default value is Normal. ```yaml Type: DetailsLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -184,7 +198,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -GroupBy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GroupedBy parameter sorts the messages in the delivery queue results. Valid values are: - DeliveryType @@ -210,7 +226,6 @@ The GroupedBy parameter sorts the messages in the delivery queue results. Valid Type: QueueDigestGroupBy Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,13 +235,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter filters the delivery queue results by the number of messages in the queue. Valid input for this parameter is an integer. The default value is 1000. For example, if you specify the value 50, the command displays the 50 queues that contain the most messages. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Timeout parameter specifies the number of seconds before the operation times out. The default value is 10 seconds. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -244,7 +264,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RMSTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Get-RMSTemplate.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-RMSTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RMSTemplate.md index e495368203..a4ee2746eb 100644 --- a/exchange/exchange-ps/exchange/Get-RMSTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RMSTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-rmstemplate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-RMSTemplate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-rmstemplate +schema: 2.0.0 +title: Get-RMSTemplate --- # Get-RMSTemplate @@ -53,13 +54,15 @@ This example retrieves the Company Confidential RMS template. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the RMS template. ```yaml Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -77,7 +83,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -TrustedPublishingDomain + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The TrustedPublishingDomain parameter specifies the trusted publishing domain you want to search for RMS templates. You can use any value that uniquely identifies the trusted publishing domain, for example: @@ -115,7 +125,6 @@ The TrustedPublishingDomain parameter specifies the trusted publishing domain yo Type: RmsTrustedPublishingDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Type parameter specifies the type of RMS template. Use one of the following values: @@ -137,7 +149,6 @@ The Type parameter specifies the type of RMS template. Use one of the following Type: RmsTemplateType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ReceiveConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-ReceiveConnector.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ReceiveConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ReceiveConnector.md index f34ec98584..fe560729f4 100644 --- a/exchange/exchange-ps/exchange/Get-ReceiveConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ReceiveConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-receiveconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ReceiveConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-receiveconnector +schema: 2.0.0 +title: Get-ReceiveConnector --- # Get-ReceiveConnector @@ -58,6 +59,9 @@ This example displays detailed information for the Receive connector named Recei ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Receive connector that you want to view. You can use any value that uniquely identifies the Receive connector. For example: - Name @@ -71,7 +75,6 @@ You can't use this parameter with the Server parameter. Type: ReceiveConnectorIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -89,7 +95,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter filters the results by the specified Mailbox server or Edge Transport server. You can use any value that uniquely identifies the server. For example: - Name @@ -112,7 +120,6 @@ You can't use this parameter with the Identity parameter. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Recipient.md b/exchange/exchange-ps/ExchangePowerShell/Get-Recipient.md similarity index 86% rename from exchange/exchange-ps/exchange/Get-Recipient.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Recipient.md index 4b5a71f8b1..4497518c48 100644 --- a/exchange/exchange-ps/exchange/Get-Recipient.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Recipient.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recipient applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-Recipient -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recipient +schema: 2.0.0 +title: Get-Recipient --- # Get-Recipient @@ -144,6 +145,9 @@ This example retrieves information about all the mail contacts in your organizat ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the recipient object that you want to view. You can use any value that uniquely identifies the recipient. For example: - Name @@ -157,7 +161,6 @@ The Identity parameter specifies the recipient object that you want to view. You Type: RecipientIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -167,6 +170,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -179,7 +185,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -189,6 +194,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is available only in the cloud-based service. The AuthenticationType parameter specifies the recipient by authentication type. Use one of the following values: @@ -200,7 +208,6 @@ The AuthenticationType parameter specifies the recipient by authentication type. Type: AuthenticationType Parameter Sets: AnrSet, Identity, RecipientPreviewFilterSet Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -210,13 +217,15 @@ Accept wildcard characters: False ``` ### -BookmarkDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -226,6 +235,9 @@ Accept wildcard characters: False ``` ### -Capabilities + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -234,7 +246,6 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: AnrSet, Identity, RecipientPreviewFilterSet Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -244,6 +255,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -254,7 +268,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,6 +277,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Database parameter return all recipients stored on the specified mailbox database. You can use any value that uniquely identifies the database. For example: @@ -276,7 +292,6 @@ The Database parameter return all recipients stored on the specified mailbox dat Type: DatabaseIdParameter Parameter Sets: DatabaseSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -286,6 +301,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -294,7 +312,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,6 +321,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -319,7 +339,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -329,6 +348,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -342,7 +364,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -352,13 +373,15 @@ Accept wildcard characters: False ``` ### -IncludeBookmarkObject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -368,6 +391,9 @@ Accept wildcard characters: False ``` ### -IncludeManagerWithDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill IncludeManagerWithDisplayName Description }} @@ -376,7 +402,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet, RecipientPreviewFilterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -386,6 +411,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedRecipients + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. Soft-deleted recipients are deleted recipients that are still recoverable. @@ -396,7 +424,6 @@ Soft-deleted recipients are deleted recipients that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -406,6 +433,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -417,7 +447,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -427,13 +456,15 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -443,13 +474,15 @@ Accept wildcard characters: False ``` ### -PropertySet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: PropertySet Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -459,6 +492,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -471,7 +507,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -481,13 +516,15 @@ Accept wildcard characters: False ``` ### -RecipientPreviewFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientPreviewFilter parameter tests a recipient filter that you would use in a dynamic distribution group, address list, or email address policy. This parameter uses the LDAP filter syntax. ```yaml Type: String Parameter Sets: RecipientPreviewFilterSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -497,6 +534,9 @@ Accept wildcard characters: False ``` ### -RecipientType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientType parameter filters the results by the specified recipient type. Valid values are: - DynamicDistributionGroup @@ -514,7 +554,6 @@ You can specify multiple values separated by commas. Type: RecipientType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -524,6 +563,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are: - DiscoveryMailbox @@ -563,7 +605,6 @@ The value of the RecipientType parameter affects the values that you can use for Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -573,13 +614,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -589,6 +632,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -608,7 +654,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientFilterConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RecipientFilterConfig.md index 76a02ece24..050feb8da1 100644 --- a/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recipientfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-RecipientFilterConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recipientfilterconfig +schema: 2.0.0 +title: Get-RecipientFilterConfig --- # Get-RecipientFilterConfig @@ -41,13 +42,15 @@ This example returns detailed information about the recipient filter configurati ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -65,7 +71,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RecipientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientPermission.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-RecipientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RecipientPermission.md index 985fc7ff66..65d31fe008 100644 --- a/exchange/exchange-ps/exchange/Get-RecipientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recipientpermission applicable: Exchange Online -title: Get-RecipientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recipientpermission +schema: 2.0.0 +title: Get-RecipientPermission --- # Get-RecipientPermission @@ -58,6 +59,9 @@ This example lists the users who have SendAs permission on the mailbox Help Desk ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter identifies the recipient that you want to view. The user or group specified by the Trustee parameter has Send As permissions on this recipient. You can specify any type of recipient, for example: - Mailboxes @@ -79,7 +83,6 @@ You can use any value that uniquely identifies the recipient. For example: Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Online + The AccessRights parameter filters the results by permission. The only valid value for this parameter is SendAs. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Online + The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -Trustee + +> Applicable: Exchange Online + The Trustee parameter filters the results by who has Send As permissions on the specified recipient. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -160,7 +172,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientStatisticsReport.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RecipientStatisticsReport.md index 8f2d888cba..e11d4e6142 100644 --- a/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RecipientStatisticsReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recipientstatisticsreport applicable: Exchange Online -title: Get-RecipientStatisticsReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recipientstatisticsreport +schema: 2.0.0 +title: Get-RecipientStatisticsReport --- # Get-RecipientStatisticsReport diff --git a/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-RecordReviewNotificationTemplateConfig.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RecordReviewNotificationTemplateConfig.md index 4f413a8bf3..a6dfb25f93 100644 --- a/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RecordReviewNotificationTemplateConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recordreviewnotificationtemplateconfig applicable: Security & Compliance -title: Get-RecordReviewNotificationTemplateConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recordreviewnotificationtemplateconfig +schema: 2.0.0 +title: Get-RecordReviewNotificationTemplateConfig --- # Get-RecordReviewNotificationTemplateConfig diff --git a/exchange/exchange-ps/exchange/Get-RecoverableItems.md b/exchange/exchange-ps/ExchangePowerShell/Get-RecoverableItems.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-RecoverableItems.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RecoverableItems.md index aebb11746e..796b999fed 100644 --- a/exchange/exchange-ps/exchange/Get-RecoverableItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RecoverableItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-recoverableitems applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RecoverableItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-recoverableitems +schema: 2.0.0 +title: Get-RecoverableItems --- # Get-RecoverableItems @@ -74,6 +75,9 @@ This example returns all of the available recoverable deleted messages with the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox that contains the deleted items that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -91,9 +95,8 @@ In Exchange Online, you can specify multiple mailboxes separated by commas. If t ```yaml Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: OnPremises +Parameter Sets: OnPremises, Cloud Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -102,20 +105,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: GeneralMailboxOrMailUserIdParameter[] -Parameter Sets: Cloud -Aliases: -Applicable: Exchange Online +### -EntryID -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -### -EntryID The EntryID parameter specifies the deleted item that you want to restore. The EntryID value for the deleted item is unique in the mailbox. You can find the EntryID for specific items by using other search filters on the Get-RecoverableItems cmdlet (subject, date range, etc.). @@ -124,7 +117,6 @@ You can find the EntryID for specific items by using other search filters on the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -134,6 +126,9 @@ Accept wildcard characters: False ``` ### -FilterEndTime + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The FilterEndTime specifies the end date/time of the date range. This parameter uses the LastModifiedTime value of the item. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -142,7 +137,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,6 +146,9 @@ Accept wildcard characters: False ``` ### -FilterItemType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example: - IPM.Appointment (Meetings and appointments) @@ -164,7 +161,6 @@ The FilterItemType parameter filters the results by the specified MessageClass ( Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,6 +170,9 @@ Accept wildcard characters: False ``` ### -FilterStartTime + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The FilterStartTime specifies the start date/time of the date range. This parameter uses the LastModifiedTime value of the item. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -182,7 +181,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -192,13 +190,15 @@ Accept wildcard characters: False ``` ### -LastParentFolderID + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,6 +208,9 @@ Accept wildcard characters: False ``` ### -MaxParallelSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MaxParallelSize parameter specifies the maximum number of mailboxes that are processed by the command in parallel. A valid value is an integer from 1 to 10. Typically, a higher value decreases the amount of time it takes to complete the command on multiple mailboxes. @@ -218,7 +221,6 @@ The value of this parameter has no effect when the Identity parameter specifies Type: Int32 Parameter Sets: Cloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -228,6 +230,9 @@ Accept wildcard characters: False ``` ### -PolicyTag + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill PolicyTag Description }} @@ -236,7 +241,6 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: Cloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -246,13 +250,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,6 +268,9 @@ Accept wildcard characters: False ``` ### -SkipCount + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} @@ -270,7 +279,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -280,6 +288,9 @@ Accept wildcard characters: False ``` ### -SourceFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: - DeletedItems: The Deleted Items folder. @@ -294,7 +305,6 @@ If you don't use this parameter, the command searches those three folders. Type: RecoverableItemsFolderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -304,13 +314,15 @@ Accept wildcard characters: False ``` ### -SubjectContains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SubjectContains parameter filters the items by the specified text value in the Subject field. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md b/exchange/exchange-ps/ExchangePowerShell/Get-RegulatoryComplianceUI.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RegulatoryComplianceUI.md index 69ceb96099..3b3f107381 100644 --- a/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RegulatoryComplianceUI.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-regulatorycomplianceui applicable: Security & Compliance -title: Get-RegulatoryComplianceUI +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-regulatorycomplianceui schema: 2.0.0 +title: Get-RegulatoryComplianceUI --- # Get-RegulatoryComplianceUI diff --git a/exchange/exchange-ps/exchange/Get-RemoteDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-RemoteDomain.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-RemoteDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RemoteDomain.md index ea01811a75..8fa4cd2d7e 100644 --- a/exchange/exchange-ps/exchange/Get-RemoteDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RemoteDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-remotedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RemoteDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-remotedomain +schema: 2.0.0 +title: Get-RemoteDomain --- # Get-RemoteDomain @@ -56,6 +57,9 @@ This example returns all domains where Transport Neutral Encapsulation Format (T ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the remote domain that you want to view. You can use any value that uniquely identifies the remote domain. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the remote domain that you want to view. You ca Type: RemoteDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -86,7 +92,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -104,7 +112,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-RemoteMailbox.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RemoteMailbox.md index f40415ec08..288f6d8327 100644 --- a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-RemoteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-remotemailbox +schema: 2.0.0 +title: Get-RemoteMailbox --- # Get-RemoteMailbox @@ -83,6 +84,9 @@ First, run the following command to prompt you for your credentials and then sto ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the remote mailbox that you want to view. You can use any value that uniquely identifies the remote mailbox. For example: - Name @@ -100,7 +104,6 @@ The Identity parameter specifies the remote mailbox that you want to view. You c Type: RemoteMailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -122,7 +128,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +137,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Archive switch is required to return the user's archive mailbox in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +155,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -156,7 +166,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +175,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -197,7 +211,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +220,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -218,7 +234,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +243,9 @@ Accept wildcard characters: False ``` ### -OnPremisesOrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OnPremisesOrganizationalUnit parameter filters the results by the object's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -241,7 +259,6 @@ Valid input for this parameter is an organizational unit (OU) or domain that's r Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -261,7 +281,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -271,6 +290,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. **Note**: Limitations on domain controllers might affect the number of results returned for the value unlimited. For more information, see [this article](https://learn.microsoft.com/troubleshoot/windows-server/identity/domain-controller-returns-500-values-ldap-response). @@ -279,7 +301,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,6 +310,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -303,7 +327,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md b/exchange/exchange-ps/ExchangePowerShell/Get-ReportExecutionInstance.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ReportExecutionInstance.md index 134a709559..8c2a4481b7 100644 --- a/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ReportExecutionInstance.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-reportexecutioninstance applicable: Exchange Online, Exchange Online Protection -title: Get-ReportExecutionInstance -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-reportexecutioninstance +schema: 2.0.0 +title: Get-ReportExecutionInstance --- # Get-ReportExecutionInstance @@ -48,13 +49,15 @@ This example returns detailed information for the specified report execution ins ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the report execution instance that you want to view. The identity of the instance is a unique GUID value. ```yaml Type: InstanceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -ScheduleId + +> Applicable: Exchange Online, Exchange Online Protection + The ScheduleId parameter filters the results by the specified ScheduleId property value, which is a GUID. Note that multiple report execution instances can have the same ScheduleId value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionPolicy.md index 483f073460..5e6ea078a9 100644 --- a/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-reportsubmissionpolicy applicable: Exchange Online -title: Get-ReportSubmissionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-reportsubmissionpolicy +schema: 2.0.0 +title: Get-ReportSubmissionPolicy --- # Get-ReportSubmissionPolicy @@ -43,13 +44,15 @@ This example returns the settings of the report submission policy in your organi ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission policy that you want to view. The only available policy is named DefaultReportSubmissionPolicy. ```yaml Type: ReportSubmissionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionRule.md index f64f8d899b..90b8ad8b50 100644 --- a/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-reportsubmissionrule applicable: Exchange Online -title: Get-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-reportsubmissionrule +schema: 2.0.0 +title: Get-ReportSubmissionRule --- # Get-ReportSubmissionRule @@ -39,13 +40,15 @@ This example returns detailed information about the report submission rule in yo ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission rule that you want to view. The default rule is named DefaultReportSubmissionRule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -55,6 +58,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by whether the report submission rule is enabled or disabled. Valid values are: - Disabled @@ -67,7 +73,6 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ResourceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-ResourceConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ResourceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ResourceConfig.md index e5087116d5..fc626e15b6 100644 --- a/exchange/exchange-ps/exchange/Get-ResourceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ResourceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-resourceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-ResourceConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-resourceconfig +schema: 2.0.0 +title: Get-ResourceConfig --- # Get-ResourceConfig @@ -41,6 +42,9 @@ This example returns all of the available custom room and equipment mailbox prop ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -49,7 +53,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -67,7 +73,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ResubmitRequest.md b/exchange/exchange-ps/ExchangePowerShell/Get-ResubmitRequest.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ResubmitRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ResubmitRequest.md index e6837d4223..aa641f4105 100644 --- a/exchange/exchange-ps/exchange/Get-ResubmitRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ResubmitRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-resubmitrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ResubmitRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-resubmitrequest +schema: 2.0.0 +title: Get-ResubmitRequest --- # Get-ResubmitRequest @@ -48,13 +49,15 @@ This example returns details about the resubmit request with the identity 1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the resubmit request you want to view. Each resubmit request is identified by an incremented integer value. ```yaml Type: ResubmitRequestIdentityParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -77,7 +83,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionCompliancePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RetentionCompliancePolicy.md index fbb20052f5..6f0edb31bd 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy applicable: Security & Compliance -title: Get-RetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentioncompliancepolicy +schema: 2.0.0 +title: Get-RetentionCompliancePolicy --- # Get-RetentionCompliancePolicy @@ -61,6 +62,9 @@ This example displays detailed information for the policy named "Regulation 123 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -71,7 +75,6 @@ The Identity parameter specifies the retention policy that you want to view. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -DistributionDetail + +> Applicable: Security & Compliance + The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. If you don't use this switch, the values of the DistributionStatus and \*Location property values will be inaccurate. @@ -89,7 +95,6 @@ If you don't use this switch, the values of the DistributionStatus and \*Locatio Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -ErrorPolicyOnly + +> Applicable: Security & Compliance + The ErrorPolicyOnly switch specifies whether to show only policies that have distribution errors in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -ExcludeTeamsPolicy + +> Applicable: Security & Compliance + The ExcludeTeamsPolicy switch specifies whether to exclude Teams policies from the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -IncludeTestModeResults + +> Applicable: Security & Compliance + The IncludeTestModeResults switch specifies whether to include the status of test mode in the policy details. You don't need to specify a value with this switch. For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). @@ -139,7 +151,6 @@ For more information about simulation mode, see [Learn about simulation mode](ht Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -165,6 +178,9 @@ Accept wildcard characters: False ``` ### -RetentionRuleTypes + +> Applicable: Security & Compliance + The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes and HasRules properties in the results. You don't need to specify a value with this switch. To see the RetentionRuleTypes property, you need to pipe the command to a formatting cmdlet. For example, `Get-RetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes`. If you don't use the RetentionRuleTypes switch, the values RetentionRuleTypes appears blank and HasRules appears False. @@ -173,7 +189,6 @@ To see the RetentionRuleTypes property, you need to pipe the command to a format Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -183,13 +198,15 @@ Accept wildcard characters: False ``` ### -TeamsPolicyOnly + +> Applicable: Security & Compliance + The TeamsPolicyOnly switch specifies whether to show only Teams policies in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RetentionComplianceRule.md index 9c1279ce96..4340821384 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-retentioncompliancerule applicable: Security & Compliance -title: Get-RetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentioncompliancerule +schema: 2.0.0 +title: Get-RetentionComplianceRule --- # Get-RetentionComplianceRule @@ -56,6 +57,9 @@ This example displays detailed information for the retention rule named "30 Day ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention rule you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the retention rule you want to view. You can us Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter filters the retention rule results by the associated retention policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -88,7 +94,6 @@ You can use this parameter with the Identity parameter in the same command. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RetentionEvent.md b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionEvent.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-RetentionEvent.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RetentionEvent.md index c650acf830..e8c112c3ed 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionEvent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionEvent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-retentionevent applicable: Exchange Online, Security & Compliance -title: Get-RetentionEvent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentionevent +schema: 2.0.0 +title: Get-RetentionEvent --- # Get-RetentionEvent @@ -49,13 +50,15 @@ This example returns detailed information about retention the specified retentio ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the retention event that you want to view. ```yaml Type: EwsStoreObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -AllStatus + +> Applicable: Exchange Online + The AllStatus switch specifies whether to include zero count events in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-RetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicy.md index 231c381cff..4b13d321a9 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-retentionpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentionpolicy +schema: 2.0.0 +title: Get-RetentionPolicy --- # Get-RetentionPolicy @@ -43,13 +44,15 @@ This example returns all the properties of the retention policy RP Finance. The ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the policy name. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -67,7 +73,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicyTag.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicyTag.md index 53ece7d08e..97f1c0a293 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RetentionPolicyTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-retentionpolicytag applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-RetentionPolicyTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentionpolicytag +schema: 2.0.0 +title: Get-RetentionPolicyTag --- # Get-RetentionPolicyTag @@ -83,13 +84,15 @@ This example returns all retention tags of Inbox and All types and pipes the res ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the tag. ```yaml Type: RetentionPolicyTagIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -107,7 +113,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,13 +122,15 @@ Accept wildcard characters: False ``` ### -IncludeSystemTags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeSystemTags switch specifies whether to return any system tags. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter returns the retention tags that are assigned to the retention policy that's applied to the specified mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -152,7 +162,6 @@ This parameter only returns default policy tags (DPTs) and personal tags; it doe Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -OptionalInMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OptionalInMailbox parameter is used with the Mailbox parameter to return any opt-in retention tags that are assigned to the specified mailbox. You don't need to specify a value with this switch. An opt-in retention tag is a personal tag that was explicitly assigned to the mailbox with the Set-RetentionPolicyTag -Mailbox -OptionalInMailbox command. @@ -170,7 +182,6 @@ An opt-in retention tag is a personal tag that was explicitly assigned to the ma Type: SwitchParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +191,9 @@ Accept wildcard characters: False ``` ### -Types + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Types parameter specifies the type of retention tag to return. Valid values include: - Calendar @@ -204,7 +218,6 @@ The parameter accepts multiple values separated by a comma. Type: ElcFolderType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ReviewItems.md b/exchange/exchange-ps/ExchangePowerShell/Get-ReviewItems.md similarity index 97% rename from exchange/exchange-ps/exchange/Get-ReviewItems.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ReviewItems.md index b9fa1c3b40..63618d7061 100644 --- a/exchange/exchange-ps/exchange/Get-ReviewItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ReviewItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-reviewitems applicable: Exchange Online -title: Get-ReviewItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-reviewitems +schema: 2.0.0 +title: Get-ReviewItems --- # Get-ReviewItems @@ -84,6 +85,9 @@ This example retrieves all items pending disposition for the label with the immu ## PARAMETERS ### -TargetLabelId + +> Applicable: Exchange Online + The TargetLabelId parameter specifies the label that you want to retrieve review items for. A valid value for this parameter is the immutable ID of the label. To get the immutable ID value of a label, replace \ with the name of the label, and then run the following command in Exchange Online PowerShell: `Get-ComplianceTag -Identity "" | select ImmutableId`. @@ -92,7 +96,6 @@ To get the immutable ID value of a label, replace \ with th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Disposed + +> Applicable: Exchange Online + The Disposed parameter specifies whether to return disposed items instead of items pending disposition. Valid values are: - $true: Return disposed items. @@ -111,7 +117,6 @@ The Disposed parameter specifies whether to return disposed items instead of ite Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -IncludeHeaders + +> Applicable: Exchange Online + The IncludeHeaders parameter specifies whether headers are returned as a property with the review items. Valid values are: - $true: Headers are returned as a property with the review items. This option is useful when converting the output to a PSObject in PowerShell or when exporting to CSV. @@ -130,7 +138,6 @@ The IncludeHeaders parameter specifies whether headers are returned as a propert Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -PagingCookie + +> Applicable: Exchange Online + The PagingCookie parameter identifies the page to retrieve. This parameter is useful in the following scenarios: - To avoid throttling while retrieving a large number of items. @@ -151,7 +161,6 @@ The PagingCookie value is returned in the PaginationCookie property each time th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-RoleAssignmentPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RoleAssignmentPolicy.md index 20474cb2b2..0265d8527c 100644 --- a/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RoleAssignmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-roleassignmentpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-RoleAssignmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-roleassignmentpolicy +schema: 2.0.0 +title: Get-RoleAssignmentPolicy --- # Get-RoleAssignmentPolicy @@ -63,13 +64,15 @@ For more information about pipelining and the Format-List cmdlet, see [About Pip ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the assignment policy to view. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -89,7 +95,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RoleGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-RoleGroup.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-RoleGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RoleGroup.md index 7e6cfdc324..2a63f95861 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RoleGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-rolegroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-RoleGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-rolegroup +schema: 2.0.0 +title: Get-RoleGroup --- # Get-RoleGroup @@ -69,6 +70,9 @@ This example retrieves a list of all linked role groups and the Active Directory ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group to retrieve. If the name of the role group contains spaces, enclose the name in quotation marks ("). If the Identity parameter isn't specified, all role groups are returned. @@ -77,7 +81,6 @@ If the Identity parameter isn't specified, all role groups are returned. Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -95,7 +101,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -129,7 +137,6 @@ You can filter on the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -151,7 +161,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,13 +170,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -177,6 +188,9 @@ Accept wildcard characters: False ``` ### -ShowPartnerLinked + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is functional only in the cloud-based service. This ShowPartnerLinked switch specifies whether to return built-in role groups that are of type PartnerRoleGroup. You don't need to specify a value with this switch. @@ -187,7 +201,6 @@ This type of role group is used in the cloud-based service to allow partner serv Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -197,6 +210,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -210,7 +226,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RoleGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Get-RoleGroupMember.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-RoleGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RoleGroupMember.md index 8416becc8f..eb04094c83 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RoleGroupMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-rolegroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-RoleGroupMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-rolegroupmember +schema: 2.0.0 +title: Get-RoleGroupMember --- # Get-RoleGroupMember @@ -52,13 +53,15 @@ This example retrieves a list of all the members of the Organization Administrat ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group for which member information should be retrieved. If the role group name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupMemberIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -76,7 +82,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -98,7 +106,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-RoutingGroupConnector.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RoutingGroupConnector.md index 2f0f384197..02c53261b2 100644 --- a/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RoutingGroupConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-routinggroupconnector applicable: Exchange Server 2010 -title: Get-RoutingGroupConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-routinggroupconnector +schema: 2.0.0 +title: Get-RoutingGroupConnector --- # Get-RoutingGroupConnector @@ -43,13 +44,15 @@ This example displays detailed configuration information for the routing group c ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name or GUID of the routing group connector. The name is expressed as [[Administrative Group Name\\]Routing Group Name]\\Routing Group Connector Name. You can use the wildcard character (\*) as part of the administrative group or routing group name. ```yaml Type: RoutingGroupConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RpcClientAccess.md b/exchange/exchange-ps/ExchangePowerShell/Get-RpcClientAccess.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-RpcClientAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Get-RpcClientAccess.md index adedda699a..558b8e2687 100644 --- a/exchange/exchange-ps/exchange/Get-RpcClientAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-RpcClientAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-rpcclientaccess applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-RpcClientAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-rpcclientaccess +schema: 2.0.0 +title: Get-RpcClientAccess --- # Get-RpcClientAccess @@ -48,13 +49,15 @@ This example returns detailed information for the RPC Client Access service on t ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that you want to view. You can use any value that uniquely identifies the server. For example: @@ -77,7 +83,6 @@ You can use any value that uniquely identifies the server. For example: Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SCInsights.md b/exchange/exchange-ps/ExchangePowerShell/Get-SCInsights.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SCInsights.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SCInsights.md index 7675f4455f..4ff893c003 100644 --- a/exchange/exchange-ps/exchange/Get-SCInsights.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SCInsights.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-scinsights applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-SCInsights -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-scinsights +schema: 2.0.0 +title: Get-SCInsights --- # Get-SCInsights @@ -55,6 +56,9 @@ This example return insights data for March 15, 2018. ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. To specify a date/time value for this parameter, use either of the following options: @@ -66,7 +70,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentPolicy.md index 1330056090..126fcd4417 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safeattachmentpolicy applicable: Exchange Online -title: Get-SafeAttachmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safeattachmentpolicy +schema: 2.0.0 +title: Get-SafeAttachmentPolicy --- # Get-SafeAttachmentPolicy @@ -49,6 +50,9 @@ This example shows detailed information about the safe attachment policy named D ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment policy that you want to view. You can use any value that uniquely identifies the policy. For example: @@ -61,7 +65,6 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentRule.md index 0dded56904..d5b539c3be 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safeattachmentrule applicable: Exchange Online -title: Get-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safeattachmentrule +schema: 2.0.0 +title: Get-SafeAttachmentRule --- # Get-SafeAttachmentRule @@ -50,6 +51,9 @@ This example returns detailed information about the safe attachment rule named R ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment rule that you want to view. You can use any value that uniquely identifies the rule. For example: @@ -62,7 +66,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksAggregateReport.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksAggregateReport.md index 27c72f641a..921116fc89 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksAggregateReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinksaggregatereport applicable: Exchange Online -title: Get-SafeLinksAggregateReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safelinksaggregatereport +schema: 2.0.0 +title: Get-SafeLinksAggregateReport --- # Get-SafeLinksAggregateReport @@ -56,6 +57,9 @@ This example returns results summarized by Email Client and Teams results for th ## PARAMETERS ### -Action + +> Applicable: Exchange Online + The Action parameter filters the results by action. Valid values are: - Allowed @@ -73,7 +77,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -AppNameList + +> Applicable: Exchange Online + The AppNameList parameter filters the results by the app where the link was found. Valid values are: - Email Client @@ -95,7 +101,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -115,7 +123,6 @@ Yesterday is the most recent date that you can specify. You can't specify a date Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -135,7 +145,6 @@ Yesterday is the most recent date that you can specify. You can't specify a date Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -SummarizeBy + +> Applicable: Exchange Online + The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of Action or AppNameList on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that specific Action or App on one row in the report. For this cmdlet, valid values are: @@ -156,7 +168,6 @@ For this cmdlet, valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksDetailReport.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksDetailReport.md index ef6379a4e6..7d26d0b6c1 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksDetailReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinksdetailreport applicable: Exchange Online -title: Get-SafeLinksDetailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safelinksdetailreport +schema: 2.0.0 +title: Get-SafeLinksDetailReport --- # Get-SafeLinksDetailReport @@ -75,6 +76,9 @@ This example returns filters the results by the following information: ## PARAMETERS ### -Action + +> Applicable: Exchange Online + The Action parameter filters the results by action. Valid values are: - Allowed: URL was allowed due to a "Good" verdict. @@ -94,7 +98,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -AppNameList + +> Applicable: Exchange Online + The AppNameList parameter filters the results by the app where the link was found. Valid values are: - Email Client @@ -116,7 +122,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Exchange Online + The Domain parameter filters the results by the domain in the URL. You can specify multiple values separated by commas. @@ -134,7 +142,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -154,7 +164,6 @@ Yesterday is the most recent date that you can specify. You can't specify a date Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -164,13 +173,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -180,13 +191,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. @@ -204,7 +220,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -214,6 +229,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. @@ -224,7 +242,6 @@ Yesterday is the most recent date that you can specify. You can't specify a date Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksPolicy.md index 63a24625de..a50d913ed8 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinkspolicy applicable: Exchange Online -title: Get-SafeLinksPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safelinkspolicy +schema: 2.0.0 +title: Get-SafeLinksPolicy --- # Get-SafeLinksPolicy @@ -49,6 +50,9 @@ This example shows detailed information about the Safe Links policy named Contos ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links policy that you want to view. You can use any value that uniquely identifies the policy. For example: @@ -61,7 +65,6 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksRule.md index 279ebc68cd..73b94df76c 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinksrule applicable: Exchange Online -title: Get-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-safelinksrule +schema: 2.0.0 +title: Get-SafeLinksRule --- # Get-SafeLinksRule @@ -50,6 +51,9 @@ This example returns detailed information about the Safe Links rule named Resear ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links rule that you want to view. You can use any value that uniquely identifies the rule. For example: @@ -62,7 +66,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md b/exchange/exchange-ps/ExchangePowerShell/Get-SearchDocumentFormat.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SearchDocumentFormat.md index 562980e971..ddcea38f6a 100644 --- a/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SearchDocumentFormat.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-searchdocumentformat applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-SearchDocumentFormat -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-searchdocumentformat +schema: 2.0.0 +title: Get-SearchDocumentFormat --- # Get-SearchDocumentFormat @@ -50,13 +51,15 @@ This example retrieves all properties of the docx file format. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of a file format. ```yaml Type: SearchDocumentFormatId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -81,7 +87,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-SecOpsOverridePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SecOpsOverridePolicy.md index a986f97d43..ecff279a3f 100644 --- a/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SecOpsOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-secopsoverridepolicy applicable: Exchange Online -title: Get-SecOpsOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-secopsoverridepolicy +schema: 2.0.0 +title: Get-SecOpsOverridePolicy --- # Get-SecOpsOverridePolicy @@ -41,6 +42,9 @@ This example returns detailed information about the one and only SecOps mailbox ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the SecOps override policy that you want to mod Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md b/exchange/exchange-ps/ExchangePowerShell/Get-SecurityPrincipal.md similarity index 87% rename from exchange/exchange-ps/exchange/Get-SecurityPrincipal.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SecurityPrincipal.md index 458dcbe1b3..28d3b1a44d 100644 --- a/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SecurityPrincipal.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-securityprincipal applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-SecurityPrincipal -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-securityprincipal +schema: 2.0.0 +title: Get-SecurityPrincipal --- # Get-SecurityPrincipal @@ -70,13 +71,15 @@ This example retrieves well-known security principals and displays only the Name ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the security principal. When the security principal is explicitly specified by using this parameter, no additional security principals are returned. ```yaml Type: ExtendedSecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -94,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -119,7 +127,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -IncludeDomainLocalFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IncludeDomainLocalFrom parameter specifies whether to return domain local groups from the FQDN of the specified Active Directory domain (for example, contoso.com) in the results. @@ -139,7 +149,6 @@ Don't use this parameter with the Filter or Identity parameters. Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -160,7 +172,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: ExtendedOrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -170,13 +181,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -RoleGroupAssignable + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The RoleGroupAssignable switch filters security principals by returning only objects that can be assigned to an RBAC role group. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -Types + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Types parameter filters the results by object type. Valid values are: - Computer @@ -217,7 +235,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SendConnector.md b/exchange/exchange-ps/ExchangePowerShell/Get-SendConnector.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-SendConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SendConnector.md index b285afa86f..05f88698a8 100644 --- a/exchange/exchange-ps/exchange/Get-SendConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SendConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sendconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SendConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sendconnector +schema: 2.0.0 +title: Get-SendConnector --- # Get-SendConnector @@ -41,13 +42,15 @@ This example displays detailed information about the Send connector named Contos ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name, or GUID of the Send connector. If the Identity name contains spaces, enclose the name in quotation marks ("). You can omit the Identity parameter label. You can also include the server name by using the format ServerName\\ConnectorName. ```yaml Type: SendConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -65,7 +71,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-SenderFilterConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-SenderFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SenderFilterConfig.md index b89a8e9412..4cf064d7b1 100644 --- a/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SenderFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-senderfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SenderFilterConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-senderfilterconfig +schema: 2.0.0 +title: Get-SenderFilterConfig --- # Get-SenderFilterConfig @@ -41,13 +42,15 @@ This example returns detailed information about the Sender Filter configuration ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -65,7 +71,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SenderIdConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-SenderIdConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SenderIdConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SenderIdConfig.md index 1e0dad4cd1..ec6ce1c598 100644 --- a/exchange/exchange-ps/exchange/Get-SenderIdConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SenderIdConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-senderidconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SenderIdConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-senderidconfig +schema: 2.0.0 +title: Get-SenderIdConfig --- # Get-SenderIdConfig @@ -40,6 +41,9 @@ This example returns detailed information about the Sender ID configuration on t ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -48,7 +52,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-SenderReputationConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SenderReputationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SenderReputationConfig.md index 83288be5e1..871add3003 100644 --- a/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SenderReputationConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-senderreputationconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SenderReputationConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-senderreputationconfig +schema: 2.0.0 +title: Get-SenderReputationConfig --- # Get-SenderReputationConfig @@ -40,6 +41,9 @@ This example returns detailed information about the sender reputation configurat ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -48,7 +52,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServerComponentState.md b/exchange/exchange-ps/ExchangePowerShell/Get-ServerComponentState.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ServerComponentState.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ServerComponentState.md index 2008d37985..5a82a37409 100644 --- a/exchange/exchange-ps/exchange/Get-ServerComponentState.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ServerComponentState.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-servercomponentstate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ServerComponentState -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-servercomponentstate +schema: 2.0.0 +title: Get-ServerComponentState --- # Get-ServerComponentState @@ -49,6 +50,9 @@ This example returns detailed information for the component state of the Unified ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Exchange server where you want to view the configuration settings. You can use the following values: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the Exchange server where you want to view the Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -Component + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Component parameter specifies the component or endpoint for which you want to retrieve the state. To see the available values, run the following command: `Get-ServerComponentState `. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -93,7 +101,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServerHealth.md b/exchange/exchange-ps/ExchangePowerShell/Get-ServerHealth.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-ServerHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ServerHealth.md index 329cfe409b..3dd602e8a9 100644 --- a/exchange/exchange-ps/exchange/Get-ServerHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ServerHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-serverhealth applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ServerHealth -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-serverhealth +schema: 2.0.0 +title: Get-ServerHealth --- # Get-ServerHealth @@ -53,6 +54,9 @@ This example returns the server health for server Server01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the Exchange server where you want to run this Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -HaImpactingOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The HaImpactingOnly switch specifies whether the cmdlet must roll up only the monitors that have HaImpacting set to True. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -HealthSet + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The HealthSet parameter returns the health state of a group of monitors. Monitors that are similar or are tied to a component's architecture are grouped to form a health set. You can determine the collection of monitors (and associated probes and responders) in a given health set by using the Get-MonitoringItemIdentity cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Get-ServerMonitoringOverride.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ServerMonitoringOverride.md index 2986dafdb9..641724b1b8 100644 --- a/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ServerMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-servermonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ServerMonitoringOverride -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-servermonitoringoverride +schema: 2.0.0 +title: Get-ServerMonitoringOverride --- # Get-ServerMonitoringOverride @@ -40,6 +41,9 @@ This example retrieves all monitoring overrides for the Exch01 server. ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -53,7 +57,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-ServiceDeliveryReport.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ServiceDeliveryReport.md index 842dc2fa11..8b0404f1c8 100644 --- a/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ServiceDeliveryReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-servicedeliveryreport applicable: Exchange Online, Exchange Online Protection -title: Get-ServiceDeliveryReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-servicedeliveryreport +schema: 2.0.0 +title: Get-ServiceDeliveryReport --- # Get-ServiceDeliveryReport @@ -41,13 +42,15 @@ This example shows the delivery path information for the recipient chris@contoso ## PARAMETERS ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -57,13 +60,15 @@ Accept wildcard characters: False ``` ### -Recipient + +> Applicable: Exchange Online, Exchange Online Protection + The Recipient parameter specifies the email address of the recipient you want to test. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md b/exchange/exchange-ps/ExchangePowerShell/Get-ServicePrincipal.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-ServicePrincipal.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ServicePrincipal.md index ee06d9d363..19cfbc1188 100644 --- a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ServicePrincipal.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-serviceprincipal applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-ServicePrincipal -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-serviceprincipal +schema: 2.0.0 +title: Get-ServicePrincipal --- # Get-ServicePrincipal @@ -52,6 +53,9 @@ This example returns detailed information about the service principal with the O ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the service principal that you want to view. You can use any value that uniquely identifies the service principal. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the service principal that you want to view. Yo Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 0 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SettingOverride.md b/exchange/exchange-ps/ExchangePowerShell/Get-SettingOverride.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-SettingOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SettingOverride.md index dec2d72019..2fb293f518 100644 --- a/exchange/exchange-ps/exchange/Get-SettingOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SettingOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-settingoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SettingOverride -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-settingoverride +schema: 2.0.0 +title: Get-SettingOverride --- # Get-SettingOverride @@ -52,6 +53,9 @@ This example displays a detailed information for the setting override object nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the setting override that you want to view. You can use any value that uniquely identifies the override. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the setting override that you want to view. You Type: SettingOverrideIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SharingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-SharingPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-SharingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SharingPolicy.md index a9e5d5b87f..928a905807 100644 --- a/exchange/exchange-ps/exchange/Get-SharingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SharingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sharingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-SharingPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sharingpolicy +schema: 2.0.0 +title: Get-SharingPolicy --- # Get-SharingPolicy @@ -50,6 +51,9 @@ This example retrieves the full information for the sharing policy Fabrikam. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the sharing policy that you want to view. You can use one of the following values: - ADObjectID @@ -61,7 +65,6 @@ The Identity parameter specifies the sharing policy that you want to view. You c Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -79,7 +85,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SiteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailbox.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-SiteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SiteMailbox.md index a35a4f6e0c..1953f1a4b1 100644 --- a/exchange/exchange-ps/exchange/Get-SiteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sitemailbox applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SiteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sitemailbox +schema: 2.0.0 +title: Get-SiteMailbox --- # Get-SiteMailbox @@ -64,6 +65,9 @@ This example queries for site mailboxes that are marked for deletion and removes ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the site mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -77,7 +81,6 @@ The Identity parameter specifies the identity of the site mailbox. You can use a Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -99,7 +105,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -BypassOwnerCheck + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. @@ -117,7 +125,6 @@ If you don't use this switch, and you aren't a member or owner of the site mailb Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -DeletedSiteMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeletedSiteMailbox switch returns site mailboxes that have been marked for pending deletion. You don't need to specify a value with this switch. When the lifecycle application in SharePoint closes a site mailbox, the site mailbox is retained for the period specified in the lifecycle policy in the closed state. The mailbox can then be reactivated by an end user or by a SharePoint administrator. After the retention period, the Exchange site mailbox that's housed in the mailbox database will have its name prepended with MDEL: to indicate that it has been marked for deletion. To free storage space and the alias, use the Remove-Mailbox cmdlet to manually remove these site mailboxes from the mailbox database. @@ -135,7 +145,6 @@ When the lifecycle application in SharePoint closes a site mailbox, the site mai Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,13 +154,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -171,7 +185,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxDiagnostics.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxDiagnostics.md index a79fefc2f8..e868fb6ee1 100644 --- a/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxDiagnostics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sitemailboxdiagnostics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SiteMailboxDiagnostics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sitemailboxdiagnostics +schema: 2.0.0 +title: Get-SiteMailboxDiagnostics --- # Get-SiteMailboxDiagnostics @@ -55,6 +56,9 @@ This example returns the event information for the Marketing Events 2015 site ma ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the site mailbox that you want to view. You can use any value that uniquely identifies the site mailbox. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the site mailbox that you want to view. You can Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -BypassOwnerCheck + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. If you don't use this switch and you aren't a member or owner of the site mailbox, the command will fail. @@ -86,7 +92,6 @@ If you don't use this switch and you aren't a member or owner of the site mailbo Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -105,7 +113,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -SendMeEmail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendMeEmail switch specifies that the diagnostic information is sent to the primary SMTP email address of the user account that's running the command. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxProvisioningPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxProvisioningPolicy.md index 1e107e4c93..91b294c205 100644 --- a/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SiteMailboxProvisioningPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sitemailboxprovisioningpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SiteMailboxProvisioningPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sitemailboxprovisioningpolicy +schema: 2.0.0 +title: Get-SiteMailboxProvisioningPolicy --- # Get-SiteMailboxProvisioningPolicy @@ -52,6 +53,9 @@ This example returns detailed information about the site mailbox provisioning po ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the site mailbox provisioning policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the site mailbox provisioning policy that you w Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SmimeConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-SmimeConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-SmimeConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SmimeConfig.md index 94acefe7bf..cdd857bd7f 100644 --- a/exchange/exchange-ps/exchange/Get-SmimeConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SmimeConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-smimeconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-SmimeConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-smimeconfig +schema: 2.0.0 +title: Get-SmimeConfig --- # Get-SmimeConfig @@ -40,13 +41,15 @@ This example shows the S/MIME configuration that's used with Outlook on the web. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md b/exchange/exchange-ps/ExchangePowerShell/Get-SmtpDaneInboundStatus.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SmtpDaneInboundStatus.md index 2bc72a8f55..7c93c5cd2b 100644 --- a/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SmtpDaneInboundStatus.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-smtpdaneinboundstatus applicable: Exchange Online -title: Get-SmtpDaneInboundStatus -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-smtpdaneinboundstatus +schema: 2.0.0 +title: Get-SmtpDaneInboundStatus --- # Get-SmtpDaneInboundStatus @@ -41,13 +42,15 @@ This example checks the DANE status for the accepted domain contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online + The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to view information about DANE (for example, contoso.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md b/exchange/exchange-ps/ExchangePowerShell/Get-SpoofIntelligenceInsight.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SpoofIntelligenceInsight.md index 01335195b4..351bcb4516 100644 --- a/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SpoofIntelligenceInsight.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-spoofintelligenceinsight applicable: Exchange Online, Exchange Online Protection -title: Get-SpoofIntelligenceInsight -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-spoofintelligenceinsight +schema: 2.0.0 +title: Get-SpoofIntelligenceInsight --- # Get-SpoofIntelligenceInsight @@ -57,13 +58,15 @@ This example exports the same list of spoofed senders to a CSV file. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter is available but isn't used. ```yaml Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SpoofMailReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-SpoofMailReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SpoofMailReport.md index 312ec706dc..30898b8ba5 100644 --- a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SpoofMailReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-spoofmailreport applicable: Exchange Online, Exchange Online Protection -title: Get-SpoofMailReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-spoofmailreport +schema: 2.0.0 +title: Get-SpoofMailReport --- # Get-SpoofMailReport @@ -65,6 +66,9 @@ This example shows the insider spoofing detections in your organization during t ## PARAMETERS ### -Action + +> Applicable: Exchange Online, Exchange Online Protection + The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. You can specify multiple values separated by commas. @@ -75,7 +79,6 @@ Common values for this report are GoodMail and CaughtAsSpam. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by incoming messages. The valid value for this parameter is Inbound. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -109,7 +117,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Exchange Online, Exchange Online Protection + The EventType parameter filters the report by the event type. The only valid value for this parameter is SpoofMail. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Exchange Online Protection + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Exchange Online Protection + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,13 +180,15 @@ Accept wildcard characters: False ``` ### -ProbeTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,6 +198,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -191,7 +209,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md b/exchange/exchange-ps/ExchangePowerShell/Get-StoreUsageStatistics.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md rename to exchange/exchange-ps/ExchangePowerShell/Get-StoreUsageStatistics.md index 4a09b7af84..ecf022b35a 100644 --- a/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-StoreUsageStatistics.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-storeusagestatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-StoreUsageStatistics -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-storeusagestatistics +schema: 2.0.0 +title: Get-StoreUsageStatistics --- # Get-StoreUsageStatistics @@ -78,6 +79,9 @@ This example retrieves store usage statistics for database DB1 and sorts the out ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox to get usage statistics from. You can use one of the following values to identify the mailbox: - GUID @@ -96,7 +100,6 @@ You can't use this parameter with the Database or Server parameters. Type: GeneralMailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Database parameter specifies the name of the mailbox database to get usage statistics from (the top 25 largest mailboxes on the specified mailbox database). You can use any value that uniquely identifies the mailbox database. For example: - Name @@ -118,7 +124,6 @@ You can't use this parameter with the Identity or Server parameters. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Mailbox server to get usage statistics from (the top 25 mailboxes on all active databases on the specified server). You can use one of the following values to identify the server: - Fully qualified domain name (FQDN) @@ -139,7 +147,6 @@ You can't use this parameter with the Database or Identity parameters. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -149,6 +156,9 @@ Accept wildcard characters: False ``` ### -CopyOnServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CopyOnServer parameter specifies the mailbox database copy to get usage statistics from. You can use any value that uniquely identifies the mailbox database. For example: - Name @@ -161,7 +171,6 @@ You use this parameter with the Server or Identity parameters. Type: ServerIdParameter Parameter Sets: Database, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +180,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,6 +198,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -202,7 +216,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -IncludePassive + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludePassive switch specifies whether to include usage statistics from active and passive copies of mailbox databases on the Mailbox server you specified with the Server parameter. You don't need to specify a value with this switch. If you don't use this switch, only statistics from active copies of mailbox databases are included in the results. @@ -220,7 +236,6 @@ If you don't use this switch, only statistics from active copies of mailbox data Type: SwitchParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewActivity.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewActivity.md index 420045a251..71f674f883 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewActivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewactivity applicable: Exchange Online, Security & Compliance -title: Get-SupervisoryReviewActivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewactivity +schema: 2.0.0 +title: Get-SupervisoryReviewActivity --- # Get-SupervisoryReviewActivity @@ -47,6 +48,9 @@ This example exports all the supervisory review activities for a policy to a .cs ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -55,7 +59,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: True Position: Named @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -PolicyId + +> Applicable: Exchange Online, Security & Compliance + {{ Fill PolicyId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: True Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -89,7 +97,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewOverallProgressReport.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewOverallProgressReport.md index 3a432c1505..dbc52974fd 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewOverallProgressReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewoverallprogressreport applicable: Security & Compliance -title: Get-SupervisoryReviewOverallProgressReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewoverallprogressreport +schema: 2.0.0 +title: Get-SupervisoryReviewOverallProgressReport --- # Get-SupervisoryReviewOverallProgressReport @@ -43,6 +44,9 @@ This example returns a list of the total number of supervised communications cla ## PARAMETERS ### -EndDate + +> Applicable: Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -51,7 +55,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -93,6 +100,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -101,7 +111,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyReport.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyReport.md index d3982ce31b..34eb1e064a 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyreport applicable: Exchange Online, Security & Compliance -title: Get-SupervisoryReviewPolicyReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewpolicyreport +schema: 2.0.0 +title: Get-SupervisoryReviewPolicyReport --- # Get-SupervisoryReviewPolicyReport @@ -60,6 +61,9 @@ This example returns the supervisory review policy events for the policy named E ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -68,7 +72,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Policies + +> Applicable: Exchange Online, Security & Compliance + The Policies parameter filters the results by the supervisory review policy. You can specify multiple values separated by commas. @@ -118,7 +128,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -136,7 +148,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyV2.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyV2.md index cc356b57a5..a6b4994a08 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewPolicyV2.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyv2 applicable: Exchange Online, Security & Compliance -title: Get-SupervisoryReviewPolicyV2 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewpolicyv2 +schema: 2.0.0 +title: Get-SupervisoryReviewPolicyV2 --- # Get-SupervisoryReviewPolicyV2 @@ -47,6 +48,9 @@ This example returns detailed information for the supervisory review policy name ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the supervisory review policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the supervisory review policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewReport.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewReport.md index 5e1a033aa5..c5358a7103 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewreport applicable: Exchange Online, Security & Compliance -title: Get-SupervisoryReviewReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewreport +schema: 2.0.0 +title: Get-SupervisoryReviewReport --- # Get-SupervisoryReviewReport @@ -52,6 +53,9 @@ This example returns the supervisory review events for the policy named US Broke ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -60,7 +64,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Exchange Online, Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Exchange Online, Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -Policies + +> Applicable: Exchange Online, Security & Compliance + The Policies parameter filters the results by the supervisory review policy. You can specify multiple values separated by commas. @@ -110,7 +120,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Reviewers + +> Applicable: Exchange Online, Security & Compliance + The Reviewers parameter filters the results by the reviewers of the supervisory review policy. You can specify multiple values separated by commas. @@ -128,7 +140,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -146,7 +160,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewRule.md index 1a7f812f23..135c9a1e38 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewrule applicable: Exchange Online, Security & Compliance -title: Get-SupervisoryReviewRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewrule +schema: 2.0.0 +title: Get-SupervisoryReviewRule --- # Get-SupervisoryReviewRule @@ -56,6 +57,9 @@ This example returns the rule that assigned to the supervisory review policy nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance + The Identity parameter specifies the supervisory review rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the supervisory review rule that you want to vi Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -IncludeRuleXml + +> Applicable: Security & Compliance + {{ Fill IncludeRuleXml Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Exchange Online, Security & Compliance + The Policy parameter filters the results by supervisory review policy that's assigned to the rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -102,7 +110,6 @@ The Policy parameter filters the results by supervisory review policy that's ass Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewTopCasesReport.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewTopCasesReport.md index f630b5e84b..b6ff38b992 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SupervisoryReviewTopCasesReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewtopcasesreport applicable: Security & Compliance -title: Get-SupervisoryReviewTopCasesReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-supervisoryreviewtopcasesreport +schema: 2.0.0 +title: Get-SupervisoryReviewTopCasesReport --- # Get-SupervisoryReviewTopCasesReport @@ -42,6 +43,9 @@ This example returns detailed information on supervisory policies, including the ## PARAMETERS ### -EndDate + +> Applicable: Security & Compliance + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -50,7 +54,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -Page + +> Applicable: Security & Compliance + The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -76,13 +81,15 @@ Accept wildcard characters: False ``` ### -PageSize + +> Applicable: Security & Compliance + The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -92,6 +99,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Security & Compliance + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -100,7 +110,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-SweepRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SweepRule.md index ceab5bc86d..4a56442e92 100644 --- a/exchange/exchange-ps/exchange/Get-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SweepRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-SweepRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-sweeprule +schema: 2.0.0 +title: Get-SweepRule --- # Get-SweepRule @@ -59,6 +60,9 @@ This example returns detailed information for the Sweep rule with the specified ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Sweep rule that you want to view. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). @@ -69,7 +73,6 @@ The Identity parameter specifies the Sweep rule that you want to view. You can u Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -BypassScopeCheck + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -103,7 +111,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter filters the results by the specified mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -130,7 +140,6 @@ The Mailbox parameter filters the results by the specified mailbox. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -Provider + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Provider parameter filters the results by the specified provider. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -164,7 +178,6 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -SkipCount + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} @@ -182,7 +198,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SystemMessage.md b/exchange/exchange-ps/ExchangePowerShell/Get-SystemMessage.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-SystemMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Get-SystemMessage.md index ba18ccc28c..86e3e2f970 100644 --- a/exchange/exchange-ps/exchange/Get-SystemMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-SystemMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-systemmessage applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-SystemMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-systemmessage +schema: 2.0.0 +title: Get-SystemMessage --- # Get-SystemMessage @@ -74,6 +75,9 @@ You should output the list to a file, because the list is very long, and you'll ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the custom system message that you want to view. You can use any value that uniquely identifies the system message. For example: - Identity @@ -131,7 +135,6 @@ Maximum number of levels (depth) in a mailbox folder: Type: SystemMessageIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -141,6 +144,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -149,7 +155,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +164,9 @@ Accept wildcard characters: False ``` ### -Original + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Original switch filters the results by the default system messages that are included with Exchange. You don't need to specify a value with this switch. You can't use this switch with the Identity parameter. @@ -167,7 +175,6 @@ You can't use this switch with the Identity parameter. Type: SwitchParameter Parameter Sets: Original Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicy.md index 4f520c8a57..b7738fa384 100644 --- a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-teamsprotectionpolicy applicable: Exchange Online -title: Get-TeamsProtectionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-teamsprotectionpolicy +schema: 2.0.0 +title: Get-TeamsProtectionPolicy --- # Get-TeamsProtectionPolicy @@ -40,13 +41,15 @@ This example shows detailed information about the Teams protection policy in the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Teams protection policy that you want to view. There's only one Teams protection policy in an organization named Teams Protection Policy. ```yaml Type: TeamsProtectionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicyRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicyRule.md index 5aba335ec7..ce99649cfb 100644 --- a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TeamsProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-teamsprotectionpolicyrule applicable: Exchange Online -title: Get-TeamsProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-teamsprotectionpolicyrule +schema: 2.0.0 +title: Get-TeamsProtectionPolicyRule --- # Get-TeamsProtectionPolicyRule @@ -41,13 +42,15 @@ This example shows detailed information about the Teams protection policy in the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Teams protection policy rule that you want to view. There's only one Teams protection policy rule in an organization named Teams Protection Policy Rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter filters the results by the State value of the rule. Valid values are: - Enabled @@ -66,7 +72,6 @@ The State parameter filters the results by the State value of the rule. Valid va Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md b/exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListItems.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListItems.md index e011044ffb..2281e8eb73 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-tenantallowblocklistitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-TenantAllowBlockListItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-tenantallowblocklistitems +schema: 2.0.0 +title: Get-TenantAllowBlockListItems --- # Get-TenantAllowBlockListItems @@ -71,6 +72,9 @@ This example returns information for all allowed non-Microsoft phishing simulati ## PARAMETERS ### -ListType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListType parameter specifies the list to view. Valid values are: - FileHash @@ -82,7 +86,6 @@ The ListType parameter specifies the list to view. Valid values are: Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -Entry + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Entry parameter filters the results based on the ListType parameter value. Valid values are: - FileHash: The exact SHA256 file hash value. @@ -105,7 +111,6 @@ This value is shown in the Value property of the entry in the output of the Get- Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -NoExpiration + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The NoExpiration switch filters the results by entries that are set to never expire. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: NoExpiration Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -Allow + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Allow switch filters the results for allow entries. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -Block + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Block switch filters the results for block entries. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -ExpirationDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ExpirationDate parameter filters the results by expiration date in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -174,7 +188,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: Expiration Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -184,6 +197,9 @@ Accept wildcard characters: False ``` ### -ListSubType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListSubType parameter filters the results by subtype. Valid values are: - AdvancedDelivery @@ -193,7 +209,6 @@ The ListSubType parameter filters the results by subtype. Valid values are: Type: ListSubType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -203,6 +218,9 @@ Accept wildcard characters: False ``` ### -OutputJson + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The OutputJson switch specifies whether to return all entries in a single JSON value. You don't need to specify a value with this switch. You use this switch to prevent the command from halting on the first entry that contains a syntax error. @@ -211,7 +229,6 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListSpoofItems.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListSpoofItems.md index a77fd3036a..4a6937ad9f 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TenantAllowBlockListSpoofItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-tenantallowblocklistspoofitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-TenantAllowBlockListSpoofItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-tenantallowblocklistspoofitems +schema: 2.0.0 +title: Get-TenantAllowBlockListSpoofItems --- # Get-TenantAllowBlockListSpoofItems @@ -71,13 +72,15 @@ This example exports the same list of spoofed pairs to a CSV file. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter is available but isn't used. ```yaml Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 0 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Action parameter filters the results by action type. Valid values are: - Allow @@ -96,7 +102,6 @@ The Action parameter filters the results by action type. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -SpoofType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SpoofType parameter filters the results by spoof type. Valid values are: - External @@ -115,7 +123,6 @@ The SpoofType parameter filters the results by spoof type. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md b/exchange/exchange-ps/ExchangePowerShell/Get-TextMessagingAccount.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-TextMessagingAccount.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TextMessagingAccount.md index 11e102c7e7..6d7d0bf508 100644 --- a/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TextMessagingAccount.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-textmessagingaccount applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-TextMessagingAccount -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-textmessagingaccount +schema: 2.0.0 +title: Get-TextMessagingAccount --- # Get-TextMessagingAccount @@ -55,6 +56,9 @@ This example finds all user mailboxes where text messaging notifications are ena ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -72,7 +76,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -90,7 +96,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -108,7 +116,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -128,7 +138,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicy.md index 5299f4079b..f3cb66dd00 100644 --- a/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-throttlingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ThrottlingPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-throttlingpolicy +schema: 2.0.0 +title: Get-ThrottlingPolicy --- # Get-ThrottlingPolicy @@ -55,13 +56,15 @@ This example displays the parameters and values for throttling policy Throttling ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter identifies the name of the throttling policy that you want to return settings for. ```yaml Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -79,7 +85,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -Diagnostics + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Diagnostics switch specifies whether you want the output to include the diagnostics string. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -Explicit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Explicit switch specifies whether to return only the policy settings that have been directly assigned using this policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicyScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ThrottlingPolicyScope parameter specifies the scope of the throttling policy. You can use the following values: - Global @@ -133,7 +145,6 @@ For information about each of these policy scopes, see [User workload management Type: ThrottlingPolicyScopeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicyAssociation.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md rename to exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicyAssociation.md index 6850db5cc9..77d4935205 100644 --- a/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-ThrottlingPolicyAssociation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-throttlingpolicyassociation applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-ThrottlingPolicyAssociation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-throttlingpolicyassociation +schema: 2.0.0 +title: Get-ThrottlingPolicyAssociation --- # Get-ThrottlingPolicyAssociation @@ -71,6 +72,9 @@ This example returns detailed information for the throttling policy association ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the throttling policy association that you want to view. You can use any value that uniquely identifies the throttling policy association. For example: - Name @@ -91,7 +95,6 @@ The Identity parameter specifies the throttling policy association that you want Type: ThrottlingPolicyAssociationIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -113,7 +119,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -131,7 +139,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,13 +148,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +166,15 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ThrottlingPolicy parameter filters the results by throttling policy. You can use any value that uniquely identifies the throttling policy. For example: - Name @@ -183,7 +197,6 @@ The ThrottlingPolicy parameter filters the results by throttling policy. You can Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportAgent.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportAgent.md index 8efaaf32bc..82e2fe42d4 100644 --- a/exchange/exchange-ps/exchange/Get-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportAgent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportagent +schema: 2.0.0 +title: Get-TransportAgent --- # Get-TransportAgent @@ -49,13 +50,15 @@ This example displays detailed information about the Transport Rule agent that's ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the display name of the transport agent to be displayed. The length of the name can't exceed 64 characters. ```yaml Type: TransportAgentObjectId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -73,7 +79,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -95,7 +103,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportConfig.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-TransportConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportConfig.md index 3357a4be56..02598b341e 100644 --- a/exchange/exchange-ps/exchange/Get-TransportConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Get-TransportConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportconfig +schema: 2.0.0 +title: Get-TransportConfig --- # Get-TransportConfig @@ -50,6 +51,9 @@ This example lists all delivery status notification-related (DSN) configuration ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -58,7 +62,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -78,7 +84,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportPipeline.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportPipeline.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-TransportPipeline.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportPipeline.md index 8366b7fc1a..f475a86fd2 100644 --- a/exchange/exchange-ps/exchange/Get-TransportPipeline.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportPipeline.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportpipeline applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportPipeline -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportpipeline +schema: 2.0.0 +title: Get-TransportPipeline --- # Get-TransportPipeline @@ -55,6 +56,9 @@ This example returns a list of agents registered in the transport pipeline, with ## PARAMETERS ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -63,7 +67,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Get-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportRule.md index d55f8756f4..f0b41ab022 100644 --- a/exchange/exchange-ps/exchange/Get-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-TransportRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportrule +schema: 2.0.0 +title: Get-TransportRule --- # Get-TransportRule @@ -71,6 +72,9 @@ In on-premises Exchange, this example returns a summary list of all rules that e ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -81,7 +85,6 @@ The Identity parameter specifies the rule that you want to view. You can use any Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -101,7 +107,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The State parameter specifies filters the results by enabled or disabled rules. Valid values are: - Enabled: Only enabled rules are returned in the results. @@ -122,7 +130,6 @@ If you don't use this parameter, the command returns all rules, both enabled and Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This parameter is functional only in on-premises Exchange. The DlpPolicy parameter filters the results by the name of the specified data loss prevention (DLP) policy. If the value contains spaces, enclose the value in quotation marks ("). @@ -142,7 +152,6 @@ DLP policies in your organization allow you to prevent unintentional disclosure Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -ExcludeConditionActionDetails + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ExcludeConditionActionDetails parameter specifies whether to hide specific details from the results. Valid values are: @@ -163,7 +175,6 @@ The ExcludeConditionActionDetails parameter specifies whether to hide specific d Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Filter parameter filters the results by using an OPATH. This parameter searches the Description property, which includes the conditions, exceptions, actions and the associated values of a transport rule. This parameter uses the syntax `"Description -like 'Text*'"`. For example, `"Description -like '192.168.1.1*'"`. @@ -183,7 +197,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -193,13 +206,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportRuleAction.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRuleAction.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-TransportRuleAction.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportRuleAction.md index a7052dc127..356cfd7f34 100644 --- a/exchange/exchange-ps/exchange/Get-TransportRuleAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRuleAction.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportruleaction applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-TransportRuleAction -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportruleaction +schema: 2.0.0 +title: Get-TransportRuleAction --- # Get-TransportRuleAction @@ -51,13 +52,15 @@ For more information about pipelining, see [About Pipelines](https://learn.micro ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the action that you want to view. To see the list of available names, run the command Get-TransportRuleAction. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRulePredicate.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-TransportRulePredicate.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportRulePredicate.md index 1781b502e3..002d434fe7 100644 --- a/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportRulePredicate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportrulepredicate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Get-TransportRulePredicate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportrulepredicate +schema: 2.0.0 +title: Get-TransportRulePredicate --- # Get-TransportRulePredicate @@ -62,13 +63,15 @@ For more information about how to work with the output of a command, see [Workin ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the predicate that you want to view. To see the list of available names, run the command Get-TransportRulePredicate. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-TransportServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportServer.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-TransportServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportServer.md index 9e6bfd34f4..be4676662a 100644 --- a/exchange/exchange-ps/exchange/Get-TransportServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportserver +schema: 2.0.0 +title: Get-TransportServer --- # Get-TransportServer @@ -50,6 +51,9 @@ This example retrieves the detailed transport configuration information for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Transport server that you want to view. You can use any value that uniquely identifies the server. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the Transport server that you want to view. You Type: TransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -79,7 +85,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TransportService.md b/exchange/exchange-ps/ExchangePowerShell/Get-TransportService.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-TransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Get-TransportService.md index de2c585879..a7da169a33 100644 --- a/exchange/exchange-ps/exchange/Get-TransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-TransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-transportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-TransportService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-transportservice +schema: 2.0.0 +title: Get-TransportService --- # Get-TransportService @@ -48,6 +49,9 @@ This example retrieves the detailed transport configuration information for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Mailbox server that hosts the Transport service configuration you want to view. You can use any value that uniquely identifies the server. For example: - Name @@ -61,7 +65,6 @@ You can't use this parameter on an Edge Transport server. Type: TransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -79,7 +85,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Trust.md b/exchange/exchange-ps/ExchangePowerShell/Get-Trust.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-Trust.md rename to exchange/exchange-ps/ExchangePowerShell/Get-Trust.md index 06c4e8a053..035a77f9d4 100644 --- a/exchange/exchange-ps/exchange/Get-Trust.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-Trust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-trust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-Trust -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-trust +schema: 2.0.0 +title: Get-Trust --- # Get-Trust @@ -42,13 +43,15 @@ This example enumerates all trusts for the domain Contoso.com. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainName parameter specifies that trusts returned are restricted to the domain name specified. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMActiveCalls.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMActiveCalls.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-UMActiveCalls.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMActiveCalls.md index ad6d739107..291c7a984f 100644 --- a/exchange/exchange-ps/exchange/Get-UMActiveCalls.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMActiveCalls.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umactivecalls applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMActiveCalls -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umactivecalls +schema: 2.0.0 +title: Get-UMActiveCalls --- # Get-UMActiveCalls @@ -90,6 +91,9 @@ This example displays a list of active calls associated with the UM dial plan My ## PARAMETERS ### -DialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DialPlan parameter specifies the UM dial plan for which you want to retrieve active calls. You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command. @@ -98,7 +102,6 @@ You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in t Type: UMDialPlanIdParameter Parameter Sets: DialPlan Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -InstanceServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InstanceServer parameter specifies the Mailbox server running the Microsoft Exchange Unified Messaging service for which you want to retrieve active calls. You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command. @@ -116,7 +122,6 @@ You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in t Type: UMServer Parameter Sets: ServerInstance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -IPGateway + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IPGateway parameter specifies the UM IP gateway for which you want to retrieve active calls. You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command. @@ -134,7 +142,6 @@ You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in t Type: UMIPGatewayIdParameter Parameter Sets: UMIPGateway Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -144,13 +151,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Server parameter filters the results by the specified Unified Messaging server. You can use any value that uniquely identifies the server. For example: - Name @@ -173,7 +185,6 @@ You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in t Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMAutoAttendant.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMAutoAttendant.md index 4ae3dced8b..f8dd5e3588 100644 --- a/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umautoattendant +schema: 2.0.0 +title: Get-UMAutoAttendant --- # Get-UMAutoAttendant @@ -60,13 +61,15 @@ This examples displays all the UM auto attendants associated with the UM dial pl ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM auto attendant that's being viewed. This is the directory object ID for the UM auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies whether to display all the UM auto attendants that are associated with the UM dial plan that's specified. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallAnsweringRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMCallAnsweringRule.md index e469e77136..0c79f7fbfd 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: Get-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umcallansweringrule +schema: 2.0.0 +title: Get-UMCallAnsweringRule --- # Get-UMCallAnsweringRule @@ -53,13 +54,15 @@ This example displays the properties of the call answering rule MyUMCallAnswerin ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for a call answering rule being viewed. ```yaml Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox that contains the UM call answering rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -104,7 +112,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallDataRecord.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-UMCallDataRecord.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMCallDataRecord.md index 868677c8f0..ff1aaeaeeb 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallDataRecord.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umcalldatarecord applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMCallDataRecord -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umcalldatarecord +schema: 2.0.0 +title: Get-UMCallDataRecord --- # Get-UMCallDataRecord @@ -58,6 +59,9 @@ This example displays the UM call data records for the UM-enabled user Tony. ## PARAMETERS ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox that UM call data records are displayed for. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -75,7 +79,6 @@ The Mailbox parameter specifies the UM-enabled mailbox that UM call data records Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallRouterSettings.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMCallRouterSettings.md index 44123198a3..45deb8cca3 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallRouterSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umcallroutersettings applicable: Exchange Server 2013, Exchange Server 2016 -title: Get-UMCallRouterSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umcallroutersettings +schema: 2.0.0 +title: Get-UMCallRouterSettings --- # Get-UMCallRouterSettings @@ -50,6 +51,9 @@ This example displays detailed information for the Microsoft Exchange Unified Me ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -63,7 +67,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallSummaryReport.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMCallSummaryReport.md index 87b5ea88f8..c37b790bbe 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMCallSummaryReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umcallsummaryreport applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMCallSummaryReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umcallsummaryreport +schema: 2.0.0 +title: Get-UMCallSummaryReport --- # Get-UMCallSummaryReport @@ -86,6 +87,9 @@ This example displays the statistics for calls received or placed by Mailbox ser ## PARAMETERS ### -GroupBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The GroupBy parameter specifies how to return the results. Valid values are: - Day: Daily statistics for the last 90 days. @@ -96,7 +100,6 @@ The GroupBy parameter specifies how to return the results. Valid values are: Type: GroupBy Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the Unified Messaging (UM) dial plan to show statistics for. If you don't specify a dial plan, statistics are included for all dial plans in the organization. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -UMIPGateway + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMIPGateway parameter specifies the UM IP gateway to show statistics for. If you don't specify a UM IP gateway, statistics are included for all UM IP gateways for a selected dial plan, or, if no dial plan is selected, results will be returned for all UM IP gateways in the organization. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMDialPlan.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMDialPlan.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-UMDialPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMDialPlan.md index fe86e9ee42..dbac8b385c 100644 --- a/exchange/exchange-ps/exchange/Get-UMDialPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMDialPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMDialPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umdialplan +schema: 2.0.0 +title: Get-UMDialPlan --- # Get-UMDialPlan @@ -52,13 +53,15 @@ This example displays a formatted list of properties for the UM dial plan MyUMDi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the UM dial plan ID. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMHuntGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMHuntGroup.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-UMHuntGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMHuntGroup.md index d1a7328d41..2c4eae3937 100644 --- a/exchange/exchange-ps/exchange/Get-UMHuntGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMHuntGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umhuntgroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMHuntGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umhuntgroup +schema: 2.0.0 +title: Get-UMHuntGroup --- # Get-UMHuntGroup @@ -60,13 +61,15 @@ This example displays all of the UM hunt groups associated with the UM dial plan ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM hunt group being viewed. This is the directory object ID for the UM hunt group. ```yaml Type: UMHuntGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan associated with a UM hunt group. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMIPGateway.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMIPGateway.md index f027b0d0a4..a34b158d04 100644 --- a/exchange/exchange-ps/exchange/Get-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umipgateway +schema: 2.0.0 +title: Get-UMIPGateway --- # Get-UMIPGateway @@ -62,13 +63,15 @@ This example displays all the UM IP gateways including IP gateway simulators in ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM IP gateway being viewed. This parameter is the directory object ID for the UM IP gateway. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -IncludeSimulator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IncludeSimulator switch retrieves the simulator of the UM IP gateway being viewed. You don't need to specify a value with this switch. A simulator allows a client to connect to the Mailbox server. @@ -102,7 +110,6 @@ A simulator allows a client to connect to the Mailbox server. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailbox.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-UMMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMMailbox.md index 215a6b501d..b2de66ff19 100644 --- a/exchange/exchange-ps/exchange/Get-UMMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ummailbox +schema: 2.0.0 +title: Get-UMMailbox --- # Get-UMMailbox @@ -70,6 +71,9 @@ This example displays detailed information for the UM-enabled mailbox for tonysm ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the UM-enabled mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -87,7 +91,6 @@ The Identity parameter specifies the UM-enabled mailbox that you want to view. Y Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -109,7 +115,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -127,7 +135,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -137,13 +144,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -168,7 +180,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -178,6 +189,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -189,7 +203,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -199,6 +212,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -210,7 +226,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -220,6 +235,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -230,7 +248,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -240,13 +257,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -256,6 +275,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -270,7 +292,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPin.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-UMMailboxPIN.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPin.md index c3eb5e4cc0..04ded39c11 100644 --- a/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPin.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ummailboxpin applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMMailboxPIN -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ummailboxpin +schema: 2.0.0 +title: Get-UMMailboxPin --- # Get-UMMailboxPin @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-UMMailboxPIN cmdlet to return information from a Unified Messaging (UM)-enabled user's mailbox. +Use the Get-UMMailboxPin cmdlet to return information from a Unified Messaging (UM)-enabled user's mailbox. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -32,7 +33,7 @@ Get-UMMailboxPin [[-Identity] ] ``` ## DESCRIPTION -The Get-UMMailboxPIN cmdlet returns information calculated from the PIN data stored in encrypted form in the user's mailbox. This cmdlet also shows whether the mailbox or user access has been locked out. +The Get-UMMailboxPin cmdlet returns information calculated from the PIN data 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. @@ -42,14 +43,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Get-UMMailboxPIN +Get-UMMailboxPin ``` This example displays the UM mailbox PIN-related properties for all UM-enabled users. ### Example 2 ```powershell -Get-UMMailboxPIN -Identity tonysmith@contoso.com +Get-UMMailboxPin -Identity tonysmith@contoso.com ``` This example displays the UM mailbox PIN-related properties for tonysmith@contoso.com. @@ -57,6 +58,9 @@ This example displays the UM mailbox PIN-related properties for tonysmith@contos ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -92,7 +98,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -129,7 +139,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -IgnoreErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreErrors switch specifies whether to ignore errors. You don't need to specify a value with this switch. When you use this switch, errors that occur are written as warnings. @@ -147,7 +159,6 @@ When you use this switch, errors that occur are written as warnings. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -167,7 +181,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPolicy.md index d3e95a0446..6bb94bc162 100644 --- a/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Get-UMMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ummailboxpolicy +schema: 2.0.0 +title: Get-UMMailboxPolicy --- # Get-UMMailboxPolicy @@ -60,13 +61,15 @@ This examples displays all the UM mailbox policies associated with the UM dial p ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM mailbox policy being viewed. This is the directory object ID for the UM mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies that all UM mailbox policies associated with the UM dial plan are displayed. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UmServer.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMServer.md similarity index 96% rename from exchange/exchange-ps/exchange/Get-UmServer.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMServer.md index 0ba48166ad..eeb14f3928 100644 --- a/exchange/exchange-ps/exchange/Get-UmServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umserver applicable: Exchange Server 2010 -title: Get-UmServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umserver +schema: 2.0.0 +title: Get-UMServer --- # Get-UMServer @@ -54,6 +55,9 @@ This example returns detailed information for the Unified Messaging server named ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Unified Messaging server that you want to view. You can use any value that uniquely identifies the server. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the Unified Messaging server that you want to v Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UMService.md b/exchange/exchange-ps/ExchangePowerShell/Get-UMService.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-UMService.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UMService.md index 6551e952a2..1baf293205 100644 --- a/exchange/exchange-ps/exchange/Get-UMService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UMService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-umservice applicable: Exchange Server 2013, Exchange Server 2016 -title: Get-UMService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-umservice +schema: 2.0.0 +title: Get-UMService --- # Get-UMService @@ -52,6 +53,9 @@ This example displays detailed information for the Microsoft Exchange Unified Me ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the Mailbox server that hosts the Unified Messaging service configuration you want to view. You can use any value that uniquely identifies the server. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the Mailbox server that hosts the Unified Messa Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedAuditLogRetentionPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UnifiedAuditLogRetentionPolicy.md index 07a961fcf8..9156191778 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedAuditLogRetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedauditlogretentionpolicy applicable: Security & Compliance -title: Get-UnifiedAuditLogRetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-unifiedauditlogretentionpolicy +schema: 2.0.0 +title: Get-UnifiedAuditLogRetentionPolicy --- # Get-UnifiedAuditLogRetentionPolicy @@ -53,6 +54,9 @@ This example lists the configurable properties for all audit log retention polic ## PARAMETERS ### -Operation + +> Applicable: Security & Compliance + The Operations parameter filters the results by the operations that are specified in the policy. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -61,7 +65,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -RecordType + +> Applicable: Security & Compliance + The RecordType parameter filters the results by the record types that are defined in the policy. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). ```yaml Type: AuditRecordType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter filters the policy results by the retention duration specified in the policy. Valid values are: - ThreeMonths @@ -100,7 +108,6 @@ Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears -Applicable: Security & Compliance Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -UserId + +> Applicable: Security & Compliance + The UserIds parameter filters the policy results by the ID of the users who are specified in the policy. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -118,7 +128,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroup.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-UnifiedGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroup.md index 0d661079bb..0673369181 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup applicable: Exchange Online, Exchange Online Protection -title: Get-UnifiedGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-unifiedgroup +schema: 2.0.0 +title: Get-UnifiedGroup --- # Get-UnifiedGroup @@ -103,6 +104,9 @@ This example returns Microsoft 365 Groups that are created when a Microsoft Team ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to view. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -118,7 +122,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to view. Type: UnifiedGroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -128,13 +131,15 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Online, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -159,7 +167,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -169,6 +176,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromSendersOrMembers recipients in the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromSendersOrMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property is empty. @@ -177,7 +187,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,6 +196,9 @@ Accept wildcard characters: False ``` ### -IncludeAllProperties + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeAllProperties switch specifies whether to include the values of all properties in the results. You don't need to specify a value with this switch. If you don't use this switch, the values of some properties (for example, CalendarMemberReadOnly, CalendarUrl, InboxUrl, PeopleUrl, and PhotoUrl) might appear blank. @@ -195,7 +207,6 @@ If you don't use this switch, the values of some properties (for example, Calend Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -205,6 +216,9 @@ Accept wildcard characters: False ``` ### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeBypassModerationFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of BypassModerationFromSendersOrMembers recipients in the BypassModerationFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, BypassModerationFromSendersOrMembers recipients are shown as GUIDs and the BypassModerationFromSendersOrMembersWithDisplayNames property is empty. @@ -213,7 +227,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -223,6 +236,9 @@ Accept wildcard characters: False ``` ### -IncludeGrantSendOnBehalfToWithDisplayNames + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeGrantSendOnBehalfToWithDisplayNames switch specifies whether to return the SMTP addresses and display names of GrantSendOnBehalfTo recipients in the GrantSendOnBehalfToWithDisplayNames property. You don't need to specify a value with this switch. This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, GrantSendOnBehalfTo recipients are shown as GUIDs and the GrantSendOnBehalfToWithDisplayNames property is empty. @@ -231,7 +247,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -241,6 +256,9 @@ Accept wildcard characters: False ``` ### -IncludeModeratedByWithDisplayNames + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the ModeratedByWithDisplayNames property is empty. @@ -249,7 +267,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -259,6 +276,9 @@ Accept wildcard characters: False ``` ### -IncludeRejectMessagesFromSendersOrMembersWithDisplayNames + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeRejectMessagesFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of RejectMessagesFromSendersOrMembers recipients in the RejectMessagesFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the RejectMessagesFromSendersOrMembersWithDisplayNames property is empty. @@ -267,7 +287,6 @@ This switch was introduced to restore human-readable identifiers in the results Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -277,6 +296,9 @@ Accept wildcard characters: False ``` ### -IncludeSoftDeletedGroups + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeSoftDeletedGroups switch specifies whether to include soft-deleted Microsoft 365 Groups in the results. You don't need to specify a value with this switch. Soft-deleted Microsoft 365 Groups are deleted groups that are still recoverable. @@ -285,7 +307,6 @@ Soft-deleted Microsoft 365 Groups are deleted groups that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -295,13 +316,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -311,6 +334,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Online, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -325,7 +351,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroupLinks.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroupLinks.md index e47851e9e1..daf58d4d2b 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UnifiedGroupLinks.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedgrouplinks applicable: Exchange Online, Exchange Online Protection -title: Get-UnifiedGroupLinks -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-unifiedgrouplinks +schema: 2.0.0 +title: Get-UnifiedGroupLinks --- # Get-UnifiedGroupLinks @@ -43,6 +44,9 @@ This example show the members of the Microsoft 365 Group named Human Resources D ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to view. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to view. Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -LinkType + +> Applicable: Exchange Online, Exchange Online Protection + The LinkType parameter filters the results by recipient roles in the Microsoft 365 Group. Valid values are: - Members: Participate in conversations, create Teams channels, collaborate on files, and edit the connected SharePoint site. @@ -76,7 +82,6 @@ The LinkType parameter filters the results by recipient roles in the Microsoft 3 Type: LinkType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-User.md b/exchange/exchange-ps/ExchangePowerShell/Get-User.md similarity index 88% rename from exchange/exchange-ps/exchange/Get-User.md rename to exchange/exchange-ps/ExchangePowerShell/Get-User.md index 3cafe8aba0..e2d12cf058 100644 --- a/exchange/exchange-ps/exchange/Get-User.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-User.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-user applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Get-User -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-user +schema: 2.0.0 +title: Get-User --- # Get-User @@ -102,6 +103,9 @@ This example uses the Filter parameter to retrieve information about all users t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter the user that you want to view. You can use any value that uniquely identifies the user. For example: - Name @@ -114,7 +118,6 @@ The Identity parameter the user that you want to view. You can use any value tha Type: UserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -136,7 +142,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -146,6 +151,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Arbitration switch is required to return arbitration mailboxes in the results. You don't need to specify a value with this switch. @@ -158,7 +166,6 @@ To return arbitration mailboxes that are used to store audit log settings or dat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +175,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuditLog switch is required to return audit log mailboxes in the results. You don't need to specify a value with this switch. @@ -180,7 +190,6 @@ To return other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,6 +199,9 @@ Accept wildcard characters: False ``` ### -AuxAuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuxAuditLog switch is required to return auxiliary audit log mailboxes in the results. You don't need to specify a value with this switch. @@ -202,7 +214,6 @@ To return other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +223,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. @@ -222,7 +236,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -232,6 +245,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -240,7 +256,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -250,6 +265,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -265,7 +283,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -275,6 +292,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -288,7 +308,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -298,6 +317,9 @@ Accept wildcard characters: False ``` ### -IncludeDirectReportsWithDisplayNames + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill IncludeDirectReportsWithDisplayNames Description }} @@ -306,7 +328,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, AnrSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -316,6 +337,9 @@ Accept wildcard characters: False ``` ### -IsVIP + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The IsVIP switch filters the results by priority accounts. You don't need to specify a value with this switch. @@ -326,7 +350,6 @@ For more information about priority accounts, see [Manage and monitor priority a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -336,6 +359,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -347,7 +373,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -357,6 +382,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + The PublicFolder switch is required to return public folder mailboxes in the results. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -365,7 +393,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -375,6 +402,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. @@ -387,7 +417,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -397,6 +426,9 @@ Accept wildcard characters: False ``` ### -RecipientTypeDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientTypeDetails parameter filters the results by the specified user subtype. Valid values are: - DisabledUser @@ -429,7 +461,6 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -439,13 +470,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -455,6 +488,9 @@ Accept wildcard characters: False ``` ### -Sortby + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -472,7 +508,6 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -482,6 +517,9 @@ Accept wildcard characters: False ``` ### -SupervisoryReviewPolicy + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -490,7 +528,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md b/exchange/exchange-ps/ExchangePowerShell/Get-UserBriefingConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-UserBriefingConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UserBriefingConfig.md index 6c04f88148..4053998bbe 100644 --- a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UserBriefingConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-userbriefingconfig applicable: Exchange Online -title: Get-UserBriefingConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-userbriefingconfig +schema: 2.0.0 +title: Get-UserBriefingConfig --- # Get-UserBriefingConfig @@ -51,13 +52,15 @@ This example returns the Briefing configuration for the user lila@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user that you want to view (for example, lila@contoso.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UserPhoto.md b/exchange/exchange-ps/ExchangePowerShell/Get-UserPhoto.md similarity index 92% rename from exchange/exchange-ps/exchange/Get-UserPhoto.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UserPhoto.md index 5314df112d..5112382af9 100644 --- a/exchange/exchange-ps/exchange/Get-UserPhoto.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UserPhoto.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-userphoto applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-UserPhoto -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-userphoto +schema: 2.0.0 +title: Get-UserPhoto --- # Get-UserPhoto @@ -80,6 +81,9 @@ This example displays information about the user photo that was uploaded to Pila ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the user account. You can use any value that uniquely identifies the user account. For example: - Name @@ -97,7 +101,6 @@ The Identity parameter specifies the user account. You can use any value that un Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -Anr + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: - CommonName (CN) @@ -119,7 +125,6 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +134,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -137,7 +145,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +154,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -178,7 +190,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +199,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,6 +217,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -215,7 +231,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +240,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -236,7 +254,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,13 +263,15 @@ Accept wildcard characters: False ``` ### -PhotoType + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,6 +281,9 @@ Accept wildcard characters: False ``` ### -Preview + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Preview switch filters the results by preview photos. You don't need to specify a value with this switch. A preview photo is a photo that was uploaded to the user's account, but wasn't saved, for example, if a user uploads a photo in Outlook on the web Options, but doesn't save it. If you use the Preview switch after a user photo is saved, this cmdlet returns an error saying the preview photo doesn't exist. @@ -270,7 +292,6 @@ A preview photo is a photo that was uploaded to the user's account, but wasn't s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. @@ -290,7 +314,6 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,13 +323,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,6 +341,9 @@ Accept wildcard characters: False ``` ### -SortBy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. @@ -326,7 +354,6 @@ You can sort by the Id property. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md b/exchange/exchange-ps/ExchangePowerShell/Get-UserPrincipalNamesSuffix.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md rename to exchange/exchange-ps/ExchangePowerShell/Get-UserPrincipalNamesSuffix.md index b9afdf3095..47c8e975ea 100644 --- a/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-UserPrincipalNamesSuffix.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-userprincipalnamessuffix applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-UserPrincipalNamesSuffix -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-userprincipalnamessuffix +schema: 2.0.0 +title: Get-UserPrincipalNamesSuffix --- # Get-UserPrincipalNamesSuffix @@ -46,6 +47,9 @@ This example returns all UPN suffixes for the Active Directory forest. ## PARAMETERS ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -57,7 +61,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: ExtendedOrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md b/exchange/exchange-ps/ExchangePowerShell/Get-VivaInsightsSettings.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Get-VivaInsightsSettings.md index bbfd395ab1..3e9042e558 100644 --- a/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-VivaInsightsSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivainsightssettings applicable: Exchange Online -title: Get-VivaInsightsSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivainsightssettings +schema: 2.0.0 +title: Get-VivaInsightsSettings --- # Get-VivaInsightsSettings @@ -58,13 +59,15 @@ This example shows the configuration of Microsoft Viva Insights in Microsoft Tea ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user that you want to view. You identify the user by their User Principal Name (UPN) (for example, roy@contoso.onmicrosoft.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Feature + +> Applicable: Exchange Online + The Feature parameter filters the results by the specified Microsoft Viva Insights feature. Valid values are: - Headspace: Represents all features of Headspace. @@ -83,7 +89,6 @@ The Feature parameter filters the results by the specified Microsoft Viva Insigh Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeature.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-VivaModuleFeature.md rename to exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeature.md index b2787501f8..3cff28b979 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeature.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature applicable: Exchange Online -title: Get-VivaModuleFeature -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivamodulefeature +schema: 2.0.0 +title: Get-VivaModuleFeature --- # Get-VivaModuleFeature @@ -56,13 +56,15 @@ This example returns the details of the Reflection feature in Viva Insights. ## PARAMETERS ### -ModuleId + +> Applicable: Exchange Online + The ModuleId parameter specifies the Viva module of the features that you want to view. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -72,6 +74,9 @@ Accept wildcard characters: False ``` ### -FeatureId + +> Applicable: Exchange Online + The FeatureId parameter specifies the specific feature in the Viva module that you want to view. You can view details about all the features in a Viva module that support feature access controls by running the cmdlet without the FeatureId parameter. These details include the identifiers of all features in a Viva module that support feature access controls. @@ -80,7 +85,6 @@ You can view details about all the features in a Viva module that support featur Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Positional @@ -90,13 +94,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeatureEnablement.md similarity index 98% rename from exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md rename to exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeatureEnablement.md index 8fed8e655e..47a20bcf39 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeatureEnablement.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeatureenablement applicable: Exchange Online -title: Get-VivaModuleFeatureEnablement -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivamodulefeatureenablement +schema: 2.0.0 +title: Get-VivaModuleFeatureEnablement --- # Get-VivaModuleFeatureEnablement diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeaturePolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeaturePolicy.md index 1e4a57e8a1..bebd8abdc5 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-VivaModuleFeaturePolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeaturepolicy applicable: Exchange Online -title: Get-VivaModuleFeaturePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivamodulefeaturepolicy +schema: 2.0.0 +title: Get-VivaModuleFeaturePolicy --- # Get-VivaModuleFeaturePolicy @@ -88,15 +88,17 @@ This example returns details about the policies for all features across all Viva ## PARAMETERS ### -FeatureId + +> Applicable: Exchange Online + The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. ```yaml Type: String -Parameter Sets: FeaturePolicy +Parameter Sets: FeaturePolicy, FeaturePolicyWithMembers Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -105,27 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: FeaturePolicyWithMembers -Aliases: -Applicable: Exchange Online +### -ModuleId -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` +> Applicable: Exchange Online -### -ModuleId The ModuleId parameter specifies the Viva module of the feature policies that you want to view. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -135,6 +126,9 @@ Accept wildcard characters: False ``` ### -PolicyId + +> Applicable: Exchange Online + The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view. To view details about all policies for a feature in a Viva module, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module. @@ -143,7 +137,6 @@ To view details about all policies for a feature in a Viva module, run this cmdl Type: String Parameter Sets: FeaturePolicy Aliases: -Applicable: Exchange Online Required: False Position: Positional @@ -153,7 +146,10 @@ Accept wildcard characters: False ``` ### -MemberIds -The MemberIds parameter specifies the specific users or groups for which you want to view the policies for the feature in the Viva module. + +> Applicable: Exchange Online + +The MemberIds parameter specifies the specific users or groups for which you want to view the policies for the feature in the Viva module. You can provide up to three member IDs. Use the \* character to specify all modules or features. @@ -161,7 +157,6 @@ You can provide up to three member IDs. Use the \* character to specify all modu Type: String[] Parameter Sets: FeaturePolicyWithMembers Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -171,13 +166,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/ExchangePowerShell/Get-VivaOrgInsightsDelegatedRole.md similarity index 95% rename from exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md rename to exchange/exchange-ps/ExchangePowerShell/Get-VivaOrgInsightsDelegatedRole.md index 22defddf64..b4d9ec3c12 100644 --- a/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-VivaOrgInsightsDelegatedRole.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/get-vivaorginsightsdelegatedrole -title: Get-VivaOrgInsightsDelegatedRole -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivaorginsightsdelegatedrole +schema: 2.0.0 +title: Get-VivaOrgInsightsDelegatedRole --- # Get-VivaOrgInsightsDelegatedRole @@ -49,6 +49,9 @@ This example filters the results by the specified delegator. ## PARAMETERS ### -Delegator + +> Applicable: Exchange Online + The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is given to delegates. A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. @@ -57,7 +60,6 @@ A valid value for this parameter is the ObjectID value of the delegator account. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -67,13 +69,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Get-WebServicesVirtualDirectory.md similarity index 91% rename from exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Get-WebServicesVirtualDirectory.md index 1345ae232f..bfc03e42ee 100644 --- a/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-WebServicesVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-webservicesvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-WebServicesVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-webservicesvirtualdirectory +schema: 2.0.0 +title: Get-WebServicesVirtualDirectory --- # Get-WebServicesVirtualDirectory @@ -71,6 +72,9 @@ This example returns a summary list of all virtual directories in the client acc ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the EWS virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -85,7 +89,6 @@ You can't use the Identity and Server parameters in the same command. Type: VirtualDirectoryIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -108,7 +114,6 @@ You can't use the Server and Identity parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. @@ -126,7 +134,6 @@ If you don't use this switch, the properties in Active Directory and in the Inte Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +143,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -ShowMailboxVirtualDirectories + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. By default, this cmdlet shows information about virtual directories in the Client Access services on Mailbox servers. Client connections are proxied from the Client Access services on Mailbox servers to the backend services on Mailbox servers. Clients don't connect directly to the backend services. @@ -162,7 +174,6 @@ We recommend that you use this parameter only under the direction of Microsoft C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md b/exchange/exchange-ps/ExchangePowerShell/Get-X400AuthoritativeDomain.md similarity index 90% rename from exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Get-X400AuthoritativeDomain.md index 3be7ea0728..0779c91d83 100644 --- a/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-X400AuthoritativeDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-x400authoritativedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Get-X400AuthoritativeDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-x400authoritativedomain +schema: 2.0.0 +title: Get-X400AuthoritativeDomain --- # Get-X400AuthoritativeDomain @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-X400AuthoritativeDomain cmdlet to view the configuration information for the X.400 authoritative domains configured in your organization. For more information about how to configure an X.400 authoritative domain, see [Set-X400AuthoritativeDomain](https://learn.microsoft.com/powershell/module/exchange/set-x400authoritativedomain). +Use the Get-X400AuthoritativeDomain cmdlet to view the configuration information for the X.400 authoritative domains configured in your organization. For more information about how to configure an X.400 authoritative domain, see [Set-X400AuthoritativeDomain](https://learn.microsoft.com/powershell/module/exchangepowershell/set-x400authoritativedomain). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -41,13 +42,15 @@ This example displays detailed information about the X.400 authoritative domain ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies a string value for the X.400 authoritative domain. Enter either the GUID or the name of the remote domain. ```yaml Type: X400AuthoritativeDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -57,6 +60,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -65,7 +71,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/ExchangePowerShell/Get-eDiscoveryCaseAdmin.md similarity index 94% rename from exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md rename to exchange/exchange-ps/ExchangePowerShell/Get-eDiscoveryCaseAdmin.md index 2af5f1721a..b5742b5617 100644 --- a/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/ExchangePowerShell/Get-eDiscoveryCaseAdmin.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-ediscoverycaseadmin applicable: Security & Compliance -title: Get-eDiscoveryCaseAdmin -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-ediscoverycaseadmin +schema: 2.0.0 +title: Get-eDiscoveryCaseAdmin --- # Get-eDiscoveryCaseAdmin @@ -43,13 +44,15 @@ This example returns a summary list of all eDiscovery Administrators. ## PARAMETERS ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Security & Compliance + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md b/exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyCollection.md similarity index 90% rename from exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyCollection.md index bdec677fd8..0785727433 100644 --- a/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-dlppolicycollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Import-DlpPolicyCollection -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-dlppolicycollection +schema: 2.0.0 +title: Import-DlpPolicyCollection --- # Import-DlpPolicyCollection @@ -50,13 +51,15 @@ This example imports the DLP policy collection in the file C:\\My Documents\\DLP ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the DLP policy you want to import. The DLP policy must exist in the XML file you specify with the FileData parameter. ```yaml Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FileData parameter specifies the DLP policy collection file you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -74,7 +80,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -93,7 +101,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -127,7 +139,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -137,13 +148,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyTemplate.md similarity index 93% rename from exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyTemplate.md index 41752441f8..7cd67448e0 100644 --- a/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-DlpPolicyTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-dlppolicytemplate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Import-DlpPolicyTemplate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-dlppolicytemplate +schema: 2.0.0 +title: Import-DlpPolicyTemplate --- # Import-DlpPolicyTemplate @@ -42,6 +43,9 @@ This example imports the DLP policy template file C:\\My Documents\\External DLP ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FileData parameter specifies the DLP policy template file you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -50,7 +54,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Import-ExchangeCertificate.md similarity index 92% rename from exchange/exchange-ps/exchange/Import-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Import-ExchangeCertificate.md index f9175f98ff..16a6171171 100644 --- a/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Import-ExchangeCertificate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-exchangecertificate +schema: 2.0.0 +title: Import-ExchangeCertificate --- # Import-ExchangeCertificate @@ -101,6 +102,9 @@ This example imports a chain of certificates from the PKCS #7 file C:\\Certifica ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FileData parameter specifies the contents of the certificate file that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -115,7 +119,6 @@ If the value contains spaces, enclose the value in quotation marks ("). Type: Byte[] Parameter Sets: FileData Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -125,6 +128,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Exchange Server 2013 + **Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To import a certificate file without using the FileName parameter, use the FileData parameter. This parameter is available only in Exchange 2013. @@ -139,7 +145,6 @@ If the value contains spaces, enclose the value in quotation marks ("). Type: String Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2013 Required: True Position: Named @@ -149,13 +154,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: String[] Parameter Sets: FileName Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -165,6 +172,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -174,7 +184,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +193,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -192,7 +204,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -FriendlyName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FriendlyName parameter specifies a friendly name for the certificate. The value must be less than 64 characters. The friendly name value is descriptive text and doesn't affect the functionality of the certificate. @@ -210,7 +224,6 @@ The friendly name value is descriptive text and doesn't affect the functionality Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,6 +233,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Password parameter specifies the password that's required to import the certificate. You can use the following methods as a value for this parameter: @@ -232,7 +248,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -242,6 +257,9 @@ Accept wildcard characters: False ``` ### -PrivateKeyExportable + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PrivateKeyExportable parameter specifies whether the certificate has an exportable private key and controls whether you can export the certificate from this server. Valid values are: - $true: The private key is exportable, so you can export the certificate from this server. @@ -251,7 +269,6 @@ The PrivateKeyExportable parameter specifies whether the certificate has an expo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,6 +278,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -274,7 +294,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,13 +303,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-FilePlanProperty.md b/exchange/exchange-ps/ExchangePowerShell/Import-FilePlanProperty.md similarity index 92% rename from exchange/exchange-ps/exchange/Import-FilePlanProperty.md rename to exchange/exchange-ps/ExchangePowerShell/Import-FilePlanProperty.md index 0a64f7f630..9065fc4a6c 100644 --- a/exchange/exchange-ps/exchange/Import-FilePlanProperty.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-FilePlanProperty.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-fileplanproperty applicable: Security & Compliance -title: Import-FilePlanProperty +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-fileplanproperty schema: 2.0.0 +title: Import-FilePlanProperty --- # Import-FilePlanProperty @@ -42,13 +44,15 @@ This example imports the specified CSV file. ## PARAMETERS ### -RawCsv + +> Applicable: Security & Compliance + The RawCsv parameter specifies the CSV file to import. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -58,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -67,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -77,13 +83,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -93,6 +101,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -101,7 +112,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -111,13 +121,15 @@ Accept wildcard characters: False ``` ### -ValidateOnly + +> Applicable: Security & Compliance + The ValidateOnly switch validates the CSV file without importing. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -127,13 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Import-JournalRuleCollection.md similarity index 89% rename from exchange/exchange-ps/exchange/Import-JournalRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Import-JournalRuleCollection.md index 535e6e67f0..20711926b1 100644 --- a/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-JournalRuleCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-journalrulecollection applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Import-JournalRuleCollection -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-journalrulecollection +schema: 2.0.0 +title: Import-JournalRuleCollection --- # Import-JournalRuleCollection @@ -33,7 +34,7 @@ The Import-JournalRuleCollection cmdlet imports a journal rule collection you pr Importing a journal rule collection from an XML file removes or overwrites all pre-existing journal rules in your organization. Make sure that you have a backup of your current journal rule collection before you import and overwrite your current journal rules. -For more information about how to export a journal rule collection to an XML file, see [Export-JournalRuleCollection](https://learn.microsoft.com/powershell/module/exchange/export-journalrulecollection). +For more information about how to export a journal rule collection to an XML file, see [Export-JournalRuleCollection](https://learn.microsoft.com/powershell/module/exchangepowershell/export-journalrulecollection). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -49,13 +50,15 @@ This example imports journal rules from the XML file named ExportedJournalRules. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of a journal rule to be imported. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FileData parameter specifies the XML file that contains the exported journal rule collection from the Export-JournalRuleCollection cmdlet. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -73,7 +79,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -92,7 +100,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md b/exchange/exchange-ps/ExchangePowerShell/Import-RecipientDataProperty.md similarity index 88% rename from exchange/exchange-ps/exchange/Import-RecipientDataProperty.md rename to exchange/exchange-ps/ExchangePowerShell/Import-RecipientDataProperty.md index 3c8ed062fd..4aa0575df7 100644 --- a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-RecipientDataProperty.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-recipientdataproperty applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Import-RecipientDataProperty -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-recipientdataproperty +schema: 2.0.0 +title: Import-RecipientDataProperty --- # Import-RecipientDataProperty @@ -62,6 +63,9 @@ This example imports the picture file for Ayla Kol. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox or contact that you're adding the picture or spoken name file to. You can use any value that uniquely identifies the user. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the mailbox or contact that you're adding the p Type: MailboxUserContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FileData parameter specifies the picture or spoken name file that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -95,7 +101,6 @@ To import a spoken name, use the SpokenName switch. A valid spoken name file is Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -114,7 +122,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -132,7 +142,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -Picture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Picture switch specifies that you're importing the user's picture file. You don't need to specify a value with this switch. You can't use this switch with the SpokenName switch. @@ -150,7 +162,6 @@ You can't use this switch with the SpokenName switch. Type: SwitchParameter Parameter Sets: ImportPicture Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -SpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SpokenName switch specifies that you're importing the user's spoken name file. You don't need to specify a value with this switch. You can't use this switch with the Picture switch. @@ -168,7 +182,6 @@ You can't use this switch with the Picture switch. Type: SwitchParameter Parameter Sets: ImportSpokenName Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Import-TransportRuleCollection.md similarity index 87% rename from exchange/exchange-ps/exchange/Import-TransportRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Import-TransportRuleCollection.md index 30fae12016..ac58f3c39e 100644 --- a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-TransportRuleCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-transportrulecollection applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Import-TransportRuleCollection -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-transportrulecollection +schema: 2.0.0 +title: Import-TransportRuleCollection --- # Import-TransportRuleCollection @@ -34,7 +35,7 @@ Import-TransportRuleCollection [[-Identity] ] [-FileData] Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in Exchange Server 2010. The Identity parameter specifies the transport rule that you want to import. You can use any value that uniquely identifies the rule. For example: @@ -62,7 +66,6 @@ The Identity parameter specifies the transport rule that you want to import. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FileData parameter specifies the XML file that contains the exported transport rule collection from the Export-TransportRuleCollection cmdlet. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -80,7 +86,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -99,7 +107,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -119,7 +129,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -137,7 +149,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Import-UMPrompt.md b/exchange/exchange-ps/ExchangePowerShell/Import-UMPrompt.md similarity index 92% rename from exchange/exchange-ps/exchange/Import-UMPrompt.md rename to exchange/exchange-ps/ExchangePowerShell/Import-UMPrompt.md index 5f34ab73ab..84ada54feb 100644 --- a/exchange/exchange-ps/exchange/Import-UMPrompt.md +++ b/exchange/exchange-ps/ExchangePowerShell/Import-UMPrompt.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/import-umprompt applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Import-UMPrompt -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/import-umprompt +schema: 2.0.0 +title: Import-UMPrompt --- # Import-UMPrompt @@ -89,6 +90,9 @@ This example imports the welcome greeting file AfterHoursWelcomeGreeting.wav fro ## PARAMETERS ### -PromptFileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PromptFileData parameter specifies the byte array of the custom prompt. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -97,7 +101,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: UploadDialPlanPrompts, UploadAutoAttendantPrompts Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -PromptFileName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PromptFileName parameter specifies the name of the custom prompt. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -123,13 +128,15 @@ Accept wildcard characters: False ``` ### -PromptFileStream + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PromptFileStream parameter specifies whether the audio file will be uploaded or imported as an audio stream and not a byte array. The default setting is for the audio file to imported as a byte array. ```yaml Type: Stream Parameter Sets: UploadAutoAttendantPromptsStream, UploadDialPlanPromptsStream Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -139,13 +146,15 @@ Accept wildcard characters: False ``` ### -UMAutoAttendant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMAutoAttendant parameter specifies the UM auto attendant ID. This parameter specifies the directory object identifier for the UM auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: UploadAutoAttendantPrompts, UploadAutoAttendantPromptsStream Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -155,13 +164,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan. ```yaml Type: UMDialPlanIdParameter Parameter Sets: UploadDialPlanPrompts, UploadDialPlanPromptsStream Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -171,6 +182,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -180,7 +194,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -190,13 +203,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Install-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Install-TransportAgent.md similarity index 89% rename from exchange/exchange-ps/exchange/Install-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Install-TransportAgent.md index 9e51b2aaa8..92cf1ae653 100644 --- a/exchange/exchange-ps/exchange/Install-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Install-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/install-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Install-TransportAgent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/install-transportagent +schema: 2.0.0 +title: Install-TransportAgent --- # Install-TransportAgent @@ -46,13 +47,15 @@ This example shows how a fictitious application named Test App is installed in t ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the display name of the transport agent to be installed. The length of the name can't exceed 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -AssemblyPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AssemblyPath parameter specifies the location of the transport agent Microsoft.NET assembly. Universal Naming Convention (UNC) file paths can't be used. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -TransportAgentFactory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransportAgentFactory parameter specifies the Microsoft.NET class type of the transport agent factory. The developer of the transport agent being installed provides the transport agent factory and related information. For more information, see the documentation provided by the developer of the transport agent. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -94,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -103,7 +113,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +122,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -121,7 +133,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +142,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -143,7 +157,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md b/exchange/exchange-ps/ExchangePowerShell/Install-UnifiedCompliancePrerequisite.md similarity index 95% rename from exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md rename to exchange/exchange-ps/ExchangePowerShell/Install-UnifiedCompliancePrerequisite.md index dfc3b902a4..81065e9097 100644 --- a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md +++ b/exchange/exchange-ps/ExchangePowerShell/Install-UnifiedCompliancePrerequisite.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/install-unifiedcomplianceprerequisite applicable: Security & Compliance -title: Install-UnifiedCompliancePrerequisite -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/install-unifiedcomplianceprerequisite +schema: 2.0.0 +title: Install-UnifiedCompliancePrerequisite --- # Install-UnifiedCompliancePrerequisite @@ -71,6 +72,9 @@ This example recreates the Compliance Policy Center, even if the site has alread ## PARAMETERS ### -ForceInitialize + +> Applicable: Security & Compliance + The ForceInitialize switch recreates the Compliance Policy Center, even if it has already been created. You don't specify a value with this switch. You can't use this switch with the LoadOnly switch. @@ -79,7 +83,6 @@ You can't use this switch with the LoadOnly switch. Type: SwitchParameter Parameter Sets: Initialize Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -LoadOnly + +> Applicable: Security & Compliance + The LoadOnly switch loads the current settings of the Compliance Policy Center. You don't specify a value with this switch. You can't use this switch with the ForceInitialize switch. @@ -97,7 +103,6 @@ You can't use this switch with the ForceInitialize switch. Type: SwitchParameter Parameter Sets: LoadOnly Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -PolicyCenterSiteOwner + +> Applicable: Security & Compliance + The PolicyCenterSiteOwner parameter specifies the email address of the owner of the Compliance Policy Center. You can use this parameter by itself or with the ForceInitialize switch. ```yaml Type: SmtpAddress Parameter Sets: Initialize Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md b/exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSearchActionStep.md similarity index 85% rename from exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md rename to exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSearchActionStep.md index d208ed10b8..2faa34ef03 100644 --- a/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md +++ b/exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSearchActionStep.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/invoke-compliancesearchactionstep applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance -title: Invoke-ComplianceSearchActionStep -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/invoke-compliancesearchactionstep +schema: 2.0.0 +title: Invoke-ComplianceSearchActionStep --- # Invoke-ComplianceSearchActionStep @@ -40,13 +41,15 @@ This cmdlet is reserved for internal Microsoft use. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + This cmdlet is reserved for internal Microsoft use. ```yaml Type: ComplianceSearchActionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: 1 @@ -56,13 +59,15 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + This cmdlet is reserved for internal Microsoft use. ```yaml Type: PSObject Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: True Position: Named @@ -72,13 +77,15 @@ Accept wildcard characters: False ``` ### -Step + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + This cmdlet is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md b/exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSecurityFilterAction.md similarity index 95% rename from exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md rename to exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSecurityFilterAction.md index af2ca95201..43023c90bc 100644 --- a/exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Invoke-ComplianceSecurityFilterAction.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/invoke-compliancesecurityfilteraction applicable: Security & Compliance -title: Invoke-ComplianceSecurityFilterAction -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/invoke-compliancesecurityfilteraction +schema: 2.0.0 +title: Invoke-ComplianceSecurityFilterAction --- # Invoke-ComplianceSecurityFilterAction @@ -108,6 +109,9 @@ This example sets the boundary of the specified OneDrive site to the specified C ## PARAMETERS ### -Action + +> Applicable: Security & Compliance + The Action parameter specifies the action for the command. Valid values are: - GetStatus @@ -117,7 +121,6 @@ The Action parameter specifies the action for the command. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -127,6 +130,9 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Security & Compliance + The EmailAddress parameter specifies the the affected user mailbox. You can use the following values to uniquely identify the mailbox: - Name @@ -140,7 +146,6 @@ If the value contains spaces, enclose the value in quotation marks. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 2 @@ -150,6 +155,9 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: Security & Compliance + The PropertyName parameter specifies the name of the property of the compliance boundary for the OneDrive site that you want to view or modify. Valid values are: - CustomAttribute1 to CustomAttribute15 @@ -160,7 +168,6 @@ Use the PropertyValue parameter to set the compliance boundary. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 3 @@ -170,13 +177,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: Security & Compliance + The PropertyValue parameter specifies the value of the PropertyName value when you use the Action parameter value Set to set the compliance boundary of a OneDrive site. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 4 @@ -186,13 +195,15 @@ Accept wildcard characters: False ``` ### -SiteUrl + +> Applicable: Security & Compliance + The SiteUrl parameter specifies the OneDrive site that you want to view or modify. This parameter uses the syntax `https://-my.sharepoint.com/personal/__onmicrosoft_com/_layouts/15/onedrive.aspx`. For example: `https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx`. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 5 @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -211,7 +225,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -221,13 +234,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md b/exchange/exchange-ps/ExchangePowerShell/Invoke-HoldRemovalAction.md similarity index 94% rename from exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md rename to exchange/exchange-ps/ExchangePowerShell/Invoke-HoldRemovalAction.md index 3579f174b8..ebf40db69c 100644 --- a/exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Invoke-HoldRemovalAction.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/invoke-holdremovalaction applicable: Security & Compliance -title: Invoke-HoldRemovalAction -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/invoke-holdremovalaction +schema: 2.0.0 +title: Invoke-HoldRemovalAction --- # Invoke-HoldRemovalAction @@ -60,6 +61,9 @@ This example displays all hold removals that have been done using this cmdlet. ## PARAMETERS ### -Action + +> Applicable: Security & Compliance + The Action parameter specifies the mode that the cmdlet operates in. Valid values are: - GetHoldRemovals: Shows all hold removals that were done using this cmdlet. @@ -70,7 +74,6 @@ The Action parameter specifies the mode that the cmdlet operates in. Valid value Type: HoldRemovalActionType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -89,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the email address of the mailbox that contains the holds to view or remove. This parameter is required when you use the value GetHolds or RemoveHold for the Action parameter. @@ -107,7 +115,6 @@ This parameter is required when you use the value GetHolds or RemoveHold for the Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to force remove the hold even when the policy is active. Instead, you should remove the hold from the case hold policy. @@ -125,7 +135,6 @@ You can use this switch to force remove the hold even when the policy is active. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -HoldId + +> Applicable: Security & Compliance + The HoldId parameter specifies the hold that you want to view or remove. To find valid values for this parameter, use this cmdlet with the Action parameter value GetHolds and look for the HoldId property in the output. @@ -143,7 +155,6 @@ To find valid values for this parameter, use this cmdlet with the Action paramet Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -153,6 +164,9 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + The SharePointLocation parameter specifies the URL of the SharePoint site that contains the holds to view or remove. This parameter is required when you use the value GetHolds or RemoveHold for the Action parameter. @@ -161,7 +175,6 @@ This parameter is required when you use the value GetHolds or RemoveHold for the Type: String Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md b/exchange/exchange-ps/ExchangePowerShell/Invoke-MonitoringProbe.md similarity index 87% rename from exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md rename to exchange/exchange-ps/ExchangePowerShell/Invoke-MonitoringProbe.md index 858171d8c8..7292433a9c 100644 --- a/exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md +++ b/exchange/exchange-ps/ExchangePowerShell/Invoke-MonitoringProbe.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/invoke-monitoringprobe applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Invoke-MonitoringProbe -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/invoke-monitoringprobe +schema: 2.0.0 +title: Invoke-MonitoringProbe --- # Invoke-MonitoringProbe @@ -51,13 +52,15 @@ This example creates an Exchange ActiveSync monitoring probe on the EX1 server. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the monitoring probe to run. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -80,7 +86,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Account + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Account parameter specifies the identity of the mailbox or user account that will run the monitoring probe. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -Endpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Endpoint parameter specifies the name of the monitoring probe endpoint to connect to, for example, contoso.mail.com. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -ItemTargetExtension + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ItemTargetExtension parameter specifies cmdlet extension data that you can pass to the monitoring probe. The probe that runs on the server may require specific data for its execution. This data is presented to the probe on execution in an XML format. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Password parameter specifies the password of the mailbox or user account that will run the monitoring probe. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -PropertyOverride + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PropertyOverride parameter specifies a property that you want to override, for example, to set the time-out value to be extended beyond the default value. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,13 +185,15 @@ Accept wildcard characters: False ``` ### -SecondaryAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SecondaryAccount parameter specifies the identity of the delegate mailbox or user account that will run the monitoring probe. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +203,15 @@ Accept wildcard characters: False ``` ### -SecondaryEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SecondaryEndpoint parameter specifies the name of the secondary monitoring probe endpoint to connect to, for example, contoso.mail.fabrikam.com. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,13 +221,15 @@ Accept wildcard characters: False ``` ### -SecondaryPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SecondaryPassword parameter specifies the password of the delegate mailbox or user account that will run the monitoring probe. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -218,13 +239,15 @@ Accept wildcard characters: False ``` ### -TimeOutSeconds + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TimeOutSeconds parameter specifies the monitoring operation time-out period. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Mount-Database.md b/exchange/exchange-ps/ExchangePowerShell/Mount-Database.md similarity index 88% rename from exchange/exchange-ps/exchange/Mount-Database.md rename to exchange/exchange-ps/ExchangePowerShell/Mount-Database.md index 8d6dc5909a..b9d8d46279 100644 --- a/exchange/exchange-ps/exchange/Mount-Database.md +++ b/exchange/exchange-ps/ExchangePowerShell/Mount-Database.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/mount-database applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Mount-Database -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/mount-database +schema: 2.0.0 +title: Mount-Database --- # Mount-Database @@ -46,6 +47,9 @@ This example mounts the database MyDatabase. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies mailbox database that you want to mount. You can use any value that uniquely identifies the database. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies mailbox database that you want to mount. You ca Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -AcceptDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AcceptDataLoss switch specifies that you accept the data loss caused by missing committed transaction log files without asking for confirmation. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -91,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +126,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to mount an empty database, or to override any errors or warnings that are encountered during the database mount. @@ -125,7 +137,6 @@ Use this switch to mount an empty database, or to override any errors or warning Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -NewCapacity + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The NewCapacity switch specifies that you want to trigger the forced creation of a database only if all copies of the database don't have an .edb file. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,13 +164,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Move-ActiveMailboxDatabase.md similarity index 89% rename from exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Move-ActiveMailboxDatabase.md index c59b2bf565..20923aba50 100644 --- a/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Move-ActiveMailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/move-activemailboxdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-ActiveMailboxDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/move-activemailboxdatabase +schema: 2.0.0 +title: Move-ActiveMailboxDatabase --- # Move-ActiveMailboxDatabase @@ -134,6 +135,9 @@ This example performs a server switchover for the Mailbox server MBX1. All activ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox database that you want to activate. You can use any value that uniquely identifies the database. For example: - Name @@ -146,7 +150,6 @@ You can't use this parameter with the Server parameter Type: DatabaseIdParameter Parameter Sets: Identity, SkipAllChecks Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -156,6 +159,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the server that you want to move all active mailbox databases from. You can use any value that uniquely identifies the server. For example: - Name @@ -169,7 +175,6 @@ You can't use this parameter with the Identity parameter Type: MailboxServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -179,6 +184,9 @@ Accept wildcard characters: False ``` ### -ActivatePreferredOnServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActivatePreferredOnServer parameter specifies the Mailbox server where you want to activate all mailbox databases that have copies with an ActivationPreference value of 1. You can use any value that uniquely identifies the server. For example: - Name @@ -192,7 +200,6 @@ You can use this parameter as part of ending maintenance mode on a Mailbox serve Type: MailboxServerIdParameter Parameter Sets: ActivatePreferred Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -202,13 +209,15 @@ Accept wildcard characters: False ``` ### -ActivateOnServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActivateOnServer parameter specifies the name of the Mailbox server on which the mailbox database copy should be activated. ```yaml Type: MailboxServerIdParameter Parameter Sets: Identity, Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 2 @@ -218,6 +227,9 @@ Accept wildcard characters: False ``` ### -SkipAllChecks + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The SkipAllChecks switch specifies whether to skip all checks. You don't need to specify a value with this switch. This switch is equivalent to specifying all of the individual skip parameters that are available on this cmdlet. @@ -228,7 +240,6 @@ You can only use this switch with the ActivateOnServer parameter. Type: SwitchParameter Parameter Sets: SkipAllChecks Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -238,6 +249,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -247,7 +261,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,13 +270,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,6 +288,9 @@ Accept wildcard characters: False ``` ### -MountDialOverride + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MountDialOverride parameter is used to override the auto database mount dial (AutoDatabaseMountDial) setting for the target server and specify an alternate setting. The following are possible values: - None: When using this value, the currently configured auto database mount dial setting on the target server will be used. @@ -285,7 +303,6 @@ The MountDialOverride parameter is used to override the auto database mount dial Type: DatabaseMountDialOverride Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -295,13 +312,15 @@ Accept wildcard characters: False ``` ### -MoveAllDatabasesOrNone + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The MoveAllDatabasesOrNone switch specifies whether to prevent any databases from moving if a single active database on the server can't be moved. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -311,13 +330,15 @@ Accept wildcard characters: False ``` ### -MoveComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MoveComment parameter specifies an optional administrative reason for the move operation. The comment is recorded in the Event log. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -327,6 +348,9 @@ Accept wildcard characters: False ``` ### -SkipActiveCopyChecks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipActiveCopyChecks switch specifies whether to skip checking the current active copy to see if it's currently a seeding source for any passive databases. You don't need to specify a value with this switch. **Note**: When you use this switch, you can move a database that's currently a seeding source, which cancels the seed operation. @@ -335,7 +359,6 @@ The SkipActiveCopyChecks switch specifies whether to skip checking the current a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -345,6 +368,9 @@ Accept wildcard characters: False ``` ### -SkipClientExperienceChecks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipClientExperienceChecks switch specifies whether to skip the search catalog (content index) state check to see if the search catalog is healthy and up to date. You don't need to specify a value with this switch. If the search catalog for the database copy you're activating is in an unhealthy or unusable state and you use this parameter to skip the search catalog health check and activate the database copy, you will need to either re-crawl or reseed the search catalog. @@ -353,7 +379,6 @@ If the search catalog for the database copy you're activating is in an unhealthy Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -363,13 +388,15 @@ Accept wildcard characters: False ``` ### -SkipCpuChecks + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The SkipCpuChecks switch specifies whether to skip the high CPU utilization checks. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -379,6 +406,9 @@ Accept wildcard characters: False ``` ### -SkipHealthChecks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipHealthChecks switch specifies whether to bypass passive copy health checks. You don't need to specify a value with this switch. When you use this switch, you can move the active copy to a database copy that's in the Failed state. You should only use this switch if the initial attempt to move the active database has failed. This is because the SkipHealthChecks switch performs additional validation to ensure that the log files are consistent, which can take a considerable amount of time. @@ -387,7 +417,6 @@ When you use this switch, you can move the active copy to a database copy that's Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -397,13 +426,15 @@ Accept wildcard characters: False ``` ### -SkipLagChecks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipLagChecks switch specifies whether to allow a copy to be activated that has replay and copy queues outside of the configured criteria. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -413,6 +444,9 @@ Accept wildcard characters: False ``` ### -SkipMaximumActiveDatabasesChecks + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipMaximumActiveDatabasesChecks switch specifies whether to skip checking the value of MaximumPreferredActiveDatabases during the best copy and server selection (BCSS) process. You don't need to specify a value with this switch. Any configured value for MaximumActiveDatabases will still be honored during the BCSS process and by the Information Store. @@ -421,7 +455,6 @@ Any configured value for MaximumActiveDatabases will still be honored during the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -431,13 +464,15 @@ Accept wildcard characters: False ``` ### -SkipMoveSuppressionChecks + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The SkipMoveSuppressionChecks switch specifies whether to skip the move suppression checks. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -447,13 +482,15 @@ Accept wildcard characters: False ``` ### -TerminateOnWarning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TerminateOnWarning switch specifies whether to terminate the task and output an error message if a warning is encountered during the switchover operation. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -463,13 +500,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Move-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/Move-AddressList.md similarity index 90% rename from exchange/exchange-ps/exchange/Move-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Move-AddressList.md index d2c70381c6..8a33bcacdd 100644 --- a/exchange/exchange-ps/exchange/Move-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Move-AddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/move-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-AddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/move-addresslist +schema: 2.0.0 +title: Move-AddressList --- # Move-AddressList @@ -43,6 +44,9 @@ This example moves the address list with GUID c3fffd8e-026b-41b9-88c4-8c21697ac8 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the address list that you want to move. You can use any value that uniquely identifies the address list. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the address list that you want to move. You can Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Container parameter specifies where to move the address list. Valid input for this parameter is under the root "\\" (also known as All Address Lists) or under an existing address list. You can use any value that uniquely identifies the address list. For example: - Name @@ -75,7 +81,6 @@ The Container parameter specifies where to move the address list. Valid input fo Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -96,7 +104,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Move-DatabasePath.md b/exchange/exchange-ps/ExchangePowerShell/Move-DatabasePath.md similarity index 88% rename from exchange/exchange-ps/exchange/Move-DatabasePath.md rename to exchange/exchange-ps/ExchangePowerShell/Move-DatabasePath.md index 88ab1bea84..3a1b166654 100644 --- a/exchange/exchange-ps/exchange/Move-DatabasePath.md +++ b/exchange/exchange-ps/ExchangePowerShell/Move-DatabasePath.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/move-databasepath applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-DatabasePath -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/move-databasepath +schema: 2.0.0 +title: Move-DatabasePath --- # Move-DatabasePath @@ -54,6 +55,9 @@ This example sets a new path for the mailbox database specified by the mailbox d ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the database that you want to move. You can use any value that uniquely identifies the database. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the database that you want to move. You can use Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConfigurationOnly switch specifies whether to change the configuration of the database without moving any files. You don't need to specify a value with this switch. If you don't use this switch, the configuration of the database changes and the files are moved. @@ -82,7 +88,6 @@ If you don't use this switch, the configuration of the database changes and the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -103,7 +111,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -EDBFilePath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EdbFilePath parameter specifies a new file path for the database. All current database files are moved to this location. The default location is `%ExchangeInstallPath%Mailbox\LocalCopies\MBDatabase.edb`. This file path can't be the same as the path for the backup copy of the database. ```yaml Type: EdbFilePath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +156,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -153,7 +167,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -LogFolderPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogFolderPath parameter specifies the folder where log files are stored. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -195,13 +212,15 @@ Accept wildcard characters: False ``` ### -EDBFilePath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EdbFilePath parameter specifies a new file path for the database. All current database files are moved to this location. The default location is ``%ExchangeInstallPath%Mailbox\LocalCopies\MBDatabase.edb`. This file path can't be the same as the path for the backup copy of the database. ```yaml Type: EdbFilePath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Move-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/Move-OfflineAddressBook.md similarity index 90% rename from exchange/exchange-ps/exchange/Move-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/Move-OfflineAddressBook.md index 52e6b27ad3..c66383eeb8 100644 --- a/exchange/exchange-ps/exchange/Move-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Move-OfflineAddressBook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/move-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Move-OfflineAddressBook -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/move-offlineaddressbook +schema: 2.0.0 +title: Move-OfflineAddressBook --- # Move-OfflineAddressBook @@ -44,6 +45,9 @@ This example moves OAB generation in Exchange 2010 to the server named Server1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the GUID, distinguished name (DN), or OAB name that represents a specific OAB. You can also include the path by using the format Server\\OfflineAddressBookName. You can omit the parameter label so that only the OAB name or GUID is supplied. @@ -52,7 +56,6 @@ You can omit the parameter label so that only the OAB name or GUID is supplied. Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -112,7 +122,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ATPBuiltInProtectionRule.md similarity index 95% rename from exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ATPBuiltInProtectionRule.md index 85953675d6..05e0967f85 100644 --- a/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ATPBuiltInProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-atpbuiltinprotectionrule applicable: Exchange Online -title: New-ATPBuiltInProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-atpbuiltinprotectionrule +schema: 2.0.0 +title: New-ATPBuiltInProtectionRule --- # New-ATPBuiltInProtectionRule @@ -54,6 +55,9 @@ This cmdlet creates the rule for the Built-in protection preset security policy. ## PARAMETERS ### -SafeAttachmentPolicy + +> Applicable: Exchange Online + The SafeAttachmentPolicy parameter specifies the Safe Attachments policy that's associated with the Built-in preset security policy. Use the following command to identify the policy: `Get-SafeAttachmentPolicy | Where-Object -Property IsBuiltInProtection -eq -Value "True"`. The name of the default Safe Attachments policy that's used for the Built-in protection preset security policy is Built-In Protection Policy. @@ -62,7 +66,6 @@ The name of the default Safe Attachments policy that's used for the Built-in pro Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -SafeLinksPolicy + +> Applicable: Exchange Online + The SafeLinksPolicy parameter specifies the Safe Links policy that's associated with the Built-in preset security policy. Use the following command to identify the policy: `Get-SafeLinksPolicy | Where-Object -Property IsBuiltInProtection -eq -Value "True"`. The name of the default Safe Links policy that's used for the Built-in protection preset security policy is Built-In Protection Policy. @@ -80,7 +86,6 @@ The name of the default Safe Links policy that's used for the Built-in protectio Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -115,7 +125,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -141,6 +152,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -156,7 +170,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -183,7 +199,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -193,6 +208,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. The name of the only rule is ATP Built-In Protection Rule. @@ -201,7 +219,6 @@ The name of the only rule is ATP Built-In Protection Rule. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -211,13 +228,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ATPProtectionPolicyRule.md similarity index 96% rename from exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ATPProtectionPolicyRule.md index 9397716f14..5d3eb131cf 100644 --- a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-atpprotectionpolicyrule applicable: Exchange Online -title: New-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-atpprotectionpolicyrule +schema: 2.0.0 +title: New-ATPProtectionPolicyRule --- # New-ATPProtectionPolicyRule @@ -58,6 +59,9 @@ This example creates the rule for the Standard preset security policy. No restri ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. Since you don't need to create rules other than those used by the Standard preset security policy or the Strict preset security policy, we highly recommend that you use the default rule names for clarity and consistency. @@ -66,7 +70,6 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -SafeAttachmentPolicy + +> Applicable: Exchange Online + The SafeAttachmentPolicy parameter specifies the existing Safe Attachments policy that's associated with the preset security policy. If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the Safe Attachments policy will be one of the following values: @@ -89,7 +95,6 @@ You can find the Safe Attachments policy that's used by the Standard or Strict p Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -SafeLinksPolicy + +> Applicable: Exchange Online + The SafeLinksPolicy parameter specifies the existing Safe Links policy that's associated with the preset security policy. If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the Safe Attachments policy will be one of the following values: @@ -112,7 +120,6 @@ You can find the Safe Links policy that's used by the Standard or Strict preset Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -147,7 +159,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the rule is enabled. Valid values are: - $true: The rule is enabled. The State value of the rule is Enabled. This is the default value. @@ -171,7 +185,6 @@ After you create the rule, you turn on or turn off the preset security policy us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -197,6 +212,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -212,7 +230,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -222,6 +239,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -239,7 +259,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Required: False Position: Named @@ -249,6 +268,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. @@ -259,7 +281,6 @@ When you create the policy, you must use the default value. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -269,13 +290,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -285,6 +308,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -300,7 +326,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -310,6 +335,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -327,7 +355,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -337,13 +364,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/New-AcceptedDomain.md similarity index 90% rename from exchange/exchange-ps/exchange/New-AcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/New-AcceptedDomain.md index 157ffaec81..7b60a5bca3 100644 --- a/exchange/exchange-ps/exchange/New-AcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AcceptedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-accepteddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AcceptedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-accepteddomain +schema: 2.0.0 +title: New-AcceptedDomain --- # New-AcceptedDomain @@ -44,13 +45,15 @@ This example creates the new authoritative accepted domain Contoso. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a unique name for the accepted domain object. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainName parameter specifies the SMTP domain that you want to establish as an accepted domain. Valid input for the DomainName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. The domain name string may not contain more than 256 characters. @@ -68,7 +74,6 @@ However, you can't embed a wildcard character, as shown in the following example Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -87,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,6 +104,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -105,7 +115,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +124,9 @@ Accept wildcard characters: False ``` ### -DomainType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainType parameter specifies the type of accepted domain that you want to configure. Valid values are Authoritative, InternalRelay or ExternalRelay. You must set at least one value. In an authoritative domain, messages are delivered to a recipient that has a domain account in your Exchange organization. In an internal relay domain, messages are relayed to a server outside your Exchange organization, but still under the authority of your company or IT department. Use the internal relay domain if you want to treat the messages to this domain as internal messages. In an external relay domain, messages are relayed to an email server, outside your organization, which you don't control. @@ -125,7 +137,6 @@ The default value is Authoritative. Type: AcceptedDomainType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncDeviceAccessRule.md similarity index 88% rename from exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncDeviceAccessRule.md index 136f962987..81e0237759 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncDeviceAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-activesyncdeviceaccessrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-ActiveSyncDeviceAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-activesyncdeviceaccessrule +schema: 2.0.0 +title: New-ActiveSyncDeviceAccessRule --- # New-ActiveSyncDeviceAccessRule @@ -52,13 +53,15 @@ This example creates a device access rule that uses the UserAgent characteristic ## PARAMETERS ### -AccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AccessLevel parameter specifies the access level of devices that are defined by the rule. Valid values for this parameter are Allow, Block and Quarantine. ```yaml Type: DeviceAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Characteristic + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Characteristic parameter specifies the device characteristic or category that's used by the rule. Valid values for this parameter are: - DeviceModel @@ -80,7 +86,6 @@ The Characteristic parameter specifies the device characteristic or category tha Type: DeviceAccessCharacteristic Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -QueryString + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The QueryString parameter specifies the device identifier that's used by the rule. This parameter uses a text value that's used with Characteristic parameter value to define the device. Wildcards or partial matches aren't allowed. You can use the Get-MobileDevice cmdlet to find the text values that you can use with the QueryString parameter. For example: Get-MobileDevice | Format-List DeviceOS,DeviceModel,DeviceType. @@ -98,7 +106,6 @@ You can use the Get-MobileDevice cmdlet to find the text values that you can use Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -117,7 +127,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,6 +136,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -135,7 +147,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,13 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncMailboxPolicy.md similarity index 80% rename from exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncMailboxPolicy.md index 2480ceb160..9d14e34c18 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-activesyncmailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-ActiveSyncMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-activesyncmailboxpolicy +schema: 2.0.0 +title: New-ActiveSyncMailboxPolicy --- # New-ActiveSyncMailboxPolicy @@ -116,13 +117,15 @@ This example creates the Mobile Device mailbox policy Contoso that has several p ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -132,6 +135,9 @@ Accept wildcard characters: False ``` ### -AllowApplePushNotifications + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowApplePushNotifications parameter specifies whether push notifications are allowed for Apple mobile devices. The default value is $true. @@ -140,7 +146,6 @@ The AllowApplePushNotifications parameter specifies whether push notifications a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -150,13 +155,15 @@ Accept wildcard characters: False ``` ### -AllowBluetooth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowBluetooth parameter specifies whether the Bluetooth capabilities of the mobile phone are allowed. The available options are Disable, HandsfreeOnly, and Allow. The default value is Allow. ```yaml Type: BluetoothType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -166,13 +173,15 @@ Accept wildcard characters: False ``` ### -AllowBrowser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect non-Microsoft browsers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,13 +191,15 @@ Accept wildcard characters: False ``` ### -AllowCamera + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -198,13 +209,15 @@ Accept wildcard characters: False ``` ### -AllowConsumerEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowConsumerEmail parameter specifies whether the mobile phone user can configure a personal email account on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -214,13 +227,15 @@ Accept wildcard characters: False ``` ### -AllowDesktopSync + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,13 +245,15 @@ Accept wildcard characters: False ``` ### -AllowExternalDeviceManagement + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the device. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,13 +263,15 @@ Accept wildcard characters: False ``` ### -AllowHTMLEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowHTMLEmail parameter specifies whether HTML email is enabled on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,13 +281,15 @@ Accept wildcard characters: False ``` ### -AllowInternetSharing + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowInternetSharing parameter specifies whether the mobile phone can be used as a modem to connect a computer to the Internet. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -278,13 +299,15 @@ Accept wildcard characters: False ``` ### -AllowIrDA + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -294,13 +317,15 @@ Accept wildcard characters: False ``` ### -AllowMobileOTAUpdate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowMobileOTAUpdate parameter specifies whether certain updates are seen by devices that implemented support for this restricting functionality. Further control can be specified via the MobileOTAUpdateMode parameter. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -310,13 +335,15 @@ Accept wildcard characters: False ``` ### -AllowNonProvisionableDevices + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + When set to $true, the AllowNonProvisionableDevices parameter enables all devices to synchronize with the computer running Exchange, regardless of whether the device can enforce all the specific settings established in the Mobile Device mailbox policy. This also includes devices managed by a separate device management system. When set to $false, this parameter blocks these devices that aren't provisioned from synchronizing with the server running Exchange. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -326,13 +353,15 @@ Accept wildcard characters: False ``` ### -AllowPOPIMAPEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -342,13 +371,15 @@ Accept wildcard characters: False ``` ### -AllowRemoteDesktop + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -358,13 +389,15 @@ Accept wildcard characters: False ``` ### -AllowSimpleDevicePassword + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSimpleDevicePassword parameter specifies whether a simple device password is allowed. A simple device password is a password that has a specific pattern, such as 1111 or 1234. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -374,13 +407,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMEEncryptionAlgorithmNegotiation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSMIMEEncryptionAlgorithmNegotiation parameter specifies whether the messaging application on the device can negotiate the encryption algorithm in case a recipient's certificate doesn't support the specified encryption algorithm. ```yaml Type: SMIMEEncryptionAlgorithmNegotiationType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -390,13 +425,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMESoftCerts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -406,13 +443,15 @@ Accept wildcard characters: False ``` ### -AllowStorageCard + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowStorageCard parameter specifies whether the device can access information stored on a storage card. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -422,13 +461,15 @@ Accept wildcard characters: False ``` ### -AllowTextMessaging + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowTextMessaging parameter specifies whether text messaging is allowed from the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -438,13 +479,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedApplications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -454,13 +497,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedInstallationPackages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be run on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -470,13 +515,15 @@ Accept wildcard characters: False ``` ### -AllowWiFi + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowWiFi parameter specifies whether wireless Internet access is allowed on the device. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -486,13 +533,15 @@ Accept wildcard characters: False ``` ### -AlphanumericDevicePasswordRequired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlphanumericDevicePasswordRequired parameter specifies whether the device password must be alphanumeric. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -502,13 +551,15 @@ Accept wildcard characters: False ``` ### -ApprovedApplicationList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApprovedApplicationList parameter specifies a list of approved applications for the device. ```yaml Type: ApprovedApplicationCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -518,13 +569,15 @@ Accept wildcard characters: False ``` ### -AttachmentsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AttachmentsEnabled parameter specifies whether the user can download attachments. When set to $false, the user is blocked from downloading attachments. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -534,6 +587,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -543,7 +599,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -553,13 +608,15 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeviceEncryptionEnabled parameter, when set to $true, enables device encryption on the mobile phone. The default value is $false. Currently, only the storage card can be encrypted on devices running Windows Mobile 6.0 or later. We recommend that you don't use this setting and use the RequireStorageCardEncryption parameter instead. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -569,13 +626,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + When set to $true, the DevicePasswordEnabled parameter specifies that the user set a password for the device. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -585,13 +644,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordExpiration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DevicePasswordExpiration parameter specifies the length of time, in days, that a password can be used. After this length of time, a new password must be created. The format of the parameter is dd.hh.mm:ss, for example, 24.00:00 = 24 hours. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -601,13 +662,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordHistory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DevicePasswordHistory parameter specifies the number of previously used passwords to store. When a user creates a password, the user can't reuse a stored password that was previously used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -617,13 +680,15 @@ Accept wildcard characters: False ``` ### -DevicePolicyRefreshInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DevicePolicyRefreshInterval parameter specifies how often the policy is sent from the server to the mobile phone ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -633,6 +698,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -641,7 +709,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -651,13 +718,15 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -667,13 +736,15 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault parameter specifies whether this policy is the default Mobile Device mailbox policy. The default value is $false. If another policy is currently set as the default, setting this parameter replaces the old default policy with this policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -683,13 +754,15 @@ Accept wildcard characters: False ``` ### -IsDefaultPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault parameter specifies whether this policy is the default Mobile Device mailbox policy. The default value is $false. If another policy is currently set as the default, setting this parameter replaces the old default policy with this policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -699,13 +772,15 @@ Accept wildcard characters: False ``` ### -MaxAttachmentSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile phone. The default value is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -715,6 +790,9 @@ Accept wildcard characters: False ``` ### -MaxCalendarAgeFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the device. Valid values are: - All @@ -727,7 +805,6 @@ The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days Type: CalendarAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -737,13 +814,15 @@ Accept wildcard characters: False ``` ### -MaxDevicePasswordFailedAttempts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxDevicePasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the device. You can enter any number from 4 through 16. The default value is 8. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -753,6 +832,9 @@ Accept wildcard characters: False ``` ### -MaxEmailAgeFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the device. Possible values are: @@ -770,7 +852,6 @@ Possible values are: Type: EmailAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -780,13 +861,15 @@ Accept wildcard characters: False ``` ### -MaxEmailBodyTruncationSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the device. The value is specified in kilobytes (KB). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -796,13 +879,15 @@ Accept wildcard characters: False ``` ### -MaxEmailHTMLBodyTruncationSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are synchronized to the device. The value is specified in KB. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -812,13 +897,15 @@ Accept wildcard characters: False ``` ### -MaxInactivityTimeDeviceLock + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxInactivityTimeDeviceLock parameter specifies the length of time that the device can be inactive before the password is required to reactivate the device. You can enter any interval between 30 seconds and 1 hour. The default value is 15 minutes. The format of the parameter is hh.mm:ss, for example, 15:00 = 15 minutes. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -828,13 +915,15 @@ Accept wildcard characters: False ``` ### -MinDevicePasswordComplexCharacters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MinDevicePasswordComplexCharacters parameter specifies the minimum number of complex characters required in a device password. A complex character isn't a letter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -844,13 +933,15 @@ Accept wildcard characters: False ``` ### -MinDevicePasswordLength + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MinDevicePasswordLength parameter specifies the minimum number of characters in the device password. You can enter any number from 1 through 16. The maximum length a password can be is 16 characters. The default value is 4. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -860,13 +951,15 @@ Accept wildcard characters: False ``` ### -PasswordRecoveryEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PasswordRecoveryEnabled parameter specifies whether you can store the recovery password for the device on an Exchange server. When set to $true, you can store the recovery password for the device on an Exchange server. The default value is $false. The recovery password can be viewed from either Outlook on the web or the Exchange admin center. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -876,13 +969,15 @@ Accept wildcard characters: False ``` ### -RequireDeviceEncryption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -892,13 +987,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptedSMIMEMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -908,13 +1005,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptionSMIMEAlgorithm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message. ```yaml Type: EncryptionSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -924,13 +1023,15 @@ Accept wildcard characters: False ``` ### -RequireManualSyncWhenRoaming + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireManualSyncWhenRoaming parameter specifies whether the device must synchronize manually while roaming. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -940,13 +1041,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEAlgorithm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message. ```yaml Type: SignedSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -956,13 +1059,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSignedSMIMEMessages parameter specifies whether the device must send signed S/MIME messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -972,13 +1077,15 @@ Accept wildcard characters: False ``` ### -RequireStorageCardEncryption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireStorageCardEncryption parameter specifies whether encryption of a storage card is required. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -988,13 +1095,15 @@ Accept wildcard characters: False ``` ### -UnapprovedInROMApplicationList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1004,13 +1113,15 @@ Accept wildcard characters: False ``` ### -UNCAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled. Access to specific shares is configured on the Microsoft Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1020,13 +1131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1036,13 +1149,15 @@ Accept wildcard characters: False ``` ### -WSSAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled. Access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncVirtualDirectory.md similarity index 89% rename from exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncVirtualDirectory.md index 03c846da01..7580c9fdba 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ActiveSyncVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-activesyncvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ActiveSyncVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-activesyncvirtualdirectory +schema: 2.0.0 +title: New-ActiveSyncVirtualDirectory --- # New-ActiveSyncVirtualDirectory @@ -72,13 +73,15 @@ This example creates an Exchange ActiveSync virtual directory for the company Fo ## PARAMETERS ### -ApplicationRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ApplicationRoot parameter specifies the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -AppPoolId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AppPoolId parameter specifies the IIS application pool in which the virtual directory runs. We recommend that you leave this parameter at its default setting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -113,7 +121,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -151,7 +163,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -170,7 +184,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -192,7 +208,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -ExternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalAuthenticationMethods parameter restricts the authentication methods that can be used to connect to the virtual directory from outside the firewall. Valid values are: - Adfs @@ -233,7 +251,6 @@ The default value is blank ($null), which means all available authentication met Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,13 +260,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,13 +278,15 @@ Accept wildcard characters: False ``` ### -InstallProxySubDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InstallProxySubDirectory parameter was used to create an subdirectory that was required for proxying ActiveSync connections with Exchange 2007. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,6 +296,9 @@ Accept wildcard characters: False ``` ### -InternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalAuthenticationMethods parameter restricts the authentication methods that can be used to connect to the virtual directory from inside the firewall. Valid values are: - Adfs @@ -306,7 +330,6 @@ The default value is blank ($null), which means all available authentication met Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,13 +339,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,13 +357,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -348,6 +375,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -359,7 +389,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -369,6 +398,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -380,7 +412,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -390,13 +421,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,13 +439,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AdaptiveScope.md b/exchange/exchange-ps/ExchangePowerShell/New-AdaptiveScope.md similarity index 94% rename from exchange/exchange-ps/exchange/New-AdaptiveScope.md rename to exchange/exchange-ps/ExchangePowerShell/New-AdaptiveScope.md index 88433a9deb..793c5eec68 100644 --- a/exchange/exchange-ps/exchange/New-AdaptiveScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AdaptiveScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-adaptivescope applicable: Security & Compliance -title: New-AdaptiveScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-adaptivescope +schema: 2.0.0 +title: New-AdaptiveScope --- # New-AdaptiveScope @@ -56,13 +57,15 @@ This example create an adaptive query scope named Project X with the following d ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the adaptive scope. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -FilterConditions + +> Applicable: Security & Compliance + The FilterConditions parameter specifies the conditions that are included in the dynamic boundary. Valid syntax and values depend of the value of the LocationType parameter: - User or Group: Active Directory attributes. For example, for the condition "('Country or region' equals 'US' or 'Canada') and 'Department' equals 'Finance'", use the following syntax: `@{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "Canada"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "Equals"; "Name" = "Department"}); "Conjunction" = "And"}` @@ -83,7 +89,6 @@ You can't use this parameter with the RawQuery parameter. Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -LocationType + +> Applicable: Security & Compliance + The LocationType parameter specifies the location where the adaptive scope filter is defined. Valid values are: - User @@ -104,7 +112,6 @@ Type: DynamicBoundaryLocationType Parameter Sets: (All) Aliases: Accepted values: Unknown, User, Group, Site -Applicable: Security & Compliance Required: True Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -RawQuery + +> Applicable: Security & Compliance + The RawQuery parameter switches the scope to advanced query mode. You use OPATH filter syntax for advanced query mode. You can't use this parameter with the FilterConditions parameter. @@ -122,7 +132,6 @@ You can't use this parameter with the FilterConditions parameter. Type: String Parameter Sets: AdaptiveScopeRawQuery Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -AdministrativeUnit + +> Applicable: Security & Compliance + {{ Fill AdministrativeUnit Description }} ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AddressBookPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-AddressBookPolicy.md similarity index 87% rename from exchange/exchange-ps/exchange/New-AddressBookPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-AddressBookPolicy.md index 4bade089b4..0549ac3edd 100644 --- a/exchange/exchange-ps/exchange/New-AddressBookPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AddressBookPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-addressbookpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-AddressBookPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-addressbookpolicy +schema: 2.0.0 +title: New-AddressBookPolicy --- # New-AddressBookPolicy @@ -51,13 +52,15 @@ This example creates an address book policy with the following settings: ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the address book policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -AddressLists + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AddressLists parameter specifies the address lists that will be used by mailbox users who are assigned this address book policy. This parameter accepts multiple values, which should be separated by a comma. For example, "\\Mr. Munson's Class","Mrs. McKay's Class","Mrs. Count's Class". ```yaml Type: AddressListIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -GlobalAddressList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The GlobalAddressList parameter specifies the identity of the GAL that will be used by mailbox users who are assigned this address book policy. You can specify only one GAL for each address book policy. ```yaml Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -OfflineAddressBook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OfflineAddressBook parameter specifies the identity of the OAB that will be used by mailbox users who are assigned this address book policy. You can specify only one OAB for each address book policy. ```yaml Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -115,9 +124,12 @@ Accept wildcard characters: False ``` ### -RoomList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RoomList parameter specifies an address list that used for location experiences for mailbox users who have this address book policy assigned to them. -- When using location experiences (for example, Room Finder or selecting a conference room when scheduling a meeting), users see only resources that match the [RecipientFilter](https://learn.microsoft.com/powershell/module/exchange/new-addresslist#-recipientfilter) results from the address list that's specified by this parameter. +- When using location experiences (for example, Room Finder or selecting a conference room when scheduling a meeting), users see only resources that match the [RecipientFilter](https://learn.microsoft.com/powershell/module/exchangepowershell/new-addresslist#-recipientfilter) results from the address list that's specified by this parameter. - When using experiences that aren't location specific (for example, the To or Cc fields of a calendar event), the address lists specified by the AddressLists parameter in this address book policy are applied. The address list specified by this parameter isn't used. A valid value for this parameter is one address list. You can use any value that uniquely identifies the address list. For example: @@ -133,7 +145,6 @@ A valid value for this parameter is one address list. You can use any value that Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -152,7 +166,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -162,6 +175,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -170,7 +186,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/New-AddressList.md similarity index 89% rename from exchange/exchange-ps/exchange/New-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/New-AddressList.md index 540855b553..b0e5d2457b 100644 --- a/exchange/exchange-ps/exchange/New-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-AddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-addresslist +schema: 2.0.0 +title: New-AddressList --- # New-AddressList @@ -101,13 +102,15 @@ This example creates the address list AL\_AgencyB that includes mailboxes that h ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name for the new address list. The maximum length is 64 characters, and it can't include a carriage return or a backslash (\\). If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -117,6 +120,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -134,7 +140,6 @@ You need to use this parameter when you use any Conditional parameters as part o Type: WellKnownRecipientType Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -161,7 +169,6 @@ You can't use this parameter in combination with the IncludedRecipients paramete Type: String Parameter Sets: CustomFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -171,6 +178,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -181,7 +191,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -191,6 +200,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -201,7 +213,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -211,6 +222,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -221,7 +235,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -231,6 +244,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -241,7 +257,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -251,6 +266,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -261,7 +279,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -271,6 +288,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -281,7 +301,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -291,6 +310,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -301,7 +323,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -311,6 +332,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -321,7 +345,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -331,6 +354,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -341,7 +367,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -351,6 +376,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -361,7 +389,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -371,6 +398,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -381,7 +411,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -391,6 +420,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -401,7 +433,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,6 +442,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -421,7 +455,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -431,6 +464,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -441,7 +477,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -451,6 +486,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -461,7 +499,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -471,6 +508,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -481,7 +521,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -491,6 +530,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -501,7 +543,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -511,6 +552,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -521,7 +565,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -531,6 +574,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -540,7 +586,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -550,6 +595,9 @@ Accept wildcard characters: False ``` ### -Container + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Container parameter specifies where to create the address list. Valid input for this parameter is under the root "\\" (also known as All Address Lists) or under an existing address list. You can use any value that uniquely identifies the address list. For example: - Name @@ -563,7 +611,6 @@ If you don't use this parameter,the address list is created under the root (\\). Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -573,6 +620,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DisplayName parameter specifies the display name of the address list. The display name is visible in the Exchange admin center and Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -581,7 +631,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -591,6 +640,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -599,7 +651,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -609,6 +660,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -624,7 +678,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -634,13 +687,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md b/exchange/exchange-ps/ExchangePowerShell/New-AddressRewriteEntry.md similarity index 90% rename from exchange/exchange-ps/exchange/New-AddressRewriteEntry.md rename to exchange/exchange-ps/ExchangePowerShell/New-AddressRewriteEntry.md index 1c5c9541bd..0d8d06f58d 100644 --- a/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AddressRewriteEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-addressrewriteentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AddressRewriteEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-addressrewriteentry +schema: 2.0.0 +title: New-AddressRewriteEntry --- # New-AddressRewriteEntry @@ -59,13 +60,15 @@ This example creates an address rewrite entry that rewrites all email addresses ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a unique name for this address rewrite entry. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -ExternalAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalAddress parameter specifies the final email addresses that you want. If the InternalAddress parameter specifies a single email address (chris@contoso.com), the ExternalAddress parameter must also specify a single email address (support@contoso.com). If the InternalAddress parameter specifies a single domain (contoso.com) or a domain and all subdomains (\*.contoso.com), the ExternalAddress parameter must specify a single domain (fabrikam.com). You can't use the wildcard character (\*) with the ExternalAddress parameter. @@ -83,7 +89,6 @@ You can't use the wildcard character (\*) with the ExternalAddress parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -InternalAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalAddress parameter specifies the original email addresses that you want to change. You can use the following values: - Single email address: david@contoso.com @@ -103,7 +111,6 @@ The InternalAddress parameter specifies the original email addresses that you wa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -122,7 +132,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -140,7 +152,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -ExceptionList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExceptionList parameter specifies the email address domains that shouldn't be rewritten when the InternalAddress parameter contains the wildcard character to rewrite addresses in a domain and all subdomains (\*.contoso.com). You can enter multiple domain values in the ExceptionList parameter separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -OutboundOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OutboundOnly parameter enables or disables outbound-only address rewriting. Valid input for this parameter is $true or $false. The value $true means address rewriting occurs in outbound mail only. The value $false means address rewriting occurs on outbound mail and also on inbound mail (rewritten email addresses are changed back to the original email addresses in inbound mail). The default value is $false. You must set this parameter to $true if the InternalAddress parameter contains the wildcard character to rewrite addresses in a domain and all subdomains (\*.contoso.com). @@ -176,7 +192,6 @@ Also, when you configure outbound-only address rewriting, you need to configure Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md b/exchange/exchange-ps/ExchangePowerShell/New-AdminAuditLogSearch.md similarity index 84% rename from exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md rename to exchange/exchange-ps/ExchangePowerShell/New-AdminAuditLogSearch.md index 1059619e55..6f6e1a5d91 100644 --- a/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AdminAuditLogSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-adminauditlogsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: New-AdminAuditLogSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-adminauditlogsearch +schema: 2.0.0 +title: New-AdminAuditLogSearch --- # New-AdminAuditLogSearch @@ -66,6 +67,9 @@ This example returns entries in the administrator audit log of an Exchange Onlin ## PARAMETERS ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -74,7 +78,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named Default value: None @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -91,7 +97,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named Default value: None @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -StatusMailRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The StatusMailRecipients parameter specifies the recipients that should receive the administrator audit log report. The recipient must be a valid SMTP address. If you want to specify more than one recipient, separate each SMTP address with a comma. @@ -108,7 +116,6 @@ If you want to specify more than one recipient, separate each SMTP address with Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named Default value: None @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Cmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Cmdlets parameter specifies the cmdlets you want to search for in the administrator audit log. Only the log entries that contain the cmdlets you specify are returned. If you want to specify more than one cmdlet, separate each cmdlet with a comma. @@ -125,7 +135,6 @@ If you want to specify more than one cmdlet, separate each cmdlet with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -143,7 +155,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -160,7 +174,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -ExternalAccess + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ExternalAccess parameter returns only audit log entries for cmdlets that were run by a user outside of your organization. In Exchange Online, use this parameter to return audit log entries for cmdlets run by Microsoft datacenter administrators. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Name parameter specifies the name of the administrator audit log search. The name is shown in the subject line of the audit log report email message. If the name of the report contains spaces, enclose the name in quotation marks ("). @@ -193,7 +211,6 @@ If the name of the report contains spaces, enclose the name in quotation marks ( Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -202,6 +219,9 @@ Accept wildcard characters: False ``` ### -ObjectIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ObjectIds parameter specifies that only administrator audit log entries that contain the specified changed objects should be returned. This parameter accepts a variety of objects, such as mailboxes, aliases, Send connector names and so on. If you want to specify more than one object ID, separate each ID with a comma. @@ -210,7 +230,6 @@ If you want to specify more than one object ID, separate each ID with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Parameters parameter specifies the parameters you want to search for in the administrator audit log. Only the log entries that contain the parameters you specify are returned. You can only use this parameter if you use the Cmdlets parameter. If you want to specify more than one parameter, separate each parameter with a comma. @@ -227,7 +249,6 @@ If you want to specify more than one parameter, separate each parameter with a c Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -236,6 +257,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The UserIds parameter specifies that only the administrator audit log entries that contain the specified ID of the user who ran the cmdlet should be returned. If you want to specify more than one user ID, separate each ID with a comma. @@ -244,7 +268,6 @@ If you want to specify more than one user ID, separate each ID with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -253,6 +276,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -261,7 +287,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-AntiPhishPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/New-AntiPhishPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-AntiPhishPolicy.md index 412a2a5340..3275adc777 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AntiPhishPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-antiphishpolicy applicable: Exchange Online, Exchange Online Protection -title: New-AntiPhishPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-antiphishpolicy +schema: 2.0.0 +title: New-AntiPhishPolicy --- # New-AntiPhishPolicy @@ -91,13 +92,15 @@ In Microsoft Defender for Office 365, this example creates and enables an antiph ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the antiphish policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -AuthenticationFailAction + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The AuthenticationFailAction parameter specifies the action to take when the message fails composite authentication (a mixture of traditional SPF, DKIM, and DMARC email authentication checks and proprietary backend intelligence). Valid values are: @@ -134,7 +142,6 @@ The AuthenticationFailAction parameter specifies the action to take when the mes Type: SpoofAuthenticationFailAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -153,7 +163,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -DmarcQuarantineAction + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`. Valid values are: @@ -176,7 +188,6 @@ This parameter is meaningful only when the HonorDmarcPolicy parameter is set to Type: SpoofDmarcQuarantineAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -DmarcRejectAction + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The DmarcRejectAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=reject`. Valid values are: @@ -199,7 +213,6 @@ This parameter is meaningful only when the HonorDmarcPolicy parameter is set to Type: SpoofDmarcRejectAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -209,6 +222,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. To create a disabled anti-phishing policy (the combination of the antiphish rule and the associated antiphish policy), use `-Enabled $false` on the **New-AntiPhishRule** cmdlet. @@ -221,7 +237,6 @@ In the output of the **Get-AntiPhishRule** cmdlet, whether the anti-phishing pol Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -EnableFirstContactSafetyTips + +> Applicable: Exchange Online, Exchange Online Protection + The EnableFirstContactSafetyTips parameter specifies whether to enable or disable the safety tip that's shown when recipients first receive an email from a sender or do not often receive email from a sender. Valid values are: - $true: First contact safety tips are enabled. @@ -240,7 +258,6 @@ The EnableFirstContactSafetyTips parameter specifies whether to enable or disabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -250,6 +267,9 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligence + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence, which is artificial intelligence (AI) that determines user email patterns with their frequent contacts. Mailbox intelligence helps distinguish between messages from legitimate and impersonated senders based on a recipient's previous communication history. Valid values are: @@ -261,7 +281,6 @@ The EnableMailboxIntelligence parameter specifies whether to enable or disable m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -271,6 +290,9 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligenceProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligenceProtection specifies whether to enable or disable taking action for impersonation detections from mailbox intelligence results. Valid values are: @@ -286,7 +308,6 @@ If you set this parameter to the value $false when the value of the EnableMailbo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -296,6 +317,9 @@ Accept wildcard characters: False ``` ### -EnableOrganizationDomainsProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Microsoft 365 organization. Valid values are: @@ -307,7 +331,6 @@ The EnableOrganizationDomainsProtection parameter specifies whether to enable do Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -317,6 +340,9 @@ Accept wildcard characters: False ``` ### -EnableSimilarDomainsSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for domain impersonation detections. Valid values are: @@ -328,7 +354,6 @@ The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the saf Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -338,6 +363,9 @@ Accept wildcard characters: False ``` ### -EnableSimilarUsersSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for user impersonation detections. Valid values are: @@ -349,7 +377,6 @@ The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -359,6 +386,9 @@ Accept wildcard characters: False ``` ### -EnableSpoofIntelligence + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableSpoofIntelligence parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: @@ -370,7 +400,6 @@ The EnableSpoofIntelligence parameter specifies whether to enable or disable ant Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -380,6 +409,9 @@ Accept wildcard characters: False ``` ### -EnableTargetedDomainsProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableTargetedDomainsProtection parameter specifies whether to enable domain impersonation protection for a list of specified domains. Valid values are: @@ -391,7 +423,6 @@ The EnableTargetedDomainsProtection parameter specifies whether to enable domain Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -401,6 +432,9 @@ Accept wildcard characters: False ``` ### -EnableTargetedUserProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for a list of specified users. Valid values are: @@ -412,7 +446,6 @@ The EnableTargetedUserProtection parameter specifies whether to enable user impe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -422,6 +455,9 @@ Accept wildcard characters: False ``` ### -EnableUnauthenticatedSender + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableUnauthenticatedSender parameter enables or disables unauthenticated sender identification in Outlook. Valid values are: @@ -438,7 +474,6 @@ To prevent these identifiers from being added to messages from specific senders, Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -448,6 +483,9 @@ Accept wildcard characters: False ``` ### -EnableUnusualCharactersSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for unusual characters in domain and user impersonation detections. Valid values are: @@ -459,7 +497,6 @@ The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -469,6 +506,9 @@ Accept wildcard characters: False ``` ### -EnableViaTag + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableViaTag parameter enables or disables adding the via tag to the From address in Outlook (chris@contso.com via fabrikam.com). Valid values are: @@ -485,7 +525,6 @@ To prevent the via tag from being added to messages from specific senders, you h Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -495,6 +534,9 @@ Accept wildcard characters: False ``` ### -ExcludedDomains + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. @@ -507,7 +549,6 @@ The maximum number of entries is approximately 1000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -517,6 +558,9 @@ Accept wildcard characters: False ``` ### -ExcludedSenders + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. @@ -527,7 +571,6 @@ The maximum number of entries is approximately 1000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -537,6 +580,9 @@ Accept wildcard characters: False ``` ### -HonorDmarcPolicy + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The HonorDmarcPolicy enables or disables using the sender's DMARC policy to determine what to do to messages that fail DMARC checks. Valid values are: @@ -548,7 +594,6 @@ The HonorDmarcPolicy enables or disables using the sender's DMARC policy to dete Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -558,6 +603,9 @@ Accept wildcard characters: False ``` ### -ImpersonationProtectionState + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ImpersonationProtectionState parameter specifies the configuration of impersonation protection. Valid values are: @@ -570,7 +618,6 @@ The ImpersonationProtectionState parameter specifies the configuration of impers Type: ImpersonationProtectionState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -580,6 +627,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionAction parameter specifies what to do with messages that fail mailbox intelligence protection. Valid values are: @@ -597,7 +647,6 @@ This parameter is meaningful only if the EnableMailboxIntelligence and EnableMai Type: ImpersonationAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -607,6 +656,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionActionRecipients parameter specifies the recipients to add to detected messages when the MailboxIntelligenceProtectionAction parameter is set to the value Redirect or BccMessage. @@ -617,7 +669,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -627,6 +678,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by mailbox intelligence (the MailboxIntelligenceProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -645,7 +699,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -655,6 +708,9 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Online, Exchange Online Protection + The MakeDefault switch makes this antiphish policy the default antiphish policy. You don't need to specify a value with this switch. The default antiphish policy is applied to everyone (no corresponding antiphish rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). @@ -663,7 +719,6 @@ The default antiphish policy is applied to everyone (no corresponding antiphish Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -673,6 +728,9 @@ Accept wildcard characters: False ``` ### -PhishThresholdLevel + +> Applicable: Exchange Online + This setting is part of advanced settings and is available only in Microsoft Defender for Office 365. The PhishThresholdLevel parameter specifies the tolerance level that's used by machine learning in the handling of phishing messages. Valid values are: @@ -686,7 +744,6 @@ The PhishThresholdLevel parameter specifies the tolerance level that's used by m Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -696,13 +753,15 @@ Accept wildcard characters: False ``` ### -PolicyTag + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -712,13 +771,15 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online, Exchange Online Protection + The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -728,13 +789,15 @@ Accept wildcard characters: False ``` ### -SimilarUsersSafetyTipsCustomText + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -744,6 +807,9 @@ Accept wildcard characters: False ``` ### -SpoofQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The SpoofQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by spoof intelligence (the AuthenticationFailAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -760,7 +826,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -770,6 +835,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. @@ -780,7 +848,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -790,6 +857,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: @@ -805,7 +875,6 @@ The TargetedDomainProtectionAction parameter specifies the action to take on det Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -815,6 +884,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by domain impersonation protection (the TargetedDomainProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -833,7 +905,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -843,6 +914,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainsToProtect + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. @@ -853,7 +927,6 @@ You can specify multiple domains separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -863,6 +936,9 @@ Accept wildcard characters: False ``` ### -TargetedUserActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. @@ -873,7 +949,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -883,6 +958,9 @@ Accept wildcard characters: False ``` ### -TargetedUserProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: @@ -898,7 +976,6 @@ The TargetedUserProtectionAction parameter specifies the action to take on detec Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -908,6 +985,9 @@ Accept wildcard characters: False ``` ### -TargetedUserQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by user impersonation protection (the TargetedUserProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -926,7 +1006,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -936,6 +1015,9 @@ Accept wildcard characters: False ``` ### -TargetedUsersToProtect + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. @@ -950,7 +1032,6 @@ This parameter uses the syntax: "DisplayName;EmailAddress". Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -960,13 +1041,15 @@ Accept wildcard characters: False ``` ### -UnusualCharactersSafetyTipsCustomText + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -976,13 +1059,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/New-AntiPhishRule.md similarity index 92% rename from exchange/exchange-ps/exchange/New-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-AntiPhishRule.md index 79afcd0346..b779bdcd5c 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: New-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-antiphishrule +schema: 2.0.0 +title: New-AntiPhishRule --- # New-AntiPhishRule @@ -59,13 +60,15 @@ This example creates an antiphish rule named Research Department with the follow ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the antiphish rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AntiPhishPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The AntiPhishPolicy parameter specifies the antiphish policy that's associated with the antiphish rule. You can use any value that uniquely identifies the policy. For example: @@ -89,7 +95,6 @@ You can't specify the default antiphish policy. And, you can't specify an antiph Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -124,7 +134,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the rule is enabled. Valid values are: - $true: The rule is enabled. This is the default value. @@ -145,7 +157,6 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -186,7 +202,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -196,6 +211,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -213,7 +231,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -223,6 +240,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -237,7 +257,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -247,13 +266,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -263,6 +284,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -278,7 +302,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -288,6 +311,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -305,7 +331,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -315,13 +340,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-App.md b/exchange/exchange-ps/ExchangePowerShell/New-App.md similarity index 88% rename from exchange/exchange-ps/exchange/New-App.md rename to exchange/exchange-ps/ExchangePowerShell/New-App.md index 12f88e9b57..36786d92f6 100644 --- a/exchange/exchange-ps/exchange/New-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-App.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-App -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-app +schema: 2.0.0 +title: New-App --- # New-App @@ -146,6 +147,9 @@ This example installs the Contoso CRM app manifest.xml from a URL on the Contoso ## PARAMETERS ### -AddInOverrides + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AddInOverrides Description }} @@ -154,7 +158,6 @@ This parameter is available only in the cloud-based service. Type: AddInOverrides Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -164,13 +167,15 @@ Accept wildcard characters: False ``` ### -AllowReadWriteMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowReadWriteMailbox switch specifies whether the app allows read/write mailbox permission. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +185,9 @@ Accept wildcard characters: False ``` ### -AllowSetting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AllowSetting Description }} @@ -188,7 +196,6 @@ This parameter is available only in the cloud-based service. Type: AllowSetting Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -198,6 +205,9 @@ Accept wildcard characters: False ``` ### -AppState + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AppState Description }} @@ -206,7 +216,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,6 +225,9 @@ Accept wildcard characters: False ``` ### -AppType + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AppType Description }} @@ -224,7 +236,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -234,6 +245,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -243,7 +257,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,6 +266,9 @@ Accept wildcard characters: False ``` ### -DefaultStateForUser + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultStateForUser parameter specifies the default initial state of an organization app. Valid values are: - Enabled: The organization app is enabled by default. @@ -265,7 +281,6 @@ You need to use the OrganizationApp switch when you use this parameter. Type: DefaultStateForUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -275,6 +290,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -283,7 +301,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +310,9 @@ Accept wildcard characters: False ``` ### -DownloadOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DownloadOnly switch specifies whether to get the app manifest file and prompt the user for confirmation before committing to actual installation. You don't need to specify a value with this switch. When you use this switch, the cmdlet only downloads the app manifest file and displays the app properties without installing the app. @@ -301,7 +321,6 @@ When you use this switch, the cmdlet only downloads the app manifest file and di Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -311,6 +330,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter specifies whether the app is available to users in the organization. Valid values are: - $true: The app is available to the specified users. This is the default value. @@ -322,7 +344,6 @@ This setting overrides the ProvidedTo, UserList and DefaultStateForUser settings Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -332,13 +353,15 @@ Accept wildcard characters: False ``` ### -Etoken + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -348,6 +371,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FileData parameter specifies the location of the app manifest file. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -356,7 +382,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: ExtensionFileData Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -366,13 +391,15 @@ Accept wildcard characters: False ``` ### -FileStream + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FileStream parameter is used only by the Exchange admin center to support the app file uploader. Don't use this parameter to specify the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url or FileData parameter. ```yaml Type: Stream Parameter Sets: ExtensionFileStream Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -382,6 +409,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Identity Description }} @@ -390,7 +420,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -400,6 +429,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox where you want to install the app. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -417,7 +449,6 @@ The Mailbox parameter specifies the mailbox where you want to install the app. Y Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -427,13 +458,15 @@ Accept wildcard characters: False ``` ### -MarketplaceAssetID + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MarketplaceAssetID parameter specifies the Office Store identifier for the app. You need to use this parameter if you use theMarketplaceServicesUrl parameter. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -443,13 +476,15 @@ Accept wildcard characters: False ``` ### -MarketplaceCorrelationID + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MarketplaceCorrelationID parameter specifies the Office Store correlation identifier for the app. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -459,13 +494,15 @@ Accept wildcard characters: False ``` ### -MarketplaceQueryMarket + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MarketplaceQueryMarket parameter specifies the locale that an app is filed under at the office marketplace. For example, an app for the United States market in English uses the value en-US. The default value is en-US. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -475,13 +512,15 @@ Accept wildcard characters: False ``` ### -MarketplaceServicesUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MarketplaceServicesUrl parameter specifies the full services URL for the app. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url or FileData parameter. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -491,13 +530,15 @@ Accept wildcard characters: False ``` ### -MarketplaceUserProfileType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MarketplaceUserProfileType parameter specifies the user profile type for the Office Store. ```yaml Type: String Parameter Sets: ExtensionOfficeMarketplace Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -507,13 +548,15 @@ Accept wildcard characters: False ``` ### -OrganizationApp + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OrganizationApp switch specifies that the scope of the app is organizational (not bound to a specific user). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -523,13 +566,15 @@ Accept wildcard characters: False ``` ### -PrivateCatalog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PrivateCatalog switch specifies whether the app is located in a private catalog. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -539,6 +584,9 @@ Accept wildcard characters: False ``` ### -ProvidedTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ProvidedTo parameter specifies the availability of the app in your organization. Valid values are: - Everyone: This is the default value. This app is provided to every user in the organization. Every user sees this app listed in the installed apps list in Outlook on the web Options. When an app in the installed apps list is enabled, users can use the features of this app in their email. All users are blocked from installing their own instances of this app, including but not limited to users with install apps permissions. @@ -550,7 +598,6 @@ You use this parameter with the OrganizationApp switch. Type: ClientExtensionProvidedTo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -560,6 +607,9 @@ Accept wildcard characters: False ``` ### -UpdateAppState + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UpdateAppState Description }} @@ -568,7 +618,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -578,6 +627,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Url parameter specifies the full URL location of the app manifest file that you want to install. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url or FileData parameter. **Note**: URLs with redirections are not supported in Exchange Server 2016, Exchange Server 2019, and Exchange Online. Use a direct URL to the manifest. @@ -586,7 +638,6 @@ The Url parameter specifies the full URL location of the app manifest file that Type: Uri Parameter Sets: ExtensionPrivateURL Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -596,6 +647,9 @@ Accept wildcard characters: False ``` ### -UserList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://learn.microsoft.com/office/dev/add-ins/publish/centralized-deployment). Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. For example: @@ -619,7 +673,6 @@ You use this parameter with the OrganizationApp switch. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -629,6 +682,9 @@ Accept wildcard characters: False ``` ### -Version + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Version Description }} @@ -637,7 +693,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -647,13 +702,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-AppRetentionCompliancePolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-AppRetentionCompliancePolicy.md index 669e94235e..3e58c6fc38 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AppRetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-appretentioncompliancepolicy applicable: Security & Compliance -title: New-AppRetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-appretentioncompliancepolicy +schema: 2.0.0 +title: New-AppRetentionCompliancePolicy --- # New-AppRetentionCompliancePolicy @@ -70,13 +71,15 @@ After you create the retention policy, use the New-AppRetentionComplianceRule cm ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the app retention compliance policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -AdaptiveScopeLocation + +> Applicable: Security & Compliance + The AdaptiveScopeLocation parameter specifies the adaptive scope location to include in the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -96,7 +102,6 @@ The AdaptiveScopeLocation parameter specifies the adaptive scope location to inc Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -Applications + +> Applicable: Security & Compliance + The Applications parameter specifies the applications to include in the policy. This parameter uses the following syntax: `"LocationType:App1,LocationType:App2,...LocationType:AppN`: @@ -136,7 +144,6 @@ This parameter uses the following syntax: `"LocationType:App1,LocationType:App2, Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -146,13 +153,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -171,7 +183,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter enables or disables the policy. Valid values are: - $true: The policy is enabled. This is the default value. @@ -190,7 +204,6 @@ The Enabled parameter enables or disables the policy. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -200,6 +213,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - A mailbox @@ -219,7 +235,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -229,6 +244,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocationException + +> Applicable: Security & Compliance + The ExchangeLocationException parameter specifies the mailboxes exclude from the policy when you use the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -247,7 +265,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -257,6 +274,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -265,7 +285,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -275,6 +294,9 @@ Accept wildcard characters: False ``` ### -ModernGroupLocation + +> Applicable: Security & Compliance + The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. Valid values are: - A Microsoft 365 Group @@ -293,7 +315,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -303,6 +324,9 @@ Accept wildcard characters: False ``` ### -ModernGroupLocationException + +> Applicable: Security & Compliance + The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude from the policy when you use the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -318,7 +342,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -328,6 +351,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + **Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. @@ -338,7 +364,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -348,6 +373,9 @@ Accept wildcard characters: False ``` ### -RestrictiveRetention + +> Applicable: Security & Compliance + The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: - $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. @@ -361,7 +389,6 @@ Therefore, before you lock a policy, it's critical that you understand your orga Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -371,13 +398,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/New-AppRetentionComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-AppRetentionComplianceRule.md index 3d8602cf9a..03b4a2058f 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AppRetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-appretentioncompliancerule applicable: Security & Compliance -title: New-AppRetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-appretentioncompliancerule +schema: 2.0.0 +title: New-AppRetentionComplianceRule --- # New-AppRetentionComplianceRule @@ -63,13 +64,15 @@ This example creates a new retention rule named RetUnlimited and adds it to the ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the app retention compliance rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the app retention compliance policy that contains the app retention compliance policy rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -89,7 +95,6 @@ The Policy parameter specifies the app retention compliance policy that contains Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -124,7 +134,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -144,7 +156,6 @@ Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information Type: PswsHashtable[] Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -162,7 +176,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: Default, ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,6 +185,9 @@ Accept wildcard characters: False ``` ### -ExcludedItemClasses + +> Applicable: Security & Compliance + The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter 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 @@ -191,7 +207,6 @@ You can specify multiple item class values by using the following syntax: `"Valu Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -201,6 +216,9 @@ Accept wildcard characters: False ``` ### -ExpirationDateOption + +> Applicable: Security & Compliance + The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: - CreationAgeInDays @@ -210,7 +228,6 @@ The ExpirationDateOption parameter specifies whether the expiration date is calc Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -220,13 +237,15 @@ Accept wildcard characters: False ``` ### -MachineLearningModelIDs + +> Applicable: Security & Compliance + {{ Fill MachineLearningModelIDs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -236,6 +255,9 @@ Accept wildcard characters: False ``` ### -RetentionComplianceAction + +> Applicable: Security & Compliance + The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - Delete @@ -246,7 +268,6 @@ The RetentionComplianceAction parameter specifies the retention action for the r Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -256,6 +277,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - An integer: The hold duration in days. @@ -265,7 +289,6 @@ The RetentionDuration parameter specifies the hold duration for the retention ru Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -275,6 +298,9 @@ Accept wildcard characters: False ``` ### -RetentionDurationDisplayHint + +> Applicable: Security & Compliance + The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. - Days @@ -288,7 +314,6 @@ Type: HoldDurationHint Parameter Sets: Default Aliases: Accepted values: Days, Months, Years -Applicable: Security & Compliance Required: False Position: Named @@ -298,13 +323,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-ApplicationAccessPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-ApplicationAccessPolicy.md index 3a8139e536..7fb71820ea 100644 --- a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ApplicationAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection -title: New-ApplicationAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-applicationaccesspolicy +schema: 2.0.0 +title: New-ApplicationAccessPolicy --- # New-ApplicationAccessPolicy @@ -86,6 +87,9 @@ This example creates a new application access policy with the following settings ## PARAMETERS ### -AccessRight + +> Applicable: Exchange Online, Exchange Online Protection + The AccessRight parameter specifies the restriction type that you want to assign in the application access policy. Valid values are: - RestrictAccess: Allows the associated app to only access data that's associated with mailboxes specified by the PolicyScopeGroupID parameter. @@ -95,7 +99,6 @@ The AccessRight parameter specifies the restriction type that you want to assign Type: ApplicationAccessPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -AppId + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID of the apps to include in the policy. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. You can specify multiple app GUID values separated by commas or you can specify * to indicate all applications. @@ -113,7 +119,6 @@ You can specify multiple app GUID values separated by commas or you can specify Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -PolicyScopeGroupID + +> Applicable: Exchange Online, Exchange Online Protection + The PolicyScopeGroupID parameter specifies the recipient to define in the policy. Valid recipient types are security principals in Exchange Online (users or groups, including nested groups, that can have permissions assigned to them). For example: - Mailboxes with associated user accounts (UserMailbox) @@ -156,7 +164,6 @@ If you need to scope the policy to shared mailboxes, you can add the shared mail Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -166,6 +173,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -175,7 +185,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -185,13 +194,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online, Exchange Online Protection + The Description parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -201,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AuthRedirect.md b/exchange/exchange-ps/ExchangePowerShell/New-AuthRedirect.md similarity index 89% rename from exchange/exchange-ps/exchange/New-AuthRedirect.md rename to exchange/exchange-ps/ExchangePowerShell/New-AuthRedirect.md index d885bf6957..ce878ff18c 100644 --- a/exchange/exchange-ps/exchange/New-AuthRedirect.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AuthRedirect.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-authredirect applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AuthRedirect -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-authredirect +schema: 2.0.0 +title: New-AuthRedirect --- # New-AuthRedirect @@ -48,13 +49,15 @@ This example creates an OAuth redirection object with the following settings: ## PARAMETERS ### -AuthScheme + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AuthScheme parameter specifies the authentication scheme that's used by the authentication redirection object. Typically, this value is Bearer. ```yaml Type: AuthScheme Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -TargetUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetUrl parameter specifies the FQDN of the Exchange Client Access Server that's responsible for processing the redirected OAuth authentication requests. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -89,7 +97,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AuthServer.md b/exchange/exchange-ps/ExchangePowerShell/New-AuthServer.md similarity index 90% rename from exchange/exchange-ps/exchange/New-AuthServer.md rename to exchange/exchange-ps/ExchangePowerShell/New-AuthServer.md index 5837e8cdb9..cbcdf925ab 100644 --- a/exchange/exchange-ps/exchange/New-AuthServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AuthServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-authserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AuthServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-authserver +schema: 2.0.0 +title: New-AuthServer --- # New-AuthServer @@ -73,13 +74,15 @@ This command creates an authorization server object with the specified settings. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a unique name for the authorization server object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -AuthMetadataUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AuthMetadataUrl parameter specifies the URL for the Microsoft 365 authorization server for your cloud-based organization. ```yaml Type: String Parameter Sets: AuthMetadataUrl, NativeClientAuthServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Type parameter specifies the type of authorization tokens that are issued by the authorization server. Valid values are: - ADFS @@ -117,7 +125,6 @@ The Type parameter specifies the type of authorization tokens that are issued by Type: AuthServerType Parameter Sets: NativeClientAuthServer, AppSecret Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -ApplicationIdentifier + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available in the April 18, 2025 Hotfix update (HU) for Exchange 2019 CU15 and Exchange 2016 CU23. {{ Fill ApplicationIdentifier Description }} @@ -135,7 +145,6 @@ This parameter is available in the April 18, 2025 Hotfix update (HU) for Exchang Type: String Parameter Sets: AppSecret Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -154,7 +166,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,13 +193,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2016, Exchange Server 2019 + {{ Fill DomainName Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,6 +211,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the authorization server is enabled. Valid values are: - $true: Authorization tokens that are issued by the authorization server are accepted. This is the default value @@ -205,7 +223,6 @@ The Enabled parameter specifies whether the authorization server is enabled. Val Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,6 +232,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. We don't recommend using this switch in a production environment. @@ -223,7 +243,6 @@ We don't recommend using this switch in a production environment. Type: SwitchParameter Parameter Sets: AuthMetadataUrl, NativeClientAuthServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,13 +252,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-AuthenticationPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/New-AuthenticationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-AuthenticationPolicy.md index 4c06f72d1a..e623800578 100644 --- a/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AuthenticationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-authenticationpolicy applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-AuthenticationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-authenticationpolicy +schema: 2.0.0 +title: New-AuthenticationPolicy --- # New-AuthenticationPolicy @@ -77,13 +78,15 @@ In Exchange 2019, this example creates a new authentication policy named Researc ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name for the authentication policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthActiveSync + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthActiveSync switch specifies whether to allow Basic authentication with Exchange ActiveSync. You don't need to specify a value with this switch. @@ -103,7 +109,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthAutodiscover + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthAutodiscover switch specifies whether to allow Basic authentication with Autodiscover. You don't need to specify a value with this switch. @@ -123,7 +131,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthImap + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthImap switch specifies whether to allow Basic authentication with IMAP. You don't need to specify a value with this switch. @@ -143,7 +153,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthMapi + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthMapi switch specifies whether to allow Basic authentication with MAPI. You don't need to specify a value with this switch. @@ -163,7 +175,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthOfflineAddressBook + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthOfflineAddressBook switch specifies whether to allow Basic authentication with Offline Address Books. You don't need to specify a value with this switch. @@ -183,7 +197,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthOutlookService + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthOutlookService switch specifies whether to allow Basic authentication with the Outlook service. You don't need to specify a value with this switch. @@ -203,7 +219,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -213,6 +228,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthPop + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthPop switch specifies whether to allow Basic authentication with POP. You don't need to specify a value with this switch. @@ -223,7 +241,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +250,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthPowershell + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthPowerShell switch specifies whether to allow Basic authentication with PowerShell. You don't need to specify a value with this switch. @@ -243,7 +263,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,6 +272,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthReportingWebServices + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthReporting Web Services switch specifies whether to allow Basic authentication with reporting web services. You don't need to specify a value with this switch. @@ -263,7 +285,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -273,6 +294,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthRpc + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthRpc switch specifies whether to allow Basic authentication with RPC. You don't need to specify a value with this switch. @@ -283,7 +307,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -293,6 +316,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthSmtp + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthSmtp switch specifies whether to allow Basic authentication with SMTP. You don't need to specify a value with this switch. @@ -303,7 +329,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,6 +338,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthWebServices + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthWebServices switch specifies whether to allow Basic authentication with Exchange Web Services (EWS). You don't need to specify a value with this switch. @@ -323,7 +351,6 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -333,6 +360,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthActiveSync + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthActiveSync switch specifies whether to allow only modern authentication with Exchange ActiveSync in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -349,7 +379,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -359,6 +388,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthAutodiscover + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthAutodiscover switch specifies whether to allow only modern authentication with Autodiscover in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -375,7 +407,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -385,6 +416,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthImap + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthImap switch specifies whether to allow only modern authentication with IMAP in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -401,7 +435,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -411,6 +444,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthMapi + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthMapi switch specifies whether to allow only modern authentication with MAPI in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -427,7 +463,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -437,6 +472,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthOfflineAddressBook + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthOfflineAddressBook switch specifies whether to allow only modern authentication with Offline Address Books in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -453,7 +491,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -463,6 +500,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthPop + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthPop switch specifies whether to allow only modern authentication with POP in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -479,7 +519,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -489,6 +528,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthRpc + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthRpc switch specifies whether to allow only modern authentication with RPC in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -505,7 +547,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -515,6 +556,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthWebServices + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthWebServices switch specifies whether to allow only modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU2 or later hybrid environments. You don't need to specify a value with this switch. @@ -531,7 +575,6 @@ Before you disable the legacy authentication methods for this protocol, verify t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -541,6 +584,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthActiveSync + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthActiveSync switch specifies whether to block modern authentication with Exchange ActiveSync in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -549,7 +595,6 @@ The BlockModernAuthActiveSync switch specifies whether to block modern authentic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -559,6 +604,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthAutodiscover + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthAutodiscover switch specifies whether to block modern authentication with Autodiscover in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -567,7 +615,6 @@ The BlockModernAuthAutodiscover switch specifies whether to block modern authent Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -577,6 +624,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthImap + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthImap switch specifies whether to block modern authentication with IMAP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -585,7 +635,6 @@ The BlockModernAuthImap switch specifies whether to block modern authentication Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -595,6 +644,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthMapi + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthMapi switch specifies whether to block modern authentication with MAPI in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -603,7 +655,6 @@ The BlockModernAuthMapi switch specifies whether to block modern authentication Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -613,6 +664,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthOfflineAddressBook + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthOfflineAddressBook switch specifies whether to block modern authentication with Offline Address Books in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -621,7 +675,6 @@ The BlockModernAuthOfflineAddressBook switch specifies whether to block modern a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -631,6 +684,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthPop + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthPop switch specifies whether to block modern authentication with POP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -639,7 +695,6 @@ The BlockModernAuthPop switch specifies whether to block modern authentication w Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -649,6 +704,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthRpc + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthRpc switch specifies whether to block modern authentication with RPC in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -657,7 +715,6 @@ The BlockModernAuthRpc switch specifies whether to block modern authentication w Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -667,6 +724,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthWebServices + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthWebServices switch specifies whether to block modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -675,7 +735,6 @@ The BlockModernAuthWebServices switch specifies whether to block modern authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -685,6 +744,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -694,7 +756,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -704,13 +765,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelPolicy.md index 41c5654713..ed2a9f99e1 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-autosensitivitylabelpolicy applicable: Security & Compliance -title: New-AutoSensitivityLabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-autosensitivitylabelpolicy +schema: 2.0.0 +title: New-AutoSensitivityLabelPolicy --- # New-AutoSensitivityLabelPolicy @@ -71,13 +72,15 @@ This example creates an auto-labeling policy named GlobalPolicy for the specifie ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the auto-labeling policy. If the value contains spaces, enclose the value with quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -ApplySensitivityLabel + +> Applicable: Security & Compliance + The ApplySensitivityLabel parameter specifies the label to use for the auto-labeling policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -128,7 +138,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedBy + +> Applicable: Security & Compliance + The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). @@ -150,7 +162,6 @@ You can't use this parameter with the OneDriveSharedBy parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf + +> Applicable: Security & Compliance + {{ Fill ExceptIfOneDriveSharedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -176,13 +189,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -192,13 +207,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -208,6 +225,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies whether to include email messages in the policy. The valid value for this parameter is All. If you don't want to include email messages in the policy, don't use this parameter (the default value is blank or $null). You can use this parameter in the following procedures: @@ -228,7 +248,6 @@ You can't specify inclusions and exclusions in the same policy. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -238,6 +257,9 @@ Accept wildcard characters: False ``` ### -ExchangeSender + +> Applicable: Security & Compliance + The ExchangeSender parameter specifies the users whose email is included in the policy. You identify the users by email address. You can specify internal or external email addresses. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -250,7 +272,6 @@ You can't use this parameter with the ExchangeSenderException or ExchangeSenderM Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -260,6 +281,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderException + +> Applicable: Security & Compliance + The ExchangeSenderException parameter specifies the internal users whose email is excluded from the policy. You identify the users by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -272,7 +296,6 @@ You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf p Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -282,6 +305,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf + +> Applicable: Security & Compliance + The ExchangeSenderMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -296,7 +322,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -306,6 +331,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException + +> Applicable: Security & Compliance + The ExchangeSenderMemberOfException parameter specifies the distribution groups or mail-enabled security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -320,7 +348,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -330,6 +357,9 @@ Accept wildcard characters: False ``` ### -ExternalMailRightsManagementOwner + +> Applicable: Security & Compliance + The ExternalMailRightsManagementOwner parameter specifies the email address of a user mailbox that's used to encrypt incoming email messages from external senders using RMS. This parameter works only on Exchange locations, and the policy must apply a label that has an encryption action. @@ -338,7 +368,6 @@ This parameter works only on Exchange locations, and the policy must apply a lab Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -348,6 +377,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -356,7 +388,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -366,13 +397,15 @@ Accept wildcard characters: False ``` ### -Locations + +> Applicable: Security & Compliance + {{ Fill Locations Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -382,6 +415,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Security & Compliance + The Mode parameter specifies the action and notification level of the auto-labeling policy. Valid values are: - Enable: The policy is enabled for actions and notifications. This is the default value. @@ -394,7 +430,6 @@ Type: PolicyMode Parameter Sets: (All) Aliases: Accepted values: Enable, TestWithNotifications, TestWithoutNotifications, Disable, PendingDeletion -Applicable: Security & Compliance Required: False Position: Named @@ -404,13 +439,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -420,13 +457,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -436,6 +475,9 @@ Accept wildcard characters: False ``` ### -OneDriveLocation + +> Applicable: Security & Compliance + The OneDriveLocation parameter specifies the OneDrive sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -444,7 +486,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -454,6 +495,9 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException + +> Applicable: Security & Compliance + This parameter specifies the OneDrive sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -462,7 +506,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -472,6 +515,9 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy + +> Applicable: Security & Compliance + The OneDriveSharedBy parameter specifies the users to include in the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). @@ -484,7 +530,6 @@ You can't use this parameter with the ExceptIfOneDriveSharedBy parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -494,13 +539,15 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf + +> Applicable: Security & Compliance + {{ Fill OneDriveSharedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -510,6 +557,9 @@ Accept wildcard characters: False ``` ### -OverwriteLabel + +> Applicable: Security & Compliance + The OverwriteLabel parameter specifies whether to overwrite a manual label. Valid values are: - $true: Overwrite the manual label. @@ -521,7 +571,6 @@ This parameter works only on Exchange locations. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -531,6 +580,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. @@ -539,7 +591,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -549,13 +600,15 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -565,13 +618,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies the priority of the policy. The highest priority policy will take action over lower priority policies if two policies are applicable for a file. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -581,13 +636,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -597,13 +654,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -613,6 +672,9 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + The SharePointLocation parameter specifies the SharePoint sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint sites can't be added to a policy until they have been indexed. @@ -621,7 +683,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -631,6 +692,9 @@ Accept wildcard characters: False ``` ### -SharePointLocationException + +> Applicable: Security & Compliance + This parameter specifies the SharePoint sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -639,7 +703,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -649,13 +712,15 @@ Accept wildcard characters: False ``` ### -UnifiedAuditLogEnabled + +> Applicable: Security & Compliance + {{ Fill UnifiedAuditLogEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -665,13 +730,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md b/exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelRule.md similarity index 94% rename from exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelRule.md index 43a5384ec8..b329df41b6 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AutoSensitivityLabelRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-autosensitivitylabelrule applicable: Security & Compliance -title: New-AutoSensitivityLabelRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-autosensitivitylabelrule +schema: 2.0.0 +title: New-AutoSensitivityLabelRule --- # New-AutoSensitivityLabelRule @@ -97,13 +98,15 @@ This example creates an autolabeling rule named "SocialSecurityRule" that is ass ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the auto-labeling policy rule. If the value contains spaces, enclose the value with quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Security & Compliance + The Workload parameter specifies the workload. Valid values are: - Exchange @@ -124,7 +130,6 @@ Type: Workload Parameter Sets: (All) Aliases: Accepted values: Exchange, SharePoint, OneDriveForBusiness -Applicable: Security & Compliance Required: True Position: Named @@ -134,6 +139,9 @@ Accept wildcard characters: False ``` ### -AccessScope + +> Applicable: Security & Compliance + The AccessScope parameter specifies a condition for the auto-labeling policy rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule is applied to content that's accessible inside the organization. @@ -145,7 +153,6 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Required: False Position: Named @@ -155,13 +162,15 @@ Accept wildcard characters: False ``` ### -ActivationDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -171,6 +180,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The AnyOfRecipientAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -185,7 +197,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -195,6 +206,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -205,7 +219,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -215,13 +228,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -240,7 +258,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -250,6 +267,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"; minCount="1"; minConfidence="85"})`. @@ -262,7 +282,6 @@ Exact Data Match sensitive information types are supported only groups. For exam Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -272,13 +291,15 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ContentExtensionMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for words in file name extensions. You can specify multiple words separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -288,6 +309,9 @@ Accept wildcard characters: False ``` ### -ContentPropertyContainsWords + +> Applicable: Security & Compliance + The ContentPropertyContainsWords parameter specifies a condition for the auto-labeling policy rule that's based on a property match in content. The rule is applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -296,7 +320,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -306,6 +329,9 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the auto-labeling policy rule is enabled or disabled. Valid values are: - $true: The rule is disabled. @@ -315,7 +341,6 @@ The Disabled parameter specifies whether the auto-labeling policy rule is enable Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -325,13 +350,15 @@ Accept wildcard characters: False ``` ### -DocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill DocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -341,6 +368,9 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected + +> Applicable: Security & Compliance + The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -350,7 +380,6 @@ The DocumentIsPasswordProtected parameter specifies a condition for the auto-lab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -360,6 +389,9 @@ Accept wildcard characters: False ``` ### -DocumentIsUnsupported + +> Applicable: Security & Compliance + The DocumentIsUnsupported parameter specifies a condition for the auto-labeling policy rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -369,7 +401,6 @@ The DocumentIsUnsupported parameter specifies a condition for the auto-labeling Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -379,6 +410,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesWords + +> Applicable: Security & Compliance + The DocumentNameMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -391,7 +425,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -401,6 +434,9 @@ Accept wildcard characters: False ``` ### -DocumentSizeOver + +> Applicable: Security & Compliance + The DocumentSizeOver parameter specifies a condition for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -419,7 +455,6 @@ You can use this condition in auto-labeling policy rules that are scoped only to Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -429,6 +464,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAccessScope + +> Applicable: Security & Compliance + The ExceptIfAccessScopeAccessScope parameter specifies an exception for the auto-labeling policy rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule isn't applied to content that's accessible inside the organization. @@ -440,7 +478,6 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Required: False Position: Named @@ -450,6 +487,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. - Single word: `"no_reply"` @@ -464,7 +504,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -474,6 +513,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -484,7 +526,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -494,6 +535,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the auto-labeling policy rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -502,7 +546,6 @@ This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minC Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -512,13 +555,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words in file name extensions. You can specify multiple words separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -528,6 +573,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentPropertyContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentPropertyContainsWords parameter specifies an exception for the auto-labeling policy rule that's based on a property match in content. The rule is not applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -536,7 +584,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -546,13 +593,15 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill ExceptIfDocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -562,6 +611,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected + +> Applicable: Security & Compliance + The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -571,7 +623,6 @@ The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -581,6 +632,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsUnsupported + +> Applicable: Security & Compliance + The ExceptIfDocumentIsUnsupported parameter specifies an exception for the auto-labeling policy rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -590,7 +644,6 @@ The ExceptIfDocumentIsUnsupported parameter specifies an exception for the auto- Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -600,6 +653,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesWords + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -612,7 +668,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -622,6 +677,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentSizeOver + +> Applicable: Security & Compliance + The ExceptIfDocumentSizeOver parameter specifies an exception for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -640,7 +698,6 @@ You can use this exception in auto-labeling policy rules that are scoped only to Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -650,6 +707,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + The ExceptIfFrom parameter specifies an exception for the auto-labeling policy rule that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -663,7 +723,6 @@ The ExceptIfFrom parameter specifies an exception for the auto-labeling policy r Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -673,6 +732,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfFromAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -687,7 +749,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -697,6 +758,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -707,7 +771,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -717,6 +780,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Security & Compliance + The ExceptIfFromMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent by group members. You identify the group members by their email addresses. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -725,7 +791,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -735,6 +800,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -743,7 +811,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -753,6 +820,9 @@ Accept wildcard characters: False ``` ### -ExceptIfProcessingLimitExceeded + +> Applicable: Security & Compliance + The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule that looks for files where scanning couldn't complete. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -762,7 +832,6 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the aut Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -772,13 +841,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -788,6 +859,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + The ExceptIfSenderDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -796,7 +870,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -806,6 +879,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIPRanges + +> Applicable: Security & Compliance + The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -818,7 +894,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -828,6 +903,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + The ExceptIfSentTo parameter specifies an exception for the auto-labeling policy rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -845,7 +923,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -855,6 +932,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Security & Compliance + The ExceptIfSentToMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -863,7 +943,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -873,6 +952,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -883,7 +965,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -893,13 +974,15 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -909,13 +992,15 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -925,6 +1010,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Security & Compliance + The FromAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -939,7 +1027,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -949,6 +1036,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Security & Compliance + The FromAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -959,7 +1049,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -969,13 +1058,15 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -985,6 +1076,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -993,7 +1087,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1003,13 +1096,15 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1019,6 +1114,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the auto-labeling policy that contains the auto-labeling policy rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -1029,7 +1127,6 @@ The Policy parameter specifies the auto-labeling policy that contains the auto-l Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -1039,13 +1136,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1055,6 +1154,9 @@ Accept wildcard characters: False ``` ### -ProcessingLimitExceeded + +> Applicable: Security & Compliance + The ProcessingLimitExceeded parameter specifies a condition for the auto-labeling policy rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -1064,7 +1166,6 @@ The ProcessingLimitExceeded parameter specifies a condition for the auto-labelin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1074,13 +1175,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Security & Compliance + The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1090,6 +1193,9 @@ Accept wildcard characters: False ``` ### -ReportSeverityLevel + +> Applicable: Security & Compliance + The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: - None: You can't select this value if the rule has no actions configured. @@ -1102,7 +1208,6 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Required: False Position: Named @@ -1112,6 +1217,9 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Security & Compliance + The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - Ignore @@ -1123,7 +1231,6 @@ Type: PolicyRuleErrorAction Parameter Sets: (All) Aliases: Accepted values: Ignore, RetryThenBlock -Applicable: Security & Compliance Required: False Position: Named @@ -1133,6 +1240,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Security & Compliance + The SenderDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -1141,7 +1251,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1151,6 +1260,9 @@ Accept wildcard characters: False ``` ### -SenderIPRanges + +> Applicable: Security & Compliance + The SenderIpRanges parameter specifies a condition for the auto-sensitivity policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -1163,7 +1275,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1173,6 +1284,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + The SentTo parameter specifies a condition for the auto-sensitivity policy rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1190,7 +1304,6 @@ You can use this condition in auto-sensitivity policies that are scoped only to Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1200,6 +1313,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Security & Compliance + The SentToMemberOf parameter specifies a condition for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -1208,7 +1324,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1218,13 +1333,15 @@ Accept wildcard characters: False ``` ### -SourceType + +> Applicable: Security & Compliance + {{ Fill SourceType Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1234,6 +1351,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Security & Compliance + The SubjectMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -1244,7 +1364,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1254,13 +1373,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-AutodiscoverVirtualDirectory.md similarity index 88% rename from exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-AutodiscoverVirtualDirectory.md index d79e23f643..80f2a0f3bf 100644 --- a/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AutodiscoverVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-autodiscovervirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-AutodiscoverVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-autodiscovervirtualdirectory +schema: 2.0.0 +title: New-AutodiscoverVirtualDirectory --- # New-AutodiscoverVirtualDirectory @@ -62,13 +63,15 @@ This example creates the virtual directory autodiscover under the website autodi ## PARAMETERS ### -ApplicationRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ApplicationRoot parameter specifies the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AppPoolId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AppPoolId parameter specifies the IIS application pool in which the virtual directory runs. We recommend that you leave this parameter at its default setting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: - $true: Basic authentication is enabled. This is the default value. @@ -103,7 +111,6 @@ The BasicAuthentication parameter specifies whether Basic authentication is enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -122,7 +132,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. @@ -141,7 +153,6 @@ The DigestAuthentication parameter specifies whether Digest authentication is en Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,6 +180,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -179,7 +195,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,6 +204,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -198,7 +216,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,6 +225,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -220,7 +240,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,6 +249,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ExternalUrl parameter specifies the URL used to connect to the virtual directory from outside the network firewall. @@ -238,7 +260,6 @@ The ExternalUrl parameter specifies the URL used to connect to the virtual direc Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -248,6 +269,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The InternalUrl parameter specifies the URL used to connect to the virtual directory from inside the network firewall. @@ -256,7 +280,6 @@ The InternalUrl parameter specifies the URL used to connect to the virtual direc Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -266,6 +289,9 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OAuthAuthentication parameter specifies whether OAuth authentication is enabled on the virtual directory. Valid values are: - $true: OAuth authentication is enabled. This is the default value. @@ -275,7 +301,6 @@ The OAuthAuthentication parameter specifies whether OAuth authentication is enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -285,13 +310,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -301,6 +328,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -312,7 +342,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,6 +351,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -333,7 +365,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -343,13 +374,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -359,13 +392,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -375,6 +410,9 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: - $true: Integrated Windows authentication is enabled. This is the default value. @@ -384,7 +422,6 @@ The WindowsAuthentication parameter specifies whether Integrated Windows authent Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -394,6 +431,9 @@ Accept wildcard characters: False ``` ### -WSSecurityAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are: - $true: WS-Security authentication is enabled. This is the default value. @@ -403,7 +443,6 @@ The WSSecurityAuthentication parameter specifies whether WS-Security (Web Servic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AvailabilityConfig.md b/exchange/exchange-ps/ExchangePowerShell/New-AvailabilityConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/New-AvailabilityConfig.md rename to exchange/exchange-ps/ExchangePowerShell/New-AvailabilityConfig.md index 7019d149b7..1617b9203b 100644 --- a/exchange/exchange-ps/exchange/New-AvailabilityConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AvailabilityConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-availabilityconfig applicable: Exchange Online -title: New-AvailabilityConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-availabilityconfig +schema: 2.0.0 +title: New-AvailabilityConfig --- # New-AvailabilityConfig @@ -44,13 +45,15 @@ This example creates a new availability configuration to share free/busy informa ## PARAMETERS ### -AllowedTenantIds + +> Applicable: Exchange Online + The AllowedTenantIds parameter specifies the tenant ID values of Microsoft 365 organization that you want to share free/busy information with (for example, d6b0a40e-029b-43f2-9852-f3724f68ead9). You can specify multiple values separated by commas. A maximum of 25 values are allowed. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -OrgWideAccount + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -95,13 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md b/exchange/exchange-ps/ExchangePowerShell/New-AvailabilityReportOutage.md similarity index 93% rename from exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md rename to exchange/exchange-ps/ExchangePowerShell/New-AvailabilityReportOutage.md index 4c31737bf7..f41f532d23 100644 --- a/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-AvailabilityReportOutage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-availabilityreportoutage applicable: Exchange Server 2010 -title: New-AvailabilityReportOutage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-availabilityreportoutage +schema: 2.0.0 +title: New-AvailabilityReportOutage --- # New-AvailabilityReportOutage @@ -45,13 +46,15 @@ This example creates a timed injected outage scoped to site Site1 on the selecte ## PARAMETERS ### -SiteName + +> Applicable: Exchange Server 2010 + The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010 + The Comment parameter specifies why the outage was inserted. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -DowntimeMinutes + +> Applicable: Exchange Server 2010 + The DowntimeMinutes parameter specifies the number of minutes of downtime to insert into the outage report. ```yaml Type: Double Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -93,13 +100,15 @@ Accept wildcard characters: False ``` ### -ReportDate + +> Applicable: Exchange Server 2010 + The ReportDate parameter specifies the date to query for the outage report. ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -109,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -118,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -128,6 +139,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -136,7 +150,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -146,13 +159,15 @@ Accept wildcard characters: False ``` ### -ReportingDatabase + +> Applicable: Exchange Server 2010 + The ReportingDatabase parameter specifies the name of the database on the reporting server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -162,13 +177,15 @@ Accept wildcard characters: False ``` ### -ReportingServer + +> Applicable: Exchange Server 2010 + The ReportingServer parameter specifies the name of the reporting database server to connect to. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -178,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-CaseHoldPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/New-CaseHoldPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-CaseHoldPolicy.md index 87605314fc..a2a84309b5 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-CaseHoldPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-caseholdpolicy applicable: Security & Compliance -title: New-CaseHoldPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-caseholdpolicy +schema: 2.0.0 +title: New-CaseHoldPolicy --- # New-CaseHoldPolicy @@ -19,7 +20,7 @@ Use the New-CaseHoldPolicy cmdlet to create new case hold policies in the Micros > [!NOTE] > After you use the New-CaseHoldPolicy cmdlet to create a case hold policy, you need to use the New-CaseHoldRule cmdlet to create a case hold rule and assign the rule to the policy. **If you don't create a rule for the policy, the hold won't be created, and content locations won't be placed on hold**. > -> Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to create multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy). +> Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to create multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/get-caseholdpolicy). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -55,13 +56,15 @@ Remember, after you create the policy, you need to create a rule for the policy ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the case hold policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the eDiscovery case that you want to associate with the case hold policy. You can use the following values to identify the eDiscovery case: - Name @@ -82,7 +88,6 @@ You can find these values by running the command: Get-ComplianceCase | Format-Ta Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -117,7 +127,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -127,6 +136,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -136,7 +148,6 @@ The Enabled parameter specifies whether the policy is enabled or disabled. Valid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - A mailbox @@ -165,7 +179,6 @@ If no mailboxes are specified, then no mailboxes are placed on hold. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -175,6 +188,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -183,7 +199,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -193,13 +208,15 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + The PublicFolderLocation parameter specifies that you want to include all public folders in the case hold policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -209,6 +226,9 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + The SharePointLocation parameter specifies the SharePoint and OneDrive sites to include. You identify a site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -219,7 +239,6 @@ Sites can't be added to the policy until they have been indexed. If no sites are Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -229,13 +248,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-CaseHoldRule.md b/exchange/exchange-ps/ExchangePowerShell/New-CaseHoldRule.md similarity index 94% rename from exchange/exchange-ps/exchange/New-CaseHoldRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-CaseHoldRule.md index c169c5dfff..917d74060d 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-CaseHoldRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-caseholdrule applicable: Security & Compliance -title: New-CaseHoldRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-caseholdrule +schema: 2.0.0 +title: New-CaseHoldRule --- # New-CaseHoldRule @@ -54,13 +55,15 @@ This example places email messages received by the recipients between December 1 ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the case hold rule. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the case hold policy that contains the rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -80,7 +86,6 @@ The Policy parameter specifies the case hold policy that contains the rule. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -115,7 +125,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. Use this parameter to create a query-based hold so only the content that matches the specified search query is placed on hold. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -133,7 +145,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the case hold rule is enabled or disabled. Valid values are: - $true: The rule is disabled. @@ -152,7 +166,6 @@ The Disabled parameter specifies whether the case hold rule is enabled or disabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -162,13 +175,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/New-ClassificationRuleCollection.md similarity index 91% rename from exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/New-ClassificationRuleCollection.md index 2f589a0ceb..9cfa7a8d54 100644 --- a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ClassificationRuleCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-classificationrulecollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-ClassificationRuleCollection -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-classificationrulecollection +schema: 2.0.0 +title: New-ClassificationRuleCollection --- # New-ClassificationRuleCollection @@ -45,6 +46,9 @@ This example imports the classification rule collection file C:\\My Documents\\E ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FileData parameter specifies the classification rule collection file you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -53,7 +57,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ClientAccessArray.md b/exchange/exchange-ps/ExchangePowerShell/New-ClientAccessArray.md similarity index 95% rename from exchange/exchange-ps/exchange/New-ClientAccessArray.md rename to exchange/exchange-ps/ExchangePowerShell/New-ClientAccessArray.md index 93bc940c38..a81bd4b402 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessArray.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ClientAccessArray.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-clientaccessarray applicable: Exchange Server 2010 -title: New-ClientAccessArray -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-clientaccessarray +schema: 2.0.0 +title: New-ClientAccessArray --- # New-ClientAccessArray @@ -54,6 +55,9 @@ This example creates a Client Access array named China CAS Array with the FQDN v ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the descriptive name of the Client Access array. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). If the value contains spaces, you can't use the Name value to identify the Client Access array for the Get-ClientAccessArray, Remove-ClientAccessArray, or Set-ClientAccessArray cmdlets. If you don't use this parameter, the default value is the host part of the Fqdn parameter value. For example, if the Fqdn value is casarray01.contoso.com, the default name value is casarray01. @@ -62,7 +66,6 @@ If you don't use this parameter, the default value is the host part of the Fqdn Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010 + The Fqdn parameter specifies the fully qualified domain name of the Client Access array (for example, casarray01.contoso.com). This is the value that RPC over TCP clients use to connect to the Client Access servers in the array. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010 + The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: - Name @@ -100,7 +108,6 @@ To see a list of available sites, use the Get-ADSite cmdlet. Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -119,7 +129,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -145,13 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ClientAccessRule.md similarity index 90% rename from exchange/exchange-ps/exchange/New-ClientAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ClientAccessRule.md index af5e934438..38b6934b7f 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ClientAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-clientaccessrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-ClientAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-clientaccessrule +schema: 2.0.0 +title: New-ClientAccessRule --- # New-ClientAccessRule @@ -91,13 +92,15 @@ This example creates a new client access rule named Block ActiveSync that blocks ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the client access rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. ```yaml Type: ClientAccessRulesAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -AnyOfAuthenticationTypes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The AnyOfAuthenticationTypes parameter specifies a condition for the client access rule that's based on the client's authentication type. @@ -143,7 +151,6 @@ You can enter multiple values separated by commas. Don't use quotation marks. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -153,6 +160,9 @@ Accept wildcard characters: False ``` ### -AnyOfClientIPAddressesOrRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AnyOfClientIPAddressesOrRanges parameter specifies a condition for the client access rule that's based on the client's IPv4 or IPv6 address. Valid values are: - Single IP address: For example, 192.168.1.1 or 2001:DB8::2AA:FF:C0A8:640A. @@ -167,7 +177,6 @@ For more information about IPv6 addresses and syntax, see this Exchange 2013 top Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -177,6 +186,9 @@ Accept wildcard characters: False ``` ### -AnyOfProtocols + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AnyOfProtocols parameter specifies a condition for the client access rule that's based on the client's protocol. Valid values for this parameter are: @@ -202,7 +214,6 @@ You can enter multiple values separated by commas. Don't use quotation marks. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,13 +223,15 @@ Accept wildcard characters: False ``` ### -AnyOfSourceTcpPortNumbers + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -228,6 +241,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -239,7 +255,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -249,6 +264,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -257,7 +275,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -267,13 +284,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the client access rule is enabled or disabled. Valid values for this parameter are $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -283,6 +302,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfAuthenticationTypes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptAnyOfAuthenticationTypes parameter specifies an exception for the client access rule that's based on the client's authentication type. @@ -303,7 +325,6 @@ You can enter multiple values separated by commas. Don't use quotation marks. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,6 +334,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfClientIPAddressesOrRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExceptAnyOfClientIPAddressesOrRanges parameter specifies an exception for the client access rule that's based on the client's IPv4 or IPv6 address. Valid values are: - Single IP address: For example, 192.168.1.1 or 2001:DB8::2AA:FF:C0A8:640A. @@ -327,7 +351,6 @@ For more information about IPv6 addresses and syntax, see this Exchange 2013 top Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,6 +360,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfProtocols + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptAnyOfProtocols parameter specifies an exception for the client access rule that's based on the client's protocol. @@ -362,7 +388,6 @@ You can enter multiple values separated by commas. Don't use quotation marks. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -372,13 +397,15 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfSourceTcpPortNumbers + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -388,13 +415,15 @@ Accept wildcard characters: False ``` ### -ExceptUserIsMemberOf + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -404,6 +433,9 @@ Accept wildcard characters: False ``` ### -ExceptUsernameMatchesAnyOfPatterns + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. @@ -414,7 +446,6 @@ You can enter multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -424,6 +455,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -438,7 +472,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -448,6 +481,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Scope parameter specifies the scope of the client access rule. Valid values are: - Users: The rule only applies to end-user connections. @@ -457,7 +493,6 @@ The Scope parameter specifies the scope of the client access rule. Valid values Type: ClientAccessRulesScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -467,13 +502,15 @@ Accept wildcard characters: False ``` ### -UserIsMemberOf + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -483,6 +520,9 @@ Accept wildcard characters: False ``` ### -UsernameMatchesAnyOfPatterns + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. This parameter does not work with the -AnyOfProtocols UniversalOutlook parameter. @@ -493,7 +533,6 @@ You can enter multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -503,6 +542,9 @@ Accept wildcard characters: True ``` ### -UserRecipientFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPATH filter syntax to identify the user based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties. @@ -542,7 +584,6 @@ For detailed information about OPATH filter syntax in Exchange, see [Additional Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -552,13 +593,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceCase.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceCase.md similarity index 93% rename from exchange/exchange-ps/exchange/New-ComplianceCase.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceCase.md index 6366bff3d0..28d59c54ab 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceCase.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceCase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancecase applicable: Security & Compliance -title: New-ComplianceCase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancecase +schema: 2.0.0 +title: New-ComplianceCase --- # New-ComplianceCase @@ -55,13 +56,15 @@ This example creates a new eDiscovery Premium case named Coho Case 03082020 and ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the compliance case. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -CaseType + +> Applicable: Security & Compliance + The CaseType parameter specifies the type of compliance case that you want to create. Valid values are: - AdvancedEdiscovery: eDiscovery Premium cases are used to manage legal or other types of investigations. @@ -87,7 +93,6 @@ The CaseType parameter specifies the type of compliance case that you want to cr Type: ComplianceCaseType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -106,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the compliance case. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -ExternalId + +> Applicable: Security & Compliance + The ExternalId parameter specifies an optional ID or external case number that you can associate with the new compliance case. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -164,13 +177,15 @@ Accept wildcard characters: False ``` ### -SecondaryCaseType + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -180,13 +195,15 @@ Accept wildcard characters: False ``` ### -SourceCaseType + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -196,13 +213,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEvent.md similarity index 93% rename from exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEvent.md index f1f5f46411..175e4be26e 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEvent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentionevent applicable: Security & Compliance -title: New-ComplianceRetentionEvent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-complianceretentionevent +schema: 2.0.0 +title: New-ComplianceRetentionEvent --- # New-ComplianceRetentionEvent @@ -55,13 +56,15 @@ This example creates a compliance retention event named Research Project Employe ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the compliance retention event. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssetId + +> Applicable: Security & Compliance + The AssetId parameter specifies the Property:Value pair found in the properties of SharePoint or OneDrive documents that's used for retention. For example: - Product codes that you can use to retain content for only a specific product. @@ -81,7 +87,6 @@ The AssetId parameter specifies the Property:Value pair found in the properties Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -116,7 +126,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -EventDateTime + +> Applicable: Security & Compliance + The EventDateTime parameter specifies the date-time of the event. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -150,7 +164,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -160,6 +173,9 @@ Accept wildcard characters: False ``` ### -EventTags + +> Applicable: Security & Compliance + The EventTags parameter specifies the GUID value of the labels that are associated with the compliance retention event. Run the following command to see the available GUID values: `Get-ComplianceTag | Format-Table Name,GUID`. You can specify multiple values separated by commas. @@ -168,7 +184,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -178,13 +193,15 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Security & Compliance + The EventType parameter specifies the GUID value of the event that will start the retention period for labels that use this event type. Run the following command to see the available GUID values: `Get-ComplianceRetentionEventType | Format-Table Name,GUID`. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -194,13 +211,15 @@ Accept wildcard characters: False ``` ### -ExchangeAssetIdQuery + +> Applicable: Security & Compliance + The ExchangeAssetIdQuery parameter specifies the keywords that are used to scope Exchange content for the compliance retention event. For details, see [Keyword queries and search conditions for Content Search](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -210,13 +229,15 @@ Accept wildcard characters: False ``` ### -PreviewOnly + +> Applicable: Security & Compliance + {{ Fill PreviewOnly Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -226,13 +247,15 @@ Accept wildcard characters: False ``` ### -SharePointAssetIdQuery + +> Applicable: Security & Compliance + The SharePointAssetIdQuery parameter specifies one or more the Property:Value pairs that you've specified in the properties (also known as Columns) of SharePoint and OneDrive documents to scope the compliance retention event. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -242,13 +265,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEventType.md similarity index 93% rename from exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEventType.md index f8097fbf29..6d4515cd3e 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceRetentionEventType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentioneventtype applicable: Security & Compliance -title: New-ComplianceRetentionEventType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-complianceretentioneventtype +schema: 2.0.0 +title: New-ComplianceRetentionEventType --- # New-ComplianceRetentionEventType @@ -43,13 +44,15 @@ This example creates a new retention event type name Fabrikam Project ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the retention event type. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -75,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -84,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearch.md similarity index 92% rename from exchange/exchange-ps/exchange/New-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearch.md index bb3b8def59..dde0f3b69a 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancesearch applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: New-ComplianceSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancesearch +schema: 2.0.0 +title: New-ComplianceSearch --- # New-ComplianceSearch @@ -81,6 +82,9 @@ This example creates a new compliance search named AnnBeebe-InactiveMailbox that ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Name parameter specifies the name of the compliance search. If the value contains spaces, enclose the value in quotation marks. Don't use spaces in the value of this parameter if you plan on using the Case parameter. If the Name parameter contains spaces, the value of the ExchangeLocation parameter is cleared when you use the Case parameter. @@ -89,7 +93,6 @@ Don't use spaces in the value of this parameter if you plan on using the Case pa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -AllowNotFoundExchangeLocationsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The AllowNotFoundExchangeLocationsEnabled parameter specifies whether to include mailboxes other than regular user mailboxes in the compliance search. Valid values are: - $true: The search doesn't try to validate the existence of the mailbox before proceeding. This value is required if you want to search mailboxes that don't resolve as regular mailboxes. @@ -115,7 +121,6 @@ The mailbox types that are affected by the value of this parameter include: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -125,6 +130,9 @@ Accept wildcard characters: False ``` ### -Case + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The Case parameter specifies the name of an eDiscovery Standard case to associate the new compliance search with. If the value contains spaces, enclose the value in quotation marks. @@ -137,7 +145,6 @@ If the Name parameter contains spaces, the value of the ExchangeLocation paramet Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -156,7 +166,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -174,7 +186,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -184,13 +195,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Description parameter specifies an optional description for the compliance search. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -200,6 +213,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include. Valid values are: - A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Microsoft 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. @@ -212,7 +228,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -222,6 +237,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocationExclusion + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -235,7 +253,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -245,6 +262,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -253,7 +273,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -263,6 +282,9 @@ Accept wildcard characters: False ``` ### -HoldNames + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The HoldNames parameter specifies that the content locations that have been placed on hold in the specified eDiscovery case will be searched. You use the value All for this parameter. You also need to specify the name of an eDiscovery case by using the Case parameter. @@ -273,7 +295,6 @@ Also, if a content location was placed on a query-based case hold, only items th Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -283,13 +304,15 @@ Accept wildcard characters: False ``` ### -IncludeOrgContent + +> Applicable: Security & Compliance + {{ Fill IncludeOrgContent Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -299,6 +322,9 @@ Accept wildcard characters: False ``` ### -IncludeUserAppContent + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The IncludeUserAppContent parameter specifies that you want to search the cloud-based storage location for users who don't have a regular Microsoft 365 user account in your organization. These types of users include users without an Exchange Online license who use Office applications, Microsoft 365 guest users, and on-premises users whose identity is synchronized with your Microsoft 365 organization. Valid values are: @@ -310,7 +336,6 @@ The IncludeUserAppContent parameter specifies that you want to search the cloud- Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -320,6 +345,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Language parameter specifies the language for the compliance search. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -328,7 +356,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -338,6 +365,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -346,7 +376,6 @@ This parameter is reserved for internal Microsoft use. Type: ComplianceJobLogLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,6 +385,9 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The PublicFolderLocation parameter specifies that you want to include all public folders in the search. You use the value All for this parameter. @@ -364,7 +396,6 @@ The PublicFolderLocation parameter specifies that you want to include all public Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -374,6 +405,9 @@ Accept wildcard characters: False ``` ### -RefinerNames + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -382,7 +416,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -392,6 +425,9 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. @@ -402,7 +438,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -412,6 +447,9 @@ Accept wildcard characters: False ``` ### -SharePointLocationExclusion + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -420,7 +458,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -430,6 +467,9 @@ Accept wildcard characters: False ``` ### -StatusMailRecipients + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -438,7 +478,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -448,13 +487,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearchAction.md similarity index 91% rename from exchange/exchange-ps/exchange/New-ComplianceSearchAction.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearchAction.md index e2b6541d63..0ed529ffc5 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSearchAction.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancesearchaction applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: New-ComplianceSearchAction -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancesearchaction +schema: 2.0.0 +title: New-ComplianceSearchAction --- # New-ComplianceSearchAction @@ -141,6 +142,9 @@ This example exports the results returned by the content search named "Case 321 ## PARAMETERS ### -SearchName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The SearchName parameter specifies the name of the existing content search to associate with the content search action. You can specify multiple content searches separated by commas. You can find the content search by running the command Get-ComplianceSearch | Format-Table -Auto Name,Status. @@ -149,7 +153,6 @@ You can find the content search by running the command Get-ComplianceSearch | Fo Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -159,6 +162,9 @@ Accept wildcard characters: False ``` ### -ActionName + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The ActionName parameter specifies a name for the content search action. You use this parameter only when you specify multiple content searches in the SearchName parameter. @@ -167,7 +173,6 @@ The ActionName parameter specifies a name for the content search action. You use Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -177,6 +182,9 @@ Accept wildcard characters: False ``` ### -ArchiveFormat + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + 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. @@ -185,7 +193,6 @@ To specify the format for Exchange search results, use the ExchangeArchiveFormat Type: ComplianceExportArchiveFormat Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -195,6 +202,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -206,7 +216,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -216,6 +225,9 @@ Accept wildcard characters: False ``` ### -EnableDedupe + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -224,7 +236,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Export Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -235,6 +246,8 @@ Accept wildcard characters: False ### -ExchangeArchiveFormat +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). This parameter is functional only in the cloud-based service. @@ -256,7 +269,6 @@ To specify the format for SharePoint and OneDrive search results, use the ShareP Type: ComplianceExportArchiveFormat Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -266,6 +278,9 @@ Accept wildcard characters: False ``` ### -Export + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). This parameter is functional only in the cloud-based service. @@ -280,7 +295,6 @@ To only return the information about each detected item in a report, use the Rep Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -290,6 +304,9 @@ Accept wildcard characters: False ``` ### -FileTypeExclusionsForUnindexedItems + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). The FileTypeExclusionsForUnindexedItems specifies the file types to exclude because they can't be indexed. You can specify multiple values separated by commas. @@ -298,7 +315,6 @@ The FileTypeExclusionsForUnindexedItems specifies the file types to exclude beca Type: String[] Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -308,6 +324,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -316,7 +335,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -326,6 +344,9 @@ Accept wildcard characters: False ``` ### -Format + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + In Security & Compliance PowerShell, this parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. The Format parameter specifies the format of the search results when you use the Export switch. Valid values are: @@ -338,7 +359,6 @@ The Format parameter specifies the format of the search results when you use the Type: ComplianceDataTransferFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -348,13 +368,15 @@ Accept wildcard characters: False ``` ### -IncludeCredential + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The IncludeCredential switch specifies whether to include the credential in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -364,6 +386,9 @@ Accept wildcard characters: False ``` ### -IncludeSharePointDocumentVersions + +> Applicable: Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). This parameter is available only in the cloud-based service. @@ -377,7 +402,6 @@ The IncludeSharePointDocumentVersions parameter specifies whether to export prev Type: Boolean Parameter Sets: Export Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -387,13 +411,15 @@ Accept wildcard characters: False ``` ### -JobOptions + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -403,6 +429,9 @@ Accept wildcard characters: False ``` ### -NotifyEmail + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). In Security & Compliance PowerShell, this parameter requires the Export role. By default, this is assigned only to the eDiscovery Manager role group. @@ -415,7 +444,6 @@ The recipient you specify is in the To: field of the message. Type: String Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -425,6 +453,9 @@ Accept wildcard characters: False ``` ### -NotifyEmailCC + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). In Security & Compliance PowerShell, this parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. @@ -437,7 +468,6 @@ The recipient you specify is in the Cc: field of the message. Type: String Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -447,6 +477,9 @@ Accept wildcard characters: False ``` ### -Preview + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + In Security & Compliance PowerShell, this parameter requires the Preview role. By default, this role is assigned only to the eDiscovery Manager role group. The Preview switch specifies the action for the content search is to preview the results that match the search criteria. You don't need to specify a value with this switch. @@ -455,7 +488,6 @@ The Preview switch specifies the action for the content search is to preview the Type: SwitchParameter Parameter Sets: Preview Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -465,6 +497,9 @@ Accept wildcard characters: False ``` ### -Purge + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: In Security & Compliance PowerShell, this switch is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. The Purge switch specifies the action for the content search is to remove items that match the search criteria. You don't need to specify a value with this switch. @@ -481,7 +516,6 @@ The Purge switch specifies the action for the content search is to remove items Type: SwitchParameter Parameter Sets: Purge Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -491,6 +525,9 @@ Accept wildcard characters: False ``` ### -PurgeType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. The PurgeType parameter specifies how to remove items when the action is Purge. Valid values are: @@ -502,7 +539,6 @@ The PurgeType parameter specifies how to remove items when the action is Purge. Type: ComplianceDestroyType Parameter Sets: Purge Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -512,13 +548,15 @@ Accept wildcard characters: False ``` ### -ReferenceActionName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -528,13 +566,15 @@ Accept wildcard characters: False ``` ### -Region + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -544,6 +584,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). This parameter is functional only in the cloud-based service. @@ -554,7 +597,6 @@ The Report switch specifies the action for the content search is to export a rep Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -564,6 +606,9 @@ Accept wildcard characters: False ``` ### -RetentionReport + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). The RetentionReport switch specifies the action for the content search is to export a retention report. You don't need to specify a value with this switch. @@ -572,7 +617,6 @@ The RetentionReport switch specifies the action for the content search is to exp Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -582,13 +626,15 @@ Accept wildcard characters: False ``` ### -RetryOnError + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The RetryOnError switch specifies whether to retry the action on any items that failed without re-running the entire action all over again. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -598,6 +644,9 @@ Accept wildcard characters: False ``` ### -Scenario + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + In Security & Compliance PowerShell, this parameter requires the Preview role. By default, this role is assigned only to the eDiscovery Manager role group. The Scenario parameter specifies the scenario type. Valid values are: @@ -613,7 +662,6 @@ The Scenario parameter specifies the scenario type. Valid values are: Type: ComplianceSearchActionScenario Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -623,6 +671,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). The Scope parameter specifies the items to include when the action is Export. Valid values are: @@ -635,7 +686,6 @@ The Scope parameter specifies the items to include when the action is Export. Va Type: ComplianceExportScope Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -645,6 +695,9 @@ Accept wildcard characters: False ``` ### -SearchNames + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The SearchNames parameter specifies the names of the existing content searches to associate with the content search action. You separate the content search names by commas. @@ -655,7 +708,6 @@ You can find content search names by running the command Get-ComplianceSearch | Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -665,6 +717,9 @@ Accept wildcard characters: False ``` ### -SharePointArchiveFormat + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). This parameter is functional only in the cloud-based service. @@ -683,7 +738,6 @@ To specify the format for Exchange search results, use the ExchangeArchiveFormat Type: ComplianceExportArchiveFormat Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -693,6 +747,9 @@ Accept wildcard characters: False ``` ### -ShareRootPath + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. **Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). @@ -703,7 +760,6 @@ This parameter is available only in on-premises Exchange. Type: String Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -713,13 +769,15 @@ Accept wildcard characters: False ``` ### -Version + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -729,6 +787,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -737,7 +798,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSecurityFilter.md similarity index 93% rename from exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceSecurityFilter.md index cf258e62c7..fb2266e405 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceSecurityFilter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancesecurityfilter applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: New-ComplianceSecurityFilter -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancesecurityfilter +schema: 2.0.0 +title: New-ComplianceSecurityFilter --- # New-ComplianceSecurityFilter @@ -75,6 +76,9 @@ This example prevents the user from performing any compliance search actions on ## PARAMETERS ### -Action + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Action parameter specifies that type of search action that the filter is applied to. Valid values are: - Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. @@ -87,7 +91,6 @@ The Action parameter specifies that type of search action that the filter is app Type: ComplianceSecurityFilterActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -FilterName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The FilterName parameter specifies the name for the compliance security filter. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Users + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Users parameter specifies the user who gets this filter applied to their searches. Valid values are: - One or more users: Identify users by their alias or email address. You can specify multiple values separated by commas. @@ -125,7 +133,6 @@ You can't specify distribution groups with this parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -144,7 +154,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -154,13 +163,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Description parameter specifies a description for the compliance security filter. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -Filters + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Filters parameter specifies the search criteria for the compliance security filter. The filters are applied to the users specified by the Users parameter. You can create three different types of filters: - Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is `Mailbox_`, where `` is a mailbox property value. For example,`"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"` allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). @@ -184,7 +198,6 @@ You need to create a search permissions filter to explicitly prevent users from Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -Region + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Region parameter specifies the satellite location for multi-geo tenants to conduct eDiscovery searches in. Valid values are: - APC: Asia-Pacific @@ -213,7 +229,6 @@ If you don't use this parameter in a multi-geo tenant, eDiscovery searches are p Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -223,13 +238,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ComplianceTag.md b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceTag.md similarity index 89% rename from exchange/exchange-ps/exchange/New-ComplianceTag.md rename to exchange/exchange-ps/ExchangePowerShell/New-ComplianceTag.md index 9de8c0fca4..e58199a8c7 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ComplianceTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancetag applicable: Security & Compliance -title: New-ComplianceTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancetag +schema: 2.0.0 +title: New-ComplianceTag --- # New-ComplianceTag @@ -75,13 +76,15 @@ This example creates a new label named HR Content with the following settings: ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the label. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -91,13 +94,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: PriorityCleanup Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -RetentionAction + +> Applicable: Security & Compliance + The RetentionAction parameter specifies the action for the label. Valid values are: - Delete @@ -115,9 +123,8 @@ The RetentionAction parameter specifies the action for the label. Valid values a ```yaml Type: String -Parameter Sets: PriorityCleanup +Parameter Sets: Default, PriorityCleanup Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -126,20 +133,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance +### -RetentionDuration -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Security & Compliance -### -RetentionDuration The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - A positive integer. @@ -147,9 +144,8 @@ The RetentionDuration parameter specifies the number of days to retain the conte ```yaml Type: Unlimited -Parameter Sets: PriorityCleanup +Parameter Sets: Default, PriorityCleanup Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -158,20 +154,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Unlimited -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance +### -RetentionType -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Security & Compliance -### -RetentionType The RetentionType parameter specifies whether the retention duration is calculated from the content creation date, tagged date, or last modification date. Valid values are: - CreationAgeInDays @@ -181,9 +167,8 @@ The RetentionType parameter specifies whether the retention duration is calculat ```yaml Type: String -Parameter Sets: PriorityCleanup +Parameter Sets: Default, PriorityCleanup Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -192,27 +177,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance +### -AutoApprovalPeriod -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Security & Compliance -### -AutoApprovalPeriod {{ Fill AutoApprovalPeriod Description }} ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -222,13 +196,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -238,13 +214,15 @@ Accept wildcard characters: False ``` ### -ComplianceTagForNextStage + +> Applicable: Security & Compliance + {{ Fill ComplianceTagForNextStage Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -254,6 +232,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -263,7 +244,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -273,6 +253,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Security & Compliance + The EventType specifies the retention rule that's associated with the label. You can use any value that uniquely identifies the rule. For example: - Name @@ -285,7 +268,6 @@ You can use the Get-RetentionComplianceRule cmdlet to view the available retenti Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -295,6 +277,9 @@ Accept wildcard characters: False ``` ### -FilePlanProperty + +> Applicable: Security & Compliance + The FilePlanProperty parameter specifies the file plan properties to include in the label. To view the file plan property names that you need to use in this parameter, run the following commands: - `Get-FilePlanPropertyAuthority | Format-List Name` @@ -328,7 +313,6 @@ You use the second variable as the value for this parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -338,6 +322,9 @@ Accept wildcard characters: False ``` ### -FlowId + +> Applicable: Security & Compliance + **Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. The FlowId parameter specifies the Power Automate flow to run at the end of the retention period. A valid value for this parameter is the GUID value of the flow. @@ -351,7 +338,6 @@ You can find the GUID value of the flow by using either of the following methods Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -361,6 +347,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -369,7 +358,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -379,6 +367,9 @@ Accept wildcard characters: False ``` ### -IsRecordLabel + +> Applicable: Security & Compliance + The IsRecordLabel parameter specifies whether the label is a record label. Valid values are: - $true: The label is a record label. Once the label is applied to content, the label can't be removed. @@ -388,7 +379,6 @@ The IsRecordLabel parameter specifies whether the label is a record label. Valid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -398,13 +388,15 @@ Accept wildcard characters: False ``` ### -IsRecordUnlockedAsDefault + +> Applicable: Security & Compliance + {{ Fill IsRecordUnlockedAsDefault Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -414,6 +406,9 @@ Accept wildcard characters: False ``` ### -MultiStageReviewProperty + +> Applicable: Security & Compliance + The MultiStageReviewProperty parameter specifies the multi-stage review properties to include in the label. This parameter uses the following syntax: `'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'` @@ -428,7 +423,6 @@ This syntax is a JSON object that defines each review stage id, review stage nam Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -438,13 +432,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Security & Compliance + The Notes parameter specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -454,13 +450,15 @@ Accept wildcard characters: False ``` ### -Regulatory + +> Applicable: Security & Compliance + {{ Fill Regulatory Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -470,13 +468,15 @@ Accept wildcard characters: False ``` ### -ReviewerEmail + +> Applicable: Security & Compliance + The ReviewerEmail parameter specifies the email address of a reviewer for Delete and KeepAndDelete retention actions. You can specify multiple email addresses separated by commas. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -486,13 +486,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DataClassification.md b/exchange/exchange-ps/ExchangePowerShell/New-DataClassification.md similarity index 87% rename from exchange/exchange-ps/exchange/New-DataClassification.md rename to exchange/exchange-ps/ExchangePowerShell/New-DataClassification.md index ee21f6fc1a..ef07895c85 100644 --- a/exchange/exchange-ps/exchange/New-DataClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DataClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dataclassification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-DataClassification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dataclassification +schema: 2.0.0 +title: New-DataClassification --- # New-DataClassification @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [New-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. +In Exchange Online, this cmdlet has been replaced by the [New-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the New-DataClassification cmdlet to create data classification rules that use document fingerprints. @@ -57,13 +58,15 @@ This example creates a new data classification rule named "Contoso Employee-Cust ## PARAMETERS ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Description parameter specifies a description for the data classification rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -Fingerprints -The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-fingerprint) or the Examples section. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a name for the data classification rule. The value must be less than 256 characters. The value of this parameter is used in the Policy Tip that's presented to users in Outlook on the web. @@ -97,7 +105,6 @@ The value of this parameter is used in the Policy Tip that's presented to users Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -ClassificationRuleCollectionIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: ClassificationRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -123,6 +132,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -132,7 +144,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -158,6 +171,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Locale parameter specifies the language that's associated with the data classification rule. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -168,7 +184,6 @@ You can add additional language translations to the data classification rule by Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -178,13 +193,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DataEncryptionPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DataEncryptionPolicy.md index fb8c9ddfeb..f042b32c86 100644 --- a/exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DataEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dataencryptionpolicy applicable: Exchange Online -title: New-DataEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dataencryptionpolicy +schema: 2.0.0 +title: New-DataEncryptionPolicy --- # New-DataEncryptionPolicy @@ -49,13 +50,15 @@ This example creates a data encryption policy named US Mailboxes with the specif ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -AzureKeyIDs + +> Applicable: Exchange Online + The AzureKeyIDs parameter specifies the URI values of the Azure Key Vault keys to associate with the data encryption policy. You need to specify at least two Azure Key Vault keys separated by commas. For example, `"https://contosoWestUSvault01.vault.azure.net/keys/USA_Key_01","https://contosoEastUSvault01.vault.azure.net/keys/USA_Key_02"`. To find the URI value for an Azure Key Vault, replace `` with the name of the vault, and run this command in Azure Rights Management PowerShell: `Get-AzureKeyVaultKey -VaultName ).id`. For more information, see [About Azure Key Vault](https://learn.microsoft.com/azure/key-vault/general/overview). @@ -73,7 +79,6 @@ To find the URI value for an Azure Key Vault, replace `` with the nam Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -92,7 +100,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online + The Description parameter specifies an optional description for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -134,6 +145,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter enables or disable the data encryption policy. Valid values are: - $true: The policy is enabled. This is the default value. @@ -143,7 +157,6 @@ The Enabled parameter enables or disable the data encryption policy. Valid value Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -153,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroup.md similarity index 91% rename from exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroup.md index 13c5232ad5..e5d42b21af 100644 --- a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-DatabaseAvailabilityGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-databaseavailabilitygroup +schema: 2.0.0 +title: New-DatabaseAvailabilityGroup --- # New-DatabaseAvailabilityGroup @@ -81,13 +82,15 @@ This example creates a DAG named DAG3. DAG3 is configured to use SERVER1 for the ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a unique name for the new DAG of up to 15 characters. The name you use must not conflict with any computer name in the organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -ActivityState + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ActivityStateOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -122,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -DagConfiguration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: DatabaseAvailabilityGroupConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,13 +157,15 @@ Accept wildcard characters: False ``` ### -DatabaseAvailabilityGroupIpAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DatabaseAvailabilityGroupIpAddresses parameter specifies one or more static IPv4 addresses to the DAG when a Mailbox server is added to a DAG. If you specify the value Any or 0.0.0.0, the system attempts to lease one or more IPv4 addresses from a DHCP server to assign to the DAG. If you don't use this parameter, or if you specify the value 255.255.255.255 or None, the DAG is created without a cluster administrative access point. ```yaml Type: IPAddress[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -FileSystem + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The FileSystem parameter specifies the file system that's used for the DAG. Valid values are: - NTFS @@ -189,7 +205,6 @@ The FileSystem parameter specifies the file system that's used for the DAG. Vali Type: FileSystemMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -ThirdPartyReplication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ThirdPartyReplication parameter specifies to configure and enable a DAG to use non-Microsoft replication that leverages the Exchange Third Party Replication API instead of the built-in continuous replication. Valid values are Enabled and Disabled. After this mode is enabled, it can't be changed. ```yaml Type: ThirdPartyReplicationMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,13 +232,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -231,13 +250,15 @@ Accept wildcard characters: False ``` ### -WitnessDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WitnessDirectory parameter specifies the name of the directory on the witness server used to store file share witness data. The directory and share should be hosted on an Exchange server other than any of the Mailbox servers in the DAG. This allows an Exchange administrator to maintain operational control over the directory. The specified directory can't be used by any other DAGs, or used for any purpose other than for the witness server. If you don't use this parameter, the default witness directory is used. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -247,13 +268,15 @@ Accept wildcard characters: False ``` ### -WitnessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WitnessServer parameter specifies the name of a server used as a quorum witness when the DAG contains an even number of members. The specified server can't be a member of the DAG that's configured to use it. A stand-alone Mailbox server, or a Mailbox server in another DAG is recommended. ```yaml Type: FileShareWitnessServerName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroupNetwork.md similarity index 85% rename from exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroupNetwork.md index cdf95fa60f..8363b20c66 100644 --- a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DatabaseAvailabilityGroupNetwork.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-databaseavailabilitygroupnetwork applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-DatabaseAvailabilityGroupNetwork -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-databaseavailabilitygroupnetwork +schema: 2.0.0 +title: New-DatabaseAvailabilityGroupNetwork --- # New-DatabaseAvailabilityGroupNetwork @@ -47,13 +48,15 @@ This example creates the DAG network DAG1Repl in the DAG DAG1. A subnet of 10.0. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the DAG network being created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -DatabaseAvailabilityGroup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DatabaseAvailabilityGroup parameter specifies the name of the DAG that'll use the network being created. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 2 @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Description parameter specifies an optional description of up to 256 characters for the DAG network being created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +123,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +141,15 @@ Accept wildcard characters: False ``` ### -IgnoreNetwork + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreNetwork parameter excludes the DAG network from use by the DAG. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,13 +159,15 @@ Accept wildcard characters: False ``` ### -ReplicationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReplicationEnabled parameter specifies whether the DAG network being created is enabled for continuous replication. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,13 +177,15 @@ Accept wildcard characters: False ``` ### -Subnets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Subnets parameter specifies the subnets for the DAG network being created. ```yaml Type: DatabaseAvailabilityGroupSubnetId[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-DeliveryAgentConnector.md similarity index 87% rename from exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeliveryAgentConnector.md index 42534c6c9d..8727a41a18 100644 --- a/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeliveryAgentConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-deliveryagentconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-DeliveryAgentConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-deliveryagentconnector +schema: 2.0.0 +title: New-DeliveryAgentConnector --- # New-DeliveryAgentConnector @@ -62,13 +63,15 @@ The address space for the connector is c=US;a=Fabrikam;p=Contoso. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AddressSpaces parameter specifies the domain names that the delivery agent connector is responsible for. The complete syntax for entering an address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. Enclose each address space in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -DeliveryProtocol + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -135,7 +147,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +156,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -153,7 +167,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +176,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the delivery agent connector is enabled. The default value is $true. @@ -171,7 +187,6 @@ The default value is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +196,15 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. If the value of this parameter is $false, the connector can be used by all Mailbox servers in your organization. If the value of this parameter is $true, the connector can only be used by Mailbox servers in the same Active Directory site. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,13 +214,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConcurrentConnections parameter specifies the maximum number of concurrent connections this connector accepts from a specific IP address. The default value is 5. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -213,6 +232,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxMessageSize parameter specifies the maximum size of a message that's allowed to pass through this connector. When you enter a value, qualify the value with one of the following units: - B (bytes) @@ -226,7 +248,6 @@ Unqualified values are treated as bytes. The valid input range for this paramete Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,13 +257,15 @@ Accept wildcard characters: False ``` ### -MaxMessagesPerConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxMessagesPerConnection parameter specifies the maximum number of messages this connector accepts per connection. The connector terminates the connection after this limit is reached, and the sending server has to initiate a new connection to send more messages. The default value is 20. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,6 +275,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceTransportServers parameter specifies the list of Mailbox servers that host this connector. You can specify more than one server by separating their names with commas. By default, only the local server on which the command is executed is added to this parameter. @@ -260,7 +286,6 @@ By default, only the local server on which the command is executed is added to t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,13 +295,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessPolicy.md index b8386092bb..c39103379a 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconditionalaccesspolicy applicable: Security & Compliance -title: New-DeviceConditionalAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-deviceconditionalaccesspolicy +schema: 2.0.0 +title: New-DeviceConditionalAccessPolicy --- # New-DeviceConditionalAccessPolicy @@ -54,13 +55,15 @@ This example creates a new mobile device conditional access policy named Human R ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the policy. If the value contains spaces, enclose the value in double quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -105,6 +112,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -114,7 +124,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -132,7 +144,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessRule.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessRule.md index 102c007035..1b89079368 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConditionalAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconditionalaccessrule applicable: Security & Compliance -title: New-DeviceConditionalAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-deviceconditionalaccessrule +schema: 2.0.0 +title: New-DeviceConditionalAccessRule --- # New-DeviceConditionalAccessRule @@ -103,6 +104,9 @@ This example creates a new mobile device conditional access rule with the follow ## PARAMETERS ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the mobile device conditional access policy that this rule is associated with. You can use any value that uniquely identifies the policy. For example: - Name @@ -113,7 +117,6 @@ The Policy parameter specifies the mobile device conditional access policy that Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -123,6 +126,9 @@ Accept wildcard characters: False ``` ### -TargetGroups + +> Applicable: Security & Compliance + The TargetGroups parameter specifies the security groups that this rule applies to. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. You can specify multiple groups separated by commas. @@ -131,7 +137,6 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -141,6 +146,9 @@ Accept wildcard characters: False ``` ### -AccountName + +> Applicable: Security & Compliance + The AccountName parameter specifies the account name. Valid values for this parameter are: - A text value. @@ -150,7 +158,6 @@ The AccountName parameter specifies the account name. Valid values for this para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -160,6 +167,9 @@ Accept wildcard characters: False ``` ### -AccountUserName + +> Applicable: Security & Compliance + The AccountUserName parameter specifies the account user name. Valid values for this parameter are: - A text value. @@ -169,7 +179,6 @@ The AccountUserName parameter specifies the account user name. Valid values for Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -179,6 +188,9 @@ Accept wildcard characters: False ``` ### -AllowAppStore + +> Applicable: Security & Compliance + The AllowAppStore parameter specifies whether to allow access to the app store on devices. Valid values for this parameter are: - $true: Access to the app store is allowed. @@ -194,7 +206,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -204,6 +215,9 @@ Accept wildcard characters: False ``` ### -AllowAssistantWhileLocked + +> Applicable: Security & Compliance + The AllowAssistantWhileLocked parameter specifies whether to allow the use of the voice assistant while devices are locked. Valid values for this parameter are: - $true: The voice assistant can be used while devices are locked. @@ -216,7 +230,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -226,6 +239,9 @@ Accept wildcard characters: False ``` ### -AllowConvenienceLogon + +> Applicable: Security & Compliance + The AllowConvenienceLogon parameter specifies whether to allow convenience logons on devices. Valid values for this parameter are: - $true: Convenience logons are allowed. @@ -238,7 +254,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -248,6 +263,9 @@ Accept wildcard characters: False ``` ### -AllowDiagnosticSubmission + +> Applicable: Security & Compliance + The AllowDiagnosticSubmission parameter specifies whether to allow diagnostic submissions from devices. Valid values for this parameter are: - $true: Diagnostic submissions are allowed. @@ -264,7 +282,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -274,6 +291,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudBackup + +> Applicable: Security & Compliance + The AllowiCloudBackup parameter specifies whether to allow Apple iCloud Backup from devices. Valid values for this parameter are: - $true: iCloud Backup is allowed. @@ -289,7 +309,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -299,6 +318,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudDocSync + +> Applicable: Security & Compliance + The AllowiCloudDocSync parameter specifies whether to allow Apple iCloud Documents & Data sync on devices. Valid values for this parameter are: - $true: iCloud Documents & Data sync is allowed. @@ -314,7 +336,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -324,6 +345,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudPhotoSync + +> Applicable: Security & Compliance + The AllowiCloudPhotoSync parameter specifies whether to allow Apple iCloud Photos sync on devices. Valid values for this parameter are: - $true: iCloud Photos sync is allowed. @@ -339,7 +363,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -349,6 +372,9 @@ Accept wildcard characters: False ``` ### -AllowJailbroken + +> Applicable: Security & Compliance + The AllowJailbroken parameter specifies whether to allow access to your organization by jailbroken or rooted devices. - $true: Jailbroken devices are allowed. @@ -364,7 +390,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -374,6 +399,9 @@ Accept wildcard characters: False ``` ### -AllowPassbookWhileLocked + +> Applicable: Security & Compliance + The AllowPassbookWhileLocked parameter specifies whether to allow the use of Apple Passbook while devices are locked. Valid values for this parameter are: - $true: Passbook is available while devices are locked. @@ -386,7 +414,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -396,6 +423,9 @@ Accept wildcard characters: False ``` ### -AllowScreenshot + +> Applicable: Security & Compliance + The AllowScreenshot parameter specifies whether to allow screenshots on devices. Valid values for this parameter are: - $true: Screenshots are allowed. @@ -411,7 +441,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -421,6 +450,9 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Security & Compliance + The AllowSimplePassword parameter specifies whether to allow simple or non-complex passwords on devices. Valid values for this parameter are: - $true: Simple passwords are allowed. @@ -437,7 +469,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -447,6 +478,9 @@ Accept wildcard characters: False ``` ### -AllowVideoConferencing + +> Applicable: Security & Compliance + The AllowVideoConferencing parameter specifies whether to allow video conferencing on devices. Valid values for this parameter are: - $true: Video conferencing is allowed. @@ -459,7 +493,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -469,6 +502,9 @@ Accept wildcard characters: False ``` ### -AllowVoiceAssistant + +> Applicable: Security & Compliance + The AllowVoiceAssistant parameter specifies whether to allow using the voice assistant on devices. Valid values for this parameter are: - $true: The voice assistant is allowed. @@ -481,7 +517,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -491,6 +526,9 @@ Accept wildcard characters: False ``` ### -AllowVoiceDialing + +> Applicable: Security & Compliance + The AllowVoiceDialing parameter specifies whether to allow voice-activated telephone dialing. Valid values for this parameter are: - $true: Voice dialing is allowed. @@ -503,7 +541,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -513,6 +550,9 @@ Accept wildcard characters: False ``` ### -AntiVirusSignatureStatus + +> Applicable: Security & Compliance + The AntiVirusSignatureStatus parameter specifies the antivirus signature status. Valid values for this parameter are: - An integer. @@ -524,7 +564,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -534,6 +573,9 @@ Accept wildcard characters: False ``` ### -AntiVirusStatus + +> Applicable: Security & Compliance + The AntiVirusStatus parameter specifies the antivirus status. Valid values for this parameter are: - An integer. @@ -545,7 +587,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -555,6 +596,9 @@ Accept wildcard characters: False ``` ### -AppsRating + +> Applicable: Security & Compliance + The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - AllowAll @@ -570,7 +614,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -580,6 +623,9 @@ Accept wildcard characters: False ``` ### -AutoUpdateStatus + +> Applicable: Security & Compliance + The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - AutomaticCheckForUpdates @@ -595,7 +641,6 @@ This setting is available only on Windows 8.1 RT devices. Type: CAAutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -605,6 +650,9 @@ Accept wildcard characters: False ``` ### -BluetoothEnabled + +> Applicable: Security & Compliance + The BluetoothEnabled parameter specifies whether to enable or disable Bluetooth on devices. Valid values for this parameter are: - $true: Bluetooth is enabled. @@ -617,7 +665,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -627,6 +674,9 @@ Accept wildcard characters: False ``` ### -CameraEnabled + +> Applicable: Security & Compliance + The CameraEnabled parameter specifies whether to enable or disable cameras on devices. Valid values for this parameter are: - $true: Cameras are enabled. @@ -643,7 +693,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -653,6 +702,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -662,7 +714,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -672,13 +723,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -688,6 +741,9 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Security & Compliance + The EmailAddress parameter specifies the email address. Valid values are: - An email address: For example, julia@contoso.com. @@ -697,7 +753,6 @@ The EmailAddress parameter specifies the email address. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -707,6 +762,9 @@ Accept wildcard characters: False ``` ### -EnableRemovableStorage + +> Applicable: Security & Compliance + The EnableRemovableStorage parameter specifies whether removable storage can be used by devices. Valid values for this parameter are: - $true: Removable storage can be used. @@ -719,7 +777,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -729,6 +786,9 @@ Accept wildcard characters: False ``` ### -ExchangeActiveSyncHost + +> Applicable: Security & Compliance + The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Valid values for this parameter are: - A text value. @@ -738,7 +798,6 @@ The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Val Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -748,6 +807,9 @@ Accept wildcard characters: False ``` ### -FirewallStatus + +> Applicable: Security & Compliance + The FirewallStatus parameter specifies the acceptable firewall status values on devices. Valid values for this parameter are: - Required @@ -759,7 +821,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -769,6 +830,9 @@ Accept wildcard characters: False ``` ### -ForceAppStorePassword + +> Applicable: Security & Compliance + The ForceAppStorePassword parameter specifies whether to require a password to use the app store on devices. Valid values for this parameter are: - $true: App store passwords are required. @@ -781,7 +845,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -791,6 +854,9 @@ Accept wildcard characters: False ``` ### -ForceEncryptedBackup + +> Applicable: Security & Compliance + The ForceEncryptedBackup parameter specifies whether to force encrypted backups for devices. Valid values for this parameter are: - $true: Encrypted backups are required. @@ -806,7 +872,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -816,6 +881,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordAttemptsBeforeWipe + +> Applicable: Security & Compliance + The MaxPasswordAttemptsBeforeWipe parameter specifies the number of incorrect password attempts that cause devices to be automatically wiped. Valid values for this parameter are: - An integer. @@ -832,7 +900,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -842,6 +909,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordGracePeriod + +> Applicable: Security & Compliance + The MaxPasswordGracePeriod parameter specifies the length of time users are allowed to reset expired passwords on devices. This setting is available only on Apple iOS 6+ devices. @@ -852,7 +922,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -862,6 +931,9 @@ Accept wildcard characters: False ``` ### -MoviesRating + +> Applicable: Security & Compliance + The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: @@ -952,7 +1024,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -962,6 +1033,9 @@ Accept wildcard characters: False ``` ### -PasswordComplexity + +> Applicable: Security & Compliance + The PasswordComplexity parameter specifies the password complexity. Valid values for this parameter are: - An integer. @@ -971,7 +1045,6 @@ The PasswordComplexity parameter specifies the password complexity. Valid values Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -981,6 +1054,9 @@ Accept wildcard characters: False ``` ### -PasswordExpirationDays + +> Applicable: Security & Compliance + The PasswordExpirationDays parameter specifies the number of days that the same password can be used on devices before users are required to change their passwords . Valid values for this parameter are: - An integer. @@ -997,7 +1073,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1007,6 +1082,9 @@ Accept wildcard characters: False ``` ### -PasswordHistoryCount + +> Applicable: Security & Compliance + The PasswordHistoryCount parameter specifies the minimum number of unique new passwords that are required on devices before an old password can be reused. Valid values for this parameter are: - An integer. @@ -1023,7 +1101,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1033,6 +1110,9 @@ Accept wildcard characters: False ``` ### -PasswordMinComplexChars + +> Applicable: Security & Compliance + The PasswordMinComplexChars parameter specifies the minimum number of complex characters that are required for device passwords. A complex character isn't a letter. Valid values for this parameter are: - An integer. @@ -1042,7 +1122,6 @@ The PasswordMinComplexChars parameter specifies the minimum number of complex ch Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1052,6 +1131,9 @@ Accept wildcard characters: False ``` ### -PasswordMinimumLength + +> Applicable: Security & Compliance + The PasswordMinimumLength parameter specifies the minimum number of characters that are required for device passwords. Valid values for this parameter are: - An integer. @@ -1068,7 +1150,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1078,6 +1159,9 @@ Accept wildcard characters: False ``` ### -PasswordQuality + +> Applicable: Security & Compliance + The PasswordQuality parameter specifies the minimum password quality rating that's required for device passwords. Password quality is a numeric scale that indicates the security and complexity of the password. A higher quality value indicates a more secure password. Valid values for this parameter are: @@ -1091,7 +1175,6 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1101,6 +1184,9 @@ Accept wildcard characters: False ``` ### -PasswordRequired + +> Applicable: Security & Compliance + The PasswordRequired parameter specifies whether a password is required to access devices. Valid values for this parameter are: - $true: Device passwords are required. @@ -1117,7 +1203,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1127,6 +1212,9 @@ Accept wildcard characters: False ``` ### -PasswordTimeout + +> Applicable: Security & Compliance + The PasswordTimeout parameter specifies the length of time that devices can be inactive before a password is required to reactivate them. This setting is available on the following types of devices: @@ -1142,7 +1230,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1152,6 +1239,9 @@ Accept wildcard characters: False ``` ### -PhoneMemoryEncrypted + +> Applicable: Security & Compliance + The PhoneMemoryEncrypted parameter specifies whether to encrypt the memory on devices. Valid values for this parameter are: - $true: Memory is encrypted. @@ -1167,7 +1257,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1177,6 +1266,9 @@ Accept wildcard characters: False ``` ### -RegionRatings + +> Applicable: Security & Compliance + The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: @@ -1198,7 +1290,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1208,6 +1299,9 @@ Accept wildcard characters: False ``` ### -RequireEmailProfile + +> Applicable: Security & Compliance + The RequireEmailProfile parameter specifies whether an email profile is required on devices. Valid values for this parameter are: - $true: An email profile is required. This value is required for selective wipe on iOS devices. @@ -1218,7 +1312,6 @@ The RequireEmailProfile parameter specifies whether an email profile is required Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1228,6 +1321,9 @@ Accept wildcard characters: False ``` ### -SmartScreenEnabled + +> Applicable: Security & Compliance + The SmartScreenEnabled parameter specifies whether to requireWindows SmartScreen on devices. Valid values for this parameter are: - $true: SmartScreen is enabled. @@ -1240,7 +1336,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1250,6 +1345,9 @@ Accept wildcard characters: False ``` ### -SystemSecurityTLS + +> Applicable: Security & Compliance + The SystemSecurityTLS parameter specifies whether TLS encryption is used on devices. Valid values for this parameter are: - $true: TLS encryption is used. @@ -1262,7 +1360,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1272,6 +1369,9 @@ Accept wildcard characters: False ``` ### -TVShowsRating + +> Applicable: Security & Compliance + The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: @@ -1351,7 +1451,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1361,6 +1460,9 @@ Accept wildcard characters: False ``` ### -UserAccountControlStatus + +> Applicable: Security & Compliance + The UserAccountControlStatus parameter specifies how User Account Control messages are presented on devices. Valid values for this parameter are: - $null (blank): The setting isn't configured. This is the default value. @@ -1375,7 +1477,6 @@ This setting is available only on Windows 8.1 RT devices. Type: CAUserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1385,13 +1486,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -1401,6 +1504,9 @@ Accept wildcard characters: False ``` ### -WLANEnabled + +> Applicable: Security & Compliance + The WLANEnabled parameter specifies whether Wi-Fi is enabled devices. Valid values for this parameter are: - $true: Wi-Fi is enabled. @@ -1413,7 +1519,6 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1423,6 +1528,9 @@ Accept wildcard characters: False ``` ### -WorkFoldersSyncUrl + +> Applicable: Security & Compliance + The WorkFoldersSyncUrl parameter specifies the URL that's used to synchronize company data on devices. Valid input for this parameter a URL. For example, `https://workfolders.contoso.com`. @@ -1433,7 +1541,6 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationPolicy.md index 67e19df788..f3e3e885f1 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconfigurationpolicy applicable: Security & Compliance -title: New-DeviceConfigurationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-deviceconfigurationpolicy +schema: 2.0.0 +title: New-DeviceConfigurationPolicy --- # New-DeviceConfigurationPolicy @@ -54,13 +55,15 @@ This example creates a new mobile device configuration policy named Engineering ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the policy. If the value contains spaces, enclose the value in double quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -105,6 +112,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -114,7 +124,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -132,7 +144,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationRule.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationRule.md index e4505ceb8f..47cb277d91 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceConfigurationRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconfigurationrule applicable: Security & Compliance -title: New-DeviceConfigurationRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-deviceconfigurationrule +schema: 2.0.0 +title: New-DeviceConfigurationRule --- # New-DeviceConfigurationRule @@ -102,6 +103,9 @@ This example creates a new mobile device configuration rule with the following s ## PARAMETERS ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the mobile device configuration policy that this rule is associated with. You can use any value that uniquely identifies the policy. For example: - Name @@ -112,7 +116,6 @@ The Policy parameter specifies the mobile device configuration policy that this Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -122,6 +125,9 @@ Accept wildcard characters: False ``` ### -TargetGroups + +> Applicable: Security & Compliance + The TargetGroups parameter specifies the security groups that this rule applies to. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. You can specify multiple groups separated by commas. @@ -130,7 +136,6 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -140,6 +145,9 @@ Accept wildcard characters: False ``` ### -AccountName + +> Applicable: Security & Compliance + The AccountName parameter specifies the account name. Valid values for this parameter are: - A text value. @@ -149,7 +157,6 @@ The AccountName parameter specifies the account name. Valid values for this para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -159,6 +166,9 @@ Accept wildcard characters: False ``` ### -AccountUserName + +> Applicable: Security & Compliance + The AccountUserName parameter specifies the account user name. Valid values for this parameter are: - A text value. @@ -168,7 +178,6 @@ The AccountUserName parameter specifies the account user name. Valid values for Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -178,6 +187,9 @@ Accept wildcard characters: False ``` ### -AllowAppStore + +> Applicable: Security & Compliance + The AllowAppStore parameter specifies whether to allow access to the app store on devices. Valid values for this parameter are: - $true: Access to the app store is allowed. @@ -193,7 +205,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -203,6 +214,9 @@ Accept wildcard characters: False ``` ### -AllowAssistantWhileLocked + +> Applicable: Security & Compliance + The AllowAssistantWhileLocked parameter specifies whether to allow the use of the voice assistant while devices are locked. Valid values for this parameter are: - $true: The voice assistant can be used while devices are locked. @@ -215,7 +229,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -225,6 +238,9 @@ Accept wildcard characters: False ``` ### -AllowConvenienceLogon + +> Applicable: Security & Compliance + The AllowConvenienceLogon parameter specifies whether to allow convenience logons on devices. Valid values for this parameter are: - $true: Convenience logons are allowed. @@ -237,7 +253,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -247,6 +262,9 @@ Accept wildcard characters: False ``` ### -AllowDiagnosticSubmission + +> Applicable: Security & Compliance + The AllowDiagnosticSubmission parameter specifies whether to allow diagnostic submissions from devices. Valid values for this parameter are: - $true: Diagnostic submissions are allowed. @@ -263,7 +281,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -273,6 +290,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudBackup + +> Applicable: Security & Compliance + The AllowiCloudBackup parameter specifies whether to allow Apple iCloud Backup from devices. Valid values for this parameter are: - $true: iCloud Backup is allowed. @@ -288,7 +308,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -298,6 +317,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudDocSync + +> Applicable: Security & Compliance + The AllowiCloudDocSync parameter specifies whether to allow Apple iCloud Documents & Data sync on devices. Valid values for this parameter are: - $true: iCloud Documents & Data sync is allowed. @@ -313,7 +335,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -323,6 +344,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudPhotoSync + +> Applicable: Security & Compliance + The AllowiCloudPhotoSync parameter specifies whether to allow Apple iCloud Photos sync on devices. Valid values for this parameter are: - $true: iCloud Photos sync is allowed. @@ -338,7 +362,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -348,6 +371,9 @@ Accept wildcard characters: False ``` ### -AllowPassbookWhileLocked + +> Applicable: Security & Compliance + The AllowPassbookWhileLocked parameter specifies whether to allow the use of Apple Passbook while devices are locked. Valid values for this parameter are: - $true: Passbook is available while devices are locked. @@ -360,7 +386,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -370,6 +395,9 @@ Accept wildcard characters: False ``` ### -AllowScreenshot + +> Applicable: Security & Compliance + The AllowScreenshot parameter specifies whether to allow screenshots on devices. Valid values for this parameter are: - $true: Screenshots are allowed. @@ -385,7 +413,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -395,6 +422,9 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Security & Compliance + The AllowSimplePassword parameter specifies whether to allow simple or non-complex passwords on devices. Valid values for this parameter are: - $true: Simple passwords are allowed. @@ -411,7 +441,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -421,6 +450,9 @@ Accept wildcard characters: False ``` ### -AllowVideoConferencing + +> Applicable: Security & Compliance + The AllowVideoConferencing parameter specifies whether to allow video conferencing on devices. Valid values for this parameter are: - $true: Video conferencing is allowed. @@ -433,7 +465,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -443,6 +474,9 @@ Accept wildcard characters: False ``` ### -AllowVoiceAssistant + +> Applicable: Security & Compliance + The AllowVoiceAssistant parameter specifies whether to allow using the voice assistant on devices. Valid values for this parameter are: - $true: The voice assistant is allowed. @@ -455,7 +489,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -465,6 +498,9 @@ Accept wildcard characters: False ``` ### -AllowVoiceDialing + +> Applicable: Security & Compliance + The AllowVoiceDialing parameter specifies whether to allow voice-activated telephone dialing. Valid values for this parameter are: - $true: Voice dialing is allowed. @@ -477,7 +513,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -487,6 +522,9 @@ Accept wildcard characters: False ``` ### -AntiVirusSignatureStatus + +> Applicable: Security & Compliance + The AntiVirusSignatureStatus parameter specifies the antivirus signature status. Valid values for this parameter are: - An integer. @@ -498,7 +536,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -508,6 +545,9 @@ Accept wildcard characters: False ``` ### -AntiVirusStatus + +> Applicable: Security & Compliance + The AntiVirusStatus parameter specifies the antivirus status. Valid values for this parameter are: - An integer. @@ -519,7 +559,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -529,6 +568,9 @@ Accept wildcard characters: False ``` ### -AppsRating + +> Applicable: Security & Compliance + The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - AllowAll @@ -544,7 +586,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -554,6 +595,9 @@ Accept wildcard characters: False ``` ### -AutoUpdateStatus + +> Applicable: Security & Compliance + The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - AutomaticCheckForUpdates @@ -569,7 +613,6 @@ This setting is available only on Windows 8.1 RT devices. Type: AutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -579,6 +622,9 @@ Accept wildcard characters: False ``` ### -BluetoothEnabled + +> Applicable: Security & Compliance + The BluetoothEnabled parameter specifies whether to enable or disable Bluetooth on devices. Valid values for this parameter are: - $true: Bluetooth is enabled. @@ -591,7 +637,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -601,6 +646,9 @@ Accept wildcard characters: False ``` ### -CameraEnabled + +> Applicable: Security & Compliance + The CameraEnabled parameter specifies whether to enable or disable cameras on devices. Valid values for this parameter are: - $true: Cameras are enabled. @@ -617,7 +665,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -627,6 +674,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -636,7 +686,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -646,13 +695,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -662,6 +713,9 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Security & Compliance + The EmailAddress parameter specifies the email address. Valid values are: - An email address: For example, julia@contoso.com. @@ -671,7 +725,6 @@ The EmailAddress parameter specifies the email address. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -681,6 +734,9 @@ Accept wildcard characters: False ``` ### -EnableRemovableStorage + +> Applicable: Security & Compliance + The EnableRemovableStorage parameter specifies whether removable storage can be used by devices. Valid values for this parameter are: - $true: Removable storage can be used. @@ -693,7 +749,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -703,6 +758,9 @@ Accept wildcard characters: False ``` ### -ExchangeActiveSyncHost + +> Applicable: Security & Compliance + The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Valid values for this parameter are: - A text value. @@ -712,7 +770,6 @@ The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Val Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -722,6 +779,9 @@ Accept wildcard characters: False ``` ### -FirewallStatus + +> Applicable: Security & Compliance + The FirewallStatus parameter specifies the acceptable firewall status values on devices. Valid values for this parameter are: - Required @@ -733,7 +793,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -743,6 +802,9 @@ Accept wildcard characters: False ``` ### -ForceAppStorePassword + +> Applicable: Security & Compliance + The ForceAppStorePassword parameter specifies whether to require a password to use the app store on devices. Valid values for this parameter are: - $true: App store passwords are required. @@ -755,7 +817,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -765,6 +826,9 @@ Accept wildcard characters: False ``` ### -ForceEncryptedBackup + +> Applicable: Security & Compliance + The ForceEncryptedBackup parameter specifies whether to force encrypted backups for devices. Valid values for this parameter are: - $true: Encrypted backups are required. @@ -780,7 +844,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -790,6 +853,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordAttemptsBeforeWipe + +> Applicable: Security & Compliance + The MaxPasswordAttemptsBeforeWipe parameter specifies the number of incorrect password attempts that cause devices to be automatically wiped. Valid values for this parameter are: - An integer. @@ -806,7 +872,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -816,6 +881,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordGracePeriod + +> Applicable: Security & Compliance + The MaxPasswordGracePeriod parameter specifies the length of time users are allowed to reset expired passwords on devices. This setting is available only on Apple iOS 6+ devices. @@ -826,7 +894,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -836,6 +903,9 @@ Accept wildcard characters: False ``` ### -MoviesRating + +> Applicable: Security & Compliance + The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: @@ -926,7 +996,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -936,6 +1005,9 @@ Accept wildcard characters: False ``` ### -PasswordComplexity + +> Applicable: Security & Compliance + The PasswordComplexity parameter specifies the password complexity. Valid values for this parameter are: - An integer. @@ -945,7 +1017,6 @@ The PasswordComplexity parameter specifies the password complexity. Valid values Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -955,6 +1026,9 @@ Accept wildcard characters: False ``` ### -PasswordExpirationDays + +> Applicable: Security & Compliance + The PasswordExpirationDays parameter specifies the number of days that the same password can be used on devices before users are required to change their passwords . Valid values for this parameter are: - An integer. @@ -971,7 +1045,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -981,6 +1054,9 @@ Accept wildcard characters: False ``` ### -PasswordHistoryCount + +> Applicable: Security & Compliance + The PasswordHistoryCount parameter specifies the minimum number of unique new passwords that are required on devices before an old password can be reused. Valid values for this parameter are: - An integer. @@ -997,7 +1073,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1007,6 +1082,9 @@ Accept wildcard characters: False ``` ### -PasswordMinComplexChars + +> Applicable: Security & Compliance + The PasswordMinComplexChars parameter specifies the minimum number of complex characters that are required for device passwords. A complex character isn't a letter. Valid values for this parameter are: - An integer. @@ -1016,7 +1094,6 @@ The PasswordMinComplexChars parameter specifies the minimum number of complex ch Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1026,6 +1103,9 @@ Accept wildcard characters: False ``` ### -PasswordMinimumLength + +> Applicable: Security & Compliance + The PasswordMinimumLength parameter specifies the minimum number of characters that are required for device passwords. Valid values for this parameter are: - An integer. @@ -1042,7 +1122,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1052,6 +1131,9 @@ Accept wildcard characters: False ``` ### -PasswordQuality + +> Applicable: Security & Compliance + The PasswordQuality parameter specifies the minimum password quality rating that's required for device passwords. Password quality is a numeric scale that indicates the security and complexity of the password. A higher quality value indicates a more secure password. Valid values for this parameter are: @@ -1065,7 +1147,6 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1075,6 +1156,9 @@ Accept wildcard characters: False ``` ### -PasswordRequired + +> Applicable: Security & Compliance + The PasswordRequired parameter specifies whether a password is required to access devices. Valid values for this parameter are: - $true: Device passwords are required. @@ -1091,7 +1175,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1101,6 +1184,9 @@ Accept wildcard characters: False ``` ### -PasswordTimeout + +> Applicable: Security & Compliance + The PasswordTimeout parameter specifies the length of time that devices can be inactive before a password is required to reactivate them. This setting is available on the following types of devices: @@ -1116,7 +1202,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1126,6 +1211,9 @@ Accept wildcard characters: False ``` ### -PhoneMemoryEncrypted + +> Applicable: Security & Compliance + The PhoneMemoryEncrypted parameter specifies whether to encrypt the memory on devices. Valid values for this parameter are: - $true: Memory is encrypted. @@ -1141,7 +1229,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1151,6 +1238,9 @@ Accept wildcard characters: False ``` ### -RegionRatings + +> Applicable: Security & Compliance + The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: @@ -1172,7 +1262,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1182,6 +1271,9 @@ Accept wildcard characters: False ``` ### -RequireEmailProfile + +> Applicable: Security & Compliance + The RequireEmailProfile parameter specifies whether an email profile is required on devices. Valid values for this parameter are: - $true: An email profile is required. This value is required for selective wipe on iOS devices. @@ -1192,7 +1284,6 @@ The RequireEmailProfile parameter specifies whether an email profile is required Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1202,6 +1293,9 @@ Accept wildcard characters: False ``` ### -SmartScreenEnabled + +> Applicable: Security & Compliance + The SmartScreenEnabled parameter specifies whether to requireWindows SmartScreen on devices. Valid values for this parameter are: - $true: SmartScreen is enabled. @@ -1214,7 +1308,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1224,6 +1317,9 @@ Accept wildcard characters: False ``` ### -SystemSecurityTLS + +> Applicable: Security & Compliance + The SystemSecurityTLS parameter specifies whether TLS encryption is used on devices. Valid values for this parameter are: - $true: TLS encryption is used. @@ -1236,7 +1332,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1246,6 +1341,9 @@ Accept wildcard characters: False ``` ### -TVShowsRating + +> Applicable: Security & Compliance + The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: @@ -1325,7 +1423,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1335,6 +1432,9 @@ Accept wildcard characters: False ``` ### -UserAccountControlStatus + +> Applicable: Security & Compliance + The UserAccountControlStatus parameter specifies how User Account Control messages are presented on devices. Valid values for this parameter are: - $null (blank): The setting isn't configured. This is the default value. @@ -1349,7 +1449,6 @@ This setting is available only on Windows 8.1 RT devices. Type: UserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1359,13 +1458,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -1375,6 +1476,9 @@ Accept wildcard characters: False ``` ### -WLANEnabled + +> Applicable: Security & Compliance + The WLANEnabled parameter specifies whether Wi-Fi is enabled devices. Valid values for this parameter are: - $true: Wi-Fi is enabled. @@ -1387,7 +1491,6 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1397,6 +1500,9 @@ Accept wildcard characters: False ``` ### -WorkFoldersSyncUrl + +> Applicable: Security & Compliance + The WorkFoldersSyncUrl parameter specifies the URL that's used to synchronize company data on devices. Valid input for this parameter a URL. For example, `https://workfolders.contoso.com`. @@ -1407,7 +1513,6 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantPolicy.md index 13317afc2d..dbfdd374b4 100644 --- a/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-devicetenantpolicy applicable: Security & Compliance -title: New-DeviceTenantPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-devicetenantpolicy +schema: 2.0.0 +title: New-DeviceTenantPolicy --- # New-DeviceTenantPolicy @@ -53,13 +54,15 @@ This example creates your organization's mobile device tenant policy. You can ha ## PARAMETERS ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -97,7 +105,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -115,7 +125,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DeviceTenantRule.md b/exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantRule.md similarity index 95% rename from exchange/exchange-ps/exchange/New-DeviceTenantRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantRule.md index 214a1d7524..6cde541a4c 100644 --- a/exchange/exchange-ps/exchange/New-DeviceTenantRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DeviceTenantRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-devicetenantrule applicable: Security & Compliance -title: New-DeviceTenantRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-devicetenantrule +schema: 2.0.0 +title: New-DeviceTenantRule --- # New-DeviceTenantRule @@ -56,6 +57,9 @@ You can have only one mobile device tenant rule in your organization. ## PARAMETERS ### -ApplyPolicyTo + +> Applicable: Security & Compliance + The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: - ExchangeOnline @@ -66,7 +70,6 @@ The ApplyPolicyTo parameter specifies where to apply the policy in your organiza Type: PolicyResourceScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -BlockUnsupportedDevices + +> Applicable: Security & Compliance + The BlockUnsupportedDevices parameter specifies whether to block access to your organization by unsupported devices. Valid values for this parameter are: - $true: Unsupported devices are blocked. @@ -85,7 +91,6 @@ The BlockUnsupportedDevices parameter specifies whether to block access to your Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -104,7 +112,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -ExclusionList + +> Applicable: Security & Compliance + The ExclusionList parameter specifies the security groups to exclude from this policy. Members of the specified security groups who have non-compliant devices are not affected by block access actions. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. @@ -140,7 +152,6 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-DistributionGroup.md similarity index 87% rename from exchange/exchange-ps/exchange/New-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-DistributionGroup.md index f6466a1301..ac577a237c 100644 --- a/exchange/exchange-ps/exchange/New-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-DistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-distributiongroup +schema: 2.0.0 +title: New-DistributionGroup --- # New-DistributionGroup @@ -84,6 +85,9 @@ This example creates a distribution group named ITDepartment and specifies the m ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the group. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). This value is also used for the DisplayName property if you don't use the DisplayName parameter. @@ -92,7 +96,6 @@ This value is also used for the DisplayName property if you don't use the Displa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -126,7 +132,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -155,7 +163,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,6 +172,9 @@ Accept wildcard characters: False ``` ### -BccBlocked + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The BccBlocked parameter specifies whether members of the group don't receive messages if the group is used in the Bcc line. Valid values are: @@ -176,7 +186,6 @@ The BccBlocked parameter specifies whether members of the group don't receive me Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -186,6 +195,9 @@ Accept wildcard characters: False ``` ### -BypassNestedModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ByPassNestedModerationEnabled parameter specifies how to handle message approval when a moderated group contains other moderated groups as members. Valid values are: - $true: After a moderator approves a message sent to the group, the message is automatically approved for all other moderated groups that are members of the group. @@ -197,7 +209,6 @@ This parameter can be used only by top-level organization and tenant administrat Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -207,6 +218,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -216,7 +230,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,13 +239,15 @@ Accept wildcard characters: False ``` ### -CopyOwnerToMember + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CopyOwnerToMember switch specifies whether group owners specified by the ManagedBy parameter are also members of the group. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -242,6 +257,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill Description Description }} @@ -250,7 +268,6 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -260,6 +277,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -270,7 +290,6 @@ If a group naming policy is enforced in your organization, users need to follow Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,6 +299,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -288,7 +310,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -298,6 +319,9 @@ Accept wildcard characters: False ``` ### -HiddenGroupMembershipEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the distribution group from users who aren't members of the group. You don't need to specify a value with this switch. @@ -310,7 +334,6 @@ You can use this setting to help comply with regulations that require you to hid Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -320,6 +343,9 @@ Accept wildcard characters: False ``` ### -IgnoreNamingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The IgnoreNamingPolicy switch specifies whether to prevent this group from being affected by your organization's group naming policy. You don't need to specify a value with this switch. The group naming policy is defined by the DistributionGroupNamingPolicy and DistributionGroupNameBlockedWordList parameters on the Set-OrganizationConfig cmdlet. @@ -328,7 +354,6 @@ The group naming policy is defined by the DistributionGroupNamingPolicy and Dist Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -338,6 +363,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies an owner for the group. A group must have at least one owner. If you don't use this parameter to specify the owner when you create the group, the user account that created the group is the owner. The group owner is able to: - Modify the properties of the group @@ -376,7 +404,6 @@ Owners that you specify with this parameter are not automatically added as group Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -386,6 +413,9 @@ Accept wildcard characters: False ``` ### -MemberDepartRestriction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MemberDepartRestriction parameter specifies the restrictions that you put on requests to leave the group. Valid values are: - Open: Members can leave the group without approval from one of the group owners. This is the default value for universal distribution groups. You can't use this value on universal security groups. @@ -395,7 +425,6 @@ The MemberDepartRestriction parameter specifies the restrictions that you put on Type: MemberUpdateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -405,6 +434,9 @@ Accept wildcard characters: False ``` ### -MemberJoinRestriction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MemberJoinRestriction parameter specifies the restrictions that you put on requests to join the group. Valid values are: - Open: Users can add themselves to the group without approval from a group owner. You can't use this value on universal security groups. @@ -415,7 +447,6 @@ The MemberJoinRestriction parameter specifies the restrictions that you put on r Type: MemberUpdateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -425,6 +456,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Members parameter specifies the recipients (mail-enabled objects) that are members of the group. You can use any value that uniquely identifies the recipient. For example: - Name @@ -446,7 +480,6 @@ The maximum number of entries for this parameter is 10000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -456,6 +489,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this group. A moderator approves messages sent to the group before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -475,7 +511,6 @@ For distribution groups, if you set the ModerationEnabled parameter to the value Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -485,6 +520,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -496,7 +534,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -506,13 +543,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -522,6 +561,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter specifies the location in Active Directory where the group is created. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -535,7 +577,6 @@ Valid input for this parameter is an organizational unit (OU) or domain that's r Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -545,13 +586,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -561,6 +604,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -572,7 +618,6 @@ The default value is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -582,6 +627,9 @@ Accept wildcard characters: False ``` ### -RoomList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RoomList switch specifies that all members of this distribution group are room mailboxes. You don't need to specify a value with this switch. You can create a distribution group for an office building in your organization and add all rooms in that building to the distribution group. Room list distribution groups are used to generate a list of building locations for meeting requests in Outlook 2010 or later. Room lists allow a user to select a building and get availability information for all rooms in that building, without having to add each room individually. @@ -590,7 +638,6 @@ You can create a distribution group for an office building in your organization Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -600,6 +647,9 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). @@ -608,7 +658,6 @@ The SamAccountName parameter (also known as the pre-Windows 2000 user account or Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -618,6 +667,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -630,7 +682,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -640,6 +691,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Type parameter specifies the type of group that you want to create. Valid values are: - Distribution: A distribution group. These groups can't have permissions assigned. This is the default value. @@ -651,7 +705,6 @@ The group's scope is always Universal. Type: GroupType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -661,13 +714,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DkimSigningConfig.md b/exchange/exchange-ps/ExchangePowerShell/New-DkimSigningConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/New-DkimSigningConfig.md rename to exchange/exchange-ps/ExchangePowerShell/New-DkimSigningConfig.md index 5bd296a8ba..0dfaee8eb1 100644 --- a/exchange/exchange-ps/exchange/New-DkimSigningConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DkimSigningConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection -title: New-DkimSigningConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dkimsigningconfig +schema: 2.0.0 +title: New-DkimSigningConfig --- # New-DkimSigningConfig @@ -48,6 +49,9 @@ This example enables DKIM message signing for the contoso.com domain. ## PARAMETERS ### -DomainName + +> Applicable: Exchange Online, Exchange Online Protection + The DomainName parameter specifies the domain in your organization that you want to enable DKIM message signing for. By default, DKIM message signing is enabled for the initial \*.onmicrosoft.com domain in the organization (for example, contoso.onmicrosoft.com). @@ -58,7 +62,6 @@ For custom domains that don't have DKIM messaging signing enabled, the DKIM sign Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. @@ -77,7 +83,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 2 @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -BodyCanonicalization + +> Applicable: Exchange Online, Exchange Online Protection + The BodyCanonicalization parameter specifies the canonicalization algorithm that's used to create and verify the message body part of the DKIM signature. This value effectively controls the sensitivity of DKIM to changes to the message body in transit. Valid values are: - Relaxed: Changes in whitespace and changes in empty lines at the end of the message body are tolerated. This is the default value. @@ -112,7 +122,6 @@ The BodyCanonicalization parameter specifies the canonicalization algorithm that Type: CanonicalizationType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -131,7 +143,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -141,6 +152,9 @@ Accept wildcard characters: False ``` ### -HeaderCanonicalization + +> Applicable: Exchange Online, Exchange Online Protection + The HeaderCanonicalization parameter specifies the canonicalization algorithm that's used to create and verify the message header part of the DKIM signature. This value effectively controls the sensitivity of DKIM to changes to the message headers in transit. Valid values are: - Relaxed: Common modifications to the message header are tolerated (for example, Header field line rewrapping, changes in unnecessary whitespace or empty lines, and changes in case for header fields). This is the default value. @@ -150,7 +164,6 @@ The HeaderCanonicalization parameter specifies the canonicalization algorithm th Type: CanonicalizationType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,6 +173,9 @@ Accept wildcard characters: False ``` ### -KeySize + +> Applicable: Exchange Online, Exchange Online Protection + The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are: - 1024 (this is the default value) @@ -171,7 +187,6 @@ RSA keys are supported. Ed25519 keys aren't supported. Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpCompliancePolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpCompliancePolicy.md index 17a536c78d..bc1368c34b 100644 --- a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpcompliancepolicy applicable: Security & Compliance -title: New-DlpCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpcompliancepolicy +schema: 2.0.0 +title: New-DlpCompliancePolicy --- # New-DlpCompliancePolicy @@ -153,13 +154,15 @@ This example creates a DLP policy for Microsoft 365 Copilot (Preview) in several ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the DLP policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -169,13 +172,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -185,6 +190,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -194,7 +202,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -204,13 +211,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill EndpointDlpAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -220,13 +229,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill EndpointDlpAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -236,13 +247,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpExtendedLocations + +> Applicable: Security & Compliance + {{ Fill EndpointDlpExtendedLocations Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -252,6 +265,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpLocation + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The EndpointDLPLocation parameter specifies the user accounts to include in the DLP policy for Endpoint DLP when they are logged on to an onboarded device. You identify the account by name or email address. You can use the value All to include all user accounts. @@ -264,7 +280,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -274,6 +289,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The EndpointDlpLocationException parameter specifies the user accounts to exclude from Endpoint DLP when you use the value All for the EndpointDlpLocation parameter. You identify the account by name or email address. @@ -286,7 +304,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -296,6 +313,9 @@ Accept wildcard characters: False ``` ### -EnforcementPlanes + +> Applicable: Security & Compliance + The EnforcementPlanes parameter defines the layer where policy actions are run. This parameter uses the following syntax: `-EnforcementPlanes @("")`. @@ -309,7 +329,6 @@ Currently, supported values are: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -319,6 +338,9 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedBy + +> Applicable: Security & Compliance + The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). @@ -331,7 +353,6 @@ You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMember Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -341,6 +362,9 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf + +> Applicable: Security & Compliance + The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to exclude from the DLP policy (the OneDrive sites of group members are excluded from the policy). You identify the groups by email address. To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). @@ -355,7 +379,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -365,13 +388,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -381,13 +406,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -397,6 +424,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies whether to include email messages in the DLP policy. The valid value for this parameter is All. If you don't want to include email messages in the policy, don't use this parameter (the default value is blank or $null). You can use this parameter in the following procedures: @@ -413,7 +443,6 @@ You can't specify inclusions and exclusions in the same policy. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -423,6 +452,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf + +> Applicable: Security & Compliance + The ExchangeSenderMemberOf parameter specifies the distribution groups or security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -437,7 +469,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -447,6 +478,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException + +> Applicable: Security & Compliance + The ExchangeSenderMemberOfException parameter specifies the distribution groups or security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -461,7 +495,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -471,6 +504,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -479,7 +515,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -489,13 +524,15 @@ Accept wildcard characters: False ``` ### -IsFromSmartInsights + +> Applicable: Security & Compliance + {{ Fill IsFromSmartInsights Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -505,6 +542,9 @@ Accept wildcard characters: False ``` ### -Locations + +> Applicable: Security & Compliance + The Locations parameter specifies to whom, what, and where the DLP policy applies. This parameter uses the following properties: - Workload: What the DLP policy applies to. Use the value `Applications`. @@ -532,7 +572,6 @@ After you create the `$loc` variable as shown in the previous examples, use the Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -542,6 +581,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Security & Compliance + The Mode parameter specifies the action and notification level of the DLP policy. Valid values are: - Enable: The policy is enabled for actions and notifications. This is the default value. @@ -553,7 +595,6 @@ The Mode parameter specifies the action and notification level of the DLP policy Type: PolicyMode Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -563,13 +604,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -579,13 +622,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -595,6 +640,9 @@ Accept wildcard characters: False ``` ### -OneDriveLocation + +> Applicable: Security & Compliance + The OneDriveLocation parameter specifies whether to include OneDrive sites in the policy. A valid value for this parameter is All, which is also the default value. You can use this parameter in the following procedures: @@ -617,7 +665,6 @@ You can't specify inclusions and exclusions in the same policy. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named Default value: None @@ -626,13 +673,15 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException + +> Applicable: Security & Compliance + Don't use this parameter. See the OneDriveLocation parameter for an explanation. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named Default value: None @@ -641,6 +690,9 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy + +> Applicable: Security & Compliance + The OneDriveSharedBy parameter specifies the users to include in the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). @@ -653,7 +705,6 @@ You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDri Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -663,6 +714,9 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf + +> Applicable: Security & Compliance + The OneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the DLP policy (the OneDrive sites of group members are included in the policy). You identify the groups by email address. To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). @@ -677,7 +731,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -687,6 +740,9 @@ Accept wildcard characters: False ``` ### -OnPremisesScannerDlpLocation + +> Applicable: Security & Compliance + The OnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to include in the DLP policy. You can use the value All to include all on-premises file shares and SharePoint document libraries and folders. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -697,7 +753,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -707,6 +762,9 @@ Accept wildcard characters: False ``` ### -OnPremisesScannerDlpLocationException + +> Applicable: Security & Compliance + The OnPremisesScannerDlpLocationException parameter specifies the on-premises file shares and SharePoint document libraries and folders to exclude from the DLP policy if you use the value All for the OnPremisesScannerDlpLocation parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -717,7 +775,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -727,6 +784,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. @@ -735,7 +795,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -745,6 +804,9 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + The PolicyTemplateInfo specifies the built-in or custom DLP policy templates to use in the DLP policy. For more information about DLP policy templates, see [What the DLP policy templates include](https://learn.microsoft.com/purview/what-the-dlp-policy-templates-include). @@ -753,7 +815,6 @@ For more information about DLP policy templates, see [What the DLP policy templa Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -763,6 +824,9 @@ Accept wildcard characters: False ``` ### -PowerBIDlpLocation + +> Applicable: Security & Compliance + The PowerBIDlpLocation parameter specifies the Power BI workspace IDs to include in the DLP policy. Only workspaces hosted in Premium Gen2 capacities are permitted. You can use the value All to include all supported workspaces. You can find the workspace ID using any of the following procedures: @@ -779,7 +843,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The PowerBIDlpLocationException parameter specifies the Power BI workspace IDs to exclude from the DLP policy when you use the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. You can find the workspace ID using any of the following procedures: @@ -803,7 +869,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and policies can't have the same priority value. Valid values and the default value depend on the number of existing policies. For example, if there are 5 existing policies: @@ -827,7 +895,6 @@ If you modify the priority value of a policy, the position of the policy in the Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -837,13 +904,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -853,13 +922,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -869,6 +940,9 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + The SharePointLocation parameter specifies the SharePoint sites to include in the DLP policy. You identify the site by its URL value, or you can use the value All to include all sites. You can't add SharePoint sites to the policy until they have been indexed. @@ -879,7 +953,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The SharePointLocationException parameter specifies the SharePoint sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can't add SharePoint sites to the policy until they have been indexed. @@ -899,7 +975,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + {{ Fill TeamsAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -925,13 +1002,15 @@ Accept wildcard characters: False ``` ### -TeamsAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill TeamsAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -941,6 +1020,9 @@ Accept wildcard characters: False ``` ### -TeamsLocation + +> Applicable: Security & Compliance + The TeamsLocation parameter specifies the Teams chat and channel messages to include in the DLP policy. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. You can use the value All to include all accounts, distribution groups, and mail-enabled security groups. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -949,7 +1031,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The TeamsLocation parameter specifies the Teams chat and channel messages to exclude from the DLP policy when you use the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -967,7 +1051,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The ThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to include in the DLP policy. You can use the value All to include all connected apps. @@ -989,7 +1075,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -999,6 +1084,9 @@ Accept wildcard characters: False ``` ### -ThirdPartyAppDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The ThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps to exclude from the DLP policy when you use the value All for the ThirdPartyAppDlpLocation parameter. @@ -1011,7 +1099,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1021,13 +1108,15 @@ Accept wildcard characters: False ``` ### -ValidatePolicy + +> Applicable: Security & Compliance + {{ Fill ValidatePolicy Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1037,13 +1126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DlpComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpComplianceRule.md index 177d38fa19..eceadf5ef2 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpcompliancerule applicable: Security & Compliance -title: New-DlpComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpcompliancerule +schema: 2.0.0 +title: New-DlpComplianceRule --- # New-DlpComplianceRule @@ -326,13 +327,15 @@ This is an example of applying a CCSI-based DLP rule that should be handled by a ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the new DLP rule. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -342,6 +345,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the existing DLP policy that will contain the new DLP rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -353,7 +359,6 @@ The Policy parameter specifies the existing DLP policy that will contain the new Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -363,6 +368,9 @@ Accept wildcard characters: False ``` ### -AccessScope + +> Applicable: Security & Compliance + The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule is applied to content that's accessible or delivered to a recipient inside the organization. @@ -373,7 +381,6 @@ The AccessScope parameter specifies a condition for the DLP rule that's based on Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -383,13 +390,15 @@ Accept wildcard characters: False ``` ### -ActivationDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -399,6 +408,9 @@ Accept wildcard characters: False ``` ### -AddRecipients + +> Applicable: Security & Compliance + The AddRecipients parameter specifies an action for the DLP rule that adds the specified recipients to email messages. This parameter uses the following syntax: - `@{ = "emailaddress"}`. For example, `@{AddToRecipients = "laura@contoso.com"}` or `@{BlindCopyTo = "julia@contoso.com"}`. @@ -410,7 +422,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -420,6 +431,9 @@ Accept wildcard characters: False ``` ### -AdvancedRule + +> Applicable: Security & Compliance + The AdvancedRule parameter uses complex rule syntax that supports multiple AND, OR, and NOT operators and nested groups. This parameter uses JSON syntax that's similar to the traditional advanced syntax in Example 2, but read from a file that contains additional operators and combinations that aren't traditionally supported. @@ -430,7 +444,6 @@ For syntax details, see Example 3. Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -440,13 +453,15 @@ Accept wildcard characters: False ``` ### -AlertProperties + +> Applicable: Security & Compliance + {{ Fill AlertProperties Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -456,6 +471,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The AnyOfRecipientAddressContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -470,7 +488,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -480,6 +497,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -490,7 +510,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -500,6 +519,9 @@ Accept wildcard characters: False ``` ### -ApplyBrandingTemplate + +> Applicable: Security & Compliance + The ApplyBrandingTemplate parameter specifies an action for the DLP rule that applies a custom branding template for messages encrypted by Microsoft Purview Message Encryption. You identify the custom branding template by name. If the name contains spaces, enclose the name in quotation marks ("). Use the EnforcePortalAccess parameter to control whether external users are required to use the encrypted message portal to view encrypted messages. @@ -508,7 +530,6 @@ Use the EnforcePortalAccess parameter to control whether external users are requ Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -518,6 +539,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimer + +> Applicable: Security & Compliance + The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = ; FallbackAction = }`. - Text: Specifies the disclaimer text to add. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. @@ -530,7 +554,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -540,13 +563,15 @@ Accept wildcard characters: False ``` ### -AttachmentIsNotLabeled + +> Applicable: Security & Compliance + {{ Fill AttachmentIsNotLabeled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -556,6 +581,9 @@ Accept wildcard characters: False ``` ### -BlockAccess + +> Applicable: Security & Compliance + The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: - $true: Blocks further access to the source item that matched the rule. The owner, author, and site owner can still access the item. @@ -565,7 +593,6 @@ The BlockAccess parameter specifies an action for the DLP rule that blocks acces Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -575,6 +602,9 @@ Accept wildcard characters: False ``` ### -BlockAccessScope + +> Applicable: Security & Compliance + The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - All: Blocks access to everyone except the owner and the last modifier. @@ -585,7 +615,6 @@ The BlockAccessScope parameter specifies the scope of the block access action. V Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -595,13 +624,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -611,6 +642,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -620,7 +654,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -630,6 +663,9 @@ Accept wildcard characters: False ``` ### -ContentCharacterSetContainsWords + +> Applicable: Security & Compliance + The ContentCharacterSetContainsWords parameter specifies a condition for the rule that looks for character set names in messages. You can specify multiple values separated by commas. Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874`. @@ -638,7 +674,6 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -648,6 +683,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. @@ -660,7 +698,6 @@ For an example of advanced syntax, see Example 2 in this topic. Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -670,13 +707,15 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -686,13 +725,15 @@ Accept wildcard characters: False ``` ### -ContentFileTypeMatches + +> Applicable: Security & Compliance + {{ Fill ContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -702,6 +743,9 @@ Accept wildcard characters: False ``` ### -ContentIsNotLabeled + +> Applicable: Security & Compliance + The ContentIsNotLabeled parameter specifies a condition for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: - $true: Look for attachments or documents that aren't labeled. @@ -713,7 +757,6 @@ In Exchange, this condition is matched only if both the attachment and the messa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -723,6 +766,9 @@ Accept wildcard characters: False ``` ### -ContentIsShared + +> Applicable: Security & Compliance + The ContentIsNotLabeled parameter specifies a condition for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: - $true: Look for attachments or documents that aren't labeled. @@ -734,7 +780,6 @@ In Exchange, this condition is matched only if both the attachment and the messa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -744,6 +789,9 @@ Accept wildcard characters: False ``` ### -ContentPropertyContainsWords + +> Applicable: Security & Compliance + The ContentPropertyContainsWords parameter specifies a condition for the DLP rule that's based on a property match in content. The rule is applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -752,7 +800,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -762,6 +809,9 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: - $true: The rule is disabled. @@ -771,7 +821,6 @@ The Disabled parameter specifies whether the DLP rule is disabled. Valid values Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -781,6 +830,9 @@ Accept wildcard characters: False ``` ### -DocumentContainsWords + +> Applicable: Security & Compliance + The DocumentContainsWords parameter specifies a condition for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -791,7 +843,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -801,6 +852,9 @@ Accept wildcard characters: False ``` ### -DocumentCreatedBy + +> Applicable: Security & Compliance + The DocumentCreatedBy parameter specifies a condition for the DLP rule that looks for documents that are created by the specificed identity. You can specify multiple values separated by commas. This parameter applies to Sharepoint and Onedrive workloads. @@ -809,7 +863,6 @@ This parameter applies to Sharepoint and Onedrive workloads. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -819,6 +872,9 @@ Accept wildcard characters: False ``` ### -DocumentCreatedByMemberOf + +> Applicable: Security & Compliance + The DocumentCreatedByMemberOf parameter specifies a condition for the DLP rule that looks for documents that are created by a member of the specificed group. You can specify multiple values separated by commas. This parameter applies to Sharepoint and Onedrive workloads. @@ -827,7 +883,6 @@ This parameter applies to Sharepoint and Onedrive workloads. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -837,6 +892,9 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected + +> Applicable: Security & Compliance + The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -846,7 +904,6 @@ The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -856,6 +913,9 @@ Accept wildcard characters: False ``` ### -DocumentIsUnsupported + +> Applicable: Security & Compliance + The DocumentIsUnsupported parameter specifies a condition for the DLP rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -865,7 +925,6 @@ The DocumentIsUnsupported parameter specifies a condition for the DLP rule that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -875,6 +934,9 @@ Accept wildcard characters: False ``` ### -DocumentMatchesPatterns + +> Applicable: Security & Compliance + The DocumentMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -885,7 +947,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -895,6 +956,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesPatterns + +> Applicable: Security & Compliance + The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -903,7 +967,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -913,6 +976,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesWords + +> Applicable: Security & Compliance + The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -925,7 +991,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -935,6 +1000,9 @@ Accept wildcard characters: False ``` ### -DocumentSizeOver + +> Applicable: Security & Compliance + The DocumentSizeOver parameter specifies a condition for the DLP rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -953,7 +1021,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -962,6 +1029,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -DomainCountOver + +> Applicable: Security & Compliance + The DomainCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipient domains is greater than the specified value. You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. @@ -970,7 +1040,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. In Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -979,6 +1048,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -EncryptRMSTemplate + +> Applicable: Security & Compliance + The EncryptRMSTemplate parameter specifies an action for the DLP rule that applies rights management service (RMS) templates to files. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. @@ -987,7 +1059,6 @@ Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -997,13 +1068,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpBrowserRestrictions + +> Applicable: Security & Compliance + {{ Fill EndpointDlpBrowserRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1013,6 +1086,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpRestrictions + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The EndpointDlpRestrictions parameter specifies the restricted endpoints for Endpoint DLP. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. @@ -1041,7 +1117,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1051,6 +1126,9 @@ Accept wildcard characters: False ``` ### -EnforcePortalAccess + +> Applicable: Security & Compliance + The EnforcePortalAccess parameter specifies whether external recipients are required to view encrypted mail using the encrypted message portal when the ApplyBrandingTemplate action is also specified. Valid values are: - $true: External recipients are required to use the encrypted message portal to view encrypted messages. @@ -1060,7 +1138,6 @@ The EnforcePortalAccess parameter specifies whether external recipients are requ Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1070,6 +1147,9 @@ Accept wildcard characters: False ``` ### -EvaluateRulePerComponent + +> Applicable: Security & Compliance + The EvaluateRulePerComponent parameter specifies whether a match for conditions and exceptions in the rule is contained within the same message component. Valid values are: - $true: A DLP rule match for conditions and exceptions must be in the same message component (for example, in the message body or in a single attachment). @@ -1088,7 +1168,6 @@ This parameter works with the following conditions or exceptions only: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1098,6 +1177,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAccessScope + +> Applicable: Security & Compliance + The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule isn't applied to content that's accessible or delivered to a recipient inside the organization. @@ -1108,7 +1190,6 @@ The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1118,6 +1199,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. - Single word: `"no_reply"` @@ -1132,7 +1216,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1142,6 +1225,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1152,7 +1238,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1162,6 +1247,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentCharacterSetContainsWords parameter specifies an exception for the rule that looks for character set names in messages. To specify multiple words, this parameter uses the syntax: `Word1,word2,...wordN`. Don't use leading or trailing spaces. @@ -1172,7 +1260,6 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1182,6 +1269,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. @@ -1192,7 +1282,6 @@ Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1202,13 +1291,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1218,13 +1309,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentFileTypeMatches + +> Applicable: Security & Compliance + {{ Fill ExceptIfContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1234,6 +1327,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentIsShared + +> Applicable: Security & Compliance + The ContentIsNotLabeled parameter specifies an exception for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: - $true: Look for attachments or documents that aren't labeled. @@ -1245,7 +1341,6 @@ In Exchange, this condition is matched only if both the attachment and the messa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1255,6 +1350,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentPropertyContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentPropertyContainsWords parameter specifies an exception for the DLP rule that's based on a property match in content. The rule is not applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -1263,7 +1361,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1273,6 +1370,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentContainsWords + +> Applicable: Security & Compliance + The ExceptIfDocumentContainsWords parameter specifies an exception for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1283,7 +1383,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1293,6 +1392,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedBy + +> Applicable: Security & Compliance + The DocumentCreatedBy parameter specifies an exception for the DLP rule that looks for documents that are created by the specificed identity. You can specify multiple values separated by commas. This parameter applies to Sharepoint and Onedrive workloads. @@ -1301,7 +1403,6 @@ This parameter applies to Sharepoint and Onedrive workloads. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1311,6 +1412,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedByMemberOf + +> Applicable: Security & Compliance + The DocumentCreatedByMemberOf parameter specifies an exception for the DLP rule that looks for documents that are created by a member of the specificed group. You can specify multiple values separated by commas. This parameter applies to Sharepoint and Onedrive workloads. @@ -1319,7 +1423,6 @@ This parameter applies to Sharepoint and Onedrive workloads. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1329,6 +1432,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected + +> Applicable: Security & Compliance + The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -1338,7 +1444,6 @@ The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1348,6 +1453,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsUnsupported + +> Applicable: Security & Compliance + The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -1357,7 +1465,6 @@ The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1367,6 +1474,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1375,7 +1485,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1385,6 +1494,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfDocumentMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -1395,7 +1507,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1405,6 +1516,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesWords + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1417,7 +1531,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1427,6 +1540,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentSizeOver + +> Applicable: Security & Compliance + The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -1445,7 +1561,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1455,6 +1570,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + The ExceptIfFrom parameter specifies an exception for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1463,7 +1581,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1473,6 +1590,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfFromAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1487,7 +1607,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1497,6 +1616,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1507,7 +1629,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1517,6 +1638,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Security & Compliance + The FromMemberOf parameter specifies an exception for the DLP rule that looks for messages sent by group members. You identify the group by its email address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -1525,7 +1649,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1535,6 +1658,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope + +> Applicable: Security & Compliance + The ExceptIfFromScope parameter specifies an exception for the rule that looks for the location of message senders. Valid values are: - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. @@ -1546,7 +1672,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1556,6 +1681,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride + +> Applicable: Security & Compliance + The ExceptIfHasSenderOverride parameter specifies an exception for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: - $true: Look for messages where the sender took action to override a DLP policy. @@ -1567,7 +1695,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1577,6 +1704,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Security & Compliance + The HeaderContainsWords parameter specifies an exception for the DLP rule that looks for words in a header field. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1587,7 +1717,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1597,6 +1726,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1605,7 +1737,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1615,6 +1746,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver + +> Applicable: Security & Compliance + The ExceptIfMessageSizeOver parameter specifies an exception for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. When you enter a value, qualify the value with one of the following units: @@ -1633,7 +1767,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1643,6 +1776,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Security & Compliance + The ExceptIfMessageTypeMatches parameter specifies an exception for the rule that looks for messages of the specified type. Valid values are: - ApprovalRequest: Moderation request messages sent to moderators. @@ -1660,7 +1796,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1670,6 +1805,9 @@ Accept wildcard characters: False ``` ### -ExceptIfProcessingLimitExceeded + +> Applicable: Security & Compliance + The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP rule that looks for files where scanning couldn't complete. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -1679,7 +1817,6 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1689,6 +1826,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords + +> Applicable: Security & Compliance + The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: - City @@ -1729,7 +1869,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1739,6 +1878,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -1779,7 +1921,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1789,13 +1930,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1805,6 +1948,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords + +> Applicable: Security & Compliance + The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: - City @@ -1845,7 +1991,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1855,6 +2000,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -1895,7 +2043,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1905,6 +2052,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + The ExceptIfSenderDomainIs parameter specifies an exception for the DLP rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1913,7 +2063,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1923,6 +2072,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIPRanges + +> Applicable: Security & Compliance + The ExceptIfSenderIpRanges parameter specifies an exception for the DLP rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -1935,7 +2087,6 @@ You can specify values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1945,6 +2096,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + The ExceptIfSentTo parameter specifies an exception for the DLP rule that looks for recipients in messages. You identify the recipients by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1953,7 +2107,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1963,6 +2116,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Security & Compliance + The ExceptIfSentToMemberOf parameter specifies an exception for the DLP rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1971,7 +2127,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1981,6 +2136,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Security & Compliance + The ExceptIfSubjectContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in the Subject field of messages. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1995,7 +2153,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2005,6 +2162,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -2015,7 +2175,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2025,6 +2184,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Security & Compliance + The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the rule that looks for words in the Subject field or body of messages. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -2035,7 +2197,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2045,6 +2206,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in DLP policies that are scoped only to Exchange. @@ -2053,7 +2217,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2063,6 +2226,9 @@ Accept wildcard characters: False ``` ### -ExceptIfUnscannableDocumentExtensionIs + +> Applicable: Security & Compliance + The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -2071,7 +2237,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2081,6 +2246,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Security & Compliance + The ExceptIfWithImportance parameter specifies an exception for the rule that looks for messages with the specified importance level. Valid values are: - Low @@ -2093,7 +2261,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2103,13 +2270,15 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2119,6 +2288,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + The From parameter specifies a condition for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2127,7 +2299,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2137,6 +2308,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Security & Compliance + The FromAddressContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -2151,7 +2325,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2161,6 +2334,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Security & Compliance + The FromAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -2171,7 +2347,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2181,6 +2356,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Security & Compliance + The FromMemberOf parameter specifies a condition for the DLP rule that looks for messages sent by group members. You identify the group by its email address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -2189,7 +2367,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2199,6 +2376,9 @@ Accept wildcard characters: False ``` ### -FromScope + +> Applicable: Security & Compliance + The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. @@ -2210,7 +2390,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2220,6 +2399,9 @@ Accept wildcard characters: False ``` ### -GenerateAlert + +> Applicable: Security & Compliance + The GenerateAlert parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2233,7 +2415,6 @@ The email message that's generated by this action contains a link to detailed in Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2243,6 +2424,9 @@ Accept wildcard characters: False ``` ### -GenerateIncidentReport + +> Applicable: Security & Compliance + The GenerateIncidentReport parameter specifies an action for the DLP rule that sends an incident report to the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2254,7 +2438,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2264,6 +2447,9 @@ Accept wildcard characters: False ``` ### -HasSenderOverride + +> Applicable: Security & Compliance + The SenderOverride parameter specifies a condition for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: - $true: Look for messages where the sender took action to override a DLP policy. @@ -2275,7 +2461,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2285,6 +2470,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Security & Compliance + The HeaderContainsWords parameter specifies a condition for the DLP rule that looks for words in a header field. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -2295,7 +2483,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2305,6 +2492,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2313,7 +2503,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2323,13 +2512,15 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2339,6 +2530,9 @@ Accept wildcard characters: False ``` ### -IncidentReportContent + +> Applicable: Security & Compliance + The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: - All @@ -2368,7 +2562,6 @@ Therefore, any additional values that you use with the value "Default" are ignor Type: ReportContentOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2378,13 +2571,15 @@ Accept wildcard characters: False ``` ### -MessageIsNotLabeled + +> Applicable: Security & Compliance + {{ Fill MessageIsNotLabeled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2394,6 +2589,9 @@ Accept wildcard characters: False ``` ### -MessageSizeOver + +> Applicable: Security & Compliance + The MessageSizeOver parameter specifies a condition for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. When you enter a value, qualify the value with one of the following units: @@ -2412,7 +2610,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2422,6 +2619,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Security & Compliance + The MessageTypeMatches parameter specifies a condition for the rule that looks for messages of the specified type. Valid values are: - ApprovalRequest: Moderation request messages sent to moderators. @@ -2439,7 +2639,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2449,13 +2648,15 @@ Accept wildcard characters: False ``` ### -MipRestrictAccess + +> Applicable: Security & Compliance + {{ Fill MipRestrictAccess Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2465,6 +2666,9 @@ Accept wildcard characters: False ``` ### -Moderate + +> Applicable: Security & Compliance + The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = "emailaddress1,emailaddress2,...emailaddressN"}`. You can use this action in DLP policies that are scoped only to Exchange. @@ -2473,7 +2677,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2483,6 +2686,9 @@ Accept wildcard characters: False ``` ### -ModifySubject + +> Applicable: Security & Compliance + The ModifySubject parameter uses regular expressions to find text patterns in the subject of the email message, and then modifies the subject with the text that you specify. This parameter uses the syntax: `@{Patterns="RegEx1","RegEx2",..."RegEx10}"; SubjectText="Replacement Text"; ReplaceStrategy="Value"}`. The `ReplaceStrategy=` property uses one of the following values: @@ -2497,7 +2703,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2507,6 +2712,9 @@ Accept wildcard characters: False ``` ### -NonBifurcatingAccessScope + +> Applicable: Security & Compliance + The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule that looks for recipients in the specified access scope. The rule is applied to all copies of the message. Valid values are: - HasInternal: At least one recipient is inside the organization. @@ -2519,7 +2727,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2529,6 +2736,9 @@ Accept wildcard characters: False ``` ### -NotifyAllowOverride + +> Applicable: Security & Compliance + The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - FalsePositive: Allows overrides in the case of false positives. @@ -2542,7 +2752,6 @@ You can specify multiple values separated by commas. The values WithoutJustifica Type: OverrideOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2552,13 +2761,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomSenderDisplayName + +> Applicable: Security & Compliance + {{ Fill NotifyEmailCustomSenderDisplayName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2568,13 +2779,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomSubject + +> Applicable: Security & Compliance + The NotifyEmailCustomSubject parameter specifies the custom text in the subject line of email notification message that's sent to recipients when the conditions of the rule are met. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2584,6 +2797,9 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomText + +> Applicable: Security & Compliance + The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. This parameter has a 5000 character limit, and supports plain text, HTML tags, and the following tokens (variables): @@ -2597,7 +2813,6 @@ This parameter has a 5000 character limit, and supports plain text, HTML tags, a Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2607,13 +2822,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailExchangeIncludeAttachment + +> Applicable: Security & Compliance + {{ Fill NotifyEmailExchangeIncludeAttachment Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2623,13 +2840,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailOnedriveRemediationActions + +> Applicable: Security & Compliance + {{ Fill NotifyEmailOnedriveRemediationActions Description }} ```yaml Type: NotifyEmailRemediationActions Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2639,6 +2858,9 @@ Accept wildcard characters: False ``` ### -NotifyEndpointUser + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. {{ Fill NotifyEndpointUser Description }} @@ -2649,7 +2871,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2659,13 +2880,15 @@ Accept wildcard characters: False ``` ### -NotifyOverrideRequirements + +> Applicable: Security & Compliance + {{ Fill NotifyOverrideRequirements Description }} ```yaml Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2675,13 +2898,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomDialog + +> Applicable: Security & Compliance + {{ Fill NotifyPolicyTipCustomDialog Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2691,13 +2916,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomText + +> Applicable: Security & Compliance + The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2707,6 +2934,9 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomTextTranslations + +> Applicable: Security & Compliance + The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax `CultureCode:Text`. Valid culture codes are supported values from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -2717,7 +2947,6 @@ To enter multiple values, use the following syntax: `"Value1","Value2",..."Value Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2727,6 +2956,9 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipDisplayOption + +> Applicable: Security & Compliance + The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: - Tip: Displays policy tip at the top of the mail. This is the default value. @@ -2736,7 +2968,6 @@ The NotifyPolicyTipDialogOption parameter specifies a display option for the pol Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2746,13 +2977,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipUrl + +> Applicable: Security & Compliance + The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2762,6 +2995,9 @@ Accept wildcard characters: False ``` ### -NotifyUser + +> Applicable: Security & Compliance + The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2775,7 +3011,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2785,6 +3020,9 @@ Accept wildcard characters: False ``` ### -NotifyUserType + +> Applicable: Security & Compliance + The NotifyUserType parameter specifies the type of notification that's used for the rule. Valid values are: - NotSet @@ -2796,7 +3034,6 @@ The NotifyUserType parameter specifies the type of notification that's used for Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.NotifyUserType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2806,13 +3043,15 @@ Accept wildcard characters: False ``` ### -OnPremisesScannerDlpRestrictions + +> Applicable: Security & Compliance + {{ Fill OnPremisesScannerDlpRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2822,6 +3061,9 @@ Accept wildcard characters: False ``` ### -PrependSubject + +> Applicable: Security & Compliance + The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is text that you specify. If the text contains spaces, enclose the value in quotation marks ("). Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. @@ -2832,7 +3074,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2842,6 +3083,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: @@ -2856,7 +3100,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2866,6 +3109,9 @@ Accept wildcard characters: False ``` ### -ProcessingLimitExceeded + +> Applicable: Security & Compliance + The ProcessingLimitExceeded parameter specifies a condition for the DLP rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -2875,7 +3121,6 @@ The ProcessingLimitExceeded parameter specifies a condition for the DLP rule tha Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2885,6 +3130,9 @@ Accept wildcard characters: False ``` ### -Quarantine + +> Applicable: Security & Compliance + This parameter specifies an action or part of an action for the rule. The Quarantine parameter specifies an action that quarantines messages. Valid values are: @@ -2896,7 +3144,6 @@ The Quarantine parameter specifies an action that quarantines messages. Valid va Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2906,6 +3153,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeContainsWords + +> Applicable: Security & Compliance + The RecipientADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: - City @@ -2946,7 +3196,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2956,6 +3205,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The RecipientADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -2996,7 +3248,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3006,6 +3257,9 @@ Accept wildcard characters: False ``` ### -RecipientCountOver + +> Applicable: Security & Compliance + The RecipientCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipients is greater than the specified value. Groups are counted as one recipient. You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. @@ -3014,7 +3268,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. In Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3024,13 +3277,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Security & Compliance + The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3040,6 +3295,9 @@ Accept wildcard characters: False ``` ### -RedirectMessageTo + +> Applicable: Security & Compliance + The RedirectMessageTo parameter specifies an action for the DLP rule that redirects the message to the specified email address. You can specify multiple values separated by commas. You can use this action in DLP policies that are scoped only to Exchange. @@ -3048,7 +3306,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3058,6 +3315,9 @@ Accept wildcard characters: False ``` ### -RemoveHeader + +> Applicable: Security & Compliance + The RemoveHeader parameter specifies an action for the DLP rule that removes a header field from the message header. This parameter uses the syntax `HeaderName` or `"HeaderName:HeaderValue"`.You can specify multiple header names or header name and value pairs separated by commas: `HeaderName1,"HeaderName2:HeaderValue2",HeaderName3,..."HeaderNameN:HeaderValueN"`. The maximum header name length is 64 characters, and header names can't contains spaces or colons ( : ). The maximum header value length is 128 characters. @@ -3068,7 +3328,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3078,6 +3337,9 @@ Accept wildcard characters: False ``` ### -RemoveRMSTemplate + +> Applicable: Security & Compliance + The RemoveRMSTemplate parameter specifies an action for the DLP rule that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: - $true: The message and attachments are decrypted. @@ -3089,7 +3351,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3099,6 +3360,9 @@ Accept wildcard characters: False ``` ### -ReportSeverityLevel + +> Applicable: Security & Compliance + The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: - None: You can't select this value if the rule has no actions configured. @@ -3110,7 +3374,6 @@ The ReportSeverityLevel parameter specifies the severity level of the incident r Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3120,13 +3383,15 @@ Accept wildcard characters: False ``` ### -RestrictAccess + +> Applicable: Security & Compliance + {{ Fill RestrictAccess Description }} ```yaml Type: System.Collections.Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3136,13 +3401,15 @@ Accept wildcard characters: False ``` ### -RestrictBrowserAccess + +> Applicable: Security & Compliance + {{ Fill RestrictBrowserAccess Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3152,6 +3419,9 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Security & Compliance + The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - Ignore @@ -3162,7 +3432,6 @@ The RuleErrorAction parameter specifies what to do if an error is encountered du Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3172,6 +3441,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeContainsWords + +> Applicable: Security & Compliance + The SenderADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: - City @@ -3212,7 +3484,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3222,6 +3493,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -3262,7 +3536,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3272,6 +3545,9 @@ Accept wildcard characters: False ``` ### -SenderAddressLocation + +> Applicable: Security & Compliance + The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: - Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. @@ -3290,7 +3566,6 @@ Note that message envelope searching is available only for the following conditi Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicySenderAddressLocation Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3300,6 +3575,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Security & Compliance + The SenderDomainIs parameter specifies a condition for the DLP rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3308,7 +3586,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3318,6 +3595,9 @@ Accept wildcard characters: False ``` ### -SenderIPRanges + +> Applicable: Security & Compliance + The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -3330,7 +3610,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3340,6 +3619,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + The SentTo parameter specifies a condition for the DLP rule that looks for recipients in messages. You identify the recipients by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3348,7 +3630,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3358,6 +3639,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Security & Compliance + The SentToMemberOf parameter specifies a condition for the DLP rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3366,7 +3650,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3376,6 +3659,9 @@ Accept wildcard characters: False ``` ### -SetHeader + +> Applicable: Security & Compliance + The SetHeader parameter specifies an action for the DLP rule that adds or modifies a header field and value in the message header. This parameter uses the syntax `"HeaderName:HeaderValue"`. You can specify multiple header name and value pairs separated by commas: `"HeaderName1:HeaderValue1",HeaderName2:HeaderValue2",..."HeaderNameN:HeaderValueN"`. The maximum header name length is 64 characters, and header names can't contains spaces or colons ( : ). The maximum header value length is 128 characters. @@ -3386,7 +3672,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3396,6 +3681,9 @@ Accept wildcard characters: False ``` ### -SharedByIRMUserRisk + +> Applicable: Security & Compliance + The SharedByIRMUserRisk parameter specifies the risk category of the user performing the violating action. Valid values are: - FCB9FA93-6269-4ACF-A756-832E79B36A2A (Elevated Risk Level) @@ -3408,7 +3696,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3418,6 +3705,9 @@ Accept wildcard characters: False ``` ### -StopPolicyProcessing + +> Applicable: Security & Compliance + The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: - $true: Stop processing more rules. @@ -3427,7 +3717,6 @@ The StopPolicyProcessing parameter specifies an action that stops processing mor Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3437,6 +3726,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Security & Compliance + The SubjectContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in the Subject field of messages. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -3451,7 +3743,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3461,6 +3752,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Security & Compliance + The SubjectMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -3471,7 +3765,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3481,6 +3774,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Security & Compliance + The SubjectOrBodyContainsWords parameter specifies a condition for the rule that looks for words in the Subject field or body of messages. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -3491,7 +3787,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3501,6 +3796,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyMatchesPatterns + +> Applicable: Security & Compliance + The SubjectOrBodyMatchesPatterns parameter specifies a condition for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3509,7 +3807,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3519,13 +3816,15 @@ Accept wildcard characters: False ``` ### -ThirdPartyAppDlpRestrictions + +> Applicable: Security & Compliance + {{ Fill ThirdPartyAppDlpRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3535,13 +3834,15 @@ Accept wildcard characters: False ``` ### -TriggerPowerAutomateFlow + +> Applicable: Security & Compliance + {{ Fill TriggerPowerAutomateFlow Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3551,6 +3852,9 @@ Accept wildcard characters: False ``` ### -UnscannableDocumentExtensionIs + +> Applicable: Security & Compliance + The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -3559,7 +3863,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3569,13 +3872,15 @@ Accept wildcard characters: False ``` ### -ValidateRule + +> Applicable: Security & Compliance + {{ Fill ValidateRule Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3585,13 +3890,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -3601,6 +3908,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Security & Compliance + The WithImportance parameter specifies a condition for the rule that looks for messages with the specified importance level. Valid values are: - Low @@ -3613,7 +3923,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpEdmSchema.md similarity index 95% rename from exchange/exchange-ps/exchange/New-DlpEdmSchema.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpEdmSchema.md index 27c440830a..a4d2cedc0c 100644 --- a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpEdmSchema.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpedmschema applicable: Security & Compliance -title: New-DlpEdmSchema -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpedmschema +schema: 2.0.0 +title: New-DlpEdmSchema --- # New-DlpEdmSchema @@ -44,6 +45,9 @@ This example creates a new DLP EDM schema using the file named edm.xml in the fo ## PARAMETERS ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the DLP EDM schema that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -52,7 +56,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpFingerprint.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpFingerprint.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DlpFingerprint.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpFingerprint.md index cbd457cd29..3acf20af84 100644 --- a/exchange/exchange-ps/exchange/New-DlpFingerprint.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpFingerprint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint applicable: Security & Compliance -title: New-DlpFingerprint -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpfingerprint +schema: 2.0.0 +title: New-DlpFingerprint --- # New-DlpFingerprint @@ -48,6 +49,9 @@ This example creates a new document fingerprint based on the file C:\\My Documen ## PARAMETERS ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the file to use as a document fingerprint. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -56,7 +60,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the document fingerprint. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -91,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -IsExact + +> Applicable: Security & Compliance + {{ Fill IsExact Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -ThresholdConfig + +> Applicable: Security & Compliance + {{ Fill ThresholdConfig Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -133,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpKeywordDictionary.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpKeywordDictionary.md index 10ac021e60..143373bf26 100644 --- a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpKeywordDictionary.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpkeyworddictionary applicable: Security & Compliance -title: New-DlpKeywordDictionary -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpkeyworddictionary +schema: 2.0.0 +title: New-DlpKeywordDictionary --- # New-DlpKeywordDictionary @@ -63,13 +64,15 @@ This example creates a DLP keyword dictionary named Inappropriate Language from ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies descriptive text for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -DoNotPersistKeywords + +> Applicable: Security & Compliance + {{ Fill DoNotPersistKeywords Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF-16. For more information, see the examples in this topic. ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -146,13 +157,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + {{ Fill Organization Description }} ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -162,13 +175,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/New-DlpPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpPolicy.md index 705a5e5e46..6f345ee2f5 100644 --- a/exchange/exchange-ps/exchange/New-DlpPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlppolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-DlpPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlppolicy +schema: 2.0.0 +title: New-DlpPolicy --- # New-DlpPolicy @@ -54,13 +55,15 @@ This example creates a new DLP policy named Contoso PII with the following value ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a descriptive name for the DLP policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Description parameter specifies an optional description for the DLP policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mode parameter specifies the action and notification level of the DLP policy. Valid values for this parameter are: - Audit: The actions specified by the DLP policy aren't enforced when a message matches the conditions specified by the policy, and the Policy Tip isn't displayed to the user. @@ -133,7 +145,6 @@ By default, the value of this parameter is set to Audit when you create a new DL Type: RuleMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Parameters parameter specifies the parameter values that are required by the DLP policy template that you specify using the Template or TemplateData parameters. DLP policy templates 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"...}`. @@ -151,7 +165,6 @@ This parameter uses the syntax: `@{Parameter1="Value1";Parameter2="Value2"...}`. Type: Hashtable Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -161,13 +174,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The State parameter enables or disables the DLP policy. Valid input for this parameter is Enabled or Disabled. By default, a new DLP policy that you create is enabled. If you want to create a disabled DLP policy, specify the value Disabled for this parameter. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -177,13 +192,15 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Template parameter specifies the existing DLP policy template from which you can create a new DLP policy. You can't use the Template and TemplateData parameters in the same command. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -193,6 +210,9 @@ Accept wildcard characters: False ``` ### -TemplateData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TemplateData parameter specifies an external DLP policy template file from which you can create a new DLP policy. You can't use the TemplateData and Template parameters in the same command. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -201,7 +221,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -211,13 +230,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationType.md similarity index 92% rename from exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationType.md index 961c0d2e48..ce313eca7d 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype applicable: Security & Compliance -title: New-DlpSensitiveInformationType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpsensitiveinformationtype +schema: 2.0.0 +title: New-DlpSensitiveInformationType --- # New-DlpSensitiveInformationType @@ -58,6 +59,9 @@ This example creates a new sensitive information type rule named "Contoso Employ ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a name for the sensitive information type rule. The value must be less than 256 characters. The value of this parameter is used in the Policy Tip that's presented to users in Outlook on the web. @@ -66,7 +70,6 @@ The value of this parameter is used in the Policy Tip that's presented to users Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Fingerprints -The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. + +> Applicable: Security & Compliance + +The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-fingerprint) or the Examples section. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the sensitive information type rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Security & Compliance + {{ Fill FileData Description }} ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -133,7 +145,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -IsExact + +> Applicable: Security & Compliance + {{ Fill IsExact Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -159,6 +172,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Security & Compliance + The Locale parameter specifies the language that's associated with the sensitive information type rule. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -169,7 +185,6 @@ You can add additional language translations to the sensitive information type r Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -ThresholdConfig + +> Applicable: Security & Compliance + {{ Fill ThresholdConfig Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -195,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationTypeRulePackage.md similarity index 94% rename from exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md rename to exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationTypeRulePackage.md index ff65bcc045..caee5727d4 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DlpSensitiveInformationTypeRulePackage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage applicable: Security & Compliance -title: New-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpsensitiveinformationtyperulepackage +schema: 2.0.0 +title: New-DlpSensitiveInformationTypeRulePackage --- # New-DlpSensitiveInformationTypeRulePackage @@ -45,6 +46,9 @@ This example imports the sensitive information type rule package C:\\My Document ## PARAMETERS ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the sensitive information type rule package that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -53,7 +57,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -MigrationId + +> Applicable: Security & Compliance + {{ Fill MigrationId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-DynamicDistributionGroup.md similarity index 88% rename from exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-DynamicDistributionGroup.md index 548bcc5965..fa1137e12b 100644 --- a/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-DynamicDistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-dynamicdistributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-DynamicDistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-dynamicdistributiongroup +schema: 2.0.0 +title: New-DynamicDistributionGroup --- # New-DynamicDistributionGroup @@ -106,6 +107,9 @@ This example creates a dynamic distribution group named Washington Management Te ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the dynamic distribution group. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). This value is also used for the DisplayName property if you don't use the DisplayName parameter. @@ -114,7 +118,6 @@ This value is also used for the DisplayName property if you don't use the Displa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -141,7 +147,6 @@ You need to use this parameter when you use any Conditional parameters as part o Type: WellKnownRecipientType Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -151,6 +156,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -170,7 +178,6 @@ The maximum length for the RecipientFilter property is 2048 characters, includin Type: String Parameter Sets: CustomFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -180,6 +187,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -204,7 +214,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -214,6 +223,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -233,7 +245,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,6 +254,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -253,7 +267,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -263,6 +276,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -273,7 +289,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -283,6 +298,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -293,7 +311,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -303,6 +320,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -313,7 +333,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,6 +342,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -333,7 +355,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -343,6 +364,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -353,7 +377,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -363,6 +386,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -373,7 +399,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -383,6 +408,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -393,7 +421,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -403,6 +430,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -413,7 +443,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -423,6 +452,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -433,7 +465,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -443,6 +474,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -453,7 +487,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -463,6 +496,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -473,7 +509,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -483,6 +518,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -493,7 +531,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -503,6 +540,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -513,7 +553,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -523,6 +562,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -533,7 +575,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -543,6 +584,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -553,7 +597,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -563,6 +606,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -573,7 +619,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -583,6 +628,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -593,7 +641,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -603,6 +650,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -612,7 +662,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -622,6 +671,9 @@ Accept wildcard characters: False ``` ### -DirectMembershipOnly + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -630,7 +682,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -640,6 +691,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the dynamic distribution group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -648,7 +702,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -658,6 +711,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -666,7 +722,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -676,6 +731,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -693,7 +751,6 @@ You use this parameter to specify at least one moderator when you set the Modera Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -703,6 +760,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -714,7 +774,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -724,6 +783,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter specifies the organizational unit (OU) where the dynamic distribution group is created. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -743,7 +805,6 @@ If you don't use the RecipientContainer parameter, the location of the dynamic d Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -753,13 +814,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -769,6 +832,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -786,7 +852,6 @@ Note that the RecipientContainer property can't be blank. The group is always li Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -796,6 +861,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -808,7 +876,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -818,13 +885,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/New-EOPProtectionPolicyRule.md similarity index 93% rename from exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-EOPProtectionPolicyRule.md index f070348810..93ddfc0f15 100644 --- a/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: New-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-eopprotectionpolicyrule +schema: 2.0.0 +title: New-EOPProtectionPolicyRule --- # New-EOPProtectionPolicyRule @@ -57,6 +58,9 @@ This example creates the rule for the Standard preset security policy. No restri ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. Since you don't need to create rules other than those used by the Standard preset security policy or the Strict preset security policy, we highly recommend that you use the default rule names for clarity and consistency. @@ -65,7 +69,6 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AntiPhishPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The AntiPhishPolicy parameter specifies the existing anti-phishing policy that's associated with the preset security policy. If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-phishing policy will be one of the following values: @@ -88,7 +94,6 @@ You can find the anti-phishing policy that's used by the Standard or Strict pres Type: AntiPhishPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -HostedContentFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedContentFilterPolicy parameter specifies the existing anti-spam policy that's associated with the preset security policy. If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-spam policy will be one of the following values: @@ -111,7 +119,6 @@ You can find the anti-spam policy that's used by the Standard or Strict preset s Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -MalwareFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedContentFilterPolicy parameter specifies the existing anti-malware policy that's associated with the preset security policy. If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-malware policy will be one of the following values: @@ -134,7 +144,6 @@ You can find the anti-malware policy that's used by the Standard or Strict prese Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -169,7 +183,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -179,6 +192,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the rule is enabled. Valid values are: - $true: The rule is enabled. The State value of the rule is Enabled. This is the default value. @@ -193,7 +209,6 @@ After you create the rule, you turn on or turn off the preset security policy us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,13 +218,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,6 +236,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -234,7 +254,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -244,6 +263,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -261,7 +283,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -271,6 +292,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. @@ -281,7 +305,6 @@ When you create the policy, you must use the default value. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -291,13 +314,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,6 +332,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -322,7 +350,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -332,6 +359,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -349,7 +379,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -359,13 +388,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-EcpVirtualDirectory.md similarity index 89% rename from exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-EcpVirtualDirectory.md index d888a64122..99729e8485 100644 --- a/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-EcpVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-ecpvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-EcpVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-ecpvirtualdirectory +schema: 2.0.0 +title: New-EcpVirtualDirectory --- # New-EcpVirtualDirectory @@ -54,13 +55,15 @@ This example creates the ECP virtual directory on the Exchange server named Serv ## PARAMETERS ### -AppPoolId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AppPoolId parameter sets the IIS application pool where the ECP virtual directory runs. We recommend that you leave this parameter at its default setting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +112,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -117,7 +127,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,6 +136,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -136,7 +148,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -158,7 +172,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +181,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. You need to set this parameter to allow the Autodiscover service to return the URL for the ECP virtual directory. @@ -176,7 +192,6 @@ This setting is important when Secure Sockets Layer (SSL) is used. You need to s Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,6 +201,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is important when SSL is used. You need to set this parameter to allow the Autodiscover service to return the URL for the ECP virtual directory. @@ -194,7 +212,6 @@ This setting is important when SSL is used. You need to set this parameter to al Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Path parameter sets the file system path of the ECP virtual directory. This parameter should be used with care and only when you must use a different file system path than the default. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,6 +239,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -231,7 +253,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +262,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -254,7 +278,6 @@ You can't create an ECP virtual directory remotely. You can only create an ECP v Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +287,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WebSiteName parameter specifies the name of the IIS website where the ECP virtual directory is created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +305,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-EdgeSubscription.md b/exchange/exchange-ps/ExchangePowerShell/New-EdgeSubscription.md similarity index 89% rename from exchange/exchange-ps/exchange/New-EdgeSubscription.md rename to exchange/exchange-ps/ExchangePowerShell/New-EdgeSubscription.md index e7c67b1d70..9df879d76c 100644 --- a/exchange/exchange-ps/exchange/New-EdgeSubscription.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-EdgeSubscription.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-edgesubscription applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-EdgeSubscription -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-edgesubscription +schema: 2.0.0 +title: New-EdgeSubscription --- # New-EdgeSubscription @@ -69,6 +70,9 @@ This example also imports the Edge Subscription file generated in Example 1 to t ## PARAMETERS ### -AccountExpiryDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AccountExpiryDuration parameter specifies how soon the EdgeSync bootstrap replication account (ESBRA) created by this command will expire. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -79,7 +83,6 @@ The value for this parameter must be a minimum of 00:02:00 or 2 minutes. The def Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -CreateInboundSendConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CreateInboundSendConnector parameter specifies whether to create the Send connector to connect the Edge Transport server and the Hub Transport servers. The default value is $true. The Send connector address space is set to "--", the smart hosts are set to "--", the Edge Transport server is set as the source server and Domain Name System (DNS) routing is disabled. This parameter is only used when you run the command on the Hub Transport server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -CreateInternetSendConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CreateInternetSendConnector parameter specifies whether to create the Send connector to connect to the Internet. The default value is $true. The Send connector address space is set to all domains (\*), the Edge Transport server is set as the source server, and DNS routing is enabled. This parameter is only used when you run the command on the Hub Transport server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -148,7 +160,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -158,6 +169,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FileData parameter specifies the byte-encoded data object that contains the Edge Subscription file information. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -168,7 +182,6 @@ You can only use this parameter when you're running the command on a Mailbox ser Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FileName parameter specifies the full path of the Edge Subscription file. You can only use this parameter when you're running this command on an Edge Transport server. @@ -186,7 +202,6 @@ You can only use this parameter when you're running this command on an Edge Tran Type: LongPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,6 +211,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. This switch is useful in the following scenarios: @@ -207,7 +225,6 @@ This switch is useful in the following scenarios: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,13 +234,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Site parameter specifies the name of the Active Directory site that contains the Mailbox servers with which the Edge Transport servers are associated. This parameter is used and required only when you run the command on a Mailbox server. ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,13 +252,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md b/exchange/exchange-ps/ExchangePowerShell/New-EdgeSyncServiceConfig.md similarity index 87% rename from exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/New-EdgeSyncServiceConfig.md index f961f43a6f..a8168f3519 100644 --- a/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-EdgeSyncServiceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-edgesyncserviceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-EdgeSyncServiceConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-edgesyncserviceconfig +schema: 2.0.0 +title: New-EdgeSyncServiceConfig --- # New-EdgeSyncServiceConfig @@ -61,6 +62,9 @@ This example creates EdgeSync service settings with the following configuration: ## PARAMETERS ### -ConfigurationSyncInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConfigurationSyncInterval parameter specifies how frequently the EdgeSync service synchronizes configuration data. The default value is 3 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -69,7 +73,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -CookieValidDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CookieValidDuration parameter specifies how long a cookie record is valid. The default value is 21 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -106,7 +114,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -FailoverDCInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FailoverDCInterval parameter specifies how long EdgeSync waits before failing over to another domain controller if it can't read configuration data from Active Directory. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -140,7 +152,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -LockDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LockDuration parameter specifies how long an instance of the EdgeSync service can maintain an exclusive lock on the synchronization rights. While an EdgeSync service maintains an exclusive lock on synchronization rights, no other EdgeSync service can take over synchronization. The default value is 6 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -158,7 +172,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +181,9 @@ Accept wildcard characters: False ``` ### -LockRenewalDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LockRenewalDuration parameter specifies how long before the expiry of an exclusive lock an EdgeSync service can renew the lock. The default value is 4 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -176,7 +192,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -LogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogEnabled parameter enables or disables the EdgeSync log. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +219,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogLevel parameter specifies the EdgeSync logging level. Valid values are: - None (This is the default value) @@ -213,7 +233,6 @@ The LogLevel parameter specifies the EdgeSync logging level. Valid values are: Type: EdgeSyncLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -223,6 +242,9 @@ Accept wildcard characters: False ``` ### -LogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogMaxAge parameter specifies the maximum duration in days to keep the EdgeSyncLog files. Log files older than the specified value can be overwritten. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -231,7 +253,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +262,9 @@ Accept wildcard characters: False ``` ### -LogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogMaxDirectorySize parameter specifies the maximum amount of disk space the EdgeSyncLog directory can use. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -259,7 +283,6 @@ The value of the LogMaxFileSize parameter must be less than or equal to the valu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -269,6 +292,9 @@ Accept wildcard characters: False ``` ### -LogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogMaxFileSize parameter specifies the maximum log file size for the EdgeSyncLog files. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -287,7 +313,6 @@ The value of the LogMaxFileSize parameter must be less than or equal to the valu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,13 +322,15 @@ Accept wildcard characters: False ``` ### -LogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogPath parameter specifies the default location for the EdgeSyncLog files. The default value is TransportRoles\\Logs\\EdgeSync\\. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,6 +340,9 @@ Accept wildcard characters: False ``` ### -OptionDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OptionDuration parameter specifies how long an instance of the EdgeSync service can maintain an optional lock on synchronization rights. While an EdgeSync service maintains an optional lock on synchronization rights, another EdgeSync service can take over synchronization after the optional lock has expired if it's initiated using the Start-EdgeSynchronization command. The default value is 30 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -321,7 +351,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -331,6 +360,9 @@ Accept wildcard characters: False ``` ### -RecipientSyncInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecipientSyncInterval parameter specifies how frequently the EdgeSync service synchronizes recipient data from the global catalog. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -339,7 +371,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -349,13 +380,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Site parameter specifies the Active Directory site that EdgeSync connects to for synchronizing configuration and recipient data. ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -365,13 +398,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-EmailAddressPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/New-EmailAddressPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-EmailAddressPolicy.md index 966babe33d..6b5b760e67 100644 --- a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-EmailAddressPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-emailaddresspolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-EmailAddressPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-emailaddresspolicy +schema: 2.0.0 +title: New-EmailAddressPolicy --- # New-EmailAddressPolicy @@ -173,13 +174,15 @@ This example creates an email address policy in an on-premises Exchange organiza ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name of the email address policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -189,6 +192,9 @@ Accept wildcard characters: False ``` ### -EnabledEmailAddressTemplates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EnabledEmailAddressTemplates parameter specifies the rules in the email address policy that are used to generate email addresses for recipients. Valid syntax for this parameter is `Type:AddressFormat`: @@ -208,7 +214,6 @@ In Exchange Online PowerShell, you can't use variables in the email address temp Type: ProxyAddressTemplateCollection Parameter Sets: AllTemplatesWithPrecannedFilter, AllTemplatesWithCustomFilter, AllTemplatesForUnifiedGroupRecipientsFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -218,6 +223,9 @@ Accept wildcard characters: False ``` ### -EnabledPrimarySMTPAddressTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EnabledPrimarySMTPAddressTemplate parameter specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. @@ -230,7 +238,6 @@ In Exchange Online PowerShell, you can't use variables in the email address temp Type: String Parameter Sets: SMTPTemplateWithPrecannedFilter, SMTPTemplateWithCustomFilter, SMTPTemplateForUnifiedGroupRecipientsFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -240,6 +247,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: @@ -259,7 +269,6 @@ You need to use this parameter when you use any Conditional parameters as part o Type: WellKnownRecipientType Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -269,6 +278,9 @@ Accept wildcard characters: False ``` ### -IncludeUnifiedGroupRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IncludeUnifiedGroupRecipients switch specifies that the email address policy applies only to Microsoft 365 Groups. You don't need to specify a value with this switch. @@ -279,7 +291,6 @@ In Exchange Online PowerShell, you always need to use this switch, because email Type: SwitchParameter Parameter Sets: AllTemplatesForUnifiedGroupRecipientsFilter, SMTPTemplateForUnifiedGroupRecipientsFilter Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -289,6 +300,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. @@ -308,7 +322,6 @@ You can't use this parameter in combination with the IncludedRecipients paramete Type: String Parameter Sets: AllTemplatesWithCustomFilter, SMTPTemplateWithCustomFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -318,6 +331,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. You can specify multiple values separated by commas. @@ -330,7 +346,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,6 +355,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. @@ -352,7 +370,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -362,6 +379,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. @@ -374,7 +394,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -384,6 +403,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. @@ -396,7 +418,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,6 +427,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. @@ -418,7 +442,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -428,6 +451,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. @@ -440,7 +466,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -450,6 +475,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. @@ -462,7 +490,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -472,6 +499,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. @@ -484,7 +514,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -494,6 +523,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. @@ -506,7 +538,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -516,6 +547,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. @@ -528,7 +562,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -538,6 +571,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. @@ -550,7 +586,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -560,6 +595,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. @@ -572,7 +610,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -582,6 +619,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. @@ -594,7 +634,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -604,6 +643,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. @@ -616,7 +658,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -626,6 +667,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. @@ -638,7 +682,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -648,6 +691,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. @@ -660,7 +706,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -670,6 +715,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. @@ -682,7 +730,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -692,6 +739,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. @@ -704,7 +754,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: AllTemplatesWithPrecannedFilter, SMTPTemplateWithPrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -714,6 +763,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -723,7 +775,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -733,6 +784,9 @@ Accept wildcard characters: False ``` ### -DisabledEmailAddressTemplates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DisabledEmailAddressTemplates parameter specifies the proxy email addresses templates that are included in an email address policy, but aren't used to configure the email addresses of recipients. @@ -748,7 +802,6 @@ You can specify multiple disabled email address templates separated by commas: ` Type: ProxyAddressTemplateCollection Parameter Sets: AllTemplatesWithPrecannedFilter, AllTemplatesWithCustomFilter, AllTemplatesForUnifiedGroupRecipientsFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -758,6 +811,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -766,7 +822,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -776,6 +831,9 @@ Accept wildcard characters: False ``` ### -ManagedByFilter + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ManagedByFilter parameter specifies the email address policies to apply to Microsoft 365 Groups based on the properties of the users who create the Microsoft 365 Groups. @@ -798,7 +856,6 @@ You can only use this parameter in Exchange Online PowerShell with the IncludeUn Type: String Parameter Sets: AllTemplatesForUnifiedGroupRecipientsFilter, SMTPTemplateForUnifiedGroupRecipientsFilter Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -808,6 +865,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Priority parameter specifies the order that the email address policies are evaluated. By default, every time that you add a new email address policy, the policy is assigned a priority of N+1, where N is the number of email address policies that you've created. If you set this parameter to a value that's the same as another email address policy, the priority of the policy that you added first is incremented by 1. @@ -818,7 +878,6 @@ If you set this parameter to a value that's the same as another email address po Type: EmailAddressPolicyPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -828,6 +887,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -843,7 +905,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -853,13 +914,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/New-ExchangeCertificate.md similarity index 92% rename from exchange/exchange-ps/exchange/New-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/New-ExchangeCertificate.md index 5d957d9ce7..365938a134 100644 --- a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ExchangeCertificate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-exchangecertificate +schema: 2.0.0 +title: New-ExchangeCertificate --- # New-ExchangeCertificate @@ -180,6 +181,9 @@ This example creates a new DER encoded (binary) certificate renewal request file ## PARAMETERS ### -BinaryEncoded + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BinaryEncoded switch specifies whether to encode the new certificate request by using Distinguished Encoding Rules (DER). You don't need to specify a value with this switch. If you don't use this switch, the request is Base64 encoded. @@ -192,7 +196,6 @@ For Base64 encoded requests, you send the contents of the file to the certificat Type: SwitchParameter Parameter Sets: Request Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +205,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -211,7 +217,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -221,6 +226,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -229,7 +237,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,6 +246,9 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainName parameter specifies one or more FQDNs or server names for theSubject Alternative Name field (also known as the Subject Alt Name or SAN field) of the certificate request or self-signed certificate. If the value in the certificate's Subject field doesn't match the destination server name or FQDN, the requestor looks for a match in the Subject Alternative Name field. @@ -254,7 +264,6 @@ The default value includes the name and FQDN of the Exchange server when both of Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,6 +273,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. By default, when you create a self-signed certificate that's enabled for SMTP (no Services parameter, or the Services parameter contains the value SMTP), you're prompted to replace the existing default SMTP certificate with the new one that you're creating. If you use the Force switch, the new SMTP certificate automatically replaces the existing SMTP certificate without asking. @@ -272,7 +284,6 @@ By default, when you create a self-signed certificate that's enabled for SMTP (n Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -282,6 +293,9 @@ Accept wildcard characters: False ``` ### -FriendlyName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FriendlyName parameter specifies a friendly name for the certificate request or self-signed certificate. The value must be less than 64 characters. The default value is Microsoft Exchange. The friendly name value is descriptive text, and doesn't affect the functionality of the certificate. @@ -290,7 +304,6 @@ The default value is Microsoft Exchange. The friendly name value is descriptive Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,6 +313,9 @@ Accept wildcard characters: False ``` ### -GenerateRequest + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GenerateRequest switch specifies that you're creating a certificate request for a certification authority (CA). You don't need to specify a value with this switch. Using this switch and exporting the output to a file generates a PKCS #10 certificate request that you send to the CA. How you send the information depends on the CA, but typically, for Base64 encoded requests, you paste the contents in an email message or in the request form on the CA's web site. @@ -312,7 +328,6 @@ If you don't use this switch, the command creates a new self-signed certificate Type: SwitchParameter Parameter Sets: Request Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,6 +337,9 @@ Accept wildcard characters: False ``` ### -IncludeAcceptedDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeAcceptedDomains switch specifies that all accepted domains in the Exchange organization are included in the Subject Alternative Name field of the certificate request or self-signed certificate. You don't need to specify a value with this switch. When you use this switch: @@ -333,7 +351,6 @@ When you use this switch: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -343,6 +360,9 @@ Accept wildcard characters: False ``` ### -IncludeAutoDiscover + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeAutoDiscover switch specifies whether to add a Subject Alternative Namevalue with the prefix autodiscover for each accepted domain in the Exchange organization. You don't need to specify a value with this switch. For example, if the organization has the accepted domains woodgrovebank.com and woodgrovebank.co.uk, using this switch results in the addition of the following values in the Subject Alternative Name field: @@ -359,7 +379,6 @@ When you use this switch: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -369,6 +388,9 @@ Accept wildcard characters: False ``` ### -IncludeServerFQDN + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeServerFQDN switch specifies that the FQDN of the Exchange server is included in the Subject Alternative Name field of the new certificate request or self-signed certificate. You don't need to specify a value with this switch. When you use this switch, and you've already included the server's FQDN in the DomainName parameter, the value isn't duplicated in the Subject Alternative Name field. @@ -377,7 +399,6 @@ When you use this switch, and you've already included the server's FQDN in the D Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -387,6 +408,9 @@ Accept wildcard characters: False ``` ### -IncludeServerNetBIOSName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeServerNetBIOSName switch specifies that the NetBIOS name of the Exchange server is included in the Subject Alternative Name field of the new certificate request or self-signed certificate. You don't need to specify a value with this switch When you use this switch, and you've already included the server's NetBIOS name in the DomainName parameter, the value isn't duplicated in the Subject Alternative Name field. @@ -395,7 +419,6 @@ When you use this switch, and you've already included the server's NetBIOS name Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -405,13 +428,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: X509Certificate2 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -421,6 +446,9 @@ Accept wildcard characters: False ``` ### -KeySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The KeySize parameter specifies the size (in bits) of the RSA public key that's associated with the new certificate request or self-signed certificate. Valid values are: - 1024 @@ -431,7 +459,6 @@ The KeySize parameter specifies the size (in bits) of the RSA public key that's Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -441,6 +468,9 @@ Accept wildcard characters: False ``` ### -PrivateKeyExportable + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PrivateKeyExportable parameter specifies whether the certificate has an exportable private key, and controls whether you can export the certificate from the server (and import the certificate on other servers). Valid values are: - $true: The private key is exportable, so you can export the certificate from the server. @@ -450,7 +480,6 @@ The PrivateKeyExportable parameter specifies whether the certificate has an expo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -460,6 +489,9 @@ Accept wildcard characters: False ``` ### -RequestFile + +> Applicable: Exchange Server 2013 + **Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To export the certificate request to a file without using the RequestFile parameter, see Example 4 and Example 5 (new) or Example 7 and Example 8 (renew). This parameter is available only in Exchange 2013. @@ -474,7 +506,6 @@ You can use this parameter only when you use the GenerateRequest switch. Type: String Parameter Sets: Request Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -484,6 +515,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -497,7 +531,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -507,6 +540,9 @@ Accept wildcard characters: False ``` ### -Services + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Services parameter specifies the Exchange services that the new self-signed certificate is enabled for. Valid values are: - None: You can enable the certificate for Exchange services later by using the Enable-ExchangeCertificate cmdlet. @@ -528,7 +564,6 @@ Once you enable a certificate for a service, you can't remove the service from t Type: AllowedServices Parameter Sets: Certificate Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -538,13 +573,15 @@ Accept wildcard characters: False ``` ### -SubjectKeyIdentifier + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SubjectKeyIdentifier parameter specifies the unique subject key identifier for a newself-signed certificate. For example, run the command: $ski = [System.Guid]::NewGuid().ToString("N"), and use the value $ski for this parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -554,6 +591,9 @@ Accept wildcard characters: False ``` ### -SubjectName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SubjectName parameter specifies the Subject field of the certificate request or self-signed certificate. Every certificate requires a value for the Subject field, and only one value is allowed. The requestor attempts to match the destination server name or FQDN with the common name (CN) value of subject. @@ -576,7 +616,6 @@ For a wildcard certificate, use a SubjectName value that contains the wildcard c Type: X500DistinguishedName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -586,13 +625,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ExchangeSettings.md b/exchange/exchange-ps/ExchangePowerShell/New-ExchangeSettings.md similarity index 92% rename from exchange/exchange-ps/exchange/New-ExchangeSettings.md rename to exchange/exchange-ps/ExchangePowerShell/New-ExchangeSettings.md index abedc962ae..a39cde59db 100644 --- a/exchange/exchange-ps/exchange/New-ExchangeSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ExchangeSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-exchangesettings applicable: Exchange Server 2016, Exchange Server 2019 -title: New-ExchangeSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-exchangesettings +schema: 2.0.0 +title: New-ExchangeSettings --- # New-ExchangeSettings @@ -44,6 +45,9 @@ This example creates a new Exchange settings object for the Audit configuration ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of a valid Exchange configuration schema that you want to create an Exchange settings object for. Valid values are - ADDriver @@ -60,7 +64,6 @@ The Name parameter specifies the name of a valid Exchange configuration schema t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +112,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -113,7 +123,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ExoPhishSimOverrideRule.md similarity index 95% rename from exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ExoPhishSimOverrideRule.md index c126bc6fbf..1c3e6a1a8f 100644 --- a/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ExoPhishSimOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-exophishsimoverriderule applicable: Exchange Online -title: New-ExoPhishSimOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-exophishsimoverriderule +schema: 2.0.0 +title: New-ExoPhishSimOverrideRule --- # New-ExoPhishSimOverrideRule @@ -47,6 +48,9 @@ This example creates a new phishing simulation override rule with the specified ## PARAMETERS ### -Policy + +> Applicable: Exchange Online + The Policy parameter specifies the phishing simulation override policy that's associated with the rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -58,7 +62,6 @@ The Policy parameter specifies the phishing simulation override policy that's as Type: PolicyIdParameter Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -SenderIpRanges + +> Applicable: Exchange Online + The SenderIpRanges parameter specifies the source IP address that's used by the non-Microsoft phishing simulation. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -82,7 +88,6 @@ A phishing simulation entry requires at least one IP address in this parameter a Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -117,7 +127,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -Domains + +> Applicable: Exchange Online + The Domains parameter specifies the email domain that's used by the non-Microsoft phishing simulation. You can use either of the following values: - The `5321.MailFrom` address (also known as the MAIL FROM address, P1 sender, or envelope sender). @@ -156,7 +170,6 @@ A phishing simulation requires at least one domain from this parameter and at le Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the name for the policy. Regardless of the value you specify, the name will be `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -182,13 +197,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ExoSecOpsOverrideRule.md similarity index 93% rename from exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ExoSecOpsOverrideRule.md index e962547317..919af1904f 100644 --- a/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ExoSecOpsOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-exosecopsoverriderule applicable: Exchange Online -title: New-ExoSecOpsOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-exosecopsoverriderule +schema: 2.0.0 +title: New-ExoSecOpsOverrideRule --- # New-ExoSecOpsOverrideRule @@ -46,6 +47,9 @@ This example creates the SecOps mailbox override rule with the specified setting ## PARAMETERS ### -Policy + +> Applicable: Exchange Online + The Policy parameter specifies the phishing simulation override policy that's associated with the rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Policy parameter specifies the phishing simulation override policy that's as Type: PolicyIdParameter Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the name for the policy. Regardless of the value you specify, the name will be `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977ef). ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -131,13 +142,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-FeatureConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/New-FeatureConfiguration.md similarity index 95% rename from exchange/exchange-ps/exchange/New-FeatureConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/New-FeatureConfiguration.md index 2f093ab5f4..bb04d6b1e3 100644 --- a/exchange/exchange-ps/exchange/New-FeatureConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FeatureConfiguration.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-featureconfiguration applicable: Security & Compliance -title: New-FeatureConfiguration +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-featureconfiguration schema: 2.0.0 +title: New-FeatureConfiguration --- # New-FeatureConfiguration @@ -71,13 +73,15 @@ This example creates a disabled collection policy named "Scoped collection polic ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the feature configuration. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -87,6 +91,9 @@ Accept wildcard characters: False ``` ### -FeatureScenario + +> Applicable: Security & Compliance + The FeatureScenario parameter specifies the scenario for the feature configuration. Currently, the only valid values are: - `KnowYourData` for collection policies - `TrustContainer` for Endpoint DLP trust container @@ -95,7 +102,6 @@ The FeatureScenario parameter specifies the scenario for the feature configurati Type: PolicyScenario Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -105,6 +111,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Security & Compliance + The Mode parameter specifies feature configuration mode. Valid values are: - Enable: The feature configuration is enabled. @@ -114,7 +123,6 @@ The Mode parameter specifies feature configuration mode. Valid values are: Type: PolicyMode Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -124,13 +132,15 @@ Accept wildcard characters: False ``` ### -ScenarioConfig + +> Applicable: Security & Compliance + The ScenarioConfig parameter specifies additional information about the feature configuration. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -140,13 +150,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -156,6 +168,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -165,7 +180,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -175,13 +189,15 @@ Accept wildcard characters: False ``` ### -Locations + +> Applicable: Security & Compliance + The locations parameter specifies where the feature configuration applies. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -191,13 +207,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-FederationTrust.md b/exchange/exchange-ps/ExchangePowerShell/New-FederationTrust.md similarity index 88% rename from exchange/exchange-ps/exchange/New-FederationTrust.md rename to exchange/exchange-ps/ExchangePowerShell/New-FederationTrust.md index b1f50c5c62..1ef2e0094b 100644 --- a/exchange/exchange-ps/exchange/New-FederationTrust.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FederationTrust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-federationtrust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-FederationTrust -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-federationtrust +schema: 2.0.0 +title: New-FederationTrust --- # New-FederationTrust @@ -64,13 +65,15 @@ This example creates the federation trust Microsoft Federation Gateway with a ce ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a friendly name for the federation trust. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -ApplicationUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ApplicationUri parameter specifies the primary domain used for the federated organization identifier. If you specify the ApplicationUri parameter, you must use the SkipNamespaceProviderProvisioning switch and also specify the AdministratorProvisioningId and ApplicationIdentifier parameters. @@ -88,7 +94,6 @@ If you specify the ApplicationUri parameter, you must use the SkipNamespaceProvi Type: String Parameter Sets: SkipNamespaceProviderProvisioning Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -SkipNamespaceProviderProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipNamespaceProviderProvisioning switch specifies that the trust and federated organization identifier are provisioned externally without using federation functionality in Microsoft Exchange. You don't need to specify a value with this switch. If you use this switch, you must specify the ApplicationIdentifier, ApplicationUri and AdministratorProvisioningId parameters. @@ -106,7 +114,6 @@ If you use this switch, you must specify the ApplicationIdentifier, ApplicationU Type: SwitchParameter Parameter Sets: SkipNamespaceProviderProvisioning Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Thumbprint parameter specifies the thumbprint of a certificate issued by a public certification authority (CA) trusted by the Microsoft Federation Gateway. For more details, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -AdministratorProvisioningId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AdministratorProvisioningId parameter specifies the provisioning key returned by the Microsoft Federation Gateway when an organization has already registered a SiteID or ApplicationID. If you specify the AdministratorProvisioningId parameter, you must use the SkipNamespaceProviderProvisioning switch and also specify the ApplicationIdentifier and ApplicationUri parameters. @@ -140,7 +152,6 @@ If you specify the AdministratorProvisioningId parameter, you must use the SkipN Type: String Parameter Sets: SkipNamespaceProviderProvisioning Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -ApplicationIdentifier + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ApplicationIdentifier parameter specifies the SiteID or ApplicationID when an organization has already registered a SiteID or ApplicationID. If you specify the ApplicationIdentifier parameter, you must use the SkipNamespaceProviderProvisioning switch and also specify the AdministratorProvisioningId and ApplicationUri parameters. @@ -158,7 +172,6 @@ If you specify the ApplicationIdentifier parameter, you must use the SkipNamespa Type: String Parameter Sets: SkipNamespaceProviderProvisioning Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +181,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -177,7 +193,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,13 +202,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,13 +220,15 @@ Accept wildcard characters: False ``` ### -MetadataUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MetadataUrl parameter specifies the URL where WS-FederationMetadata is published by the Microsoft Federation Gateway. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -SuppressDnsWarning + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The SuppressDNSWarning switch specifies whether to display the DNS warning message for creating TXT records in your public DNS when running the New-FederationTrust cmdlet. You don't need to specify a value with this switch. @@ -229,7 +251,6 @@ This switch is used automatically by the Hybrid Configuration wizard. We don't r Type: SwitchParameter Parameter Sets: FederationTrust Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -239,6 +260,9 @@ Accept wildcard characters: False ``` ### -UseLegacyProvisioningService + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UseLegacyProvisioningService switch specifies that the legacy interface on the Microsoft Federation Gateway is used for managing the federation trust, including federated domains, certificates, and federation metadata. You don't need to specify a value with this switch. When using a self-signed certificate for configuring a federation trust with the Microsoft Federation Gateway, the trust needs to be created using this switch. After the federation trust is created, this behavior can't be changed and requires the deletion and re-creation of the federation trust. @@ -247,7 +271,6 @@ When using a self-signed certificate for configuring a federation trust with the Type: SwitchParameter Parameter Sets: FederationTrust Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,13 +280,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyAuthority.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyAuthority.md index 4d11d7b876..08dece03d0 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyAuthority.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertyauthority applicable: Security & Compliance -title: New-FilePlanPropertyAuthority +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertyauthority schema: 2.0.0 +title: New-FilePlanPropertyAuthority --- # New-FilePlanPropertyAuthority @@ -39,13 +41,15 @@ This example creates a new file plan property authority named Contoso Authority. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property authority. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,6 +59,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -64,7 +71,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +80,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCategory.md index acdefd1244..4f7f68b402 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertycategor applicable: Security & Compliance -title: New-FilePlanPropertyCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertycategor schema: 2.0.0 +title: New-FilePlanPropertyCategory --- # New-FilePlanPropertyCategory @@ -39,13 +41,15 @@ This example creates a new file plan property category named Contoso Category. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property category. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,6 +59,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -64,7 +71,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +80,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCitation.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCitation.md index 80625e0af9..aa14c036c8 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyCitation.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertycitation applicable: Security & Compliance -title: New-FilePlanPropertyCitation +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertycitation schema: 2.0.0 +title: New-FilePlanPropertyCitation --- # New-FilePlanPropertyCitation @@ -39,13 +41,15 @@ This example creates a new file plan property citation named Contoso-0001. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property citation. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,13 +59,15 @@ Accept wildcard characters: False ``` ### -CitationUrl + +> Applicable: Security & Compliance + The CitationJurisdiction parameter specifies the jurisdiction for the file plan property citation. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -71,13 +77,15 @@ Accept wildcard characters: False ``` ### -CitationJurisdiction + +> Applicable: Security & Compliance + The CitationJurisdiction parameter specifies the URL for the file plan property citation. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 2 @@ -87,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -96,7 +107,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -106,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyDepartment.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyDepartment.md index 8d084f8c09..99d970af33 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyDepartment.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertydepartment applicable: Security & Compliance -title: New-FilePlanPropertyDepartment +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertydepartment schema: 2.0.0 +title: New-FilePlanPropertyDepartment --- # New-FilePlanPropertyDepartment @@ -39,13 +41,15 @@ This example creates a new file plan property department named Contoso HR. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property department. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,6 +59,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -64,7 +71,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +80,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyReferenceId.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyReferenceId.md index f32d9f3ac4..81702c562c 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertyReferenceId.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertyreferenceid applicable: Security & Compliance -title: New-FilePlanPropertyReferenceId +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertyreferenceid schema: 2.0.0 +title: New-FilePlanPropertyReferenceId --- # New-FilePlanPropertyReferenceId @@ -39,13 +41,15 @@ This example creates a new file plan property reference ID named Contoso-0001. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property reference ID. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,6 +59,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -64,7 +71,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +80,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertySubCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md rename to exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertySubCategory.md index ceff1b7f3e..2488a54aa6 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-FilePlanPropertySubCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertysubcategory applicable: Security & Compliance -title: New-FilePlanPropertySubCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fileplanpropertysubcategory schema: 2.0.0 +title: New-FilePlanPropertySubCategory --- # New-FilePlanPropertySubCategory @@ -39,13 +41,15 @@ This example creates a new file plan property subcategory named US Tax that's a ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the file plan property subcategory. The maximum length is 64 characters. If the value includes spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -55,6 +59,9 @@ Accept wildcard characters: False ``` ### -ParentId + +> Applicable: Security & Compliance + The ParentId parameter specifies parent file plan property category for this subcategory. You can use any value that uniquely identifies the parent category. For example: - Name @@ -65,7 +72,6 @@ The ParentId parameter specifies parent file plan property category for this sub Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -75,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -84,7 +93,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-Fingerprint.md b/exchange/exchange-ps/ExchangePowerShell/New-Fingerprint.md similarity index 90% rename from exchange/exchange-ps/exchange/New-Fingerprint.md rename to exchange/exchange-ps/ExchangePowerShell/New-Fingerprint.md index b2d1f80558..f72b4bc2e4 100644 --- a/exchange/exchange-ps/exchange/New-Fingerprint.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-Fingerprint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-fingerprint applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-Fingerprint -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-fingerprint +schema: 2.0.0 +title: New-Fingerprint --- # New-Fingerprint @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -**Note**: In Exchange Online, this cmdlet has been replaced by the [New-DlpFingerPrint](https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint) cmdlet in Security & Compliance PowerShell. +**Note**: In Exchange Online, this cmdlet has been replaced by the [New-DlpFingerPrint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpfingerprint) cmdlet in Security & Compliance PowerShell. Use the New-Fingerprint cmdlet to create document fingerprints that are used with data classification rules. Because the results of New-Fingerprint are not stored outside of the data classification rule, you always run New-Fingerprint and New-DataClassification or Set-DataClassification in the same PowerShell session. @@ -48,6 +49,9 @@ This example creates a new document fingerprint based on the file C:\\My Documen ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FileData parameter specifies the file to use as a document fingerprint. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -56,7 +60,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Description parameter specifies a description for the document fingerprint. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -91,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ForeignConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-ForeignConnector.md similarity index 91% rename from exchange/exchange-ps/exchange/New-ForeignConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-ForeignConnector.md index 354a0c1d76..38a27b3040 100644 --- a/exchange/exchange-ps/exchange/New-ForeignConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ForeignConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-foreignconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ForeignConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-foreignconnector +schema: 2.0.0 +title: New-ForeignConnector --- # New-ForeignConnector @@ -53,13 +54,15 @@ This example creates a Foreign connector with the following properties: ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name for the Foreign connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. - AddressSpaceType: The address space type may be SMTP, X400, or any other text string. If you omit the address space type, an SMTP address space type is assumed. @@ -88,7 +94,6 @@ You may specify multiple address spaces by separating the address spaces with co Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -107,7 +115,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -125,7 +135,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. When the value of this parameter is $false, the connector can be used by all Mailbox servers in the Exchange organization. When the value of this parameter is $true, the connector can be used only by Mailbox servers in the same Active Directory site. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceTransportServers parameter specifies the names of the Mailbox servers that use this Foreign connector. Having a single Foreign connector homed on multiple servers provides fault tolerance and high availability if one of the Mailbox servers fails. The default value of this parameter is the name of the server on which this Foreign connector is first installed. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -159,7 +173,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,13 +182,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-GlobalAddressList.md b/exchange/exchange-ps/ExchangePowerShell/New-GlobalAddressList.md similarity index 89% rename from exchange/exchange-ps/exchange/New-GlobalAddressList.md rename to exchange/exchange-ps/ExchangePowerShell/New-GlobalAddressList.md index 990ae4ba24..a51e891a50 100644 --- a/exchange/exchange-ps/exchange/New-GlobalAddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-GlobalAddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-globaladdresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-GlobalAddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-globaladdresslist +schema: 2.0.0 +title: New-GlobalAddressList --- # New-GlobalAddressList @@ -90,13 +91,15 @@ This example creates the GAL named GAL\_AgencyB by using the RecipientFilter par ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a unique name for the global address list. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -123,7 +129,6 @@ You need to use this parameter when you use any Conditional parameters as part o Type: WellKnownRecipientType Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -133,6 +138,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -150,7 +158,6 @@ You can't use this parameter in combination with the IncludedRecipients paramete Type: String Parameter Sets: CustomFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -160,6 +167,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -170,7 +180,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +189,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -190,7 +202,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -200,6 +211,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -210,7 +224,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -220,6 +233,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -230,7 +246,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -240,6 +255,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -250,7 +268,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -260,6 +277,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -270,7 +290,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -280,6 +299,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -290,7 +312,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -300,6 +321,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -310,7 +334,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -320,6 +343,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -330,7 +356,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -340,6 +365,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -350,7 +378,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -360,6 +387,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -370,7 +400,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -380,6 +409,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -390,7 +422,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -400,6 +431,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -410,7 +444,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -420,6 +453,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -430,7 +466,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -440,6 +475,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -450,7 +488,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -460,6 +497,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -470,7 +510,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -480,6 +519,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -490,7 +532,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -500,6 +541,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -510,7 +554,6 @@ You use this parameter in combination with the IncludedRecipients parameter as p Type: MultiValuedProperty Parameter Sets: PrecannedFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -520,6 +563,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -529,7 +575,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -539,6 +584,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -547,7 +595,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -557,6 +604,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -572,7 +622,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -582,13 +631,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-HoldCompliancePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-HoldCompliancePolicy.md index 68a8cdeb6a..f791c26aab 100644 --- a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HoldCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-holdcompliancepolicy applicable: Security & Compliance -title: New-HoldCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-holdcompliancepolicy +schema: 2.0.0 +title: New-HoldCompliancePolicy --- # New-HoldCompliancePolicy @@ -52,13 +53,15 @@ This example creates a preservation policy named "Regulation 123 Compliance" for ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the preservation policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -93,7 +101,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -112,7 +122,6 @@ The Enabled parameter specifies whether the policy is enabled or disabled. Valid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - A mailbox @@ -142,7 +154,6 @@ If no mailboxes are specified, then no mailboxes are placed on hold. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -160,7 +174,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + The PublicFolderLocation parameter specifies that you want to include all public folders in the preservation policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -186,6 +201,9 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -196,7 +214,6 @@ SharePoint sites can't be added to the policy until they have been indexed. If n Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -206,13 +223,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/New-HoldComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/New-HoldComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-HoldComplianceRule.md index 9ebebdb7c5..59af4874f5 100644 --- a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HoldComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-holdcompliancerule applicable: Security & Compliance -title: New-HoldComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-holdcompliancerule +schema: 2.0.0 +title: New-HoldComplianceRule --- # New-HoldComplianceRule @@ -53,13 +54,15 @@ This example creates a new preservation rule named SeptOneYear and adds it to th ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the preservation rule. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the policy to contain the rule. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -110,7 +120,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -ContentDateFrom + +> Applicable: Security & Compliance + The ContentDateFrom parameter specifies the start date of the date range for content to include. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -128,7 +140,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -ContentDateTo + +> Applicable: Security & Compliance + The ContentDateTo parameter specifies the end date of the date range for content to include. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -146,7 +160,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -156,6 +169,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -164,7 +180,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the preservation rule is enabled or disabled. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -190,6 +207,9 @@ Accept wildcard characters: False ``` ### -HoldContent + +> Applicable: Security & Compliance + The HoldContent parameter specifies the hold duration for the preservation rule. Valid values are: - An integer: The hold duration in days. @@ -199,7 +219,6 @@ The HoldContent parameter specifies the hold duration for the preservation rule. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -209,6 +228,9 @@ Accept wildcard characters: False ``` ### -HoldDurationDisplayHint + +> Applicable: Security & Compliance + The HoldDurationDisplayHint parameter specifies the units that are used to display the preservation duration in the Microsoft Purview compliance portal. Valid values are: - Days @@ -221,7 +243,6 @@ For example, if this parameter is set to the value Years, and the HoldContent pa Type: HoldDurationHint Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -231,13 +252,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterPolicy.md index c11691fd96..8bb8f78675 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedcontentfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: New-HostedContentFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-hostedcontentfilterpolicy +schema: 2.0.0 +title: New-HostedContentFilterPolicy --- # New-HostedContentFilterPolicy @@ -102,6 +103,9 @@ This example creates a spam filter policy named Contoso Executives with the foll ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the spam filter policy. If the value contains spaces, enclose the value in quotation marks ("). Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. @@ -110,7 +114,6 @@ Don't use the following characters in the name value: `\ % & * + / = ? { } | < > Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -AddXHeaderValue + +> Applicable: Exchange Online, Exchange Online Protection + The AddXHeaderValue parameter specifies the X-header name (not value) to add to spam messages when a spam filtering verdict parameter is set to the value AddXHeader. The following spam filtering verdict parameters can use the AddXHeader action: - BulkSpamAction @@ -139,7 +145,6 @@ Note that this setting is independent of the AddXHeader value of the TestModeAct Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -149,13 +154,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -165,6 +172,9 @@ Accept wildcard characters: False ``` ### -AllowedSenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with `SFV:SKA` in the `X-Forefront-Antispam-Report header` and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. **Caution**: Think very carefully before you add domains here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). @@ -177,7 +187,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,6 +196,9 @@ Accept wildcard characters: False ``` ### -AllowedSenders + +> Applicable: Exchange Online, Exchange Online Protection + The AllowedSenders parameter specifies a list of trusted senders that skip spam filtering. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses. **Caution**: Think very carefully before you add senders here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). @@ -199,7 +211,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -209,6 +220,9 @@ Accept wildcard characters: False ``` ### -BlockedSenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with `SFV:SKB` value in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP domains. **Note**: Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). @@ -221,7 +235,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -231,6 +244,9 @@ Accept wildcard characters: False ``` ### -BlockedSenders + +> Applicable: Exchange Online, Exchange Online Protection + The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with `SFV:SKB` in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP email addresses. **Note**: Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). @@ -243,7 +259,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,6 +268,9 @@ Accept wildcard characters: False ``` ### -BulkQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The BulkQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as bulk email (the BulkSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -269,7 +287,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -279,6 +296,9 @@ Accept wildcard characters: False ``` ### -BulkSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The BulkSpamAction parameter specifies the action to take on messages that are marked as bulk email (also known as gray mail) based on the bulk complaint level (BCL) of the message, and the BCL threshold you configure in the BulkThreshold parameter. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. @@ -293,7 +313,6 @@ The BulkSpamAction parameter specifies the action to take on messages that are m Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -303,6 +322,9 @@ Accept wildcard characters: False ``` ### -BulkThreshold + +> Applicable: Exchange Online, Exchange Online Protection + The BulkThreshold parameter specifies the BCL on messages that triggers the action specified by the BulkSpamAction parameter (greater than or equal to the specified BCL value). A valid value is an integer from 1 to 9. The default value is 7, which means a BCL of 7, 8, or 9 on messages will trigger the action that's specified by the BulkSpamAction parameter. A higher BCL indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see [Bulk complaint level (BCL) in EOP](https://learn.microsoft.com/defender-office-365/anti-spam-bulk-complaint-level-bcl-about). @@ -311,7 +333,6 @@ A higher BCL indicates the message is more likely to generate complaints (and is Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -321,6 +342,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -330,7 +354,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -340,13 +363,15 @@ Accept wildcard characters: False ``` ### -DownloadLink + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -356,13 +381,15 @@ Accept wildcard characters: False ``` ### -EnableEndUserSpamNotifications + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -372,6 +399,9 @@ Accept wildcard characters: False ``` ### -EnableLanguageBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The EnableLanguageBlockList parameter enables or disables marking messages that were written in specific languages as spam. Valid values are: - $true: Mark messages hat were written in the languages specified by the LanguageBlockList parameter as spam. @@ -381,7 +411,6 @@ The EnableLanguageBlockList parameter enables or disables marking messages that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -391,6 +420,9 @@ Accept wildcard characters: False ``` ### -EnableRegionBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The EnableRegionBlockList parameter enables or disables marking messages that are sent from specific countries or regions as spam. Valid values are: - $true: Mark messages from senders in the RegionBlockList parameter as spam. @@ -400,7 +432,6 @@ The EnableRegionBlockList parameter enables or disables marking messages that ar Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -410,13 +441,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -426,13 +459,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromName + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -442,13 +477,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomSubject + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -458,13 +495,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -474,13 +513,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLanguage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: EsnLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -490,13 +531,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLimit + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -506,6 +549,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishAction + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. @@ -515,7 +561,6 @@ The HighConfidencePhishAction parameter specifies the action to take on messages Type: PhishFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -525,6 +570,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence phishing (the HighConfidencePhishAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -541,7 +589,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -551,6 +598,9 @@ Accept wildcard characters: False ``` ### -HighConfidenceSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidenceSpamAction parameter specifies the action to take on messages that are marked as high confidence spam (not spam, bulk email, phishing, or high confidence phishing). Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). @@ -564,7 +614,6 @@ The HighConfidenceSpamAction parameter specifies the action to take on messages Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -574,6 +623,9 @@ Accept wildcard characters: False ``` ### -HighConfidenceSpamQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence spam (the HighConfidenceSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -590,7 +642,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -600,6 +651,9 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithBizOrInfoUrls + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -610,7 +664,6 @@ The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -620,6 +673,9 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithImageLinks + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -630,7 +686,6 @@ The IncreaseScoreWithImageLinks parameter increases the spam score of messages t Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -640,6 +695,9 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithNumericIps + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -650,7 +708,6 @@ The IncreaseScoreWithNumericIps parameter increases the spam score of messages t Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -660,6 +717,9 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithRedirectToOtherPort + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -670,7 +730,6 @@ The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of m Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -680,6 +739,9 @@ Accept wildcard characters: False ``` ### -InlineSafetyTipsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The InlineSafetyTipsEnabled parameter specifies whether to enable or disable safety tips that are shown to recipients in messages. Valid values are: - $true: Safety tips are enabled. This is the default value. @@ -689,7 +751,6 @@ The InlineSafetyTipsEnabled parameter specifies whether to enable or disable saf Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -699,6 +760,9 @@ Accept wildcard characters: False ``` ### -IntraOrgFilterState + +> Applicable: Exchange Online, Exchange Online Protection + The IntraOrgFilterState parameter specifies whether to enable anti-spam filtering for messages sent between internal users (users in the same organization). The action that's configured in the policy for the specified spam filter verdicts is taken on messages sent between internal users. Valid values are: - Default: This is the default value. Currently, this value is the same as HighConfidencePhish. @@ -712,7 +776,6 @@ The IntraOrgFilterState parameter specifies whether to enable anti-spam filterin Type: IntraOrgFilterState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -722,6 +785,9 @@ Accept wildcard characters: False ``` ### -LanguageBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported uppercase ISO 639-1 two-letter language code: AF, AR, AZ, BE, BG, BN, BR, BS, CA, CS, CY, DA, DE, EL, EN, EO, ES, ET, EU, FA, FI, FO, FR, FY, GA, GL, GU, HA, HE, HI, HR, HU, HY, ID, IS, IT, JA, KA, KK, KL, KN, KO, KU, KY, LA, LB, LT, LV, MI, MK, ML, MN, MR, MS, MT, NB, NL, NN, PA, PL, PS, PT, RM, RO, RU, SE, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TL, TR, UK, UR, UZ, VI, WEN, YI, ZH-CN, ZH-TW, and ZU. @@ -734,7 +800,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -744,6 +809,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamBulkMail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamBulkMail parameter allows spam filtering to act on bulk email messages. Valid values are: - Off: The message is stamped with the BCL, but no action is taken for a bulk email filtering verdict. In effect, the values of the BulkThreshold and BulkSpamAction parameters are irrelevant. @@ -754,7 +822,6 @@ The MarkAsSpamBulkMail parameter allows spam filtering to act on bulk email mess Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -764,6 +831,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmbedTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -774,7 +844,6 @@ The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -784,6 +853,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmptyMessages + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -794,7 +866,6 @@ The MarkAsSpamEmptyMessages parameter marks a message as spam when the message c Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -804,6 +875,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFormTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -814,7 +888,6 @@ The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -824,6 +897,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFramesInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML \ or \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -834,7 +910,6 @@ The MarkAsSpamFramesInHtml parameter marks a message as spam when the message co Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -844,6 +919,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFromAddressAuthFail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -853,7 +931,6 @@ The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -863,6 +940,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamJavaScriptInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -873,7 +953,6 @@ The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the messag Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -883,6 +962,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamNdrBackscatter + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as *backscatter*). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -892,7 +974,6 @@ The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -902,6 +983,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamObjectTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -912,7 +996,6 @@ The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the messag Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -922,6 +1005,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSensitiveWordList + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -932,7 +1018,6 @@ The MarkAsSpamSensitiveWordList parameter marks a message as spam when the messa Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -942,6 +1027,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSpfRecordHardFail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -951,7 +1039,6 @@ The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF recor Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -961,6 +1048,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamWebBugsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -971,7 +1061,6 @@ The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message c Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -981,6 +1070,9 @@ Accept wildcard characters: False ``` ### -ModifySubjectValue + +> Applicable: Exchange Online, Exchange Online Protection + The ModifySubjectValue parameter specifies the text to prepend to the existing subject of messages when a spam filtering verdict parameter is set to the value ModifySubject. The following spam filtering verdict parameters can use the ModifySubject action: - BulkSpamAction @@ -994,7 +1086,6 @@ If the value contains spaces, enclose the value in quotation marks ("). Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1004,6 +1095,9 @@ Accept wildcard characters: False ``` ### -PhishQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The PhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as phishing (the PhishSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -1020,7 +1114,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1030,6 +1123,9 @@ Accept wildcard characters: False ``` ### -PhishSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The PhishSpamAction parameter specifies the action to take on messages that are marked as phishing (not high confidence phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. @@ -1044,7 +1140,6 @@ The PhishSpamAction parameter specifies the action to take on messages that are Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1054,6 +1149,9 @@ Accept wildcard characters: False ``` ### -PhishZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The PhishZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect phishing in already delivered messages in Exchange Online mailboxes. Valid values are: - $true: ZAP for phishing messages is enabled. This is the default value. The result depends on the spam filtering verdict action for phishing messages: MoveToJmf = Read and unread phishing messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Read and unread phishing messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. @@ -1065,7 +1163,6 @@ You configure ZAP for spam with the SpamZapEnabled parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1075,6 +1172,9 @@ Accept wildcard characters: False ``` ### -QuarantineRetentionPeriod + +> Applicable: Exchange Online, Exchange Online Protection + The QuarantineRetentionPeriod parameter specifies the number of days that spam messages remain in quarantine when a spam filtering verdict parameter is set to the value Quarantine. All spam filtering verdict parameters can use the Quarantine action: - BulkSpamAction @@ -1091,7 +1191,6 @@ After the time period expires, the message is deleted. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1101,13 +1200,15 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online, Exchange Online Protection + The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1117,6 +1218,9 @@ Accept wildcard characters: False ``` ### -RedirectToRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The RedirectToRecipients parameter specifies the email addresses of replacement recipients when a spam filtering verdict parameter is set to the value Redirect. The following spam filtering verdict parameters can use the Redirect action: - BulkSpamAction @@ -1130,7 +1234,6 @@ You can specify multiple email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1140,6 +1243,9 @@ Accept wildcard characters: False ``` ### -RegionBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The RegionBlockList parameter specifies the source countries or regions that are marked as spam when the EnableRegionBlockList parameter value is $true. A valid value is a supported ISO 3166-1 two-letter country code: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XE, XJ, XS, YE, YT, ZA, ZM, and ZW. @@ -1156,7 +1262,6 @@ To empty the list, use the value $null. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1166,6 +1271,9 @@ Accept wildcard characters: False ``` ### -SpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The SpamAction parameter specifies the action to take on messages that are marked as spam (not high confidence spam, bulk email, phishing, or high confidence phishing). Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). @@ -1179,7 +1287,6 @@ The SpamAction parameter specifies the action to take on messages that are marke Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1189,6 +1296,9 @@ Accept wildcard characters: False ``` ### -SpamQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The SpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as spam (the SpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -1205,7 +1315,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1215,6 +1324,9 @@ Accept wildcard characters: False ``` ### -SpamZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SpamZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect spam in already delivered messages in Exchange Online mailboxes. Valid values are: - $true: ZAP for spam is enabled. This is the default value. The result depends on the spam filtering verdict action for spam messages: MoveToJmf = Unread spam messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Unread spam messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. @@ -1226,7 +1338,6 @@ You configure ZAP for phishing messages with the PhishZapEnabled parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1236,6 +1347,9 @@ Accept wildcard characters: False ``` ### -TestModeAction + +> Applicable: Exchange Online, Exchange Online Protection + The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\* or MarkAsSpam\* ASF parameters are set to the value Test. Valid values are: - None: This is the default value, and we recommend that you don't change it. @@ -1246,7 +1360,6 @@ The TestModeAction parameter specifies the additional action to take on messages Type: SpamFilteringTestModeAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1257,6 +1370,8 @@ Accept wildcard characters: False ### -TestModeBccToRecipients +> Applicable: Exchange Online, Exchange Online Protection + The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. Valid input for this parameter is an email address. Separate multiple email addresses with commas. @@ -1267,7 +1382,6 @@ This parameter is meaningful only when the value of the TestModeAction parameter Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1277,13 +1391,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterRule.md similarity index 92% rename from exchange/exchange-ps/exchange/New-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterRule.md index 427202c583..7dc54be6f6 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection -title: New-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-hostedcontentfilterrule +schema: 2.0.0 +title: New-HostedContentFilterRule --- # New-HostedContentFilterRule @@ -54,6 +55,9 @@ This example creates a new spam filter rule named Contoso Recipients with the fo ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. @@ -62,7 +66,6 @@ Don't use the following characters in the name value: `\ % & * + / = ? { } | < > Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -HostedContentFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedContentFilterPolicy parameter specifies the spam filter policy (content filter policy) that's associated with the rule. You can use any value that uniquely identifies the policy. For example: @@ -86,7 +92,6 @@ You can't specify the default spam filter policy, and you can't specify a spam f Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -121,7 +131,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter enables or disables the rule. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,6 +176,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception for the rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -178,7 +194,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -188,6 +203,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception for the rule that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -205,7 +223,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +232,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -229,7 +249,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -239,13 +258,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,6 +276,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition for the rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -270,7 +294,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,6 +303,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -297,7 +323,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,13 +332,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterPolicy.md index 6f78d93176..d838d30f5b 100644 --- a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: New-HostedOutboundSpamFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-hostedoutboundspamfilterpolicy +schema: 2.0.0 +title: New-HostedOutboundSpamFilterPolicy --- # New-HostedOutboundSpamFilterPolicy @@ -56,13 +57,15 @@ This example creates a new outbound spam filter policy named Contoso Executives ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the outbound spam filter policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -ActionWhenThresholdReached + +> Applicable: Exchange Online, Exchange Online Protection + The ActionWhenThresholdReach parameter specifies the action to take when any of the limits specified in the policy are reached. Valid values are: - Alert: No action, alert only. @@ -83,7 +89,6 @@ Type: OutboundRecipientLimitsExceededAction Parameter Sets: (All) Aliases: Accepted values: Alert, BlockUserForToday, BlockUser -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -AutoForwardingMode + +> Applicable: Exchange Online, Exchange Online Protection + The AutoForwardingMode specifies how the policy controls automatic email forwarding to external recipients. Valid values are: - Automatic: This is the default value. This value is now the same as Off. When this value was originally introduced, it was equivalent to On. Over time, thanks to the principles of [secure by default](https://learn.microsoft.com/defender-office-365/secure-by-default), the effect of this value was eventually changed to Off for all customers. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/all-you-need-to-know-about-automatic-email-forwarding-in/ba-p/2074888). @@ -122,7 +132,6 @@ Type: AutoForwardingMode Parameter Sets: (All) Aliases: Accepted values: Automatic, Off, On -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -BccSuspiciousOutboundAdditionalRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The BccSuspiciousOutboundAdditionalRecipients parameter specifies an email address to add to the Bcc field of outgoing spam messages. You can specify multiple email addresses separated by commas. The specified recipients are added to the Bcc field of outgoing spam messages when the value of the BccSuspiciousOutboundMail parameter is $true. @@ -140,7 +152,6 @@ The specified recipients are added to the Bcc field of outgoing spam messages wh Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -BccSuspiciousOutboundMail + +> Applicable: Exchange Online, Exchange Online Protection + The BccSuspiciousOutboundMail parameter specifies whether to add recipients to the Bcc field of outgoing spam messages. Valid values are: - $true: The recipients specified by the BccSuspiciousOutboundAdditionalRecipients parameter are added to outgoing spam messages. @@ -159,7 +173,6 @@ The BccSuspiciousOutboundMail parameter specifies whether to add recipients to t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -NotifyOutboundSpam + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: This setting has been replaced by the default alert policy named **User restricted from sending email**, which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see [Verify the alert settings for restricted users](https://learn.microsoft.com/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). The NotifyOutboundSpam parameter specify whether to notify admins when outgoing spam is detected. Valid values are: @@ -180,7 +196,6 @@ The NotifyOutboundSpam parameter specify whether to notify admins when outgoing Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -NotifyOutboundSpamRecipients + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: This setting has been replaced by the default alert policy named **User restricted from sending email**, which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see [Verify the alert settings for restricted users](https://learn.microsoft.com/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). The NotifyOutboundSpamRecipients parameter specifies the email addresses of admins to notify when an outgoing spam is detected. You can specify multiple email addresses separated by commas. @@ -200,7 +218,6 @@ The specified recipients receive notifications when the value of the NotifyOutbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,13 +227,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitExternalPerHour + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientLimitExternalPerHour parameter specifies the maximum number of external recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://learn.microsoft.com/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,13 +245,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitInternalPerHour + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -242,13 +263,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitPerDay + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientLimitInternalPerHour parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -258,13 +281,15 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online, Exchange Online Protection + The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterRule.md similarity index 91% rename from exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterRule.md index 721a9bd38a..1afdd51735 100644 --- a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: New-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-hostedoutboundspamfilterrule +schema: 2.0.0 +title: New-HostedOutboundSpamFilterRule --- # New-HostedOutboundSpamFilterRule @@ -51,6 +52,9 @@ This example creates a new outbound spam filter rule named Contoso Executives th ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the outbound spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). Don't use the following characters: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. @@ -59,7 +63,6 @@ Don't use the following characters: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -HostedOutboundSpamFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedOutboundSpamFilterPolicy parameter specifies the outbound spam filter policy that's associated with the outbound spam filter rule. You can use any value that uniquely identifies the policy. For example: @@ -83,7 +89,6 @@ You can't specify the default outbound spam filter policy, and you can't specify Type: HostedOutboundSpamFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -118,7 +128,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the rule is enabled. Valid values are: - $true: The rule is enabled. This is the default value. @@ -139,7 +151,6 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfFrom parameter specifies an exception that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -164,7 +178,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfFromMemberOf parameter specifies an exception that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: - Name @@ -189,7 +205,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +232,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Online, Exchange Online Protection + The From parameter specifies a condition that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -230,7 +250,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -240,6 +259,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The FromMemberOf parameter specifies a condition that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: - Name @@ -255,7 +277,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -279,7 +303,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -289,13 +312,15 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -305,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-HybridConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/New-HybridConfiguration.md similarity index 91% rename from exchange/exchange-ps/exchange/New-HybridConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/New-HybridConfiguration.md index a345872239..eeb2dd5b03 100644 --- a/exchange/exchange-ps/exchange/New-HybridConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-HybridConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-hybridconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-HybridConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-hybridconfiguration +schema: 2.0.0 +title: New-HybridConfiguration --- # New-HybridConfiguration @@ -64,6 +65,9 @@ This example creates the hybrid configuration named Hybrid Configuration with th ## PARAMETERS ### -ClientAccessServers + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ClientAccessServers parameter specifies the Hub Transport servers in Exchange Server 2010 SP2 or later that are configured to support hybrid deployment features. You need to specify at least one Client Access server that's accessible from the internet on TCP ports 80 and 443. The servers are configured to enable the following features: @@ -78,7 +82,6 @@ You can specify multiple servers separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -Domains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Domains parameter specifies the domain namespaces used in the hybrid deployment. These domains must be configured as accepted domains in either on-premises Exchange or Exchange Online. The domains are used in configuring the organization relationships and Send and Receive connectors used by the hybrid configuration. You can specify multiple domains separated by commas. @@ -131,7 +141,6 @@ You can specify multiple domains separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,6 +150,9 @@ Accept wildcard characters: False ``` ### -EdgeTransportServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EdgeTransportServers parameter specifies the Edge Transport servers that are configured to support the hybrid deployment features. The Edge Transport server must be accessible from the internet on port 25. Valid values are: - The Edge Transport server FQDN (for example, edge.corp.contoso.com). @@ -154,7 +166,6 @@ If you use this parameter, don't use the the ReceivingTransportServers and Sendi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,6 +175,9 @@ Accept wildcard characters: False ``` ### -ExternalIPAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalIPAddresses parameter is a legacy parameter that specifies the publicly accessible inbound IP address of Microsoft Exchange Server 2010 Hub Transport servers. You should use this parameter to change or clear legacy Exchange 2010 Hub Transport server IP address values only. IPv6 addresses aren't supported. @@ -172,7 +186,6 @@ You should use this parameter to change or clear legacy Exchange 2010 Hub Transp Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,6 +195,9 @@ Accept wildcard characters: False ``` ### -Features + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Features parameter specifies the features that are enabled for the hybrid configuration. Valid values are: - OnlineArchive: Enables the Exchange Online archive for on-premises Exchange and Exchange Online users. @@ -199,7 +215,6 @@ You can specify multiple values separated by commas. When you use the Hybrid Con Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -OnPremisesSmartHost + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OnPremisesSmartHost parameter specifies the FQDN of the on-premises Exchange Mailbox server used for secure mail transport between on-premises Exchange and Exchange Online. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +242,9 @@ Accept wildcard characters: False ``` ### -ReceivingTransportServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceivingTransportServers parameter specifies the Mailbox servers defined in the outbound connector configuration in Exchange Online. Valid values are: - The Mailbox server FQDN (for example, mbx.corp.contoso.com). @@ -240,7 +260,6 @@ Don't use this parameter with the EdgeTransportServers parameter. The value of t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -250,6 +269,9 @@ Accept wildcard characters: False ``` ### -SecureMailCertificateThumbprint + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The SecureMailCertificateThumbprint parameter specifies the thumbprint of the X.509 certificate to use as the certificate for hybrid deployment secure message transport. This certificate can't be self-signed, must be obtained from a trusted certification authority (CA), and must be installed on all Hub Transport servers specified in the TransportServers parameter. @@ -258,7 +280,6 @@ The SecureMailCertificateThumbprint parameter specifies the thumbprint of the X. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -268,6 +289,9 @@ Accept wildcard characters: False ``` ### -SendingTransportServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendingTransportServers parameter specifies the Mailbox servers defined in the inbound connector configuration in Exchange Online. Valid values are: - The Mailbox server FQDN (for example, mbx.corp.contoso.com). @@ -283,7 +307,6 @@ Don't use this parameter with the EdgeTransportServers parameter. The value of t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +316,9 @@ Accept wildcard characters: False ``` ### -ServiceInstance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is meaningful only in Office 365 operated by 21Vianet in China. To manually configure a hybrid deployment with Office 365 operated by 21Vianet in China, set the value of this parameter to 1. Otherwise, the default value is 0. @@ -303,7 +329,6 @@ All other Microsoft 365 organizations should use the Hybrid Configuration wizard Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,6 +338,9 @@ Accept wildcard characters: False ``` ### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. Valid syntax for this parameter is `"X.500IssuerX.500Subject"`: - `X.500Issuer`: The value in the certificate's Issuer field. @@ -326,7 +354,6 @@ Or, after you run Get-ExchangeCertificate to find the thumbprint value of the ce Type: SmtpX509Identifier Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -336,6 +363,9 @@ Accept wildcard characters: False ``` ### -TransportServers + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The TransportServers parameter specifies the Hub Transport servers in Exchange Server 2010 SP2 or later that are configured to support hybrid deployment features. @@ -348,7 +378,6 @@ You can specify multiple servers separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -358,13 +387,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-InboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-InboundConnector.md similarity index 92% rename from exchange/exchange-ps/exchange/New-InboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-InboundConnector.md index ab3f7a8b2d..bed3ce6485 100644 --- a/exchange/exchange-ps/exchange/New-InboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-InboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-inboundconnector applicable: Exchange Online, Exchange Online Protection -title: New-InboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-inboundconnector +schema: 2.0.0 +title: New-InboundConnector --- # New-InboundConnector @@ -76,13 +77,15 @@ This example creates the Inbound connector named Contoso Inbound Secure Connecto ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a descriptive name for the connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -SenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + The SenderDomains parameter specifies the source domains that a Partner type connector accepts messages for (limits the scope of a Partner type connector). A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, `*.contoso.com`). However, you can't embed the wildcard character (for example, `domain.*.contoso.com` isn't valid). You can specify multiple domains separated by commas. @@ -100,7 +106,6 @@ You can specify multiple domains separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -AssociatedAcceptedDomains + +> Applicable: Exchange Online, Exchange Online Protection + The AssociatedAcceptedDomains parameter restricts the source domains that use the connector to the specified accepted domains. A valid value is an SMTP domain that's configured as an accepted domain in your Microsoft 365 organization. You can specify multiple values separated by commas. @@ -118,7 +126,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -ClientHostNames + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill ClientHostNames Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -157,7 +169,6 @@ Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,6 +196,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -192,7 +208,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -ConnectorSource + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorSource parameter specifies how the connector is created. Valid input for this parameter includes the following values: - Default: The connector is manually created. This is the default value. @@ -214,7 +232,6 @@ We recommended that you don't change this value. Type: TenantConnectorSource Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -224,6 +241,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorType parameter specifies the category for the source domains that the connector accepts messages for. Valid values are: - Partner: External partners or services. @@ -233,7 +253,6 @@ The ConnectorType parameter specifies the category for the source domains that t Type: TenantConnectorType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -EFSkipIPs + +> Applicable: Exchange Online, Exchange Online Protection + the EFSkipIPs parameter specifies the source IP addresses to skip in Enhanced Filtering for Connectors when the EFSkipLastIP parameter value is $false. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -255,7 +277,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -EFSkipLastIP + +> Applicable: Exchange Online, Exchange Online Protection + The EFSkipIPs parameter specifies the behavior of Enhanced Filtering for Connectors. Valid values are: - $true: Only the last message source is skipped. @@ -274,7 +298,6 @@ The EFSkipIPs parameter specifies the behavior of Enhanced Filtering for Connect Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -284,13 +307,15 @@ Accept wildcard characters: False ``` ### -EFSkipMailGateway + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,13 +325,15 @@ Accept wildcard characters: False ``` ### -EFTestMode + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -316,6 +343,9 @@ Accept wildcard characters: False ``` ### -EFUsers + +> Applicable: Exchange Online, Exchange Online Protection + The EFUsers parameter specifies the recipients that Enhanced Filtering for Connectors applies to. The default value is blank ($null), which means Enhanced Filtering for Connectors is applied to all recipients. You can specify multiple recipient email addresses separated by commas. @@ -324,7 +354,6 @@ You can specify multiple recipient email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -334,6 +363,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter enables or disables the connector. Valid values are: - $true: The connector is enabled. This is the default value. @@ -343,7 +375,6 @@ The Enabled parameter enables or disables the connector. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -353,6 +384,9 @@ Accept wildcard characters: False ``` ### -RequireTls + +> Applicable: Exchange Online, Exchange Online Protection + The RequireTLS parameter specifies whether to require TLS transmission for all messages that are received by a Partner type connector. Valid values are: - $true: Reject messages if they aren't sent over TLS. This is the default value @@ -364,7 +398,6 @@ The RequireTLS parameter specifies whether to require TLS transmission for all m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -374,6 +407,9 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToCertificate + +> Applicable: Exchange Online, Exchange Online Protection + The RestrictDomainsToCertificate parameter specifies whether the Subject value of the TLS certificate is checked before messages can use the Partner type connector. Valid values are: - $true: Mail is allowed to use the connector only if the Subject value of the TLS certificate that the source email server uses to authenticate matches the TlsSenderCertificateName parameter value. @@ -385,7 +421,6 @@ The RestrictDomainsToCertificate parameter specifies whether the Subject value o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -395,6 +430,9 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToIPAddresses + +> Applicable: Exchange Online, Exchange Online Protection + The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that comes from unknown source IP addresses for Partner type connectors. Valid values are: - $true: Automatically reject mail from domains that are specified by the SenderDomains parameter if the source IP address isn't also specified by the SenderIPAddress parameter. @@ -406,7 +444,6 @@ The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -416,13 +453,15 @@ Accept wildcard characters: False ``` ### -ScanAndDropRecipients + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -432,6 +471,9 @@ Accept wildcard characters: False ``` ### -SenderIPAddresses + +> Applicable: Exchange Online, Exchange Online Protection + The SenderIPAddresses parameter specifies the source IPV4 IP addresses that the Partner type connector accepts messages from when the value of the RestrictDomainsToIPAddresses parameter is $true. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -447,7 +489,6 @@ IPv6 addresses are not supported. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -457,13 +498,15 @@ Accept wildcard characters: False ``` ### -TlsSenderCertificateName + +> Applicable: Exchange Online, Exchange Online Protection + The TlsSenderCertificateName parameter specifies the TLS certificate that's used when the value of the RequireTls parameter is $true. A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com is not valid). ```yaml Type: TlsCertificate Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -473,6 +516,9 @@ Accept wildcard characters: False ``` ### -TreatMessagesAsInternal + +> Applicable: Exchange Online, Exchange Online Protection + The TreatMessagesAsInternal parameter specifies an alternative method to identify messages sent from an on-premises organization as internal messages. You should only consider using this parameter when your on-premises organization doesn't use Exchange. Valid values are: - $true: Messages are considered internal if the sender's domain matches a domain that's configured in Microsoft 365. This setting allows internal mail flow between Microsoft 365 and on-premises organizations that don't have Exchange Server 2010 or later installed. However, this setting has potential security risks (for example, internal messages bypass antispam filtering), so use caution when configuring this setting. @@ -489,7 +535,6 @@ In hybrid environments, you don't need to use this parameter, because the Hybrid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -499,6 +544,9 @@ Accept wildcard characters: False ``` ### -TrustedOrganizations + +> Applicable: Exchange Online, Exchange Online Protection + The TrustedOrganizations parameter specifies other Microsoft 365 organizations that are trusted mail sources (for example, after acquisitions and mergers). You can specify multiple Microsoft 365 organizations separated by commas. This parameter works only for mail flow between two Microsoft 365 organizations, so no other parameters are used. @@ -507,7 +555,6 @@ This parameter works only for mail flow between two Microsoft 365 organizations, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -517,13 +564,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/New-InboxRule.md similarity index 85% rename from exchange/exchange-ps/exchange/New-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-InboxRule.md index a3b0fe0e83..c9db1ab9c4 100644 --- a/exchange/exchange-ps/exchange/New-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-InboxRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-InboxRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-inboxrule +schema: 2.0.0 +title: New-InboxRule --- # New-InboxRule @@ -130,13 +131,15 @@ This example raises the message importance to High if the mailbox owner is in th ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the Inbox rule. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -146,6 +149,9 @@ Accept wildcard characters: False ``` ### -FromMessageId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FromMessageId parameter specifies the message that's used to create the Inbox rule. The rule is based on the properties of the message. You identify the message by its Base64-encoded StoreObjectId property value. For example: - MailboxId\\StoreObjectId @@ -161,7 +167,6 @@ When you use this parameter to create an Inbox rule, the following message prope Type: MailboxStoreObjectIdParameter Parameter Sets: FromMessage Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -171,13 +176,15 @@ Accept wildcard characters: False ``` ### -ValidateOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. ```yaml Type: SwitchParameter Parameter Sets: FromMessage Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -187,13 +194,15 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -203,6 +212,9 @@ Accept wildcard characters: False ``` ### -ApplyCategory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApplyCategory parameter specifies an action for the Inbox rule that applies the specified category to messages. A valid value is any text value that you want to define as a category. You can specify multiple categories separated by commas. If the value contains spaces, enclose the value in quotation marks ("). The categories that you specify for this parameter are defined in the mailbox (they aren't shared between mailboxes). @@ -211,7 +223,6 @@ The categories that you specify for this parameter are defined in the mailbox (t Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -221,6 +232,9 @@ Accept wildcard characters: False ``` ### -ApplySystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApplySystemCategory parameter specifies an action for the Inbox rule that applies the specified system category to messages. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -254,7 +268,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -264,6 +277,9 @@ Accept wildcard characters: False ``` ### -BodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -276,7 +292,6 @@ The corresponding exception parameter to this condition is ExceptIfBodyContainsW Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -286,6 +301,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -295,7 +313,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -305,6 +322,9 @@ Accept wildcard characters: False ``` ### -CopyToFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CopyToFolder parameter specifies an action for the Inbox rule that copies messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -326,7 +346,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -336,6 +355,9 @@ Accept wildcard characters: False ``` ### -DeleteMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeleteMessage parameter specifies an action for the Inbox rule that sends messages to the Deleted Items folder. Valid values are: - $true: Messages that match the conditions of the rule are moved to the Deleted Items folder. @@ -345,7 +367,6 @@ The DeleteMessage parameter specifies an action for the Inbox rule that sends me Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -355,6 +376,9 @@ Accept wildcard characters: False ``` ### -DeleteSystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeleteSystemCategory parameter specifies an action for the Inbox rule that deletes the specified system category from messages. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -388,7 +412,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -398,6 +421,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -406,7 +432,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -416,6 +441,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -428,7 +456,6 @@ The corresponding condition parameter to this exception is BodyContainsWords. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -438,6 +465,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFlaggedForAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfFlaggedForAction parameter specifies an exception for the Inbox rule that looks messages with the specified message flag. Valid values are: - Any @@ -458,7 +488,6 @@ The corresponding condition parameter to this exception is FlaggedForAction. Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -468,6 +497,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: - Name @@ -485,7 +517,6 @@ The corresponding condition parameter to this exception is From. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -495,6 +526,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -507,7 +541,6 @@ The corresponding condition parameter to this exception is FromAddressContainsWo Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -517,6 +550,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasAttachment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfHasAttachment parameter specifies an exception for the Inbox rule that looks for messages with attachments. Valid values are: - $true: The rule action isn't applied to messages that have attachments. @@ -528,7 +564,6 @@ The corresponding condition parameter to this exception is HasAttachment. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -538,6 +573,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfHasClassification parameter specifies an exception for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. The corresponding condition parameter to this exception is HasClassification. @@ -546,7 +584,6 @@ The corresponding condition parameter to this exception is HasClassification. Type: MessageClassificationIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -556,6 +593,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -568,7 +608,6 @@ The corresponding condition parameter to this exception is HeaderContainsWords. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -578,6 +617,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfMessageTypeMatches parameter specifies an exception for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply @@ -598,7 +640,6 @@ The corresponding condition parameter to this exception is MessageTypeMatches. Type: InboxRuleMessageType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -608,6 +649,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfMyNameInCcBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the Cc field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is in the Cc field. @@ -619,7 +663,6 @@ The corresponding condition parameter to this exception is MyNameInCcBox. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -629,6 +672,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfMyNameInToBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the To field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is in the To field. @@ -640,7 +686,6 @@ The corresponding condition parameter to this exception is MyNameInToBox. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -650,6 +695,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInToOrCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfMyNameInToOrCcBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the To or Cc fields Valid values are. - $true: The rule action isn't applied to messages where the mailbox owner is in the To or Cc fields. @@ -661,7 +709,6 @@ The corresponding condition parameter to this exception is MyNameInToOrCcBox. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -671,6 +718,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameNotInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfMyNameNotInToBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner isn't in the To field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner isn't in the To field. @@ -682,7 +732,6 @@ The corresponding condition parameter to this exception is MyNameNotInToBox. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -692,6 +741,9 @@ Accept wildcard characters: False ``` ### -ExceptIfReceivedAfterDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfReceivedAfterDate parameter specifies an exception for the Inbox rule that looks for messages received after the specified date. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -702,7 +754,6 @@ The corresponding condition parameter to this exception is ReceivedAfterDate. Type: ExDateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -712,6 +763,9 @@ Accept wildcard characters: False ``` ### -ExceptIfReceivedBeforeDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfReceivedBeforeDate parameter specifies an exception for the Inbox rule that looks for messages received before the specified date. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -722,7 +776,6 @@ The corresponding condition parameter to this exception is ReceivedBeforeDate. Type: ExDateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -732,6 +785,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfRecipientAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in recipient email addresses. You can specify multiple values separated by commas. The maximum length of this parameter is 255 characters. @@ -742,7 +798,6 @@ The corresponding condition parameter to this exception is RecipientAddressConta Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -752,6 +807,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentOnlyToMe + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfSentOnlyToMe parameter specifies an exception for the Inbox rule that looks for messages where the only recipient is the mailbox owner. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is the only recipient. @@ -763,7 +821,6 @@ The corresponding condition parameter to this exception is SentOnlyToMe. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -773,6 +830,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -790,7 +850,6 @@ The corresponding condition parameter to this exception is SentTo. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -800,6 +859,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -812,7 +874,6 @@ The corresponding condition parameter to this exception is SubjectContainsWords. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -822,6 +883,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -834,7 +898,6 @@ The corresponding condition parameter to this exception is SubjectOrBodyContains Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -844,6 +907,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfWithImportance parameter specifies an exception for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High @@ -856,7 +922,6 @@ The corresponding condition parameter to this exception is WithImportance. Type: Importance Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -866,6 +931,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithinSizeRangeMaximum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfWithinSizeRangeMaximum parameter specifies part of an exception for the Inbox rule that looks for messages that smaller than specified maximum size. When you enter a value, qualify the value with one of the following units: @@ -886,7 +954,6 @@ The corresponding condition parameter to this exception is WithinSizeRangeMaximu Type: ByteQuantifiedSize Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -896,6 +963,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithinSizeRangeMinimum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfWithinSizeRangeMinimum parameter specifies part of an exception for the Inbox rule that looks for messages that are larger than the specified minimum size. When you enter a value, qualify the value with one of the following units: @@ -916,7 +986,6 @@ The corresponding condition parameter to this exception is WithinSizeRangeMinimu Type: ByteQuantifiedSize Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -926,6 +995,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithSensitivity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfWithSensitivity parameter specifies an exception for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal @@ -939,7 +1011,6 @@ The corresponding condition parameter to this exception is WithSensitivity. Type: Sensitivity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -949,6 +1020,9 @@ Accept wildcard characters: False ``` ### -FlaggedForAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FlaggedForAction parameter specifies a condition for the Inbox rule that looks for messages with the specified message flag. Valid values are: - Any @@ -967,7 +1041,6 @@ The FlaggedForAction parameter specifies a condition for the Inbox rule that loo Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -977,6 +1050,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. @@ -985,7 +1061,6 @@ A confirmation prompt warns you if the mailbox contains rules that were created Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -995,6 +1070,9 @@ Accept wildcard characters: False ``` ### -ForwardAsAttachmentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForwardAsAttachmentTo parameter specifies an action for the Inbox rule that forwards the message to the specified recipient as an attachment. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1010,7 +1088,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1020,6 +1097,9 @@ Accept wildcard characters: False ``` ### -ForwardTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForwardTo parameter specifies an action for the Inbox rule that forwards the message to the specified recipient. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1035,7 +1115,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1045,6 +1124,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The From parameter specifies a condition for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: - Name @@ -1062,7 +1144,6 @@ The corresponding exception parameter to this condition is ExceptIfFrom. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1072,6 +1153,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1084,7 +1168,6 @@ The corresponding exception parameter to this condition is ExceptIfFromAddressCo Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1094,6 +1177,9 @@ Accept wildcard characters: False ``` ### -HasAttachment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HasAttachment parameter specifies a condition for the Inbox rule that looks for messages with attachments. Valid values are: - $true: The rule action is applied to messages that have attachments. @@ -1105,7 +1191,6 @@ The corresponding exception parameter to this condition is ExceptIfHasAttachment Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1115,6 +1200,9 @@ Accept wildcard characters: False ``` ### -HasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HasClassification parameter specifies a condition for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. The corresponding exception parameter to this condition is ExceptIfHasClassification. @@ -1123,7 +1211,6 @@ The corresponding exception parameter to this condition is ExceptIfHasClassifica Type: MessageClassificationIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1133,6 +1220,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1145,7 +1235,6 @@ The corresponding exception parameter to this condition is ExceptIfHeaderContain Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1155,6 +1244,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -1172,7 +1264,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1182,6 +1273,9 @@ Accept wildcard characters: False ``` ### -MarkAsRead + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MarkAsRead parameter specifies an action for the Inbox rule that marks messages as read. Valid values are: - $true: Messages that match the conditions of the rule are marked as read. @@ -1191,7 +1285,6 @@ The MarkAsRead parameter specifies an action for the Inbox rule that marks messa Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1201,6 +1294,9 @@ Accept wildcard characters: False ``` ### -MarkImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MarkImportance parameter specifies an action for the Inbox rule that marks messages with the specified importance flag. Valid values are: - Low @@ -1211,7 +1307,6 @@ The MarkImportance parameter specifies an action for the Inbox rule that marks m Type: Importance Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1221,6 +1316,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MessageTypeMatches parameter specifies a condition for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply @@ -1241,7 +1339,6 @@ The corresponding exception parameter to this condition is ExceptIfMessageTypeMa Type: InboxRuleMessageType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1251,6 +1348,9 @@ Accept wildcard characters: False ``` ### -MoveToFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MoveToFolder parameter specifies an action for the Inbox rule that moves messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -1272,7 +1372,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1282,6 +1381,9 @@ Accept wildcard characters: False ``` ### -MyNameInCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MyNameInCcBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the Cc field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is in the Cc field. @@ -1293,7 +1395,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInCcBox Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1303,6 +1404,9 @@ Accept wildcard characters: False ``` ### -MyNameInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MyNameInToBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the To field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is in the To field. @@ -1314,7 +1418,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInToBox Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1324,6 +1427,9 @@ Accept wildcard characters: False ``` ### -MyNameInToOrCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MyNameInToOrCcBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the To or Cc fields Valid values are. - $true: The rule action is applied to messages where the mailbox owner is in the To or Cc fields. @@ -1335,7 +1441,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInToOrC Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1345,6 +1450,9 @@ Accept wildcard characters: False ``` ### -MyNameNotInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MyNameNotInToBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner isn't in the To field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner isn't in the To field. @@ -1356,7 +1464,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameNotInTo Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1366,6 +1473,9 @@ Accept wildcard characters: False ``` ### -PinMessage + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PinMessage parameter specifies an action for the Inbox rule that pins messages to the top of the Inbox. Valid values are: - $true: Message that match the conditions of the rule are pinned to the top of the Inbox. @@ -1375,7 +1485,6 @@ The PinMessage parameter specifies an action for the Inbox rule that pins messag Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1385,13 +1494,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Priority parameter specifies a priority for the Inbox rule that determines the order of rule processing. A lower integer value indicates a higher priority, ```yaml Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1401,6 +1512,9 @@ Accept wildcard characters: False ``` ### -ReceivedAfterDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReceivedAfterDate parameter specifies a condition for the Inbox rule that looks for messages received after the specified date. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -1411,7 +1525,6 @@ The corresponding exception parameter to this condition is ExceptIfReceivedAfter Type: ExDateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1421,6 +1534,9 @@ Accept wildcard characters: False ``` ### -ReceivedBeforeDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReceivedBeforeDate parameter specifies a condition for the Inbox rule that looks for messages received before the specified date. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -1431,7 +1547,6 @@ The corresponding exception parameter to this condition is ExceptIfReceivedBefor Type: ExDateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1441,6 +1556,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in recipient email addresses. You can specify multiple values separated by commas. The maximum length of this parameter is 255 characters. @@ -1451,7 +1569,6 @@ The corresponding exception parameter to this condition is ExceptIfRecipientAddr Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1461,6 +1578,9 @@ Accept wildcard characters: False ``` ### -RedirectTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RedirectTo parameter specifies an action for the Inbox rule that redirects the message to the specified recipient. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1476,7 +1596,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1486,6 +1605,9 @@ Accept wildcard characters: False ``` ### -SendTextMessageNotificationTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SendTextMessageNotificationTo parameter specifies an action for the Inbox rule that send a text message notification to the specified telephone number. @@ -1496,7 +1618,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1506,6 +1627,9 @@ Accept wildcard characters: False ``` ### -SentOnlyToMe + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SentOnlyToMe parameter specifies a condition for the Inbox rule that looks for messages where the only recipient is the mailbox owner. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is the only recipient. @@ -1517,7 +1641,6 @@ The corresponding exception parameter to this condition is ExceptIfSentOnlyToMe. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1527,6 +1650,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SentTo parameter specifies a condition for the Inbox rule that looks for messages with the specified recipients. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1544,7 +1670,6 @@ The corresponding exception parameter to this condition is ExceptIfSentTo. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1554,6 +1679,9 @@ Accept wildcard characters: False ``` ### -SoftDeleteMessage + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SoftDeleteMessage Description }} @@ -1562,7 +1690,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1572,6 +1699,9 @@ Accept wildcard characters: False ``` ### -StopProcessingRules + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StopProcessingRules parameter specifies an action for the Inbox rule that stops processing additional rules if the conditions of this Inbox rule are met. Valid values are:If set to $true, the StopProcessingRules parameter instructs Exchange to stop processing additional rules if the conditions of this Inbox rule are met. - $true: Stop processing more rules. @@ -1581,7 +1711,6 @@ The StopProcessingRules parameter specifies an action for the Inbox rule that st Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1591,6 +1720,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1603,7 +1735,6 @@ The corresponding exception parameter to this condition is ExceptIfSubjectContai Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1613,6 +1744,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1625,7 +1759,6 @@ The corresponding exception parameter to this condition is ExceptIfSubjectOrBody Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1635,13 +1768,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1651,6 +1786,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WithImportance parameter specifies a condition for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High @@ -1663,7 +1801,6 @@ The corresponding exception parameter to this condition is ExceptIfWithImportanc Type: Importance Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1673,6 +1810,9 @@ Accept wildcard characters: False ``` ### -WithinSizeRangeMaximum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WithinSizeRangeMaximum parameter specifies part of a condition for the Inbox rule that looks for messages that are smaller than specified maximum size. When you enter a value, qualify the value with one of the following units: @@ -1693,7 +1833,6 @@ The corresponding exception parameter to this condition is ExceptIfWithinSizeRan Type: ByteQuantifiedSize Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1703,6 +1842,9 @@ Accept wildcard characters: False ``` ### -WithinSizeRangeMinimum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WithinSizeRangeMinimum parameter specifies part of a condition for the Inbox rule that looks for messages that are larger than the specified minimum size. When you enter a value, qualify the value with one of the following units: @@ -1723,7 +1865,6 @@ The corresponding exception parameter to this condition is ExceptIfWithinSizeRan Type: ByteQuantifiedSize Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1733,6 +1874,9 @@ Accept wildcard characters: False ``` ### -WithSensitivity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WithSensitivity parameter specifies a condition for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal @@ -1746,7 +1890,6 @@ The corresponding exception parameter to this condition is ExceptIfWithSensitivi Type: Sensitivity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-InformationBarrierPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-InformationBarrierPolicy.md index 0e1826be8c..8b9e46152e 100644 --- a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-InformationBarrierPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy applicable: Security & Compliance -title: New-InformationBarrierPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy +schema: 2.0.0 +title: New-InformationBarrierPolicy --- # New-InformationBarrierPolicy @@ -90,13 +91,15 @@ This example creates a policy that allows the *Research* segment to communicate ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the information barrier policy that you want to create. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -AssignedSegment + +> Applicable: Security & Compliance + The AssignedSegment parameter specifies the Name value of segment that you want to include in the information barrier policy. You can find existing segments by running the following command: `Get-OrganizationSegment | Format-List Name,UserGroupFilter`. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -SegmentAllowedFilter + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: OrganizationSegmentAllowedFilter Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -SegmentsAllowed + +> Applicable: Security & Compliance + The SegmentsAllowed parameter specifies the segments that are allowed to communicate with the segment in this policy (users defined by the AssignedSegment parameter). Only these specified segments can communicate with the segment in this policy. You identify the segment by its Name value. If the value contains spaces, enclose the value in quotation marks ("). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). @@ -148,7 +158,6 @@ You can't use this parameter with the SegmentsBlocked parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsAllowed Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -SegmentsBlocked + +> Applicable: Security & Compliance + The SegmentsBlocked parameter specifies the segments that aren't allowed to communicate with the segment in this policy (users defined by the AssignedSegment parameter). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). You identify the segment by its Name value. If the value contains spaces, enclose the value in quotation marks ("). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). @@ -168,7 +180,6 @@ You can't use this parameter with the SegmentsAllowed parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsBlocked Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -178,13 +189,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -194,13 +207,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -210,6 +225,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -218,7 +236,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -228,13 +245,15 @@ Accept wildcard characters: False ``` ### -ModerationAllowed + +> Applicable: Security & Compliance + {{ Fill ModerationAllowed Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -244,6 +263,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Security & Compliance + The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: - Active @@ -254,7 +276,6 @@ Type: EopInformationBarrierPolicyState Parameter Sets: (All) Aliases: Accepted values: Inactive, Active -Applicable: Security & Compliance Required: False Position: Named @@ -264,13 +285,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-IntraOrganizationConnector.md similarity index 91% rename from exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-IntraOrganizationConnector.md index 4e22683783..dd86a9f2b3 100644 --- a/exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-IntraOrganizationConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-intraorganizationconnector applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-IntraOrganizationConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-intraorganizationconnector +schema: 2.0.0 +title: New-IntraOrganizationConnector --- # New-IntraOrganizationConnector @@ -49,13 +50,15 @@ This example creates an Intra-Organization connector named "MainCloudConnector" ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a friendly name for the Intra-Organization connector. If the value contains spaces, enclose the value in double quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -DiscoveryEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DiscoveryEndpoint parameter specifies the externally-accessible URL that's used for the Autodiscover service for the domain that's configured in the Intra-Organization connector. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -TargetAddressDomains + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -89,7 +97,6 @@ You specify multiple domain values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -108,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -126,7 +138,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +147,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter enables or disabled the Intra-organization connector. The valid values for this parameter are $true or $false. The default value is $true. When you set the value to $false, you completely stop connectivity for the specific connection. @@ -144,7 +158,6 @@ When you set the value to $false, you completely stop connectivity for the speci Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,6 +167,9 @@ Accept wildcard characters: False ``` ### -TargetSharingEpr + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services that will be used in the Intra-Organization connector. @@ -162,7 +178,6 @@ The TargetSharingEpr parameter specifies the URL of the target Exchange Web Serv Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -172,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/New-JournalRule.md similarity index 87% rename from exchange/exchange-ps/exchange/New-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-JournalRule.md index 2812bcf0ef..0103a92195 100644 --- a/exchange/exchange-ps/exchange/New-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-JournalRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-journalrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-JournalRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-journalrule +schema: 2.0.0 +title: New-JournalRule --- # New-JournalRule @@ -34,7 +35,7 @@ New-JournalRule -Name -JournalEmailAddress ## DESCRIPTION The New-JournalRule cmdlet creates a journal rule in your organization. -By default, new journal rules are disabled unless the Enabled parameter is set to $true. For more information about how to enable a new journal rule that was created in a disabled state, see [Enable-JournalRule](https://learn.microsoft.com/powershell/module/exchange/enable-journalrule). +By default, new journal rules are disabled unless the Enabled parameter is set to $true. For more information about how to enable a new journal rule that was created in a disabled state, see [Enable-JournalRule](https://learn.microsoft.com/powershell/module/exchangepowershell/enable-journalrule). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -50,13 +51,15 @@ This example creates and enables a journal rule. The rule applies to all email m ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters long. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -JournalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The JournalEmailAddress parameter specifies a recipient object to which journal reports are sent. You can use any value that uniquely identifies the recipient. For example: - Name @@ -79,7 +85,6 @@ The JournalEmailAddress parameter specifies a recipient object to which journal Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter specifies whether the journal rule is enabled or disabled. If the rule is disabled, it isn't applied to any email messages. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -Recipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or from a recipient are journaled. To journal messages from all recipients, don't use this parameter. @@ -150,7 +164,6 @@ To journal messages from all recipients, don't use this parameter. Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,6 +173,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Scope parameter specifies the scope of email messages to which the journal rule is applied. Valid values for this parameter are as follows: - Global: Global rules process all email messages that pass through a Transport service. This includes email messages that were already processed by the external and internal rules. The default value is Global. @@ -170,7 +186,6 @@ The Scope parameter specifies the scope of email messages to which the journal r Type: JournalRuleScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-Label.md b/exchange/exchange-ps/ExchangePowerShell/New-Label.md similarity index 94% rename from exchange/exchange-ps/exchange/New-Label.md rename to exchange/exchange-ps/ExchangePowerShell/New-Label.md index ccfa3a9d5e..6a8b3932a6 100644 --- a/exchange/exchange-ps/exchange/New-Label.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-Label.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/policy-and-compliance/new-label applicable: Security & Compliance -title: New-Label -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/policy-and-compliance/new-label +schema: 2.0.0 +title: New-Label --- # New-Label @@ -117,13 +118,15 @@ This example create a new label named "New Label" with a display name "My New La ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the sensitivity label. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -133,13 +136,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name for the sensitivity label. The display name appears in any client that supports sensitivity labels. This includes Word, Excel, PowerPoint, Outlook, SharePoint, Teams, and Power BI. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -149,13 +154,15 @@ Accept wildcard characters: False ``` ### -Tooltip + +> Applicable: Security & Compliance + The ToolTip parameter specifies the default tooltip and sensitivity label description that's seen by users. It the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -165,6 +172,9 @@ Accept wildcard characters: False ``` ### -AdvancedSettings + +> Applicable: Security & Compliance + The AdvancedSettings parameter enables specific features and capabilities for a sensitivity label. Specify this parameter with the identity (name or GUID) of the sensitivity label, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. @@ -195,7 +205,6 @@ Supported settings for built-in labeling: Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -205,6 +214,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterAlignment + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterAlignment parameter specifies the footer alignment. Valid values are: - Left @@ -217,7 +229,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -227,6 +238,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterEnabled + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterEnabled parameter enables or disables the Apply Content Marking Footer action for the label. Valid values are: - $true: The Apply Content Marking Footer action is enabled. @@ -236,7 +250,6 @@ The ApplyContentMarkingFooterEnabled parameter enables or disables the Apply Con Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -246,6 +259,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontColor + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontColor parameter specifies the color of the footer text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -254,7 +270,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -264,6 +279,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontName + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontName parameter specifies the font of the footer text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -274,7 +292,6 @@ This parameter is supported only by the Azure Information Protection unified lab Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -284,6 +301,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontSize + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontSize parameter specifies the font size (in points) of the footer text. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -292,7 +312,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -302,6 +321,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterMargin + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterMargin parameter specifies the size (in points) of the footer margin. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -312,7 +334,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -322,6 +343,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterText + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterText parameter specifies the footer text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -330,7 +354,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -340,6 +363,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderAlignment + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderAlignment parameter specifies the header alignment. Valid values are: - Left @@ -352,7 +378,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -362,6 +387,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderEnabled + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderEnabled parameter enables or disables the Apply Content Marking Header action for the label. Valid values are: - $true: The Apply Content Marking Header action is enabled. @@ -371,7 +399,6 @@ The ApplyContentMarkingHeaderEnabled parameter enables or disables the Apply Con Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -381,6 +408,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontColor + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontColor parameter specifies the color of the header text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -389,7 +419,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -399,6 +428,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontName + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontName parameter specifies the font of the header text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -407,7 +439,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -417,6 +448,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontSize + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontSize parameter specifies the font size (in points) of the header text. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -425,7 +459,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -435,6 +468,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderMargin + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderMargin parameter specifies the size (in points) of the header margin. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -445,7 +481,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -455,6 +490,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderText + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderText parameter specifies the header text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -463,7 +501,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -473,6 +510,9 @@ Accept wildcard characters: False ``` ### -ApplyDynamicWatermarkingEnabled + +> Applicable: Security & Compliance + **Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. The ApplyDynamicWatermarkingEnabled parameter enables dynamic watermarking for a specific label that applies encryption. Valid values are: @@ -486,7 +526,6 @@ You set the watermark text with the DynamicWatermarkDisplay parameter. For more Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -496,6 +535,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingEnabled + +> Applicable: Security & Compliance + The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarking Header action for the label. Valid values are: - $true: The Apply Watermarking Header action is enabled. @@ -505,7 +547,6 @@ The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarkin Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -515,6 +556,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontColor + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontColor parameter specifies the color of the watermark text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -523,7 +567,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -533,6 +576,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontName + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontName parameter specifies the font of the watermark text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -541,7 +587,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -551,6 +596,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontSize + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontSize parameter specifies the font size (in points) of the watermark text. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -559,7 +607,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -569,6 +616,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingLayout + +> Applicable: Security & Compliance + The ApplyWaterMarkingLayout parameter specifies the watermark alignment. Valid values are: - Horizontal @@ -580,7 +630,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -590,6 +639,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingText + +> Applicable: Security & Compliance + The ApplyWaterMarkingText parameter specifies the watermark text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -598,7 +650,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -608,13 +659,15 @@ Accept wildcard characters: False ``` ### -ColumnAssetCondition + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -624,13 +677,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -640,13 +695,15 @@ Accept wildcard characters: False ``` ### -Conditions + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MulitValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -656,6 +713,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -665,7 +725,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -675,6 +734,9 @@ Accept wildcard characters: False ``` ### -ContentType + +> Applicable: Security & Compliance + The ContentType parameter specifies where the sensitivity label can be applied. Valid values are: - File @@ -691,7 +753,6 @@ Values can be combined, for example: "File, Email, PurviewAssets". Type: MipLabelContentType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -701,13 +762,15 @@ Accept wildcard characters: False ``` ### -DefaultContentLabel + +> Applicable: Security & Compliance + The DefaultContentLabel specifies a label that can be automatically applied to meetings created in a labeled Teams channel. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -717,6 +780,9 @@ Accept wildcard characters: False ``` ### -DynamicWatermarkDisplay + +> Applicable: Security & Compliance + **Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. The DynamicWatermarkDisplay parameter specifies the watermark text to display for a given label. This parameter supports text and the following special tokens: @@ -730,7 +796,6 @@ This parameter is meaningful only when the ApplyDynamicWatermarkingEnabled param Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -740,6 +805,9 @@ Accept wildcard characters: False ``` ### -EncryptionAipTemplateScopes + +> Applicable: Security & Compliance + The EncryptionAipTemplateScopes parameter specifies that the label is still published and usable in the AIP classic client. An example value is `"['allcompany@labelaction.onmicrosoft.com','admin@labelaction.onmicrosoft.com']"`. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -748,7 +816,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -758,6 +825,9 @@ Accept wildcard characters: False ``` ### -EncryptionContentExpiredOnDateInDaysOrNever + +> Applicable: Security & Compliance + The EncryptionContentExpiredOnDateInDaysOrNever parameter specifies when the encrypted content expires. Valid values are: - An integer (number of days) @@ -769,7 +839,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -779,6 +848,9 @@ Accept wildcard characters: False ``` ### -EncryptionDoNotForward + +> Applicable: Security & Compliance + The EncryptionDoNotForward parameter specifies whether the Do Not Forward template is applied. Valid values are: - $true: The Do Not Forward template is applied. @@ -790,7 +862,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -800,6 +871,9 @@ Accept wildcard characters: False ``` ### -EncryptionDoubleKeyEncryptionUrl + +> Applicable: Security & Compliance + The feature for this parameter is currently in Public Preview, and is not available to everyone. The EncryptionDoubleKeyEncryptionUrl parameter specifies the Double Key Encryption endpoint URL. @@ -812,7 +886,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -822,6 +895,9 @@ Accept wildcard characters: False ``` ### -EncryptionEnabled + +> Applicable: Security & Compliance + The EncryptionEnabled parameter specifies whether encryption in enabled. Valid values are: - $true: Encryption is enabled. @@ -831,7 +907,6 @@ The EncryptionEnabled parameter specifies whether encryption in enabled. Valid v Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -841,6 +916,9 @@ Accept wildcard characters: False ``` ### -EncryptionEncryptOnly + +> Applicable: Security & Compliance + The EncryptionEncryptOnly parameter specifies whether the encrypt-only template is applied. Valid values are: - $true: The encrypt-only template is applied. @@ -852,7 +930,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -862,13 +939,15 @@ Accept wildcard characters: False ``` ### -EncryptionLinkedTemplateId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -878,6 +957,9 @@ Accept wildcard characters: False ``` ### -EncryptionOfflineAccessDays + +> Applicable: Security & Compliance + The EncryptionOfflineAccessDays parameter specifies the number of days that offline access is allowed. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -886,7 +968,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -896,6 +977,9 @@ Accept wildcard characters: False ``` ### -EncryptionPromptUser + +> Applicable: Security & Compliance + The EncryptionPromptUser parameter specifies whether to set the label with user defined permission in Word, Excel, and PowerPoint. Valid values are: - $true: The label is set with user defined permissions in Word, Excel and PowerPoint. @@ -907,7 +991,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -917,6 +1000,9 @@ Accept wildcard characters: False ``` ### -EncryptionProtectionType + +> Applicable: Security & Compliance + The EncryptionProtectionType parameter specifies the protection type for encryption. Valid values are: - Template @@ -929,7 +1015,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -939,6 +1024,9 @@ Accept wildcard characters: False ``` ### -EncryptionRightsDefinitions + +> Applicable: Security & Compliance + The EncryptionRightsDefinitions parameter specifies the rights users have when accessing protected. This parameter uses the syntax `Identity1:Rights1,Rights2;Identity2:Rights3,Rights4`. For example, `john@contoso.com:VIEW,EDIT;microsoft.com:VIEW`. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false and the EncryptionProtectionType parameter value is Template. @@ -947,7 +1035,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: EncryptionRightsDefinitionsParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -957,6 +1044,9 @@ Accept wildcard characters: False ``` ### -EncryptionRightsUrl + +> Applicable: Security & Compliance + The EncryptionRightsUrl parameter specifies the URL for hold your own key (HYOK) protection. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -965,7 +1055,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -975,6 +1064,9 @@ Accept wildcard characters: False ``` ### -EncryptionTemplateId + +> Applicable: Security & Compliance + The EncryptionTemplateId parameter lets you convert an existing protection template from Azure Information Protection to a new sensitivity label. Specify the template by its ID that you can identify by running the [Get-AipServiceTemplate](https://learn.microsoft.com/powershell/module/aipservice/get-aipservicetemplate) cmdlet from the [AIPService PowerShell module](https://learn.microsoft.com/powershell/module/aipservice). This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -983,7 +1075,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -993,13 +1084,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Security & Compliance + The Identity parameter is used to migrate an existing Azure Information Protection label by specifying a GUID value. ```yaml Type: MasterIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1009,13 +1102,15 @@ Accept wildcard characters: False ``` ### -LabelActions + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1025,6 +1120,9 @@ Accept wildcard characters: False ``` ### -LocaleSettings + +> Applicable: Security & Compliance + The LocaleSettings parameter specifies one or more localized label names or label Tooltips in different languages. Regions include all region codes supported in Office Client applications. Valid values use the following syntax: - Label display names: `{"localeKey":"DisplayName","Settings":[{"Key":"en-us","Value":"English display name"},{"Key":"de-de","Value":"Deutscher Anzeigename"},{"Key":"es-es","Value":"Nombre para mostrar en español"}]}` @@ -1034,7 +1132,6 @@ The LocaleSettings parameter specifies one or more localized label names or labe Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1044,13 +1141,15 @@ Accept wildcard characters: False ``` ### -MigrationId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1060,6 +1159,9 @@ Accept wildcard characters: False ``` ### -ParentId + +> Applicable: Security & Compliance + The ParentId parameter specifies the parent label that you want this label to be under (a sublabel). You can use any value that uniquely identifies the parent sensitivity label. For example: - Name @@ -1070,7 +1172,6 @@ The ParentId parameter specifies the parent label that you want this label to be Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1080,13 +1181,15 @@ Accept wildcard characters: False ``` ### -SchematizedDataCondition + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1096,13 +1199,15 @@ Accept wildcard characters: False ``` ### -Setting + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1112,13 +1217,15 @@ Accept wildcard characters: False ``` ### -Settings + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1128,6 +1235,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowAccessToGuestUsers + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowAccessToGuestUsers parameter enables or disables access to guest users. Valid values are: - $true: Guest access is enabled. @@ -1139,7 +1249,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1149,6 +1258,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowEmailFromGuestUsers + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowEmailFromGuestUsers parameter enables or disables email from guest users. Valid values are: - $true: Email from guest users is enabled. @@ -1160,7 +1272,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1170,6 +1281,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowFullAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowFullAccess parameter enables or disables full access. Valid values are: - $true: Full access is enabled. @@ -1181,7 +1295,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1191,6 +1304,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowLimitedAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowLimitedAccess parameter enables or disables limited access. Valid values are: - $true: Limited access is enabled. @@ -1202,7 +1318,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1212,6 +1327,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionBlockAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionBlockAccess parameter blocks access. Valid values are: - $true: Access is blocked. @@ -1223,7 +1341,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1233,6 +1350,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionEnabled + +> Applicable: Security & Compliance + The SiteAndGroupProtectionEnabled parameter enables or disables the Site and Group Protection action for the label. Valid values are: - $true: The Site and Group Protection action is enabled. @@ -1242,7 +1362,6 @@ The SiteAndGroupProtectionEnabled parameter enables or disables the Site and Gro Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1252,13 +1371,15 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionLevel + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SiteAndGroupProtectionLevelParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1268,6 +1389,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionPrivacy + +> Applicable: Security & Compliance + The SiteAndGroupProtectionPrivacy parameter specifies the privacy level for the labe. Valid values are: - Public @@ -1279,7 +1403,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+GroupProtectionPrivacy Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1289,6 +1412,9 @@ Accept wildcard characters: False ``` ### -SiteExternalSharingControlType + +> Applicable: Security & Compliance + The SiteExternalSharingControlType parameter specifies the external user sharing setting for the label. Valid values are: - ExternalUserAndGuestSharing @@ -1307,7 +1433,6 @@ These correspond to the following settings through the admin center: Type: Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1317,6 +1442,9 @@ Accept wildcard characters: False ``` ### -TeamsAllowedPresenters + +> Applicable: Security & Compliance + The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Valid values are: - Everyone @@ -1329,7 +1457,6 @@ The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AllowedPresenters Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1339,6 +1466,9 @@ Accept wildcard characters: False ``` ### -TeamsAllowMeetingChat + +> Applicable: Security & Compliance + The TeamsAllowMeetingChat parameter controls whether chat is available in Teams meetings. Valid values are: - Enabled @@ -1350,7 +1480,6 @@ The TeamsAllowMeetingChat parameter controls whether chat is available in Teams Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.MeetingChatMode Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1360,13 +1489,15 @@ Accept wildcard characters: False ``` ### -TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch + +> Applicable: Security & Compliance + {{ Fill TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1376,6 +1507,9 @@ Accept wildcard characters: False ``` ### -TeamsBypassLobbyForDialInUsers + +> Applicable: Security & Compliance + The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for dial-in users who join Teams meetings. Valid values are: - $true: Dial in users bypass the lobby when joining Teams meetings. @@ -1386,7 +1520,6 @@ The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for d Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1396,13 +1529,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelProtectionEnabled + +> Applicable: Security & Compliance + {{ Fill TeamsChannelProtectionEnabled Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1412,13 +1547,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithExternalTenants + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithExternalTenants Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1428,13 +1565,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithPrivateTeamsOnly + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1444,13 +1583,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithSameLabelOnly + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithSameLabelOnly Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1460,6 +1601,9 @@ Accept wildcard characters: False ``` ### -TeamsCopyRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: - $true: Chat messages can be copied to the clipboard. @@ -1471,7 +1615,6 @@ The value $null (blank) allows users to configure this setting in the Teams app. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1481,6 +1624,9 @@ Accept wildcard characters: False ``` ### -TeamsEndToEndEncryptionEnabled + +> Applicable: Security & Compliance + The TeamsEndToEndEncryptionEnabled parameter controls video stream encryption in Teams meetings. Valid values are: - $true: Video stream encryption is enabled. @@ -1493,7 +1639,6 @@ The value $null (blank) allows users to configure this setting in the Teams app. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1503,6 +1648,9 @@ Accept wildcard characters: False ``` ### -TeamsLobbyBypassScope + +> Applicable: Security & Compliance + The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Teams meetings. Valid values are: - Everyone @@ -1517,7 +1665,6 @@ The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.LobbyBypassScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1527,6 +1674,9 @@ Accept wildcard characters: False ``` ### -TeamsLobbyRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass the lobby when joining Teams meetings. Valid values are: - $true: Users bypass the lobby when joining Teams meetings. @@ -1537,7 +1687,6 @@ The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1547,6 +1696,9 @@ Accept wildcard characters: False ``` ### -TeamsPresentersRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsPresentersRestrictionEnforced parameter controls whether presenter restrictions are enabled in Teams meetings. Valid values are: - $true: Presenter restrictions are enabled in Teams meetings. @@ -1557,7 +1709,6 @@ The TeamsPresentersRestrictionEnforced parameter controls whether presenter rest Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1567,6 +1718,9 @@ Accept wildcard characters: False ``` ### -TeamsProtectionEnabled + +> Applicable: Security & Compliance + The TeamsProtectionEnabled parameter controls whether Teams protection is enabled in Teams meetings. Valid values are: - $true: Teams protection is enabled in Teams meetings. @@ -1576,7 +1730,6 @@ The TeamsProtectionEnabled parameter controls whether Teams protection is enable Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1586,6 +1739,9 @@ Accept wildcard characters: False ``` ### -TeamsRecordAutomatically + +> Applicable: Security & Compliance + The TeamsRecordAutomatically parameter controls whether Teams meetings are automatically recorded after they start. Valid values are: - $true: Teams meetings are automatically recorded after they start. @@ -1596,7 +1752,6 @@ The TeamsRecordAutomatically parameter controls whether Teams meetings are autom Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1606,6 +1761,9 @@ Accept wildcard characters: False ``` ### -TeamsVideoWatermark + +> Applicable: Security & Compliance + The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams meetings. Valid values are: - None @@ -1617,7 +1775,6 @@ The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WaterMarkProtectionValues Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1627,6 +1784,9 @@ Accept wildcard characters: False ``` ### -TeamsWhoCanRecord + +> Applicable: Security & Compliance + The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid values are: - Organizer @@ -1638,7 +1798,6 @@ The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid va Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WhoCanRecordOptions Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1648,13 +1807,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-LabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-LabelPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-LabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-LabelPolicy.md index ce59ac07c5..ab078d7da6 100644 --- a/exchange/exchange-ps/exchange/New-LabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-LabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-labelpolicy applicable: Security & Compliance -title: New-LabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-labelpolicy +schema: 2.0.0 +title: New-LabelPolicy --- # New-LabelPolicy @@ -60,13 +61,15 @@ This example creates the sensitivity label policy named Research and Development ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Labels + +> Applicable: Security & Compliance + The Labels parameter specifies the sensitivity labels that are associated with the policy. You can use any value that uniquely identifies the label. For example: - Name @@ -88,7 +94,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -AdvancedSettings + +> Applicable: Security & Compliance + The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. Specify this parameter with the identity (name or GUID) of the policy, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. @@ -134,7 +142,6 @@ Additionally, for Power BI: Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -144,13 +151,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -169,7 +181,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -179,6 +190,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include in the policy. A valid value is a mailbox. To specify the mailbox, you can use any value that uniquely identifies it. For example: @@ -194,7 +208,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -204,6 +217,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocationException + +> Applicable: Security & Compliance + The ExchangeLocationException parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter. A valid value is a mailbox. To specify the mailbox, you can use any value that uniquely identifies it. For example: @@ -219,7 +235,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -229,6 +244,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -237,7 +255,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -247,13 +264,15 @@ Accept wildcard characters: False ``` ### -MigrationId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -263,6 +282,9 @@ Accept wildcard characters: False ``` ### -ModernGroupLocation + +> Applicable: Security & Compliance + The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. To identify the Microsoft 365 Group, you must use the primary SMTP address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -271,7 +293,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -281,13 +302,15 @@ Accept wildcard characters: False ``` ### -ModernGroupLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -297,13 +320,15 @@ Accept wildcard characters: False ``` ### -OneDriveLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -313,13 +338,15 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -329,6 +356,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. @@ -337,7 +367,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -347,13 +376,15 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -363,13 +394,15 @@ Accept wildcard characters: False ``` ### -Setting + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -379,13 +412,15 @@ Accept wildcard characters: False ``` ### -Settings + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -395,13 +430,15 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -411,13 +448,15 @@ Accept wildcard characters: False ``` ### -SharePointLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -427,13 +466,15 @@ Accept wildcard characters: False ``` ### -SkypeLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -443,13 +484,15 @@ Accept wildcard characters: False ``` ### -SkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -459,13 +502,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-M365DataAtRestEncryptionPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-M365DataAtRestEncryptionPolicy.md index 1182270b7a..ad9a4a3cdd 100644 --- a/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-M365DataAtRestEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-m365dataatrestencryptionpolicy applicable: Exchange Online -title: New-M365DataAtRestEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-m365dataatrestencryptionpolicy +schema: 2.0.0 +title: New-M365DataAtRestEncryptionPolicy --- # New-M365DataAtRestEncryptionPolicy @@ -47,13 +48,15 @@ This example creates a Microsoft 365 data-at-rest multi-workload encryption poli ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the Microsoft 365 data-at-rest encryption policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -AzureKeyIDs + +> Applicable: Exchange Online + The AzureKeyIDs parameter specifies the URL of the encryption key in the Azure Key Vault that's used for encryption. For example, `https://contoso.vault.azure.net/keys/key1/`. You can specify multiple values separated by commas using the following syntax: `"AzureKeyID1","AzureKeyID2",..."AzureKeyIDN"`. @@ -71,7 +77,6 @@ You can specify multiple values separated by commas using the following syntax: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -90,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online + The Description parameter specifies an optional description for the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,6 +143,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -141,7 +155,6 @@ The Enabled parameter specifies whether the policy is enabled or disabled. Valid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -151,13 +164,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/New-MailContact.md similarity index 85% rename from exchange/exchange-ps/exchange/New-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailContact.md index fcccb631e5..7c7abb37c4 100644 --- a/exchange/exchange-ps/exchange/New-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailContact.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailcontact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MailContact -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailcontact +schema: 2.0.0 +title: New-MailContact --- # New-MailContact @@ -58,6 +59,9 @@ This example creates a new mail contact named Chris Ashton. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the mail contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). This value is also used for the DisplayName property if you don't use the DisplayName parameter. @@ -66,7 +70,6 @@ This value is also used for the DisplayName property if you don't use the Displa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. @@ -84,7 +90,6 @@ In on-premises environments, you can use the PrimarySMTPAddress parameter to set Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -118,7 +126,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,6 +135,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -147,7 +157,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -166,7 +178,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the mail contact. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -184,7 +198,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -202,7 +218,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,13 +227,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -228,13 +245,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -244,13 +263,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -260,6 +281,9 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: - BinHex (This is the default value) @@ -276,7 +300,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -286,6 +309,9 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -301,7 +327,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -311,6 +336,9 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -326,7 +354,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -336,6 +363,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this mail contact. A moderator approves messages sent to the mail contact before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -353,7 +383,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -363,6 +392,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -374,7 +406,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -384,6 +415,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter specifies the location in Active Directory where the new contact is created. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -397,7 +431,6 @@ Valid input for this parameter is an organizational unit (OU) or domain that's r Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -407,6 +440,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. @@ -419,7 +455,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -429,6 +464,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -441,7 +479,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -451,6 +488,9 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are: - $true: Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact. @@ -460,7 +500,6 @@ The UsePreferMessageFormat specifies whether the message format settings configu Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -470,13 +509,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailMessage.md b/exchange/exchange-ps/ExchangePowerShell/New-MailMessage.md similarity index 90% rename from exchange/exchange-ps/exchange/New-MailMessage.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailMessage.md index c016c6ef01..15dda9b258 100644 --- a/exchange/exchange-ps/exchange/New-MailMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailmessage applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailmessage +schema: 2.0.0 +title: New-MailMessage --- # New-MailMessage @@ -83,13 +84,15 @@ This example creates an email message in the Drafts folder with the subject and ## PARAMETERS ### -Body + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Body parameter specifies the content of the body section of the new email message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -BodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BodyFormat parameter specifies the format of the message body. The values can be PlainText, Rtf (Rich Text Format), or Html. By default, if the BodyFormat parameter isn't specified when the Body parameter is used, the message body is rendered in plain text. ```yaml Type: MailBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -124,7 +132,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -142,7 +152,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,13 +161,15 @@ Accept wildcard characters: False ``` ### -Subject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Subject parameter specifies the content of the subject field of the new email message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -168,13 +179,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/New-MailUser.md similarity index 86% rename from exchange/exchange-ps/exchange/New-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailUser.md index e468b87dcb..b40c8f5a49 100644 --- a/exchange/exchange-ps/exchange/New-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MailUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailuser +schema: 2.0.0 +title: New-MailUser --- # New-MailUser @@ -234,6 +235,9 @@ This example creates a new mail user for Ed Meadows in the contoso.com cloud-bas ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the mail user. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). This value is also used for the DisplayName property if you don't use the DisplayName parameter. @@ -242,7 +246,6 @@ This value is also used for the DisplayName property if you don't use the Displa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -252,15 +255,17 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. ```yaml Type: ProxyAddress -Parameter Sets: DisabledUser, EnabledUser +Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -269,20 +274,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: ProxyAddress -Parameter Sets: FederatedUser, MicrosoftOnlineServicesID -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +### -FederatedIdentity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online, Exchange Online Protection -### -FederatedIdentity This parameter is available only in the cloud-based service. The FederatedIdentity parameter associates an on-premises Active Directory user with a user in the cloud. @@ -291,7 +286,6 @@ The FederatedIdentity parameter associates an on-premises Active Directory user Type: String Parameter Sets: FederatedUser, MicrosoftOnlineServicesFederatedUser Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -301,13 +295,15 @@ Accept wildcard characters: False ``` ### -MicrosoftOnlineServicesID + +> Applicable: Exchange Online, Exchange Online Protection + The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments. ```yaml Type: WindowsLiveId -Parameter Sets: MicrosoftOnlineServicesID, MicrosoftOnlineServicesFederatedUser +Parameter Sets: MicrosoftOnlineServicesID, MicrosoftOnlineServicesFederatedUser, EnableRoomMailboxAccount Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -316,20 +312,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: WindowsLiveId -Parameter Sets: EnableRoomMailboxAccount -Aliases: -Applicable: Exchange Online, Exchange Online Protection +### -Password -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -### -Password The Password parameter specifies the password for the user's account. You can use the following methods as a value for this parameter: @@ -342,7 +328,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: EnabledUser, HVEAccount, LOBAppAccount, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -352,6 +337,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UserPrincipalName parameter specifies the name of a system user in an email address format (for example, ed@contoso.com). @@ -360,7 +348,6 @@ The UserPrincipalName parameter specifies the name of a system user in an email Type: String Parameter Sets: EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -370,6 +357,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -394,7 +384,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -404,6 +393,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -423,7 +415,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +424,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -442,7 +436,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -452,6 +445,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -460,7 +456,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -470,6 +465,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -478,7 +476,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -488,13 +485,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -504,6 +503,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -512,7 +514,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -522,13 +523,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -538,13 +541,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -554,6 +559,9 @@ Accept wildcard characters: False ``` ### -HVEAccount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The HVEAccount switch specifies that this mail user account is specifically used for the [High volume email service](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365). You don't need to specify a value with this switch. @@ -562,7 +570,6 @@ The HVEAccount switch specifies that this mail user account is specifically used Type: SwitchParameter Parameter Sets: HVEAccount Aliases: -Applicable: Exchange Online, Exchange Online Protection Position: Named Default value: None @@ -572,6 +579,9 @@ Accept wildcard characters: False ``` ### -LOBAppAccount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -580,7 +590,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: LOBAppAccount Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -590,6 +599,9 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: - BinHex (This is the default value) @@ -606,7 +618,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: DisabledUser, EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -616,6 +627,9 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service This parameter is reserved for internal Microsoft use. @@ -624,7 +638,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -634,6 +647,9 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -649,7 +665,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: DisabledUser, EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -659,6 +674,9 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -675,7 +693,6 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: DisabledUser, EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -685,6 +702,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -702,7 +722,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -712,6 +731,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -723,7 +745,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -733,6 +754,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationalUnit parameter specifies the location in Active Directory where the new mail user is created. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -746,7 +770,6 @@ Valid input for this parameter is an organizational unit (OU) or domain that's r Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -756,6 +779,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. @@ -768,7 +794,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -778,6 +803,9 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: - $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value. @@ -791,7 +819,6 @@ A user's experience in any of these management interfaces is still controlled by Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -801,6 +828,9 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ResetPasswordOnNextLogon parameter specifies whether the user must change their password the next time they log on. Valid values are: @@ -812,7 +842,6 @@ The ResetPasswordOnNextLogon parameter specifies whether the user must change th Type: Boolean Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -822,6 +851,9 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. @@ -830,7 +862,6 @@ The SamAccountName parameter (also known as the pre-Windows 2000 user account or Type: String Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -840,6 +871,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -852,7 +886,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -862,6 +895,9 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are: - $true: Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact. @@ -871,7 +907,6 @@ The UsePreferMessageFormat specifies whether the message format settings configu Type: Boolean Parameter Sets: DisabledUser, EnabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -881,13 +916,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/New-Mailbox.md similarity index 90% rename from exchange/exchange-ps/exchange/New-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/New-Mailbox.md index 8a4bb79a06..6e85684156 100644 --- a/exchange/exchange-ps/exchange/New-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-Mailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailbox +schema: 2.0.0 +title: New-Mailbox --- # New-Mailbox @@ -808,6 +809,9 @@ This example assumes that you've already created a mail-enabled security group n ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). In the cloud-based service, many special characters aren't allowed in the Name value (for example, ö, ü, or ä). For more information, see [Error when you try to create a username that contains a special character in Microsoft 365](https://learn.microsoft.com/office/troubleshoot/office-suite-issues/username-contains-special-character). @@ -816,7 +820,6 @@ In the cloud-based service, many special characters aren't allowed in the Name v Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -826,6 +829,9 @@ Accept wildcard characters: False ``` ### -AccountDisabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AccountDisabled switch specifies that the user account associated with the mailbox is disabled. You don't need to specify a value with this switch. @@ -836,7 +842,6 @@ The mailbox is created, and the associated account is created, but the account i Type: SwitchParameter Parameter Sets: DisabledUser Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -846,6 +851,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Arbitration switch is required to create arbitration mailboxes. You don't need to specify a value with this switch. @@ -856,9 +864,8 @@ To create arbitration mailboxes that are used to store audit log settings or dat ```yaml Type: SwitchParameter -Parameter Sets: Arbitration +Parameter Sets: Arbitration, Migration Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -867,20 +874,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: Migration -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -ArchiveDomain -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -ArchiveDomain This parameter is available only in on-premises Exchange. The ArchiveDomain parameter specifies the domain in the cloud-based service where the archive that's associated with this mailbox exists. For example, if the SMTP email address of the user is tony@contoso.com, the SMTP domain could be archive.contoso.com. @@ -891,7 +888,6 @@ Only use this parameter if the archive is hosted in the cloud-based service. Type: SmtpDomain Parameter Sets: RemoteArchive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -901,6 +897,9 @@ Accept wildcard characters: False ``` ### -Discovery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Discovery switch is required to create Discovery mailboxes. You don't need to specify a value with this switch. Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be repurposed or converted to another type of mailbox. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). @@ -909,7 +908,6 @@ Discovery mailboxes are created as target mailboxes for Discovery searches. Afte Type: SwitchParameter Parameter Sets: Discovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -919,6 +917,9 @@ Accept wildcard characters: False ``` ### -EnableRoomMailboxAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: @@ -936,7 +937,6 @@ A room mailbox in Exchange Online is created with associated an account that has Type: Boolean Parameter Sets: EnableRoomMailboxAccount Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -946,6 +946,9 @@ Accept wildcard characters: False ``` ### -Equipment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Equipment switch is required to create equipment mailboxes. You don't need to specify a value with this switch. Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers). @@ -954,7 +957,6 @@ Equipment mailboxes are resource mailboxes that aren't associated with a specifi Type: SwitchParameter Parameter Sets: Equipment Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -964,6 +966,9 @@ Accept wildcard characters: False ``` ### -FederatedIdentity + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FederatedIdentity parameter associates an on-premises Active Directory user with a user in the cloud. @@ -972,7 +977,6 @@ The FederatedIdentity parameter associates an on-premises Active Directory user Type: String Parameter Sets: FederatedUser, MicrosoftOnlineServicesFederatedUser Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -982,15 +986,17 @@ Accept wildcard characters: False ``` ### -InactiveMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The InactiveMailbox parameter specifies the inactive mailbox that you want to recover. To find inactive mailboxes, run the command `Get-Mailbox -InactiveMailboxOnly | Format-List Name,PrimarySmtpAddress,DistinguishedName,ExchangeGuid` and then use the DistinguishedName or ExchangeGuid property values to identify the inactive mailbox for this parameter (only those values are guaranteed to be unique for inactive mailboxes). ```yaml Type: MailboxIdParameter -Parameter Sets: InactiveMailbox +Parameter Sets: InactiveMailbox, User Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -999,20 +1005,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: MailboxIdParameter -Parameter Sets: User -Aliases: -Applicable: Exchange Online +### -LinkedDomainController -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -LinkedDomainController This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if the mailbox is a linked mailbox. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter. Use the fully qualified domain name (FQDN) of the domain controller that you want to use as the value for this parameter. @@ -1023,7 +1019,6 @@ This parameter is required only if you're creating a linked mailbox. Type: String Parameter Sets: Linked, LinkedRoomMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1033,6 +1028,9 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: @@ -1046,7 +1044,6 @@ The LinkedMasterAccount parameter specifies the master account in the forest whe Type: UserIdParameter Parameter Sets: Linked, LinkedRoomMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1056,6 +1053,9 @@ Accept wildcard characters: False ``` ### -LinkedRoom + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedRoom switch is required to create linked resource mailboxes. You don't need to specify a value with this switch. @@ -1066,7 +1066,6 @@ A linked resource mailbox is useful in a scenario where you have an account in a Type: SwitchParameter Parameter Sets: LinkedRoomMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1076,15 +1075,17 @@ Accept wildcard characters: False ``` ### -MicrosoftOnlineServicesID + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter applies only to objects in the cloud-based service and is used instead of the UserPrincipalName parameter. The MicrosoftOnlineServicesID parameter isn't available in on-premises deployments. ```yaml Type: WindowsLiveId -Parameter Sets: MicrosoftOnlineServicesFederatedUser, MicrosoftOnlineServicesFederatedUser +Parameter Sets: MicrosoftOnlineServicesFederatedUser, MicrosoftOnlineServicesFederatedUser, EnableRoomMailboxAccount Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -1093,27 +1094,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: WindowsLiveId -Parameter Sets: EnableRoomMailboxAccount -Aliases: -Applicable: Exchange Online +### -Migration -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -### -Migration The Migration switch is required to create migration mailboxes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Migration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1123,6 +1113,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Password parameter specifies the password for the mailbox (the user account that's associated with the mailbox). This parameter isn't required if you're creating a linked mailbox, resource mailbox, or shared mailbox, because the associated user accounts are disabled for these types of mailboxes. You can use the following methods as a value for this parameter: @@ -1133,9 +1126,8 @@ You can use the following methods as a value for this parameter: ```yaml Type: SecureString -Parameter Sets: User, MicrosoftOnlineServicesID, RemoteArchive +Parameter Sets: User, MicrosoftOnlineServicesID, RemoteArchive, Arbitration, DisabledUser, Discovery, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1144,20 +1136,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecureString -Parameter Sets: Arbitration, DisabledUser, Discovery, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration RemovedMailbox, Room, Shared -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -PublicFolder -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -PublicFolder The PublicFolder switch is required to create public folder mailboxes. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -1168,7 +1150,6 @@ The first public folder mailbox created in your Exchange organization is the pri Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1178,6 +1159,9 @@ Accept wildcard characters: False ``` ### -RemovedMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1186,7 +1170,6 @@ This parameter is reserved for internal Microsoft use. Type: RemovedMailboxIdParameter Parameter Sets: RemovedMailbox Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -1196,6 +1179,9 @@ Accept wildcard characters: False ``` ### -Room + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Room switch is required to create room mailboxes. You don't need to specify a value with this switch. Room mailboxes are resource mailboxes that are associated with a specific location (for example, conference rooms). @@ -1208,7 +1194,6 @@ When you use this switch in Exchange Online, an account with a random, unknown p Type: SwitchParameter Parameter Sets: EnableRoomMailboxAccount, Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1218,6 +1203,9 @@ Accept wildcard characters: False ``` ### -Shared + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Shared switch is required to create shared mailboxes. You don't need to specify a value with this switch. A shared mailbox is a mailbox where multiple users can log on to access the mailbox contents. The mailbox isn't associated with any of the users that can log on. It's associated with a disabled user account. @@ -1226,7 +1214,6 @@ A shared mailbox is a mailbox where multiple users can log on to access the mail Type: SwitchParameter Parameter Sets: Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1236,6 +1223,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. @@ -1244,9 +1234,8 @@ In the cloud-based service, use the MicrosoftOnlineServicesID parameter instead. ```yaml Type: String -Parameter Sets: User, Arbitration, AuditLog, RemoteArchive +Parameter Sets: User, Arbitration, AuditLog, RemoteArchive, AuxAuditLog, DisabledUser,Discovery, EnableRoomMailboxAccount, Equipment, Linked, LinkedRoomMailbox, Migration, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1255,20 +1244,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: AuxAuditLog, DisabledUser,Discovery, EnableRoomMailboxAccount, Equipment, Linked, LinkedRoomMailbox, Migration, Room, Shared, SupervisoryReviewPolicyMailbox -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -ActiveSyncMailboxPolicy -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -ActiveSyncMailboxPolicy The ActiveSyncMailboxPolicy parameter specifies the mobile device mailbox policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example:. - Name @@ -1281,7 +1260,6 @@ If you don't use this parameter, the default mobile device mailbox policy is use Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1291,6 +1269,9 @@ Accept wildcard characters: False ``` ### -AddressBookPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AddressBookPolicy parameter specifies the address book policy that's applied to the mailbox. You can use any value that uniquely identifies the address book policy. For example: @@ -1305,7 +1286,6 @@ For more information about address book policies, see [Address book policies in Type: AddressBookMailboxPolicyIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, MicrosoftOnlineServicesFederatedUser, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1315,6 +1295,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -1339,7 +1322,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1349,6 +1331,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -1368,7 +1353,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, DisabledUser, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1378,13 +1362,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Archive switch specifies that an archive mailbox is created for this mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1394,6 +1380,9 @@ Accept wildcard characters: False ``` ### -ArchiveDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArchiveDatabase parameter specifies the Exchange database that contains the archive that's associated with this mailbox. You can use any value that uniquely identifies the database. For example: @@ -1406,7 +1395,6 @@ The ArchiveDatabase parameter specifies the Exchange database that contains the Type: DatabaseIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1416,6 +1404,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuditLog switch is required to create audit log mailboxes. You don't need to specify a value with this switch. @@ -1428,7 +1419,6 @@ To create other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: AuditLog Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1438,6 +1428,9 @@ Accept wildcard characters: False ``` ### -AuxAuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuxAuditLog switch is required to create auxiliary audit log mailboxes. You don't need to specify a value with this switch. @@ -1450,7 +1443,6 @@ To create other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: AuxAuditLog Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -1460,6 +1452,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -1469,7 +1464,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1479,6 +1473,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Database parameter specifies the mailbox database that contains the mailbox. You can use any value that uniquely identifies the database. For example: @@ -1493,7 +1490,6 @@ Use the Get-MailboxDatabase cmdlet to see the available mailbox databases. Type: DatabaseIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1503,6 +1499,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -1511,7 +1510,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1521,6 +1519,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -1529,7 +1530,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1539,13 +1539,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1555,6 +1557,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -1563,7 +1568,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1573,6 +1577,9 @@ Accept wildcard characters: False ``` ### -HoldForMigration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HoldForMigration switch specifies whether to prevent any client or user, except the Microsoft Exchange Mailbox Replication service (MRS) process, from logging on to a public folder mailbox. You don't need to specify a value with this switch. You need to use this parameter when you create the first public folder, which is called the hierarchy mailbox, in your organization. @@ -1583,7 +1590,6 @@ Use this parameter only if you plan to migrate legacy Exchange 2010 public folde Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1593,6 +1599,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -1601,7 +1610,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1611,13 +1619,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1627,13 +1637,15 @@ Accept wildcard characters: False ``` ### -IsExcludedFromServingHierarchy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsExcludedFromServingHierarchy parameter prevents users from accessing the public folder hierarchy on this public folder mailbox. For load-balancing purposes, users are equally distributed across public folder mailboxes by default. When this parameter is set on a public folder mailbox, that mailbox isn't included in this automatic load-balancing and won't be accessed by users to retrieve the public folder hierarchy. However, if an administrator has set the DefaultPublicFolderMailbox property on a user mailbox to a specific public folder mailbox, the user will still access the specified public folder mailbox even if the IsExcludedFromServingHierarchy parameter is set for that public folder mailbox. ```yaml Type: Boolean Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1643,13 +1655,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1659,6 +1673,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies credentials to use to access the domain controller specified by the LinkedDomainController parameter. This parameter is optional, even if you're enabling a linked mailbox. @@ -1669,7 +1686,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: Linked, LinkedRoomMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1679,6 +1695,9 @@ Accept wildcard characters: False ``` ### -MailboxPlan + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxPlan parameter specifies the mailbox plan to apply to the mailbox. You can use any value that uniquely identifies the mailbox plan. For example: @@ -1697,7 +1716,6 @@ You can see the available mailbox plans by using the Get-MailboxPlan cmdlet. Type: MailboxPlanIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, DisabledUser, FederatedUser, InactiveMailbox, MicrosoftOnlineServicesFederatedUser, RemoteArchive, RemovedMailbox Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1707,6 +1725,9 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxRegion parameter specifies the geo location for the mailbox in multi-geo environments. @@ -1719,7 +1740,6 @@ To see the list of configured geo locations in Microsoft 365 Multi-Geo, run the Type: String Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, MicrosoftOnlineServicesFederatedUser, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1729,6 +1749,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicy + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox policy to enable for the mailbox that you create. @@ -1737,7 +1760,6 @@ The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox po Type: MailboxPolicyIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1747,6 +1769,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicyAllowed + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ManagedFolderMailboxPolicyAllowed switch specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for clients using versions of Microsoft Outlook earlier than Office Outlook 2007. You don't need to specify a value with this switch. @@ -1759,7 +1784,6 @@ Outlook 2003 Service Pack 3 clients are supported but are provided limited funct Type: SwitchParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1769,6 +1793,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1786,7 +1813,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1796,6 +1822,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -1807,7 +1836,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1817,13 +1845,15 @@ Accept wildcard characters: False ``` ### -Office + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Office parameter specifies the user's physical office name or number. ```yaml Type: String Parameter Sets: LinkedRoomMailbox, Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1833,6 +1863,9 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OrganizationalUnit parameter specifies the location in Active Directory where the new mailbox is created. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -1846,7 +1879,6 @@ Valid input for this parameter is an organizational unit (OU) or domain that's r Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1856,13 +1888,15 @@ Accept wildcard characters: False ``` ### -Phone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Phone parameter specifies the user's telephone number. ```yaml Type: String Parameter Sets: LinkedRoomMailbox, Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1872,6 +1906,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If you use the PrimarySmtpAddress parameter to specify the primary email address, the command sets the EmailAddressPolicyEnabled property of the mailbox to False, which means the email addresses of the mailbox aren't automatically updated by email address policies. @@ -1880,7 +1917,6 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1890,6 +1926,9 @@ Accept wildcard characters: False ``` ### -ProxyEmailAddress + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ProxyEmailAddress Description }} @@ -1898,7 +1937,6 @@ This parameter is available only in the cloud-based service. Type: Object Parameter Sets: Arbitration Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1908,6 +1946,9 @@ Accept wildcard characters: False ``` ### -RemoteArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoteArchive switch specifies that a remote archive mailbox is created for this mailbox. A remote archive exists in the cloud-based service. You don't need to specify a value with this switch. @@ -1916,7 +1957,6 @@ The RemoteArchive switch specifies that a remote archive mailbox is created for Type: SwitchParameter Parameter Sets: RemoteArchive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1926,6 +1966,9 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: - $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value. @@ -1939,7 +1982,6 @@ A user's experience in any of these management interfaces is still controlled by Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1949,6 +1991,9 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResetPasswordOnNextLogon parameter specifies whether the user is required to change their password the next time they log on to their mailbox. Valid values are: - $true: The user is required to change their password the next time they log on to their mailbox. @@ -1958,7 +2003,6 @@ The ResetPasswordOnNextLogon parameter specifies whether the user is required to Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1968,13 +2012,15 @@ Accept wildcard characters: False ``` ### -ResourceCapacity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResourceCapacity parameter specifies the capacity of the resource mailbox. For example, you can use this parameter to identify the number of seats in a conference room (room mailbox) or in a vehicle (equipment mailbox). A valid value is an integer. ```yaml Type: Int32 Parameter Sets: Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1984,6 +2030,9 @@ Accept wildcard characters: False ``` ### -RetentionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RetentionPolicy parameter specifies the retention policy that you want applied to this mailbox. You can use any value that uniquely identifies the policy. For example: @@ -2002,7 +2051,6 @@ If you don't use this parameter, the retention policy named Default MRM Policy i Type: MailboxPolicyIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2012,6 +2060,9 @@ Accept wildcard characters: False ``` ### -RoleAssignmentPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RoleAssignmentPolicy parameter specifies the role assignment policy that's applied to the mailbox. You can use any value that uniquely identifies the role assignment policy. For example: - Name @@ -2026,7 +2077,6 @@ Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment pol Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2036,6 +2086,9 @@ Accept wildcard characters: False ``` ### -RoomMailboxPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. Use the RoomMailboxPassword parameter to configure the password for the account that's associated with the room mailbox when that account is enabled and able to log in (the EnableRoomMailboxAccount parameter is set to the value $true). @@ -2060,7 +2113,6 @@ To configure the password for a room mailbox account in Exchange Online, use [Up Type: SecureString Parameter Sets: EnableRoomMailboxAccount Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2070,6 +2122,9 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. @@ -2078,7 +2133,6 @@ The SamAccountName parameter (also known as the pre-Windows 2000 user account or Type: String Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2088,6 +2142,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -2100,7 +2157,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2110,6 +2166,9 @@ Accept wildcard characters: False ``` ### -SharingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SharingPolicy parameter specifies the sharing policy that's applied to the mailbox. You can use any value that uniquely identifies the sharing policy. For example: @@ -2126,7 +2185,6 @@ If you don't use this parameter, the sharing policy named Default Sharing Policy Type: SharingPolicyIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2136,6 +2194,9 @@ Accept wildcard characters: False ``` ### -SupervisoryReviewPolicy + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -2144,7 +2205,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -2154,6 +2214,9 @@ Accept wildcard characters: False ``` ### -TargetAllMDBs + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2162,7 +2225,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, FederatedUser, InactiveMailbox, Linked, LinkedRoomMailbox, MicrosoftOnlineServicesFederatedUser, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2172,6 +2234,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ThrottlingPolicy parameter specifies the throttling policy that's applied to the mailbox. You can use any value that uniquely identifies the throttling policy. For example: @@ -2188,7 +2253,6 @@ By default, no throttling policy is applied to the mailbox. Type: ThrottlingPolicyIdParameter Parameter Sets: User, MicrosoftOnlineServicesID, Arbitration, AuditLog, AuxAuditLog, DisabledUser, Discovery, EnableRoomMailboxAccount, Equipment, InactiveMailbox, Linked, LinkedRoomMailbox, Migration, PublicFolder, RemoteArchive, RemovedMailbox, Room, Shared, SupervisoryReviewPolicyMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2198,13 +2262,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxAuditLogSearch.md similarity index 88% rename from exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxAuditLogSearch.md index 38f9329045..668aa944b8 100644 --- a/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxAuditLogSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxauditlogsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxAuditLogSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxauditlogsearch +schema: 2.0.0 +title: New-MailboxAuditLogSearch --- # New-MailboxAuditLogSearch @@ -65,6 +66,9 @@ This example returns entries from the mailbox audit logs of all users in organiz ## PARAMETERS ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -73,7 +77,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -91,7 +97,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -StatusMailRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StatusMailRecipients parameter specifies the email address where the search results are sent. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -126,7 +136,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -144,7 +156,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -ExternalAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalAccess parameter specifies whether to return only audit log entries for mailbox access by users that are outside of your organization. In Exchange Online, this parameter returns audit log entries for mailbox access by Microsoft datacenter administrators. Valid values are: $true: Audit log entries for mailbox access by external users or Microsoft datacenter administrators are returned. @@ -164,7 +178,6 @@ $false: Audit log entries for mailbox access by external users or Microsoft data Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to include Microsoft 365 Groups in the search. You don't need to specify a value with this switch. @@ -182,7 +198,6 @@ The GroupMailbox switch is required to include Microsoft 365 Groups in the searc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -192,6 +207,9 @@ Accept wildcard characters: False ``` ### -HasAttachments + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The HasAttachments parameter filters the search by messages that have attachments. Valid values are: - $true: Only messages with attachments are included in the search. @@ -201,7 +219,6 @@ The HasAttachments parameter filters the search by messages that have attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -211,6 +228,9 @@ Accept wildcard characters: False ``` ### -LogonTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LogonTypes parameter specifies the type of logons. Valid values are: - Admin: Audit log entries for mailbox access by administrator logons are returned. @@ -224,7 +244,6 @@ You can enter multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -234,6 +253,9 @@ Accept wildcard characters: False ``` ### -Mailboxes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailboxes parameter specifies the mailbox to retrieve mailbox audit log entries from. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -244,7 +266,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -254,13 +275,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a name for the search. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -270,6 +293,9 @@ Accept wildcard characters: False ``` ### -Operations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Operations parameter filters the search results by the operations that are logged by mailbox audit logging. Valid values are: - Copy @@ -291,7 +317,6 @@ You can enter multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -301,13 +326,15 @@ Accept wildcard characters: False ``` ### -ShowDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowDetails switch specifies that details of each log entry are retrieved. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -317,13 +344,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxDatabase.md similarity index 84% rename from exchange/exchange-ps/exchange/New-MailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxDatabase.md index a16092d137..6626bb96cf 100644 --- a/exchange/exchange-ps/exchange/New-MailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MailboxDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxdatabase +schema: 2.0.0 +title: New-MailboxDatabase --- # New-MailboxDatabase @@ -66,13 +67,15 @@ This example creates the mailbox database DB1 on the Mailbox server named Server ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the new mailbox database. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String -Parameter Sets: NonRecovery +Parameter Sets: NonRecovery, Recovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,27 +84,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Recovery -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Recovery -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Recovery The Recovery switch specifies that the new database is designated as a recovery database. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Recovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -111,6 +103,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -122,7 +117,6 @@ The Server parameter specifies the Exchange server where you want to run this co Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -132,13 +126,15 @@ Accept wildcard characters: False ``` ### -AutoDagExcludeFromMonitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDagExcludeFromMonitoring parameter specifies that the database being created should not be monitored by managed availability. ```yaml Type: Boolean Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +144,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -157,7 +156,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,13 +165,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,13 +183,15 @@ Accept wildcard characters: False ``` ### -EdbFilePath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EdbFilePath parameter specifies the path to the database files. The default location is `%ExchangeInstallPath%Mailbox\\.edb`. ```yaml Type: EdbFilePath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,6 +201,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromInitialProvisioning + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsExcludedFromInitialProvisioning switch specifies that this database is temporarily not considered by the mailbox provisioning load balancer. You don't need to specify a value with this switch. If you use this switch, new mailboxes aren't added automatically to this database. @@ -207,7 +212,6 @@ If you use this switch, new mailboxes aren't added automatically to this databas Type: SwitchParameter Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,13 +221,15 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsExcludedFromProvisioning parameter specifies whether this database is considered by the mailbox provisioning load balancer. If the IsExcludedFromProvisioning parameter is set to $true, no new mailboxes are automatically added to this database. ```yaml Type: Boolean Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,13 +239,15 @@ Accept wildcard characters: False ``` ### -IsSuspendedFromProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsSuspendedFromProvisioning parameter specifies whether this database is temporarily considered by the mailbox provisioning load balancer. ```yaml Type: Boolean Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -249,13 +257,15 @@ Accept wildcard characters: False ``` ### -LogFolderPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogFolderPath parameter specifies the folder location for log files.The default location is `%ExchangeInstallPath%Mailbox\` ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -265,13 +275,15 @@ Accept wildcard characters: False ``` ### -OfflineAddressBook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OfflineAddressBook parameter specifies the associated offline address book (OAB) for the new mailbox database. ```yaml Type: OfflineAddressBookIdParameter Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,6 +293,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PublicFolderDatabase parameter specifies the associated public folder database for the new mailbox database. You can use any value that uniquely identifies the public folder database. For example: - Name @@ -291,7 +306,6 @@ The PublicFolderDatabase parameter specifies the associated public folder databa Type: DatabaseIdParameter Parameter Sets: NonRecovery Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -301,13 +315,15 @@ Accept wildcard characters: False ``` ### -SkipDatabaseLogFolderCreation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxExportRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/New-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxExportRequest.md index 56a97e1c20..60444e5677 100644 --- a/exchange/exchange-ps/exchange/New-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MailboxExportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxexportrequest +schema: 2.0.0 +title: New-MailboxExportRequest --- # New-MailboxExportRequest @@ -161,6 +162,9 @@ This example exports all messages from Kweku's Inbox to the .pst file InPlaceHol ## PARAMETERS ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013 + The Mailbox parameter specifies the source mailbox where the contents are being exported from. In Exchange 2016 CU7 or later, this parameter is the type MailboxLocationIdParameter, so the easiest value that you can use to identify the mailbox is the Alias value. @@ -180,9 +184,8 @@ In Exchange 2016 CU6 or earlier, this parameter is the type MailboxOrMailUserIdP ```yaml Type: MailboxOrMailUserIdParameter -Parameter Sets: Mailbox +Parameter Sets: Mailbox, MailboxExportRequest, MailboxComplianceExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: True Position: 1 @@ -191,27 +194,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: MailboxExportRequest, MailboxComplianceExportRequest -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -ComplianceStorePath -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019 -### -ComplianceStorePath This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: MailboxComplianceExportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -221,6 +213,9 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FilePath parameter specifies the network share path of the .pst file to which data is exported, for example, \\\\SERVER01\\PST Files\\exported.pst. You need to grant the following permission to the group Exchange Trusted Subsystem to the network share where you want to export or import PST files: @@ -234,7 +229,6 @@ If you don't grant this permission, you will receive an error message stating th Type: LongPath Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -244,13 +238,15 @@ Accept wildcard characters: False ``` ### -RemoteCredential + +> Applicable: Exchange Server 2013, Exchange Server 2016 + This parameter is reserved for internal Microsoft use. ```yaml Type: PSCredential -Parameter Sets: Mailbox, MailboxExportRequest +Parameter Sets: Mailbox, MailboxExportRequest, MailboxComplianceExportRequest Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -259,20 +255,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: PSCredential -Parameter Sets: MailboxComplianceExportRequest -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -AcceptLargeDataLoss -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -AcceptLargeDataLoss The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -283,7 +269,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +278,9 @@ Accept wildcard characters: False ``` ### -AssociatedMessagesCopyOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AssociatedMessagesCopyOption parameter specifies whether associated messages are copied when the request is processed. Associated messages are special messages that contain hidden data with information about rules, views, and forms. By default, associated messages are copied. This parameter accepts the following values: - DoNotCopy: The associated messages aren't copied. @@ -305,7 +293,6 @@ Content filtering doesn't apply to associated messages. Type: FAICopyOption Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -315,6 +302,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -325,7 +315,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -335,13 +324,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BatchName parameter specifies a descriptive name for exporting a batch of mailboxes. You can use the name in the BatchName parameter as a string search when you use the Get-MailboxExportRequest cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -351,13 +342,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -367,6 +360,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -376,7 +372,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -386,6 +381,9 @@ Accept wildcard characters: False ``` ### -ConflictResolutionOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConflictResolutionOption parameter specifies what to do if there are multiple matching messages in the target. Valid values are: - ForceCopy @@ -399,7 +397,6 @@ The ConflictResolutionOption parameter specifies what to do if there are multipl Type: ConflictResolutionOption Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -409,6 +406,9 @@ Accept wildcard characters: False ``` ### -ContentFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + **Important**: You can't use this parameter to export between two dates. If you try, you'll get system convert errors. You can export from a specific date, or export to a specific date, but not both. The ContentFilter parameter uses OPATH filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter will be exported into the .pst file. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. @@ -426,7 +426,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -436,6 +435,9 @@ Accept wildcard characters: False ``` ### -ContentFilterLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -444,7 +446,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -454,13 +455,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -470,6 +473,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpster + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: @@ -482,7 +488,6 @@ If you don't use this switch, the Recoverable Items folder is copied with the fo Type: SwitchParameter Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -492,6 +497,9 @@ Accept wildcard characters: False ``` ### -ExcludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExcludeFolders parameter specifies the list of folders to exclude during the export. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -528,7 +536,6 @@ To exclude the Recoverable Items folder, you must use the ExcludeDumpster parame Type: String[] Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -538,6 +545,9 @@ Accept wildcard characters: False ``` ### -IncludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeFolders parameter specifies the list of folders to include during the export. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -574,7 +584,6 @@ The Recoverable Items folder is always included if you don't use the ExcludeDump Type: String[] Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -584,13 +593,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -600,13 +611,15 @@ Accept wildcard characters: False ``` ### -IsArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsArchive switch specifies that you're exporting from the user's archive. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -616,6 +629,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -631,7 +647,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -641,6 +656,9 @@ Accept wildcard characters: False ``` ### -MRSServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSServer parameter specifies the FQDN of the Client Access server on which the instance of the Microsoft Exchange Mailbox Replication service (MRS) is running. This parameter is used for debugging purposes only. Use this parameter only if directed by support personnel. @@ -649,7 +667,6 @@ The MRSServer parameter specifies the FQDN of the Client Access server on which Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -659,6 +676,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the specific request for tracking and display purposes. Because you can have multiple export requests per mailbox, Exchange precedes the name with the mailbox's alias. For example, if you create an export request for a user's mailbox that has the alias Kweku and specify the value of this parameter as PC1toArchive, the identity of this export request is Kweku\\PC1toArchive. If you don't specify a name using this parameter, Exchange generates up to 10 request names per mailbox, which is MailboxExportX (where X = 0-9). The identity of the request is displayed and searchable as `\MailboxExportX`. @@ -667,7 +687,6 @@ If you don't specify a name using this parameter, Exchange generates up to 10 re Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -677,13 +696,15 @@ Accept wildcard characters: False ``` ### -PreferredMessageFormat + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: MessageCopyFormat Parameter Sets: MailboxComplianceExportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -693,6 +714,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: - Lower @@ -707,7 +731,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -717,13 +740,15 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -733,6 +758,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -746,7 +774,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: MailboxComplianceExportRequest, MailboxExportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -756,13 +783,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipMerging parameter specifies steps in the export that should be skipped. This parameter is used primarily for debugging purposes. ```yaml Type: SkippableMergeComponent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -772,13 +801,15 @@ Accept wildcard characters: False ``` ### -SourceRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceRootFolder parameter specifies the root folder of the mailbox from which data is exported. If this parameter isn't specified, the command exports all folders. ```yaml Type: String Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -788,6 +819,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. @@ -796,7 +830,6 @@ If you use this switch, the request is queued, but the request won't reach the s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -806,13 +839,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -822,13 +857,15 @@ Accept wildcard characters: False ``` ### -TargetRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetRootFolder parameter specifies the top-level folder in which to export data. If you don't specify this parameter, the command exports folders to the top of the folder structure in the target .pst file. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. ```yaml Type: String Parameter Sets: Mailbox, MailboxExportRequest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -838,13 +875,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -854,13 +893,15 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: RequestWorkloadType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxFolder.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxFolder.md similarity index 90% rename from exchange/exchange-ps/exchange/New-MailboxFolder.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxFolder.md index 8edb27513b..01dfb10e92 100644 --- a/exchange/exchange-ps/exchange/New-MailboxFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxfolder +schema: 2.0.0 +title: New-MailboxFolder --- # New-MailboxFolder @@ -52,13 +53,15 @@ This example creates the folder named Personal in the root folder hierarchy of y ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the new folder. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Parent parameter specifies where to create the new mailbox folder. The syntax is `[MailboxID]:\[ParentFolder][\SubFolder]`. You can only run this cmdlet on your own mailbox, so you don't need to (or can't) specify a `MailboxID` value. @@ -95,7 +101,6 @@ Example values for this parameter are `john@contoso.com:`, `John:\Inbox` Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -114,7 +122,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -132,7 +142,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxImportRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/New-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxImportRequest.md index f037f6aba2..935c6d2a7b 100644 --- a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxImportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxImportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboximportrequest +schema: 2.0.0 +title: New-MailboxImportRequest --- # New-MailboxImportRequest @@ -160,6 +161,9 @@ This example imports all of the .pst files on a shared folder. Each .pst file na ## PARAMETERS ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013 + The Mailbox parameter specifies the destination mailbox where the content is being imported to. In Exchange 2016 CU7 or later, this parameter is the type MailboxLocationIdParameter, so the easiest value that you can use to identify the mailbox is the Alias value. @@ -179,9 +183,8 @@ In Exchange 2016 CU6 or earlier, this parameter is the type MailboxOrMailUserIdP ```yaml Type: MailboxOrMailUserIdParameter -Parameter Sets: Mailbox +Parameter Sets: Mailbox, MailboxLocationId Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: True Position: 1 @@ -190,20 +193,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: MailboxLocationIdParameter -Parameter Sets: MailboxLocationId -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +### -AzureBlobStorageAccountUri -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -AzureBlobStorageAccountUri This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -212,7 +205,6 @@ This parameter is reserved for internal Microsoft use. Type: Uri Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -222,6 +214,9 @@ Accept wildcard characters: False ``` ### -AzureSharedAccessSignatureToken + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -230,7 +225,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -240,6 +234,9 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The FilePath parameter specifies the network share path of the .pst file from which data is imported, for example, \\\\SERVER01\\PST Files\\ToImport.pst. @@ -255,7 +252,6 @@ If you don't grant this permission, you will receive an error message stating th Type: LongPath Parameter Sets: Mailbox, MailboxLocationId Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -265,6 +261,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -275,7 +274,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -285,6 +283,9 @@ Accept wildcard characters: False ``` ### -AssociatedMessagesCopyOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AssociatedMessagesCopyOption parameter specifies whether associated messages are copied when the request is processed. Associated messages are special messages that contain hidden data with information about rules, views, and forms. By default, associated messages are copied. This parameter accepts the following values: - DoNotCopy: The associated messages aren't copied. @@ -297,7 +298,6 @@ Content filtering doesn't apply to associated messages. Type: FAICopyOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -307,6 +307,9 @@ Accept wildcard characters: False ``` ### -AzureStatusPublishEndpointInfo + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -315,7 +318,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -325,6 +327,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -335,7 +340,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -345,13 +349,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter specifies a descriptive name for importing a batch of mailboxes. You can use the name in the BatchName parameter as a string search when you use the Get-MailboxImportRequest cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -361,13 +367,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default value of the CompletedRequestAgeLimit parameter is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -377,6 +385,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -386,7 +397,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -396,6 +406,9 @@ Accept wildcard characters: False ``` ### -ConflictResolutionOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConflictResolutionOption parameter specifies what to do if there are multiple matching messages in the target. Valid values are: - ForceCopy (Exchange 2016 or later) @@ -409,7 +422,6 @@ The ConflictResolutionOption parameter specifies what to do if there are multipl Type: ConflictResolutionOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -419,13 +431,15 @@ Accept wildcard characters: False ``` ### -ContentCodePage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ContentCodePage parameter specifies the specific code page to use for an ANSI pst file. ANSI pst files are used in Outlook 97 to Outlook 2002. You can find the valid values in the [Code Page Identifiers](https://learn.microsoft.com/windows/win32/intl/code-page-identifiers) topic. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -435,6 +449,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -443,7 +460,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -453,6 +469,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpster + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: @@ -465,7 +484,6 @@ If you don't use this switch, the Recoverable Items folder is copied with the fo Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -475,6 +493,9 @@ Accept wildcard characters: False ``` ### -ExcludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExcludeFolders parameter specifies the list of folders to exclude during the import. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -511,7 +532,6 @@ If the TargetRootFolder parameter isn't specified when the Recoverable Items fol Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -521,6 +541,9 @@ Accept wildcard characters: False ``` ### -IncludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeFolders parameter specifies the list of folders to include during the import. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -555,7 +578,6 @@ Wildcard characters can't be used in folder names. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -565,6 +587,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -573,7 +598,6 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: Mailbox, MailboxLocationId Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -583,13 +607,15 @@ Accept wildcard characters: False ``` ### -IsArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsArchive switch specifies that you're importing the .pst file into the user's archive. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -599,6 +625,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -614,7 +643,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -624,6 +652,9 @@ Accept wildcard characters: False ``` ### -MigrationBatch + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use @@ -632,7 +663,6 @@ This parameter is reserved for internal Microsoft use Type: MigrationBatchIdParameter Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -642,13 +672,15 @@ Accept wildcard characters: False ``` ### -MigrationMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: MailboxIdParameter, AzureImportRequest Parameter Sets: MailboxLocationId Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -658,6 +690,9 @@ Accept wildcard characters: False ``` ### -MigrationUser + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -666,7 +701,6 @@ This parameter is reserved for internal Microsoft use. Type: MigrationUserIdParameter Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -676,6 +710,9 @@ Accept wildcard characters: False ``` ### -MRSContentFilterSasUri + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -684,7 +721,6 @@ This parameter is reserved for internal Microsoft use. Type: Uri Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -694,6 +730,9 @@ Accept wildcard characters: False ``` ### -MRSServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSServer parameter specifies the FQDN of the Client Access server on which the instance of the Microsoft Exchange Mailbox Replication service (MRS) is running. This parameter is used for debugging purposes only. Use this parameter only if directed by support personnel. @@ -702,7 +741,6 @@ The MRSServer parameter specifies the FQDN of the Client Access server on which Type: Fqdn Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -712,6 +750,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the specific request for tracking and display purposes. Because you can have multiple import requests per mailbox, Exchange precedes the name with the mailbox's alias. For example, if you create an import request for a user's mailbox that has the alias Kweku and specify the value of this parameter as PC1toArchive, the identity of this import request is Kweku\\PC1toArchive. If you don't specify a name using this parameter, Exchange generates up to 10 request names per mailbox, which is MailboxImportX (where X = 0-9). The identity of the request is displayed and searchable as `\MailboxImportX`. @@ -720,7 +761,6 @@ If you don't specify a name using this parameter, Exchange generates up to 10 re Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -730,6 +770,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Priority parameter specifies the order in which this request should be processed in the request queue. Requests are processed in order, based on server health, status, priority and last update time. @@ -738,7 +781,6 @@ The Priority parameter specifies the order in which this request should be proce Type: RequestPriority Parameter Sets: Mailbox, MailboxLocationId Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -748,6 +790,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -761,7 +806,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: MailboxLocationId, AzureImportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -771,6 +815,9 @@ Accept wildcard characters: False ``` ### -SkipInitialConnectionValidation + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -779,7 +826,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -789,13 +835,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipMerging parameter specifies steps in the import that should be skipped. This parameter is used primarily for debugging purposes. ```yaml Type: SkippableMergeComponent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -805,13 +853,15 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: MailboxLocationId, AzureImportRequest Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -821,13 +871,15 @@ Accept wildcard characters: False ``` ### -SourceRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceRootFolder parameter specifies the root folder of the .pst file from which data is imported. When specified, the folder hierarchy outside the value of the SourceRootFolder parameter isn't imported, and the SourceRootFolder parameter is mapped to the TargetRootFolder parameter. If this parameter isn't specified, the command imports all folders. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -837,6 +889,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. @@ -845,7 +900,6 @@ If you use this switch, the request is queued, but the request won't reach the s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -855,13 +909,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -871,13 +927,15 @@ Accept wildcard characters: False ``` ### -TargetRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetRootFolder parameter specifies the top-level mailbox folder that the imported content is placed in. If you don't specify this parameter, the command imports folders to the top of the folder structure in the target mailbox or archive. If the folder already exists, content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -887,13 +945,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -903,6 +963,9 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -911,7 +974,6 @@ This parameter is reserved for internal Microsoft use. Type: RequestWorkloadType Parameter Sets: Mailbox, MailboxLocationId Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxRepairRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/New-MailboxRepairRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxRepairRequest.md index b5e267cdc2..e79715622b 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxRepairRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxrepairrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MailboxRepairRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxrepairrequest +schema: 2.0.0 +title: New-MailboxRepairRequest --- # New-MailboxRepairRequest @@ -94,6 +95,9 @@ This example creates a variable that identifies Ann Beebe's mailbox and then use ## PARAMETERS ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Database parameter repairs or detects corruption in all mailboxes in the specified database. You can use any value that uniquely identifies the database. For example: - Name @@ -108,7 +112,6 @@ To avoid performance issues, you're limited to one active database repair reques Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Mailbox parameter specifies the mailbox that you want to repair or detect corruption in. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -137,7 +143,6 @@ You can't use this parameter with the Database parameter. Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -147,6 +152,9 @@ Accept wildcard characters: False ``` ### -StoreMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The StoreMailbox parameter specifies the mailbox GUID of the mailbox you want to repair or detect corruption in. Use this parameter with the Database parameter. Run the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. @@ -155,7 +163,6 @@ Run the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. Type: StoreMailboxIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 2 @@ -165,6 +172,9 @@ Accept wildcard characters: False ``` ### -CorruptionType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CorruptionType parameter specifies the type of corruption that you want to detect and repair. You can use the following values: - AbandonedMoveDestination\*: Exchange 2016 or later, but only with the Database parameter, not the Mailbox parameter. @@ -215,7 +225,6 @@ You can specify multiple values separated by commas. Type: MailboxStoreCorruptionType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -225,6 +234,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Archive switch specifies whether to repair or detect corruption the archive mailbox that's associated with the specified mailbox. You don't need to specify a value with this switch. If you don't use this switch, only the primary mailbox is included. @@ -235,7 +247,6 @@ You can't use this switch with the Database parameter. Type: SwitchParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,6 +256,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -254,7 +268,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +277,15 @@ Accept wildcard characters: False ``` ### -DetectOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DetectOnly switch specifies that you want to report errors, but not fix them. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +295,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,6 +313,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. This switch runs the command immediately without waiting to be dispatched by workload management. @@ -304,7 +324,6 @@ This switch runs the command immediately without waiting to be dispatched by wor Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -314,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxRestoreRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxRestoreRequest.md index 43a1b13892..b5a99217c4 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxRestoreRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MailboxRestoreRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxrestorerequest +schema: 2.0.0 +title: New-MailboxRestoreRequest --- # New-MailboxRestoreRequest @@ -263,6 +264,9 @@ In Exchange Online, this example restores the content of the inactive, disconnec ## PARAMETERS ### -CrossTenantRestore + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -271,7 +275,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: CrossTenantRestore Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -281,6 +284,9 @@ Accept wildcard characters: False ``` ### -RemoteCredential + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -289,7 +295,6 @@ This parameter is reserved for internal Microsoft use. Type: PSCredential Parameter Sets: SourceMailbox Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -299,6 +304,9 @@ Accept wildcard characters: False ``` ### -RemoteDatabaseGuid + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -307,7 +315,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: SourceMailbox Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -317,6 +324,9 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -325,7 +335,6 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: SourceMailbox Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -335,6 +344,9 @@ Accept wildcard characters: False ``` ### -RemoteRestoreType + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -343,7 +355,6 @@ This parameter is reserved for internal Microsoft use. Type: RemoteRestoreType Parameter Sets: SourceMailbox Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -353,6 +364,9 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SourceDatabase parameter specifies the identity of the database from which you're restoring the soft-deleted or disconnected mailbox. You can use any value that uniquely identifies the database. For example: @@ -365,7 +379,6 @@ The SourceDatabase parameter specifies the identity of the database from which y Type: DatabaseIdParameter Parameter Sets: Default, MigrationLocalMailboxRestore Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -375,6 +388,9 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -383,7 +399,6 @@ This parameter is reserved for internal Microsoft use. Type: MigrationEndpointIdParameter Parameter Sets: CrossTenantRestore Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -393,6 +408,9 @@ Accept wildcard characters: False ``` ### -SourceExchangeGuid + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -401,7 +419,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: CrossTenantRestore Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -411,13 +428,15 @@ Accept wildcard characters: False ``` ### -SourceMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceMailbox parameter specifies the soft-deleted mailbox that you want to restore. The best way to identify the soft-deleted mailbox is by its GUID value. You can find the GUID value by running the following command: Get-Mailbox -SoftDeletedMailbox. ```yaml Type: SourceMailbox Parameter Sets: SourceMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -427,6 +446,9 @@ Accept wildcard characters: False ``` ### -SourceStoreMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The SourceStoreMailbox parameter specifies the MailboxGUID of the source mailbox that you want to restore content from. @@ -437,7 +459,6 @@ You can find the MailboxGUID by running the Get-MailboxStatistics cmdlet. Type: StoreMailboxIdParameter Parameter Sets: Default, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -447,6 +468,9 @@ Accept wildcard characters: False ``` ### -SourceTenant + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -455,7 +479,6 @@ This parameter is reserved for internal Microsoft use. Type: SmtpDomain Parameter Sets: CrossTenantRestore Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -465,6 +488,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetMailbox parameter specifies the GUID of the target mailbox or mail user where you want to restore content to. The target mailbox or mail user needs to exist before you can run this command successfully. You can find the GUID value for the mailbox or mail user by running the Get-Mailbox or Get-MailUser cmdlets. @@ -475,9 +501,8 @@ In Exchange 2013 or earlier, this parameter is the type MailboxOrMailUserIdParam ```yaml Type: MailboxLocationIdParameter -Parameter Sets: CrossTenantRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Parameter Sets: Default, RemoteMailboxRestoreMailboxId, CrossTenantRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -486,20 +511,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxOrMailUserIdParameter -Parameter Sets: Default, RemoteMailboxRestoreMailboxId -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 +### -AcceptLargeDataLoss -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -AcceptLargeDataLoss The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later or Exchange Online, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -510,7 +525,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -520,6 +534,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyDNMismatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowLegacyDNMismatch switch specifies that the operation should continue if the LegacyExchangeDN of the source physical mailbox and the target mailbox don't match. You don't need to specify a value with this switch. By default, this cmdlet checks to make sure that the LegacyExchangeDN on the source physical mailbox is present on the target user in the form of the LegacyExchangeDN or an X500 proxy address that corresponds to the LegacyExchangeDN. This check prevents you from accidentally restoring a source mailbox into the incorrect target mailbox. @@ -530,7 +547,6 @@ By default, this cmdlet checks to make sure that the LegacyExchangeDN on the sou Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -540,6 +556,9 @@ Accept wildcard characters: False ``` ### -AssociatedMessagesCopyOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AssociatedMessagesCopyOption parameter specifies whether associated messages are copied when the request is processed. Associated messages are special messages that contain hidden data with information about rules, views, and forms. Valid values are: - DoNotCopy: The associated messages aren't copied. @@ -552,7 +571,6 @@ Content filtering doesn't apply to associated messages. Type: FAICopyOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -562,6 +580,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -574,7 +595,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -584,13 +604,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter specifies a descriptive name for restoring a batch of mailboxes. You can use the name in the BatchName parameter as a string search when you use the Get-MailboxRestoreRequest cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -600,13 +622,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the status of a completed restore request is set to Completed. If this parameter is set to a value of 0, the status is cleared immediately instead of being changed to Completed. ```yaml Type: Unlimited Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -616,6 +640,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -625,7 +652,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -635,6 +661,9 @@ Accept wildcard characters: False ``` ### -ConflictResolutionOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConflictResolutionOption parameter specifies what to do if there are multiple matching messages in the target. Valid values are: - ForceCopy @@ -648,7 +677,6 @@ The ConflictResolutionOption parameter specifies what to do if there are multipl Type: ConflictResolutionOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -658,6 +686,9 @@ Accept wildcard characters: False ``` ### -ContentFilter + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ContentFilter parameter uses OPATH filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter will be restored. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. @@ -675,7 +706,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -685,6 +715,9 @@ Accept wildcard characters: False ``` ### -ContentFilterLanguage + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. @@ -695,7 +728,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -705,6 +737,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -713,7 +748,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -723,6 +757,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpster + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: @@ -735,7 +772,6 @@ If you don't use this switch, the Recoverable Items folder is copied with the fo Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -745,6 +781,9 @@ Accept wildcard characters: False ``` ### -ExcludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExcludeFolders parameter specifies the list of folders to exclude during the restore request. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -779,7 +818,6 @@ Wildcard characters can't be used in folder names. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -789,6 +827,9 @@ Accept wildcard characters: False ``` ### -IncludeFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeFolders parameter specifies the list of folder to include during the restore request. Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: @@ -823,7 +864,6 @@ Wildcard characters can't be used in folder names. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -833,6 +873,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -841,7 +884,6 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -851,6 +893,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -868,7 +913,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -878,6 +922,9 @@ Accept wildcard characters: False ``` ### -MRSServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSServer parameter specifies the FQDN of the Client Access server on which the instance of the Microsoft Exchange Mailbox Replication service (MRS) is running. This parameter is used for debugging purposes only. Use this parameter only if directed by support personnel. @@ -886,7 +933,6 @@ The MRSServer parameter specifies the FQDN of the Client Access server on which Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -896,6 +942,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the specific request for tracking and display purposes. Because you can have multiple restore requests per mailbox, Exchange precedes the name with the mailbox's alias. For example, if you create an export request for a user's mailbox that has the alias Kweku and specify the value of this parameter as RestoreFailedMoves, the identity of this export request is Kweku\\RestoreFailedMoves. If you didn't specify a name for the restore request when it was created, Exchange automatically generates the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -904,7 +953,6 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -914,6 +962,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -931,7 +982,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: Default, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -941,6 +991,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: @@ -956,7 +1009,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -966,6 +1018,9 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipMerging parameter specifies folder-related items to skip when restoring the mailbox. Use one of the following values: - FolderACLs @@ -979,7 +1034,6 @@ Use this parameter only if a restore request fails because of folder rules, fold Type: SkippableMergeComponent[] Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -989,6 +1043,9 @@ Accept wildcard characters: False ``` ### -SourceIsArchive + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceIsArchive switch specifies that the source mailbox is an archive mailbox. You don't need to specify a value with this switch. You can use this switch only with the SourceMailbox parameter. @@ -997,7 +1054,6 @@ You can use this switch only with the SourceMailbox parameter. Type: SwitchParameter Parameter Sets: SourceMailboxMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1007,13 +1063,15 @@ Accept wildcard characters: False ``` ### -SourceRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceRootFolder parameter specifies the root folder of the mailbox from which data is restored. If this parameter isn't specified, the command restores all folders. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1023,6 +1081,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. @@ -1031,7 +1092,6 @@ If you use this switch, the request is queued, but the request won't reach the s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1041,13 +1101,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1057,13 +1119,15 @@ Accept wildcard characters: False ``` ### -TargetIsArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetIsArchive switch specifies that the content is restored into the specified target mailbox's archive. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1073,6 +1137,9 @@ Accept wildcard characters: False ``` ### -TargetRootFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetRootFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. **Note**: To restore the contents of a primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders to migrate the content to. This content will be visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. @@ -1081,7 +1148,6 @@ The TargetRootFolder parameter specifies the top-level folder in which to restor Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1091,6 +1157,9 @@ Accept wildcard characters: False ``` ### -TargetType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetType parameter specifies the type of mailbox that's the target for the restore operation. Valid values are: - Archive @@ -1101,7 +1170,6 @@ The TargetType parameter specifies the type of mailbox that's the target for the Type: TargetTypeComponent Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1111,13 +1179,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1127,6 +1197,9 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1135,7 +1208,6 @@ This parameter is reserved for internal Microsoft use. Type: RequestWorkloadType Parameter Sets: MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/New-MailboxSearch.md similarity index 88% rename from exchange/exchange-ps/exchange/New-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/New-MailboxSearch.md index 8c7db70175..33a76bb56f 100644 --- a/exchange/exchange-ps/exchange/New-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MailboxSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MailboxSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mailboxsearch +schema: 2.0.0 +title: New-MailboxSearch --- # New-MailboxSearch @@ -103,6 +104,9 @@ In on-premises Exchange, this example creates an In-Place Hold named Hold for al ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a friendly name for the search. If the value contains spaces, enclose the value in quotation marks ("). The value of this parameter is used to create the top-level folder that holds the search results in the target mailbox that's specified by the TargetMailbox parameter. @@ -111,7 +115,6 @@ The value of this parameter is used to create the top-level folder that holds th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -121,6 +124,9 @@ Accept wildcard characters: False ``` ### -AllPublicFolderSources + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllPublicFolderSources parameter specifies whether to include all public folders in the organization in the search. Valid values are: - $true: All public folders are included in the search. This value is required when the value of the AllSourceMailboxes parameter is $false and you don't specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value is blank [$null]). @@ -130,7 +136,6 @@ The AllPublicFolderSources parameter specifies whether to include all public fol Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -140,6 +145,9 @@ Accept wildcard characters: False ``` ### -AllSourceMailboxes + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllSourceMailboxes parameter specifies whether to include all mailboxes in the search. Valid values are: - $true: All mailboxes are included in the search. This value is required when the value of the AllPublicFolderSources parameter is $false and you don't specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value is blank [$null]). @@ -149,7 +157,6 @@ The AllSourceMailboxes parameter specifies whether to include all mailboxes in t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -159,6 +166,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -168,7 +178,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -178,13 +187,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Description parameter specifies a description for the search. The description isn't displayed to users. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -194,6 +205,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -202,7 +216,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -DoNotIncludeArchive + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The DoNotIncludeArchive switch specifies that archive mailboxes are not included in the search. You don't need to specify a value with this switch. @@ -222,7 +238,6 @@ By default, archive mailboxes are included in the search. To exclude archive mai Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -232,6 +247,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -240,7 +258,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -250,6 +267,9 @@ Accept wildcard characters: False ``` ### -EstimateOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -258,7 +278,6 @@ If you don't use this switch, messages are copied to the target mailbox. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -268,6 +287,9 @@ Accept wildcard characters: False ``` ### -ExcludeDuplicateMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExcludeDuplicateMessages parameter eliminates duplication of messages in search results. Valid values are: - $true: Copy a single instance of a message if the same message exists in multiple folders or mailboxes. This is the default value. @@ -277,7 +299,6 @@ The ExcludeDuplicateMessages parameter eliminates duplication of messages in sea Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,6 +308,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -295,7 +319,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -305,13 +328,15 @@ Accept wildcard characters: False ``` ### -IncludeKeywordStatistics + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeKeywordStatistics switch returns keyword statistics (number of instances for each keyword) in search results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -321,6 +346,9 @@ Accept wildcard characters: False ``` ### -IncludeUnsearchableItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeUnsearchableItems switch specifies that items that couldn't be indexed by Exchange Search should be included in the results. You don't need to specify a value with this switch. Unsearchable items aren't placed on hold for a query-based In-Place Hold. If you need to place unsearchable items on hold, you need to create an indefinite hold (a hold without specifying any search parameters, which provides functionality similar to Litigation Hold. @@ -329,7 +357,6 @@ Unsearchable items aren't placed on hold for a query-based In-Place Hold. If you Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -339,6 +366,9 @@ Accept wildcard characters: False ``` ### -InPlaceHoldEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The InPlaceHoldEnabled parameter specifies whether to set an In-Place Hold on items in the search results. Valid values are: - $true: In-Place Hold is enabled on the search results. @@ -352,7 +382,6 @@ If you attempt to place a hold but don't specify mailboxes using the SourceMailb Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -362,13 +391,15 @@ Accept wildcard characters: False ``` ### -InPlaceHoldIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -378,6 +409,9 @@ Accept wildcard characters: False ``` ### -ItemHoldPeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold onthe mailbox items (all mailbox items or the items that are returned in the search query results). The duration is calculated from the time the item is received or created in the mailbox. Valid values are: - An integer. @@ -387,7 +421,6 @@ The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -397,6 +430,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Language parameter specifies a locale for the search. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -405,7 +441,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -415,6 +450,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LogLevel parameter specifies the logging level for the search. Valid values are: - Suppress: No logs are kept. @@ -425,7 +463,6 @@ The LogLevel parameter specifies the logging level for the search. Valid values Type: LoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -435,6 +472,9 @@ Accept wildcard characters: False ``` ### -MessageTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MessageTypes parameter specifies the message types to include in the search query. Valid values are: - Contacts @@ -454,7 +494,6 @@ The default value is blank ($null), which means all message types are included. Type: KindKeyword[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -464,6 +503,9 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Recipients parameter specifies one or more recipients to include in the search query. Messages that have the specified recipients in the To, Cc, and Bcc fields are returned in the search results. You can specify multiple recipients separated by commas. @@ -472,7 +514,6 @@ You can specify multiple recipients separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -482,6 +523,9 @@ Accept wildcard characters: False ``` ### -SearchDumpster + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The SearchDumpster switch specifies whether the dumpster is searched. You don't need to specify a value with this switch. @@ -492,7 +536,6 @@ The dumpster is a storage area in the mailbox where deleted items are temporaril Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -502,6 +545,9 @@ Accept wildcard characters: False ``` ### -SearchQuery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). If you use this parameter with other search query parameters, the query combines these parameters by using the AND operator. @@ -518,7 +564,6 @@ The other search query parameters are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -528,6 +573,9 @@ Accept wildcard characters: False ``` ### -Senders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Senders parameter specifies one or more senders to include in the search query. Messages that have the specified sender are returned in the search results. Senders can include users, distribution groups (messages sent by members of the group), SMTP addresses, or domains. You can specify multiple senders separated by commas. If the value contains spaces, enclose the value in quotation marks ("). @@ -536,7 +584,6 @@ You can specify multiple senders separated by commas. If the value contains spac Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -546,6 +593,9 @@ Accept wildcard characters: False ``` ### -SourceMailboxes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceMailboxes parameter specifies the identity of one or more mailboxes to be searched. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -570,7 +620,6 @@ To enable In-Place Hold on the search results, you need to set the AllSourceMail Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -580,6 +629,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -588,7 +640,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -598,6 +649,9 @@ Accept wildcard characters: False ``` ### -StatusMailRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StatusMailRecipients parameter specifies one or more recipients to receive a status email message upon completion of the search. You can use any value that uniquely identifies the recipient. For example: - Name @@ -613,7 +667,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -623,6 +676,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetMailbox parameter specifies the destination mailbox where the search results are copied. You can use any value that uniquely identifies themailbox. For example: - Name @@ -640,7 +696,6 @@ The TargetMailbox parameter specifies the destination mailbox where the search r Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -650,13 +705,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterPolicy.md index 0dd0822a20..b137806a42 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-malwarefilterpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MalwareFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-malwarefilterpolicy +schema: 2.0.0 +title: New-MalwareFilterPolicy --- # New-MalwareFilterPolicy @@ -72,13 +73,15 @@ This example creates a new malware filter policy named Contoso Malware Filter Po ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Action parameter specifies the action to take when malware is detected in a message. Valid values are: @@ -100,7 +106,6 @@ The Action parameter specifies the action to take when malware is detected in a Type: MalwareFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -BypassInboundMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BypassInboundMessages parameter enables or disables malware filtering on incoming messages (messages entering the organization). Valid values are: @@ -137,7 +147,6 @@ The BypassInboundMessages parameter enables or disables malware filtering on inc Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,6 +156,9 @@ Accept wildcard characters: False ``` ### -BypassOutboundMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BypassOutboundMessages parameter enables or disables malware filtering on outgoing messages (messages leaving the organization). Valid values are: @@ -158,7 +170,6 @@ The BypassOutboundMessages parameter enables or disables malware filtering on ou Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +179,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -177,7 +191,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,6 +200,9 @@ Accept wildcard characters: False ``` ### -CustomAlertText + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). @@ -197,7 +213,6 @@ This parameter is meaningful only when the value of the Action parameter is Dele Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +222,9 @@ Accept wildcard characters: False ``` ### -CustomExternalBody + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomExternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -218,7 +236,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -CustomExternalSubject + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomExternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -239,7 +259,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -249,6 +268,9 @@ Accept wildcard characters: False ``` ### -CustomFromAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomFromAddress parameter specifies the custom From address to use in notification messages for malware detections in messages from internal or external senders. This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -262,7 +284,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -272,6 +293,9 @@ Accept wildcard characters: False ``` ### -CustomFromName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomFromName parameter specifies the custom From name to use in notification messages for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -285,7 +309,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -295,6 +318,9 @@ Accept wildcard characters: False ``` ### -CustomInternalBody + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomInternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -306,7 +332,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -316,6 +341,9 @@ Accept wildcard characters: False ``` ### -CustomInternalSubject + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomInternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -327,7 +355,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,6 +364,9 @@ Accept wildcard characters: False ``` ### -CustomNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomNotifications parameter enables or disables the customization of notification messages for malware detections. Valid values are: - $true: Replace the default values used in notification messages with the values of the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. @@ -353,7 +383,6 @@ This parameter is meaningful only when the value of at least one of the followin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -363,6 +392,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -371,7 +403,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -381,6 +412,9 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderAdminNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: - $true: When malware attachments are detected in messages from external senders, a notification messages is sent to the email address that's specified by the ExternalSenderAdminAddress parameter. @@ -392,7 +426,6 @@ The EnableExternalSenderAdminNotifications parameter enables or disables sending Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -402,6 +435,9 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EnableExternalSenderNotifications parameter enables or disables sending notification messages to external senders for malware detections in their messages. Valid values are: @@ -413,7 +449,6 @@ The EnableExternalSenderNotifications parameter enables or disables sending noti Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -423,6 +458,9 @@ Accept wildcard characters: False ``` ### -EnableFileFilter + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The EnableFileFilter parameter enables or disables the common attachments filter (also known as common attachment blocking). Valid values are: @@ -438,7 +476,6 @@ You specify the action for detected files using the FileTypeAction parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -448,6 +485,9 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderAdminNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EnableInternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: - $true: When malware attachments are detected in messages from internal senders, a notification messages is sent to the email address that's specified by the InternalSenderAdminAddress parameter. @@ -459,7 +499,6 @@ The EnableInternalSenderAdminNotifications parameter enables or disables sending Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -469,6 +508,9 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EnableInternalSenderNotifications parameter enables or disables sending notification messages to internal senders for malware detections in their messages. Valid values are: @@ -480,7 +522,6 @@ The EnableInternalSenderNotifications parameter enables or disables sending noti Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -490,6 +531,9 @@ Accept wildcard characters: False ``` ### -ExternalSenderAdminAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from external senders. This parameter is meaningful only if the value of the EnableExternalSenderAdminNotifications parameter is $true. @@ -498,7 +542,6 @@ This parameter is meaningful only if the value of the EnableExternalSenderAdminN Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,6 +551,9 @@ Accept wildcard characters: False ``` ### -FileTypeAction + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The FileTypeAction parameter specifies what happens to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: @@ -521,7 +567,6 @@ This parameter is meaningful only when the value of the EnableFileFilter paramet Type: FileTypeFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -531,6 +576,9 @@ Accept wildcard characters: False ``` ### -FileTypes + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The FileTypes parameter specifies the file types that are automatically blocked by the common attachments filter, regardless of content. The default values are: @@ -549,7 +597,6 @@ To add or remove file types without affecting the other file type entries, see t Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -559,6 +606,9 @@ Accept wildcard characters: False ``` ### -InternalSenderAdminAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The InternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from internal senders. This parameter is meaningful only if the value of the EnableInternalSenderAdminNotifications parameter is $true. @@ -567,7 +617,6 @@ This parameter is meaningful only if the value of the EnableInternalSenderAdminN Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -577,6 +626,9 @@ Accept wildcard characters: False ``` ### -QuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware. You can use any value that uniquely identifies the quarantine policy. For example: @@ -595,7 +647,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -605,6 +656,9 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. @@ -613,7 +667,6 @@ The RecommendedPolicyType parameter is used for Standard and Strict policy creat Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -623,13 +676,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -639,6 +694,9 @@ Accept wildcard characters: False ``` ### -ZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware in cloud mailboxes. ZAP detects malware in unread messages that have already been delivered to the user's Inbox. Valid values are: @@ -650,7 +708,6 @@ The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterRule.md similarity index 86% rename from exchange/exchange-ps/exchange/New-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterRule.md index ad4f6ad019..31f0a6a755 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MalwareFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MalwareFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-malwarefilterrule +schema: 2.0.0 +title: New-MalwareFilterRule --- # New-MalwareFilterRule @@ -55,13 +56,15 @@ This example creates a new malware filter rule named Contoso Recipients with the ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the malware filter rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -MalwareFilterPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule. You can use any value that uniquely identifies the policy. For example: @@ -85,7 +91,6 @@ You can't specify the default malware filter policy, and you can't specify a pol Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -120,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -138,7 +150,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Enabled parameter enables or disables the malware filter rule. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -164,13 +177,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -180,6 +195,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -195,7 +213,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -205,6 +222,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -222,7 +242,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -232,6 +251,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -246,7 +268,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -256,13 +277,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -272,6 +295,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -287,7 +313,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -297,6 +322,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -314,7 +342,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -324,13 +351,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagedContentSettings.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagedContentSettings.md similarity index 95% rename from exchange/exchange-ps/exchange/New-ManagedContentSettings.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagedContentSettings.md index 1d10f3fbcb..926d185d37 100644 --- a/exchange/exchange-ps/exchange/New-ManagedContentSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagedContentSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managedcontentsettings applicable: Exchange Server 2010 -title: New-ManagedContentSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managedcontentsettings +schema: 2.0.0 +title: New-ManagedContentSettings --- # New-ManagedContentSettings @@ -66,13 +67,15 @@ This example creates managed content settings CS-Exec-Calendar for the Calendar ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies a unique name for the managed content settings. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -FolderName + +> Applicable: Exchange Server 2010 + The FolderName parameter specifies the name or GUID of the managed folder to which the managed content settings apply. ```yaml Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -MessageClass + +> Applicable: Exchange Server 2010 + The MessageClass parameter specifies the message type to which any expiration and journaling configuration settings within these content settings apply. The parameter value can be a well-known message type such as Calendar items, a specific message class such as IPM.NOTE.SMIME, or a custom message class. The following well-known message types can be used: @@ -130,7 +138,6 @@ Valid parameter values for custom message classes include: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -AddressForJournaling + +> Applicable: Exchange Server 2010 + The AddressForJournaling parameter specifies the journaling recipient where journaled messages are sent. You can use any value that uniquely identifies the recipient. For example: - Name @@ -155,7 +165,6 @@ This parameter is required if the JournalingEnabled parameter is set to $true. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -AgeLimitForRetention + +> Applicable: Exchange Server 2010 + The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -190,7 +204,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -200,13 +213,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -216,13 +231,15 @@ Accept wildcard characters: False ``` ### -JournalingEnabled + +> Applicable: Exchange Server 2010 + The JournalingEnabled parameter specifies that journaling is enabled when set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -232,13 +249,15 @@ Accept wildcard characters: False ``` ### -LabelForJournaling + +> Applicable: Exchange Server 2010 + The LabelForJournaling parameter specifies a label that's attached to an item. This label is used by the destination store to determine the content of the item and enforce the appropriate policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -248,6 +267,9 @@ Accept wildcard characters: False ``` ### -MessageFormatForJournaling + +> Applicable: Exchange Server 2010 + The MessageFormatForJournaling parameter specifies the message format that an item should be journaled in. You can use the following values: - UseMsg Outlook .msg format @@ -257,7 +279,6 @@ The MessageFormatForJournaling parameter specifies the message format that an it Type: JournalingFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -267,6 +288,9 @@ Accept wildcard characters: False ``` ### -MoveToDestinationFolder + +> Applicable: Exchange Server 2010 + The MoveToDestinationFolder parameter specifies the destination folder for a move action. The destination folder must be an existing managed custom folder. If it isn't, an error is returned. If the MoveToDestinationFolder parameter isn't present, and the value of the RetentionAction parameter is MoveToFolder, an error is returned. @@ -275,7 +299,6 @@ The destination folder must be an existing managed custom folder. If it isn't, a Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -285,6 +308,9 @@ Accept wildcard characters: False ``` ### -RetentionAction + +> Applicable: Exchange Server 2010 + The RetentionAction parameter specifies one of the following actions: - Mark as past retention limit @@ -299,7 +325,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -309,13 +334,15 @@ Accept wildcard characters: False ``` ### -RetentionEnabled + +> Applicable: Exchange Server 2010 + The RetentionEnabled parameter specifies that retention is enabled when set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -325,6 +352,9 @@ Accept wildcard characters: False ``` ### -TriggerForRetention + +> Applicable: Exchange Server 2010 + The TriggerForRetention parameter specifies the date that's considered as the start date for the retention period. An item can reach its retention limit a specific number of days after the item was delivered or after it was moved to a folder. Valid values include: @@ -340,7 +370,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionDateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -350,13 +379,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagedFolder.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagedFolder.md similarity index 96% rename from exchange/exchange-ps/exchange/New-ManagedFolder.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagedFolder.md index da5d39bc23..83bb4f8e24 100644 --- a/exchange/exchange-ps/exchange/New-ManagedFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagedFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managedfolder applicable: Exchange Server 2010 -title: New-ManagedFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managedfolder +schema: 2.0.0 +title: New-ManagedFolder --- # New-ManagedFolder @@ -89,6 +90,9 @@ This example creates an instance of the default folder Inbox. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies a unique name for the managed folder object in Active Directory. The name can have up to 65 characters. Whereas the FolderName parameter specifies the folder name as displayed to users in clients, the Name parameter is used by Exchange administration tools to represent the managed folder object. The Name parameter shouldn't be confused with the FolderName parameter. @@ -97,7 +101,6 @@ The Name parameter shouldn't be confused with the FolderName parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -DefaultFolderType + +> Applicable: Exchange Server 2010 + The DefaultFolderType parameter specifies the type of default folder to create, such as Inbox or Deleted Items. A managed folder mailbox policy can have only one managed folder of each default folder type. Additional default folders of a particular type, such as Inbox, can be created and added to different mailbox policies. This allows you to assign different managed content settings for a particular default folder type for different sets of users. @@ -138,7 +144,6 @@ The default folder types that you can specify are: Type: DefaultManagedFolderType Parameter Sets: ManagedDefaultFolder Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -148,6 +153,9 @@ Accept wildcard characters: False ``` ### -FolderName + +> Applicable: Exchange Server 2010 + The FolderName parameter specifies the folder name as it appears in users' mailboxes. The folder name can have up to 255 characters. You can't set the FolderName parameter for managed default folders, such as Inbox. The FolderName parameter shouldn't be confused with the Name parameter. @@ -156,7 +164,6 @@ The FolderName parameter shouldn't be confused with the Name parameter. Type: String Parameter Sets: ManagedCustomFolder Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -166,13 +173,15 @@ Accept wildcard characters: False ``` ### -BaseFolderOnly + +> Applicable: Exchange Server 2010 + The BaseFolderOnly parameter specifies whether the managed content settings should be applied only to the managed folder or to the folder and all its subfolders. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -182,13 +191,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010 + The Comment parameter specifies the default administrator comment to be displayed with the folder in Microsoft Office Outlook 2007 and Microsoft Office Outlook Web App. The comment can have up to 255 characters, including spaces. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -198,6 +209,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -207,7 +221,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -217,13 +230,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -233,13 +248,15 @@ Accept wildcard characters: False ``` ### -LocalizedComment + +> Applicable: Exchange Server 2010 + The LocalizedComment parameter specifies localized administrator comments and their languages. When the language setting of Outlook 2007 matches one of the locales specified in this parameter, the corresponding localized comment is displayed. Comments must be in the form ISOLanguageCode:Comment (for example, -LocalizedComment EN-US:"This is a localized comment in U.S. English"). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -249,13 +266,15 @@ Accept wildcard characters: False ``` ### -LocalizedFolderName + +> Applicable: Exchange Server 2010 + The LocalizedFolderName parameter specifies the localized folder names and their languages. When the language setting of Outlook 2007 matches one of the locales specified in this parameter, the corresponding localized folder name is displayed. Folder names must be in the form ISOLanguageCode:FolderName (for example, -LocalizedFolderName EN-US:"Business Critical"). ```yaml Type: MultiValuedProperty Parameter Sets: ManagedCustomFolder Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -265,13 +284,15 @@ Accept wildcard characters: False ``` ### -MustDisplayCommentEnabled + +> Applicable: Exchange Server 2010 + The MustDisplayCommentEnabled parameter specifies whether to set a flag used by Outlook 2007 to prevent users from minimizing a folder comment (that's visible in Outlook 2007 and Outlook Web App). If the MustDisplayCommentEnabled parameter is present and set to $true, the parameter sets a flag used by Outlook 2007 to prevent users from minimizing a folder comment. If the parameter isn't present or is set to $false, users can minimize the comment. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -281,13 +302,15 @@ Accept wildcard characters: False ``` ### -StorageQuota + +> Applicable: Exchange Server 2010 + The StorageQuota parameter specifies the storage size limit for the mailbox folder. When the folder size exceeds this limit, no additional items may be added. Storage size limits can be specified in kilobytes (KB) or megabytes (MB), for example, 100 KB or 5 MB. ```yaml Type: Unlimited Parameter Sets: ManagedCustomFolder Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -297,13 +320,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagedFolderMailboxPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagedFolderMailboxPolicy.md index 0a4c872b09..f969abf078 100644 --- a/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagedFolderMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managedfoldermailboxpolicy applicable: Exchange Server 2010 -title: New-ManagedFolderMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managedfoldermailboxpolicy +schema: 2.0.0 +title: New-ManagedFolderMailboxPolicy --- # New-ManagedFolderMailboxPolicy @@ -48,13 +49,15 @@ This example creates the managed folder mailbox policy My Managed Folder Mailbox ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the name of the new managed folder mailbox policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -ManagedFolderLinks + +> Applicable: Exchange Server 2010 + The ManagedFolderLinks parameter specifies the list of managed folders to which the managed folder mailbox policy is to be linked. ```yaml Type: ELCFolderIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagementRole.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagementRole.md similarity index 89% rename from exchange/exchange-ps/exchange/New-ManagementRole.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagementRole.md index ba2b48a05a..8a9bd82382 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagementRole.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managementrole applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-ManagementRole -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managementrole +schema: 2.0.0 +title: New-ManagementRole --- # New-ManagementRole @@ -85,13 +86,15 @@ In on-premises Exchange, this example creates the unscoped management role In-ho ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the role. The maximum length of the name is 64 characters. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -101,13 +104,15 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Parent parameter specifies the identity of the role to copy. If the name of the role contains spaces, enclose the name in quotation marks ("). If you specify the Parent parameter, you can't use the UnScopedTopLevel switch. ```yaml Type: RoleIdParameter Parameter Sets: NewDerivedRole Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -131,7 +139,6 @@ You can't use this switch with the Parent parameter. Type: SwitchParameter Parameter Sets: UnScopedTopLevelRole Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -150,7 +160,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,13 +169,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Description parameter specifies the description that's displayed when the management role is viewed using the Get-ManagementRole cmdlet. Enclose the description in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -184,7 +198,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -EnabledCmdlets + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EnabledCmdlets parameter specifies the cmdlets that are copied from the parent role. You can specify multiple values separated by commas. You can only use this parameter with the Parent parameter when you copy a role. @@ -202,7 +218,6 @@ You can only use this parameter with the Parent parameter when you copy a role. Type: String[] Parameter Sets: NewDerivedRole Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -222,7 +240,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -232,13 +249,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagementRoleAssignment.md similarity index 89% rename from exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagementRoleAssignment.md index 9cd0581b13..49a991694b 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagementRoleAssignment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managementroleassignment applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-ManagementRoleAssignment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managementroleassignment +schema: 2.0.0 +title: New-ManagementRoleAssignment --- # New-ManagementRoleAssignment @@ -177,13 +178,15 @@ This example assigns the Mail Recipients role to the Contoso Sub - Seattle role ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies a name for the new management role assignment. The maximum length of the name is 64 characters. If the management role assignment name contains spaces, enclose the name in quotation marks ("). If you don't specify a name, one will be created automatically. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -193,6 +196,9 @@ Accept wildcard characters: False ``` ### -App + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The App parameter specifies the service principal to assign the management role to. Specifically, the ObjectId GUID value from the output of the Get-ServicePrincipal cmdlet (for example, 6233fba6-0198-4277-892f-9275bf728bcc). @@ -205,7 +211,6 @@ You can't use this parameter with the SecurityGroup, Policy, or User cmdlets. Type: ServicePrincipalIdParameter Parameter Sets: App Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -215,6 +220,9 @@ Accept wildcard characters: False ``` ### -Computer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Computer parameter specifies the name of the computer to assign the management role to. @@ -225,7 +233,6 @@ You can't use this parameter with the SecurityGroup, User, or Policy parameters. Type: ComputerIdParameter Parameter Sets: Computer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -235,6 +242,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Policy parameter specifies the name of the management role assignment policy to assign the management role to. If the value contains spaces, enclose the value in quotation marks ("). The IsEndUserRole property of the role you specify using the Role parameter must be set to $true. @@ -245,7 +255,6 @@ You can't use this parameter with the App, SecurityGroup, Computer, or User para Type: MailboxPolicyIdParameter Parameter Sets: Policy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -255,6 +264,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Role parameter specifies the existing role to assign. You can use any value that uniquely identifies the role. For example: - Name @@ -269,7 +281,6 @@ If you use the App parameter, you can't specify admin or user roles; you can onl Type: RoleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -279,6 +290,9 @@ Accept wildcard characters: False ``` ### -SecurityGroup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SecurityGroup parameter specifies the name of the management role group or mail-enabled universal security group to assign the management role to. If the value contains spaces, enclose the value in quotation marks ("). You can't use this parameter with the App, Policy, Computer, or User parameters. @@ -287,7 +301,6 @@ You can't use this parameter with the App, Policy, Computer, or User parameters. Type: SecurityGroupIdParameter Parameter Sets: SecurityGroup Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -297,6 +310,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The User parameter specifies the user to assign the management role to. For the best results, we recommend using the following values: @@ -310,7 +326,6 @@ You can't use this parameter with the App, SecurityGroup, Computer, or Policy pa Type: UserIdParameter Parameter Sets: User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -320,6 +335,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -329,7 +347,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -339,6 +356,9 @@ Accept wildcard characters: False ``` ### -CustomConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CustomConfigWriteScope parameter specifies the existing configuration scope to associate with this management role assignment. If you use the CustomConfigWriteScope parameter you can't use the ExclusiveConfigWriteScope parameter. If the management scope name contains spaces, enclose the name in quotation marks ("). @@ -347,7 +367,6 @@ The CustomConfigWriteScope parameter specifies the existing configuration scope Type: ManagementScopeIdParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,13 +376,15 @@ Accept wildcard characters: False ``` ### -CustomRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomRecipientWriteScope parameter specifies the existing recipient-based management scope to associate with this management role assignment. If the management scope name contains spaces, enclose the name in quotation marks ("). If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope or ExclusiveRecipientWriteScope parameters. ```yaml Type: ManagementScopeIdParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -373,6 +394,9 @@ Accept wildcard characters: False ``` ### -CustomResourceScope + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The CustomResourceScope parameter specifies the custom management scope to associate with this management role assignment. You can use any value that uniquely identifies the management scope. For example: @@ -389,7 +413,6 @@ You use this parameter with the App parameter to assign permissions to service p Type: ManagementScopeIdParameter Parameter Sets: App Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -399,13 +422,15 @@ Accept wildcard characters: False ``` ### -Delegating + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Delegating switch specifies whether the user or USG assigned to the role can delegate the role to other users or groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: SecurityGroup, User, App Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -415,6 +440,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -423,7 +451,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +460,9 @@ Accept wildcard characters: False ``` ### -ExclusiveConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ExclusiveConfigWriteScope parameter specifies the exclusive configuration-based management scope to associate with the new role assignment. If you use the ExclusiveConfigWriteScope parameter, you can't use the CustomConfigWriteScope parameter. If the scope name contains spaces, enclose the name in quotation marks ("). @@ -441,7 +471,6 @@ The ExclusiveConfigWriteScope parameter specifies the exclusive configuration-ba Type: ManagementScopeIdParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -451,13 +480,15 @@ Accept wildcard characters: False ``` ### -ExclusiveRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExclusiveRecipientWriteScope parameter specifies the exclusive recipient-based management scope to associate with the new role assignment. If you use the ExclusiveRecipientWriteScope parameter, you can't use the CustomRecipientWriteScope or RecipientOrganizationalUnitScope parameters. If the scope name contains spaces, enclose the name in quotation marks ("). ```yaml Type: ManagementScopeIdParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -467,6 +498,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -477,7 +511,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -487,6 +520,9 @@ Accept wildcard characters: False ``` ### -RecipientAdministrativeUnitScope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the new role assignment to. @@ -497,7 +533,6 @@ Administrative units are Microsoft Entra containers of resources. You can view t Type: AdministrativeUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -507,6 +542,9 @@ Accept wildcard characters: False ``` ### -RecipientGroupScope + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecipientGroupScope parameter specifies a group to consider for scoping the role assignment. Individual members of the specified group (not nested groups) are considered as in scope for the assignment. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, or DisplayName. @@ -515,7 +553,6 @@ The RecipientGroupScope parameter specifies a group to consider for scoping the Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -525,13 +562,15 @@ Accept wildcard characters: False ``` ### -RecipientOrganizationalUnitScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope or ExclusiveRecipientWriteScope parameters. To specify an OU, use the syntax: domain/ou. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -541,6 +580,9 @@ Accept wildcard characters: False ``` ### -RecipientRelativeWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientRelativeWriteScope parameter specifies the type of restriction to apply to a recipient scope. The available types are None, Organization, MyGAL, Self, and MyDistributionGroups. The RecipientRelativeWriteScope parameter is automatically set when the CustomRecipientWriteScope or RecipientOrganizationalUnitScope parameters are used. Even though the NotApplicable, OU, MyDirectReports, CustomRecipientScope, MyExecutive, MailboxICanDelegate and ExclusiveRecipientScope values appear in the syntax block for this parameter, they can't be used directly on the command line. They are used internally by the cmdlet. @@ -549,7 +591,6 @@ Even though the NotApplicable, OU, MyDirectReports, CustomRecipientScope, MyExec Type: RecipientWriteScopeType Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -559,6 +600,9 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -571,7 +615,6 @@ Unscoped top-level management roles can only contain custom scripts or non-Excha Type: SwitchParameter Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -581,13 +624,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ManagementScope.md b/exchange/exchange-ps/ExchangePowerShell/New-ManagementScope.md similarity index 92% rename from exchange/exchange-ps/exchange/New-ManagementScope.md rename to exchange/exchange-ps/ExchangePowerShell/New-ManagementScope.md index c2fcc0e2d9..61f701edc8 100644 --- a/exchange/exchange-ps/exchange/New-ManagementScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ManagementScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-managementscope applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-ManagementScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-managementscope +schema: 2.0.0 +title: New-ManagementScope --- # New-ManagementScope @@ -127,13 +128,15 @@ This example creates the Seattle Databases scope and sets a database restriction ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the management scope. The name can be up to 64 characters. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -143,6 +146,9 @@ Accept wildcard characters: False ``` ### -DatabaseList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DatabaseList parameter specifies a list of databases to which the scope should be applied. You can use any value that uniquely identifies the database. For example: @@ -159,7 +165,6 @@ You can't use this parameter with the DatabaseRestrictionFilter, ServerList, Rec Type: DatabaseIdParameter[] Parameter Sets: DatabaseList Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -169,6 +174,9 @@ Accept wildcard characters: False ``` ### -DatabaseRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DatabaseRestrictionFilter parameter uses OPATH filter syntax to specify the databases that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. @@ -188,7 +196,6 @@ You can't use this parameter with the RecipientRestrictionFilter, ServerRestrict Type: String Parameter Sets: DatabaseFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -198,6 +205,9 @@ Accept wildcard characters: False ``` ### -RecipientRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientRestrictionFilter parameter uses OPATH filter syntax to specify the recipients that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -215,7 +225,6 @@ You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, S Type: String Parameter Sets: RecipientFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -225,6 +234,9 @@ Accept wildcard characters: False ``` ### -ServerList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ServerList parameter specifies a list of servers to which the scope should be applied. You can use any value that uniquely identifies the server. For example: @@ -242,7 +254,6 @@ You can't use this parameter with the RecipientRestrictionFilter, RecipientRoot, Type: ServerIdParameter[] Parameter Sets: ServerList Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -252,6 +263,9 @@ Accept wildcard characters: False ``` ### -ServerRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ServerRestrictionFilter parameter uses OPATH filter syntax to specify the servers that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. @@ -271,7 +285,6 @@ You can't use this parameter wit the RecipientRestrictionFilter, RecipientRoot, Type: String Parameter Sets: ServerFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -281,6 +294,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -290,7 +306,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,6 +315,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -308,7 +326,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -318,6 +335,9 @@ Accept wildcard characters: False ``` ### -Exclusive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Exclusive switch specifies that the role should be an exclusive scope. You don't need to specify a value with this switch. When you create exclusive management scopes, only users or universal security groups (USG) assigned exclusive scopes that contain objects to be modified can access those objects. Users or USGs that aren't assigned an exclusive scope that contains the objects immediately lose access to those objects. @@ -326,7 +346,6 @@ When you create exclusive management scopes, only users or universal security gr Type: SwitchParameter Parameter Sets: DatabaseList, DatabaseFilter, RecipientFilter, ServerList, ServerFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -336,6 +355,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to create an exclusive scope without showing the warning that the exclusive scope takes effect immediately. @@ -344,7 +366,6 @@ Use this switch to create an exclusive scope without showing the warning that th Type: SwitchParameter Parameter Sets: DatabaseList, DatabaseFilter, RecipientFilter, ServerList, ServerFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -354,6 +375,9 @@ Accept wildcard characters: False ``` ### -RecipientRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. Valid input for this parameter is an OU or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -367,7 +391,6 @@ You can't use this parameter with the ServerRestrictionFilter or DatabaseRestric Type: OrganizationalUnitIdParameter Parameter Sets: RecipientFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -377,13 +400,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-MapiVirtualDirectory.md similarity index 92% rename from exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-MapiVirtualDirectory.md index 54765cae91..631e4cc9bc 100644 --- a/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MapiVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mapivirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-MapiVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mapivirtualdirectory +schema: 2.0.0 +title: New-MapiVirtualDirectory --- # New-MapiVirtualDirectory @@ -55,6 +56,9 @@ This example creates a new MAPI virtual directory that has the following configu ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -64,7 +68,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -102,7 +110,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -121,7 +131,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -143,7 +155,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,6 +164,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. This parameter uses the syntax: `https:///mapi`. For example, `https://external.contoso.com/mapi`. @@ -163,7 +177,6 @@ When you use the InternalUrl or ExternalUrl parameters, you need to specify one Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +186,9 @@ Accept wildcard characters: False ``` ### -IISAuthenticationMethods + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IISAuthenticationMethods parameter specifies the authentication methods that are enabled on the virtual directory in Internet Information Services (IIS). Valid values for this parameter are: - Basic @@ -190,7 +206,6 @@ For more information about the different authentication methods, see [Understand Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. This parameter uses the syntax: `https:///mapi`. For example, `https://internal.contoso.com/mapi`. @@ -210,7 +228,6 @@ When you use the InternalUrl or ExternalUrl parameters, you need to specify one Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,6 +237,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The Role parameter species the configuration for the virtual directory. Valid values are: @@ -233,7 +253,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -254,7 +276,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +285,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +303,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MessageClassification.md b/exchange/exchange-ps/ExchangePowerShell/New-MessageClassification.md similarity index 88% rename from exchange/exchange-ps/exchange/New-MessageClassification.md rename to exchange/exchange-ps/ExchangePowerShell/New-MessageClassification.md index 2692993652..08169fc9b2 100644 --- a/exchange/exchange-ps/exchange/New-MessageClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MessageClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-messageclassification applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MessageClassification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-messageclassification +schema: 2.0.0 +title: New-MessageClassification --- # New-MessageClassification @@ -73,13 +74,15 @@ In on-premises Exchange, this example creates a locale-specific (Spanish - Spain ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name for the message classification. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DisplayName parameter specifies the title of the message classification that's displayed in Outlook and selected by users. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). The message classification XML file must be present on the sender's computer for the display name to be displayed. @@ -97,7 +103,6 @@ The message classification XML file must be present on the sender's computer for Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional on in on-premises Exchange. The Locale parameter specifies a locale-specific version of an existing message classification. You use the -Name parameter to identify the existing message classification, and the SenderDescription parameter to specify the descriptive text in another language. @@ -117,7 +125,6 @@ A valid value for this parameter is a supported culture code value from the Micr Type: CultureInfo Parameter Sets: Localized Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -127,13 +134,15 @@ Accept wildcard characters: False ``` ### -SenderDescription + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SenderDescription parameter specifies the detailed text that's shown to Outlook senders when they select a message classification to apply to a message before they send the message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -ClassificationID + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ClassificationID parameter specifies the classification ID (GUID) of an existing message classification that you want to import and use in your Exchange organization. Use this parameter if you're configuring message classifications that span two Exchange forests in the same organization. To find the ClassificationID value of the message classification, replace `` with the name of the message classification and run the following command: `Get-MessageClassification -Identity ""`. @@ -151,7 +163,6 @@ To find the ClassificationID value of the message classification, replace ` Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -170,7 +184,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -DisplayPrecedence + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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 @@ -198,7 +214,6 @@ Although Outlook only lets a user specify a single classification for a message, Type: ClassificationDisplayPrecedenceLevel Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,6 +223,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -218,7 +236,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -PermissionMenuVisible + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PermissionMenuVisible parameter specifies whether the values that you entered for the DisplayName and RecipientDescription parameters are displayed in Outlook as the user composes a message. Valid values are: - $true: Users can assign the message classification to messages before they're sent, and the classification information is displayed. This is the default value. @@ -237,7 +257,6 @@ The PermissionMenuVisible parameter specifies whether the values that you entere Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,6 +266,9 @@ Accept wildcard characters: False ``` ### -RecipientDescription + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientDescription parameter specifies the detailed text that's shown to Outlook recipient when they receive a message that has the message classification applied. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use this parameter, the value of the SenderDescription parameter is used. @@ -255,7 +277,6 @@ If you don't use this parameter, the value of the SenderDescription parameter is Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -RetainClassificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetainClassificationEnabled parameter specifies whether the message classification should persist with the message if the message is forwarded or replied to. The default value is $true. @@ -273,7 +297,6 @@ The default value is $true. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -283,13 +306,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/New-MigrationBatch.md similarity index 93% rename from exchange/exchange-ps/exchange/New-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/New-MigrationBatch.md index e17cdd2090..ef66847557 100644 --- a/exchange/exchange-ps/exchange/New-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MigrationBatch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MigrationBatch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-migrationbatch +schema: 2.0.0 +title: New-MigrationBatch --- # New-MigrationBatch @@ -585,6 +586,9 @@ A Google Workspace migration batch is created that uses the CSV migration file g ## PARAMETERS ### -UserIds + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UserIds parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify a user by email address or by their Guid property value from the Get-MigrationUser cmdlet. You can specify multiple users separated by commas. The users that you specify for this parameter must be defined in an existing migration batch. @@ -595,7 +599,6 @@ To disable the migration of the users in the original migration batch, use the D Type: MultiValuedProperty Parameter Sets: PreexistingUserIds Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -605,6 +608,9 @@ Accept wildcard characters: False ``` ### -Users + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Users parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify the users by using the Get-MigrationUser cmdlet. For example: $Failed = Get-MigrationUser -Status Failed @@ -619,7 +625,6 @@ To disable the migration of the users in the original migration batch, use the D Type: MultiValuedProperty Parameter Sets: Preexisting, PreexistingUsers Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -629,6 +634,9 @@ Accept wildcard characters: False ``` ### -Analyze + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Analyze Description }} @@ -637,7 +645,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Analysis Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -647,6 +654,9 @@ Accept wildcard characters: False ``` ### -ManagedGmailTeams + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ManagedGmailTeams Description }} @@ -655,7 +665,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ManagedGmailTeams Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -665,13 +674,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies an unique name for the migration batch on each system (Exchange On-premises or Exchange Online). The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -681,6 +692,9 @@ Accept wildcard characters: False ``` ### -CSVData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see [CSV files for mailbox migration](https://learn.microsoft.com/exchange/csv-files-for-mailbox-migration-exchange-2013-help). A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -689,9 +703,8 @@ A valid value for this parameter requires you to read the file to a byte-encoded ```yaml Type: Byte[] -Parameter Sets: Abch, Analysis, FolderMove, Local, LocalPublicFolder, Offboarding, XO1, PublicFolderToUnifiedGroup, GoogleResourceOnboarding, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery +Parameter Sets: Abch, Analysis, FolderMove, Local, LocalPublicFolder, Offboarding, XO1, PublicFolderToUnifiedGroup, GoogleResourceOnboarding, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery, Onboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -700,20 +713,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Byte[] -Parameter Sets: Onboarding -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Local -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Local This parameter is available only in on-premises Exchange. The Local switch specifies a local move (mailboxes are moved to a different mailbox database in the same Active Directory forest). You don't need to specify a value with this switch. @@ -722,7 +725,6 @@ The Local switch specifies a local move (mailboxes are moved to a different mail Type: SwitchParameter Parameter Sets: Local Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -732,6 +734,9 @@ Accept wildcard characters: False ``` ### -SourcePublicFolderDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SourcePublicFolderDatabase parameter specifies the source public folder database that's used in a public folder migration. You can use any value that uniquely identifies the database. For example: @@ -744,7 +749,6 @@ The SourcePublicFolderDatabase parameter specifies the source public folder data Type: DatabaseIdParameter Parameter Sets: LocalPublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -754,6 +758,9 @@ Accept wildcard characters: False ``` ### -AdoptPreexisting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AdoptPreexisting Description }} @@ -762,7 +769,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding, Local, Offboarding, GoogleResourceOnboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -772,6 +778,9 @@ Accept wildcard characters: False ``` ### -AllowIncrementalSyncs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AllowIncrementalSyncs parameter specifies whether to enable or disable incremental synchronization. Valid values are: @@ -783,7 +792,6 @@ The AllowIncrementalSyncs parameter specifies whether to enable or disable incre Type: Boolean Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -793,6 +801,9 @@ Accept wildcard characters: False ``` ### -AllowUnknownColumnsInCsv + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowUnknownColumnsInCsv parameter specifies whether to allow extra columns in the CSV file that aren't used by migration. Valid values are: - $true: The migration ignores (silently skips) unknown columns in the CSV file (including optional columns with misspelled column headers). All unknown columns are treated like extra columns that aren't used by migration. @@ -802,7 +813,6 @@ The AllowUnknownColumnsInCsv parameter specifies whether to allow extra columns Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -812,6 +822,9 @@ Accept wildcard characters: False ``` ### -ArchiveDomain + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ArchiveDomain Description }} @@ -820,7 +833,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: Onboarding, Offboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -830,6 +842,9 @@ Accept wildcard characters: False ``` ### -ArchiveOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ArchiveOnly switch specifies that only archive mailboxes are migrated for the users in the migration batch (primary mailboxes aren't migrated). You don't need to specify a value with this switch. You can only use this switch for local moves and remote move migrations. @@ -840,7 +855,6 @@ You can use the TargetArchiveDatabases parameter to specify the database to migr Type: SwitchParameter Parameter Sets: Local, Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -850,6 +864,9 @@ Accept wildcard characters: False ``` ### -AutoComplete + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AutoComplete switch forces the finalization of the individual mailboxes as soon as the mailbox has completed initial synchronization. You don't need to specify a value with this switch. You can only use this switch for local moves and remote move migrations. @@ -860,7 +877,6 @@ If you don't use this switch, you need to run the Complete-MigrationBatch cmdlet Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -870,6 +886,9 @@ Accept wildcard characters: False ``` ### -AutoProvisioning + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AutoProvisioning Description }} @@ -878,7 +897,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -888,6 +906,9 @@ Accept wildcard characters: False ``` ### -AutoRetryCount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AutoRetryCount parameter specifies the number of attempts to restart the migration batch to migrate mailboxes that encountered errors. @@ -896,7 +917,6 @@ The AutoRetryCount parameter specifies the number of attempts to restart the mig Type: Int32 Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -906,6 +926,9 @@ Accept wildcard characters: False ``` ### -AutoStart + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AutoStart switch immediately starts the processing of the new migration batch. You don't need to specify a value with this switch. If you don't use this switch, you need to manually start the migration batch by using the Start-MigrationBatch cmdlet. @@ -914,7 +937,6 @@ If you don't use this switch, you need to manually start the migration batch by Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -924,6 +946,9 @@ Accept wildcard characters: False ``` ### -AvoidMergeOverlap + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AvoidMergeOverlap Description }} @@ -932,7 +957,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -942,6 +966,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the migration request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the migration request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the migration request again. @@ -952,7 +979,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, FolderMove Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -962,6 +988,9 @@ Accept wildcard characters: False ``` ### -CompleteAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but completion won't start until the date/time you specify with this parameter. @@ -977,7 +1006,6 @@ In Exchange Online PowerShell, if you specify a date/time value without a time z Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -987,6 +1015,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -996,7 +1027,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1006,6 +1036,9 @@ Accept wildcard characters: False ``` ### -ContentFilter + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service for IMAP migration and Google Workspace migration. The ContentFilter parameter uses OPATH filter syntax to filter the messages by Received time. Only content that match the ContentFilter parameter will be moved to Exchange online. For example: @@ -1020,7 +1053,6 @@ You can specify the language by using the ContentFilterLanguage parameter. Type: String Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1030,6 +1062,9 @@ Accept wildcard characters: False ``` ### -ContentFilterLanguage + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service for IMAP migration and Google Workspace migration. The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. @@ -1040,7 +1075,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1050,6 +1084,9 @@ Accept wildcard characters: False ``` ### -DataFusion + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DataFusion Description }} @@ -1058,7 +1095,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1068,13 +1104,15 @@ Accept wildcard characters: False ``` ### -DisableOnCopy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DisableOnCopy switch disables the original migration job item for a user if you're copying users from an existing batch to a new batch by using the UserIds or Users parameters. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: PreexistingUserIds, Preexisting, PreexistingUsers Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1084,6 +1122,9 @@ Accept wildcard characters: False ``` ### -DisallowExistingUsers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DisallowExistingUsers switch prevents the migration of mailboxes that are currently defined in a different migration batch. You don't need to specify a value with this switch. @@ -1094,7 +1135,6 @@ A validation warning is displayed for any pre-existing mailbox in the target des Type: SwitchParameter Parameter Sets: Local, Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1104,6 +1144,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -1112,7 +1155,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1122,6 +1164,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpsters + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExcludeDumpsters switch specifies whether to migrate public folder mailboxes without including the contents of the Recoverable Items folder (formerly known as the dumpster). You don't need to specify a value with this switch. @@ -1132,7 +1177,6 @@ You use this switch only in public folder migrations from Exchange 2013 or later Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1142,6 +1186,9 @@ Accept wildcard characters: False ``` ### -ExcludeFolders + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration or Google Workspace migration, the ExcludeFolders parameter specifies mailbox folders that you don't want to migrate from the source email system to the cloud-based mailboxes. Specify the value as a string array and separate multiple folder names with commas. @@ -1177,7 +1224,6 @@ Wildcard characters can't be used in folder names. Type: MultiValuedProperty Parameter Sets: Onboarding, Analysis Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1187,6 +1233,9 @@ Accept wildcard characters: False ``` ### -ForwardingDisposition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ForwardingDisposition Description }} @@ -1195,7 +1244,6 @@ This parameter is available only in the cloud-based service. Type: GmailForwardingDisposition Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1205,13 +1253,15 @@ Accept wildcard characters: False ``` ### -GoogleResource + +> Applicable: Exchange Online + {{ Fill GoogleResource Description }} ```yaml Type: SwitchParameter Parameter Sets: GoogleResourceOnboarding Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -1221,6 +1271,9 @@ Accept wildcard characters: False ``` ### -IncludeFolders + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration or Google Workspace migration, the IncludeFolders parameter specifies mailbox folders that you want to migrate from the on-premises email system to the cloud-based mailboxes. Specify the value as a string array and separate multiple folder names with commas. @@ -1256,7 +1309,6 @@ Wildcard characters can't be used in folder names. Type: MultiValuedProperty Parameter Sets: Onboarding, Analysis Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1266,6 +1318,9 @@ Accept wildcard characters: False ``` ### -IncludeOtherContacts + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeOtherContacts Description }} @@ -1274,7 +1329,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1284,6 +1338,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the migration request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -1299,7 +1356,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: Onboarding, Offboarding, LocalPublicFolder, PublicFolderToUnifiedGroup, FolderMove Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1309,6 +1365,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Locale parameter specifies the language for the migration batch. @@ -1319,7 +1378,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1329,6 +1387,9 @@ Accept wildcard characters: False ``` ### -MigrateTasks + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MigrateTasks Description }} @@ -1337,7 +1398,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1347,6 +1407,9 @@ Accept wildcard characters: False ``` ### -MoveOptions + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The MoveOptions parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. Don't use this parameter with the SkipMoving parameter. @@ -1355,7 +1418,6 @@ Don't use this parameter with the SkipMoving parameter. Type: MultiValuedProperty Parameter Sets: Onboarding, Local, Offboarding, FolderMove Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1365,6 +1427,9 @@ Accept wildcard characters: False ``` ### -NotificationEmails + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NotificationEmails parameter specifies one or more email addresses that migration status reports are sent to. Specify the value as a string array, and separate multiple email addresses with commas. If you don't use this parameter, the status report isn't sent. @@ -1373,7 +1438,6 @@ If you don't use this parameter, the status report isn't sent. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1383,6 +1447,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1391,7 +1458,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: PreexistingUserIds, Onboarding, Local, Offboarding, PublicFolderToUnifiedGroup, WorkflowTemplate, PreexistingUsers, GoogleResourceOnboarding, FolderMove, Analysis, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1401,6 +1467,9 @@ Accept wildcard characters: False ``` ### -PrimaryOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PrimaryOnly switch specifies that only primary mailboxes are migrated for the users in the migration batch that also have archive mailboxes (archive mailboxes aren't migrated). You don't need to specify a value with this switch. You can only use this switch for local moves and remote move migrations. @@ -1411,7 +1480,6 @@ You can only use this switch for local moves and remote move migrations. Type: SwitchParameter Parameter Sets: Local, Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1421,6 +1489,9 @@ Accept wildcard characters: False ``` ### -PublicFolderToUnifiedGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The PublicFolderToUnifiedGroup switch specifies a migration from public folders to Microsoft 365 Groups. You don't need to specify a value with this switch. @@ -1429,7 +1500,6 @@ The PublicFolderToUnifiedGroup switch specifies a migration from public folders Type: SwitchParameter Parameter Sets: PublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -1439,6 +1509,9 @@ Accept wildcard characters: False ``` ### -RemoveOnCopy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RemoveOnCopy Description }} @@ -1447,7 +1520,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding, Local, Offboarding, GoogleResourceOnboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1457,6 +1529,9 @@ Accept wildcard characters: False ``` ### -RenamePrimaryCalendar + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RenamePrimaryCalendar Description }} @@ -1465,7 +1540,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1475,6 +1549,9 @@ Accept wildcard characters: False ``` ### -ReportInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReportInterval parameter specifies how frequently emailed reports should be sent to the email addresses listed within NotificationEmails. By default, emailed reports are sent every 24 hours for a batch. Setting this value to 0 indicates that reports should never be sent for this batch. @@ -1485,7 +1562,6 @@ This parameter should only be used in the cloud-based service. Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1495,6 +1571,9 @@ Accept wildcard characters: False ``` ### -Restore + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Restore Description }} @@ -1503,7 +1582,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1513,6 +1591,9 @@ Accept wildcard characters: False ``` ### -SimplifiedSwitchOver + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SimplifiedSwitchOver Description }} @@ -1521,7 +1602,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1531,6 +1611,9 @@ Accept wildcard characters: False ``` ### -SkipCalendar + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SkipCalendar switch specifies that you want to skip calendar migration during Google Workspace onboarding. You don't need to specify a value with this switch. @@ -1539,7 +1622,6 @@ The SkipCalendar switch specifies that you want to skip calendar migration durin Type: SwitchParameter Parameter Sets: Onboarding, ManagedGmailTeams Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1549,6 +1631,9 @@ Accept wildcard characters: False ``` ### -SkipContacts + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SkipContacts switch specifies that you want to skip contact migration during Google Workspace onboarding. You don't need to specify a value with this switch. @@ -1557,7 +1642,6 @@ The SkipContacts switch specifies that you want to skip contact migration during Type: SwitchParameter Parameter Sets: Onboarding, ManagedGmailTeams Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1567,6 +1651,9 @@ Accept wildcard characters: False ``` ### -SkipDelegates + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipDelegates Description }} @@ -1575,7 +1662,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding, GoogleResourceOnboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1585,6 +1671,9 @@ Accept wildcard characters: False ``` ### -SkipDetails + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipDetails Description }} @@ -1593,7 +1682,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Analysis Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1603,6 +1691,9 @@ Accept wildcard characters: False ``` ### -SkipMail + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SkipMail switch specifies that you want to skip mail migration during Google Workspace onboarding. You don't need to specify a value with this switch. @@ -1611,7 +1702,6 @@ The SkipMail switch specifies that you want to skip mail migration during Google Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1621,13 +1711,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipMerging parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. ```yaml Type: MultiValuedProperty Parameter Sets: Onboarding, Offboarding, LocalPublicFolder, XO1, GoogleResourceOnboarding Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1637,6 +1729,9 @@ Accept wildcard characters: False ``` ### -SkipMoving + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -1645,7 +1740,6 @@ The SkipMoving parameter specifies the stages of the migration that you want to Type: MultiValuedProperty Parameter Sets: Local, Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1655,6 +1749,9 @@ Accept wildcard characters: False ``` ### -SkipProvisioning + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SkipProvisioning Description }} @@ -1663,7 +1760,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Onboarding, GoogleResourceOnboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1673,13 +1769,15 @@ Accept wildcard characters: False ``` ### -SkipReports + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipReports switch specifies that you want to skip automatic reporting for the migration. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1689,6 +1787,9 @@ Accept wildcard characters: False ``` ### -SkipRules + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SkipRules switch specifies that you want to skip rule migration during Google Workspace onboarding. You don't need to specify a value with this switch. @@ -1697,7 +1798,6 @@ The SkipRules switch specifies that you want to skip rule migration during Googl Type: SwitchParameter Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1707,6 +1807,9 @@ Accept wildcard characters: False ``` ### -SkipSteps + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SkipSteps parameter specifies the steps in the staged Exchange migration that you want to skip. Valid values are: @@ -1720,7 +1823,6 @@ This parameter is only enforced for staged Exchange migrations. Type: SkippableMigrationSteps[] Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1730,6 +1832,9 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceEndpoint parameter specifies the migration endpoint to use for the source of the migration batch. You create the migration endpoint by using the New-MigrationEndpoint cmdlet. You can use any value that uniquely identifies the migration endpoint. For example: - Name (the Identity property value) @@ -1741,7 +1846,6 @@ This parameter defines the settings that are used to connect to the server where Type: MigrationEndpointIdParameter Parameter Sets: Onboarding, PublicFolderToUnifiedGroup, GoogleResourceOnboarding, Analysis Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1751,6 +1855,9 @@ Accept wildcard characters: False ``` ### -SourcePFPrimaryMailboxGuid + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SourcePFPrimaryMailboxGuid Description }} @@ -1759,7 +1866,6 @@ This parameter is available only in the cloud-based service. Type: Guid Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1769,6 +1875,9 @@ Accept wildcard characters: False ``` ### -StartAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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". @@ -1782,7 +1891,6 @@ In Exchange Online PowerShell, if you specify a date/time value without a time z Type: DateTime Parameter Sets: Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1792,6 +1900,9 @@ Accept wildcard characters: False ``` ### -TargetArchiveDatabases + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetArchiveDatabases parameter specifies the database where the archive mailboxes specified in the migration batch will be migrated to. You can use any value that uniquely identifies the database. For example: - Name @@ -1808,7 +1919,6 @@ You can only use this parameter for local moves and remote move migrations. Type: MultiValuedProperty Parameter Sets: Local, Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1818,6 +1928,9 @@ Accept wildcard characters: False ``` ### -TargetDatabases + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetDatabases parameter specifies the identity of the database that you're moving mailboxes to. You can use any value that uniquely identifies the database. For example: - Name @@ -1836,7 +1949,6 @@ If you don't use this parameter for a local move, the cmdlet uses the automatic Type: MultiValuedProperty Parameter Sets: Onboarding, Local, Offboarding, XO1, Abch Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1846,6 +1958,9 @@ Accept wildcard characters: False ``` ### -TargetDeliveryDomain + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the migration batch is complete. This parameter is required for remote move onboarding and remote offboarding migration batches @@ -1854,7 +1969,6 @@ This parameter is required for remote move onboarding and remote offboarding mig Type: String Parameter Sets: Onboarding, Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1864,6 +1978,9 @@ Accept wildcard characters: False ``` ### -TargetEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetEndpoint parameter specifies the migration endpoint to use for the destination of the migration batch. You create the migration endpoint by using the New-MigrationEndpoint cmdlet. You can use any value that uniquely identifies the migration endpoint. For example: - Name (the Identity property value) @@ -1875,7 +1992,6 @@ This parameter defines the settings that are used to connect to the destination Type: MigrationEndpointIdParameter Parameter Sets: Offboarding Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1885,6 +2001,9 @@ Accept wildcard characters: False ``` ### -TimeZone + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TimeZone parameter specifies the time zone of the administrator who submits the migration batch. A valid value for this parameter is a supported time zone key name (for example, `"Pacific Standard Time"`). @@ -1901,7 +2020,6 @@ In Exchange Online, the default value is `UTC`. Type: ExTimeZoneValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1911,13 +2029,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1927,6 +2047,9 @@ Accept wildcard characters: False ``` ### -WorkflowControlFlags + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WorkflowControlFlags parameter specifies advanced controls for the steps that are performed in the migration. Valid values are: - None (This is the default value) @@ -1939,7 +2062,6 @@ Don't use this parameter unless you're directed to do so by Microsoft Customer S Type: MigrationWorkflowControlFlags Parameter Sets: Local, Onboarding Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1949,13 +2071,15 @@ Accept wildcard characters: False ``` ### -WorkflowTemplate + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WorkflowTemplate parameter specifies advanced controls for the steps that are performed in the migration. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. ```yaml Type: String Parameter Sets: WorkflowTemplate Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1965,6 +2089,9 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1973,7 +2100,6 @@ This parameter is reserved for internal Microsoft use. Type: RequestWorkloadType Parameter Sets: Local Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1983,6 +2109,9 @@ Accept wildcard characters: False ``` ### -XMLData + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill XMLData Description }} @@ -1991,7 +2120,6 @@ This parameter is available only in the cloud-based service. Type: Byte[] Parameter Sets: Onboarding Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md b/exchange/exchange-ps/ExchangePowerShell/New-MigrationEndpoint.md similarity index 90% rename from exchange/exchange-ps/exchange/New-MigrationEndpoint.md rename to exchange/exchange-ps/ExchangePowerShell/New-MigrationEndpoint.md index f7429f506d..b70b95edb7 100644 --- a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MigrationEndpoint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-migrationendpoint applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MigrationEndpoint -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-migrationendpoint +schema: 2.0.0 +title: New-MigrationEndpoint --- # New-MigrationEndpoint @@ -297,13 +298,15 @@ This example creates an IMAP migration endpoint that supports 50 concurrent migr ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name you give to the new migration endpoint. You can use the Name parameter when you run the New-MigrationBatch cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -313,13 +316,15 @@ Accept wildcard characters: False ``` ### -Autodiscover + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + For an Exchange migration, the Autodiscover switch specifies whether to get other connection settings for the on-premises server from the Autodiscover service. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -329,13 +334,15 @@ Accept wildcard characters: False ``` ### -Compliance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Compliance switch specifies that the endpoint type is compliance. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Compliance Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -345,15 +352,17 @@ Accept wildcard characters: False ``` ### -Credentials + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, LegacyPublicFolderToUnifiedGroup +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, LegacyPublicFolderToUnifiedGroup, ExchangeRemoteMove, PSTImport Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -362,27 +371,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: PSCredential -Parameter Sets: ExchangeRemoteMove, PSTImport -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -EmailAddress -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -EmailAddress The EmailAddress parameter specifies the email address used by the Autodiscover service or in some cases used to validate the endpoint when you specify the connection settings manually. ```yaml Type: SmtpAddress -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -391,20 +389,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SmtpAddress -Parameter Sets: ExchangeOutlookAnywhere, Gmail -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -ExchangeOutlookAnywhere -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -ExchangeOutlookAnywhere This parameter is available only in the cloud-based service. The ExchangeOutlookAnywhere switch specifies the type of endpoint for staged and cutover migrations. You don't need to specify a value with this switch. @@ -413,7 +401,6 @@ The ExchangeOutlookAnywhere switch specifies the type of endpoint for staged and Type: SwitchParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -423,13 +410,15 @@ Accept wildcard characters: False ``` ### -ExchangeRemoteMove + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExchangeRemoteMove switch specifies the type of endpoint for cross-forest moves and remote move migrations in a hybrid deployment. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeRemoteMove Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -439,6 +428,9 @@ Accept wildcard characters: False ``` ### -Gmail + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Gmail switch specifies the type of endpoint for Google Workspace migrations. You don't need to specify a value with this switch. @@ -447,7 +439,6 @@ The Gmail switch specifies the type of endpoint for Google Workspace migrations. Type: SwitchParameter Parameter Sets: Gmail Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -457,6 +448,9 @@ Accept wildcard characters: False ``` ### -IMAP + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IMAP switch specifies the type of endpoint for IMAP migrations. You don't need to specify a value with this switch. @@ -465,7 +459,6 @@ The IMAP switch specifies the type of endpoint for IMAP migrations. You don't ne Type: SwitchParameter Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -475,6 +468,9 @@ Accept wildcard characters: False ``` ### -OAuthCode + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill OAuthCode Description }} @@ -483,7 +479,6 @@ This parameter is available only in the cloud-based service. Type: SecureString Parameter Sets: GoogleMarketplaceApp Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -493,6 +488,9 @@ Accept wildcard characters: False ``` ### -PSTImport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -501,7 +499,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: PSTImport Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -511,6 +508,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -519,7 +519,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: PublicFolder, MrsProxyPublicFolder Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -529,6 +528,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabaseServerLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -537,7 +539,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -547,13 +548,15 @@ Accept wildcard characters: False ``` ### -PublicFolderToUnifiedGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublicFolderToUnifiedGroup switch specifies that the endpoint type is public folders to Microsoft 365 Groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -563,6 +566,9 @@ Accept wildcard characters: False ``` ### -RemoteServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoteServer parameter specifies the FQDN of the remote server, which depends on the protocol type for moves: - For cross-forest moves and remote move migrations, this parameter refers to the Exchange server in the on-premises organization that has the Client Access server role installed that directly accepts and proxies client connections. @@ -572,7 +578,6 @@ The RemoteServer parameter specifies the FQDN of the remote server, which depend Type: Fqdn Parameter Sets: ExchangeRemoteMove, PSTImport, IMAP, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -582,6 +587,9 @@ Accept wildcard characters: False ``` ### -RpcProxyServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The RpcProxyServer parameter specifies the FQDN of the Exchange server in the on-premises Exchange organization that has the Client Access server role installed that directly accepts and proxies client connections. This parameter is used when you create an Outlook Anywhere migration endpoint for cutover and staged Exchange migrations. Typically, this FQDN will be the same as your Outlook on the web URL; for example, mail.contoso.com. This is also the URL for the proxy server that Outlook uses to connect to an Exchange server. @@ -590,9 +598,8 @@ This parameter is required only when you don't use the Autodiscover parameter. ```yaml Type: Fqdn -Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup +Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -601,20 +608,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Fqdn -Parameter Sets: ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online +### -ServiceAccountKeyFileData -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -ServiceAccountKeyFileData This parameter is available only in the cloud-based service. The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. @@ -625,7 +622,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: Gmail Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -635,15 +631,17 @@ Accept wildcard characters: False ``` ### -SourceMailboxLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SourceMailboxLegacyDN parameter specifies the LegacyExchangeDN value of an on-premises mailbox that's used to test the ability of the migration service to create a connection using this endpoint. The cmdlet tries to access this mailbox using the credentials for the administrator account specified in the command. ```yaml Type: String -Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup +Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -652,20 +650,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online +### -AcceptUntrustedCertificates -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -AcceptUntrustedCertificates This parameter is available only in the cloud-based service. {{ Fill AcceptUntrustedCertificates Description }} @@ -674,7 +662,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, IMAP Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -684,6 +671,9 @@ Accept wildcard characters: False ``` ### -ApplicationId + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ApplicationId Description }} @@ -692,7 +682,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ExchangeRemoteMove Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -702,6 +691,9 @@ Accept wildcard characters: False ``` ### -AppSecretKeyVaultUrl + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AppSecretKeyVaultUrl Description }} @@ -710,7 +702,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ExchangeRemoteMove Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -720,6 +711,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Authentication parameter specifies the authentication method used by the on-premises mail server. If you don't include this parameter, Basic authentication is used. @@ -728,7 +722,6 @@ The Authentication parameter specifies the authentication method used by the on- Type: AuthenticationMethod Parameter Sets: ExchangeOutlookAnywhere, IMAP, PublicFolder, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -738,6 +731,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -747,7 +743,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -757,6 +752,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -765,7 +763,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, ExchangeRemoteMove, PSTImport, IMAP, Gmail, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -775,6 +772,9 @@ Accept wildcard characters: False ``` ### -ExchangeServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeServer parameter specifies the FQDN of the on-premises Exchange server 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. @@ -785,7 +785,6 @@ This parameter is required only when you don't use the Autodiscover parameter. Type: String Parameter Sets: ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -795,6 +794,9 @@ Accept wildcard characters: False ``` ### -MailboxPermission + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxPermission parameter specifies what permissions to use to access the source mailbox during Outlook Anywhere onboarding (staged Exchange migration and cutover Exchange migration). @@ -812,7 +814,6 @@ This parameter can't be used for creating non-Outlook Anywhere migration endpoin Type: MigrationMailboxPermission Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -822,13 +823,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentIncrementalSyncs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -838,13 +841,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMigrations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxConcurrentMigrations parameter specifies the maximum number of mailboxes that are migrated during initial sync. This parameter is applicable for all migration types. The default value is 100. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -854,6 +859,9 @@ Accept wildcard characters: False ``` ### -NspiServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The NspiServer parameter specifies the remote Name Service Provider Interface (NSPI) server location for cutover and staged migrations. You must provide the FQDN of the server. @@ -862,7 +870,6 @@ The NspiServer parameter specifies the remote Name Service Provider Interface (N Type: String Parameter Sets: ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -872,6 +879,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -880,7 +890,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -890,6 +899,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration, the Port parameter specifies the TCP port number used by the migration process to connect to the remote server. This parameter is required when you want to migrate data from an on-premises IMAP server to cloud-based mailboxes. @@ -898,7 +910,6 @@ For an IMAP migration, the Port parameter specifies the TCP port number used by Type: Int32 Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -908,6 +919,9 @@ Accept wildcard characters: False ``` ### -RedirectUri + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RedirectUri Description }} @@ -916,7 +930,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: GoogleMarketplaceApp Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -926,6 +939,9 @@ Accept wildcard characters: False ``` ### -RemoteTenant + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RemoteTenant Description }} @@ -934,7 +950,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ExchangeRemoteMove Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -944,6 +959,9 @@ Accept wildcard characters: False ``` ### -Security + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl. @@ -952,7 +970,6 @@ For an IMAP migration, the Security parameter specifies the encryption method us Type: IMAPSecurityMechanism Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -962,13 +979,15 @@ Accept wildcard characters: False ``` ### -SkipVerification + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipVerification switch specifies whether to skip verifying that the remote server is reachable when creating a migration endpoint. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -978,6 +997,9 @@ Accept wildcard characters: False ``` ### -TestMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The TestMailbox parameter specifies an Exchange Online mailbox used as the target by the migration service to verify the connection using this endpoint. You can use any value that uniquely identifies the mailbox. For example: @@ -1001,7 +1023,6 @@ This parameter is only used to create Outlook Anywhere migration endpoints. Type: MailboxIdParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail, GoogleMarketplaceApp, PublicFolder, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1011,13 +1032,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-MobileDeviceMailboxPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-MobileDeviceMailboxPolicy.md index 6d4e325288..38821c4cb2 100644 --- a/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MobileDeviceMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-mobiledevicemailboxpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-MobileDeviceMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-mobiledevicemailboxpolicy +schema: 2.0.0 +title: New-MobileDeviceMailboxPolicy --- # New-MobileDeviceMailboxPolicy @@ -117,6 +118,9 @@ This example creates the mobile device mailbox policy Contoso Policy that has se ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the mobile device mailbox policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -129,7 +133,6 @@ The name of the built-in mobile device mailbox policy is Default. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -139,6 +142,9 @@ Accept wildcard characters: False ``` ### -AllowApplePushNotifications + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowApplePushNotifications parameter specifies whether push notifications are allowed for Apple mobile devices. Valid input for this parameter is $true or $false. The default value is $true. @@ -147,7 +153,6 @@ The AllowApplePushNotifications parameter specifies whether push notifications a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +162,9 @@ Accept wildcard characters: False ``` ### -AllowBluetooth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile device. Valid values are: - Allow (this is the default value). @@ -171,7 +179,6 @@ The value Disable disables synchronization between Outlook for Android and the O Type: BluetoothType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -181,13 +188,15 @@ Accept wildcard characters: False ``` ### -AllowBrowser + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect non-Microsoft browsers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,13 +206,15 @@ Accept wildcard characters: False ``` ### -AllowCamera + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowCamera parameter specifies whether the mobile device's camera is allowed. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -213,13 +224,15 @@ Accept wildcard characters: False ``` ### -AllowConsumerEmail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using non-Microsoft mobile device email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -229,13 +242,15 @@ Accept wildcard characters: False ``` ### -AllowDesktopSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowDesktopSync parameter specifies whether the mobile device can synchronize with a desktop computer through a cable. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -245,13 +260,15 @@ Accept wildcard characters: False ``` ### -AllowExternalDeviceManagement + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the mobile device. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -261,6 +278,9 @@ Accept wildcard characters: False ``` ### -AllowGooglePushNotifications + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowGooglePushNotifications parameter controls whether the user can receive push notifications from Google for Outlook on the web for devices. Valid input for this parameter is $true or $false. The default value is $true. @@ -269,7 +289,6 @@ The AllowGooglePushNotifications parameter controls whether the user can receive Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -279,13 +298,15 @@ Accept wildcard characters: False ``` ### -AllowHTMLEmail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowHTMLEmail parameter specifies whether HTML-formatted email is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. If set to $false, all email is converted to plain text before synchronization occurs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -295,13 +316,15 @@ Accept wildcard characters: False ``` ### -AllowInternetSharing + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowInternetSharing parameter specifies whether the mobile device can be used as a modem to connect a computer to the Internet. This process is also known as tethering. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -311,13 +334,15 @@ Accept wildcard characters: False ``` ### -AllowIrDA + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -327,6 +352,9 @@ Accept wildcard characters: False ``` ### -AllowMicrosoftPushNotifications + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowMicrosoftPushNotifications parameter specifies whether push notifications are enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. @@ -335,7 +363,6 @@ The AllowMicrosoftPushNotifications parameter specifies whether push notificatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -345,13 +372,15 @@ Accept wildcard characters: False ``` ### -AllowMobileOTAUpdate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowMobileOTAUpdate parameter specifies whether the policy can be sent to the mobile device over a cellular data connection. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -361,6 +390,9 @@ Accept wildcard characters: False ``` ### -AllowNonProvisionableDevices + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowNonProvisionableDevices parameter specifies whether all mobile devices can synchronize with Exchange. Valid input for this parameter is $true or $false. The default value is $true. When set to $true, this parameter enables all mobile devices to synchronize with Exchange, regardless of whether the device can enforce all settings that are defined by the policy. This also includes mobile devices managed by a separate device management system. When set to $false, this parameter blocks mobile devices that aren't provisioned from synchronizing with Exchange. @@ -369,7 +401,6 @@ When set to $true, this parameter enables all mobile devices to synchronize with Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -379,13 +410,15 @@ Accept wildcard characters: False ``` ### -AllowPOPIMAPEmail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by non-Microsoft email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -395,13 +428,15 @@ Accept wildcard characters: False ``` ### -AllowRemoteDesktop + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowRemoteDesktop parameter specifies whether the mobile device can initiate a remote desktop connection. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,13 +446,15 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSimplePassword parameter specifies whether a simple password is allowed on the mobile device. A simple password is a password that has a specific pattern, such as 1111 or 1234. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -427,6 +464,9 @@ Accept wildcard characters: False ``` ### -AllowSMIMEEncryptionAlgorithmNegotiation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSMIMEEncryptionAlgorithmNegotiation parameter specifies whether the messaging application on the mobile device can negotiate the encryption algorithm if a recipient's certificate doesn't support the specified encryption algorithm. Valid values for this parameter are: - AllowAnyAlgorithmNegotiation @@ -439,7 +479,6 @@ The default value is AllowAnyAlgorithmNegotiation. Type: SMIMEEncryptionAlgorithmNegotiationType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -449,13 +488,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMESoftCerts + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -465,13 +506,15 @@ Accept wildcard characters: False ``` ### -AllowStorageCard + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowStorageCard parameter specifies whether the mobile device can access information stored on a storage card. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -481,13 +524,15 @@ Accept wildcard characters: False ``` ### -AllowTextMessaging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowTextMessaging parameter specifies whether text messaging is allowed from the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -497,13 +542,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedApplications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -513,13 +560,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedInstallationPackages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages are allowed to run on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -529,13 +578,15 @@ Accept wildcard characters: False ``` ### -AllowWiFi + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowWiFi parameter specifies whether wireless Internet access is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -545,13 +596,15 @@ Accept wildcard characters: False ``` ### -AlphanumericPasswordRequired + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlphanumericPasswordRequired parameter specifies whether the password for the mobile device must be alphanumeric. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -561,13 +614,15 @@ Accept wildcard characters: False ``` ### -ApprovedApplicationList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApprovedApplicationList parameter specifies a configured list of approved applications for the device. ```yaml Type: ApprovedApplicationCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -577,6 +632,9 @@ Accept wildcard characters: False ``` ### -AttachmentsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AttachmentsEnabled parameter specifies whether attachments can be downloaded on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. When set to $false, this parameter blocks the user from downloading attachments on the mobile device. @@ -585,7 +643,6 @@ When set to $false, this parameter blocks the user from downloading attachments Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -595,6 +652,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -604,7 +664,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -614,6 +673,9 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This setting is supported by Outlook for iOS and Android. The DeviceEncryptionEnabled parameter specifies whether encryption is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. @@ -624,7 +686,6 @@ When this parameter is set to $true, device encryption is enabled on the mobile Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -634,6 +695,9 @@ Accept wildcard characters: False ``` ### -DevicePolicyRefreshInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DevicePolicyRefreshInterval parameter specifies how often the policy is sent to the mobile device. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -644,7 +708,6 @@ The default value is Unlimited. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -654,6 +717,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -662,7 +728,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -672,13 +737,15 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -688,6 +755,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault parameter specifies whether this policy is the default mobile device mailbox policy. Valid input for this parameter is $true or $false. The default value for the built-in mobile device mailbox policy named Default is $true. The default value for new mobile device mailbox policies that you create is $false. There can be only one default policy. If another policy is currently set as the default, and you set this parameter to $true, this policy becomes the default policy. The value of this parameter on the other policy is automatically changed to $false, and that policy is no longer the default policy. @@ -696,7 +766,6 @@ There can be only one default policy. If another policy is currently set as the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -706,6 +775,9 @@ Accept wildcard characters: False ``` ### -MaxAttachmentSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile device. Valid input for this parameter is a size value between 0 and 2147482624 bytes (approximately 2 GB), or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4096 or 4KB. @@ -720,7 +792,6 @@ The maximum value is 1024 bytes (one kilobyte) less than two gigabytes (2\*1024^ Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -730,6 +801,9 @@ Accept wildcard characters: False ``` ### -MaxCalendarAgeFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the mobile device. Valid values for this parameter are: - All @@ -744,7 +818,6 @@ The default value is All. Type: CalendarAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -754,6 +827,9 @@ Accept wildcard characters: False ``` ### -MaxEmailAgeFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the mobile device. Valid values for this parameter are: - All @@ -769,7 +845,6 @@ The default value is All. Type: EmailAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -779,6 +854,9 @@ Accept wildcard characters: False ``` ### -MaxEmailBodyTruncationSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. @@ -787,7 +865,6 @@ Unqualified values are treated as bytes. You can qualify the value with KB (kilo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -797,6 +874,9 @@ Accept wildcard characters: False ``` ### -MaxEmailHTMLBodyTruncationSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. @@ -805,7 +885,6 @@ Unqualified values are treated as bytes. You can qualify the value with KB (kilo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -815,6 +894,9 @@ Accept wildcard characters: False ``` ### -MaxInactivityTimeLock + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxInactivityTimeLock parameter specifies the length of time that the mobile device can be inactive before the password is required to reactivate it. Valid values are: - A timespan: hh:mm:ss, where hh = hours, mm = minutes and ss= seconds. The valid input range is 00:01:00 to 01:00:00 (one minute to one hour). @@ -824,7 +906,6 @@ The MaxInactivityTimeLock parameter specifies the length of time that the mobile Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -834,6 +915,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordFailedAttempts + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxPasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile device. You can enter any number from 4 through 16 or the value Unlimited. The default value is Unlimited. @@ -842,7 +926,6 @@ You can enter any number from 4 through 16 or the value Unlimited. The default v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -852,6 +935,9 @@ Accept wildcard characters: False ``` ### -MinPasswordComplexCharacters + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MinPasswordComplexCharacters parameter specifies the character sets that are required in the password of the mobile device. The character sets are: - Lower case letters. @@ -874,7 +960,6 @@ For Windows Phone 10 devices, the value specifies the following password complex Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -884,6 +969,9 @@ Accept wildcard characters: False ``` ### -MinPasswordLength + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This setting is supported by Outlook for Android. The MinPasswordLength parameter specifies the minimum number of characters in the mobile device password. @@ -894,7 +982,6 @@ You can enter any number from 1 through 16 or the value $null. The default value Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -904,6 +991,9 @@ Accept wildcard characters: False ``` ### -PasswordEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PasswordEnabled parameter specifies whether a password is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. When set to $true, this parameter requires the user to set a password on the mobile device. @@ -912,7 +1002,6 @@ When set to $true, this parameter requires the user to set a password on the mob Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -922,6 +1011,9 @@ Accept wildcard characters: False ``` ### -PasswordExpiration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PasswordExpiration parameter specifies how long a password can be used on a mobile device before the user is forced to change the password. Valid values are: - A timespan: ddd.hh:mm:ss, where ddd = days, hh = hours, mm = minutes and ss= seconds. The valid input range is 1.00:00:00 to 730.00:00:00 (one day to two years). @@ -931,7 +1023,6 @@ The PasswordExpiration parameter specifies how long a password can be used on a Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -941,6 +1032,9 @@ Accept wildcard characters: False ``` ### -PasswordHistory + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PasswordHistory parameter specifies the number of unique new passwords that need to be created on the mobile device before an old password can be reused. You can enter any number from 0 through 50. The default value is 0. @@ -949,7 +1043,6 @@ You can enter any number from 0 through 50. The default value is 0. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -959,6 +1052,9 @@ Accept wildcard characters: False ``` ### -PasswordRecoveryEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile device is stored in Exchange. Valid input for this parameter is $true or $false. The default value is $false. When set to $true, this parameter enables you to store the recovery password for the mobile device in Exchange. The recovery password can be viewed from Outlook on the web or the Exchange admin center. @@ -967,7 +1063,6 @@ When set to $true, this parameter enables you to store the recovery password for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -977,13 +1072,15 @@ Accept wildcard characters: False ``` ### -RequireDeviceEncryption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireDeviceEncryption parameter specifies whether encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -993,13 +1090,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptedSMIMEMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireEncryptedSMIMEMessages parameter specifies whether the mobile device must send encrypted S/MIME messages. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1009,6 +1108,9 @@ Accept wildcard characters: False ``` ### -RequireEncryptionSMIMEAlgorithm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireEncryptionSMIMEAlgorithm parameter specifies the algorithm that's required to encrypt S/MIME messages on a mobile device. The valid values for this parameter are: - DES @@ -1023,7 +1125,6 @@ The default value is TripleDES. Type: EncryptionSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1033,13 +1134,15 @@ Accept wildcard characters: False ``` ### -RequireManualSyncWhenRoaming + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireManualSyncWhenRoaming parameter specifies whether the mobile device must synchronize manually while roaming. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1049,6 +1152,9 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEAlgorithm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to sign S/MIME messages on the mobile device. Valid values for this parameter are SHA1 or MD5. The default value is SHA1. @@ -1057,7 +1163,6 @@ Valid values for this parameter are SHA1 or MD5. The default value is SHA1. Type: SignedSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1067,13 +1172,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSignedSMIMEMessages parameter specifies whether the mobile device must send signed S/MIME messages. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1083,6 +1190,9 @@ Accept wildcard characters: False ``` ### -RequireStorageCardEncryption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireStorageCardEncryption parameter specifies whether storage card encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. @@ -1091,7 +1201,6 @@ Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1101,13 +1210,15 @@ Accept wildcard characters: False ``` ### -UnapprovedInROMApplicationList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM on the mobile device. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1117,13 +1228,15 @@ Accept wildcard characters: False ``` ### -UNCAccessEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled from the mobile device. In on-premises Exchange organizations, access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1133,13 +1246,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1149,13 +1264,15 @@ Accept wildcard characters: False ``` ### -WSSAccessEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled from the mobile device. In on-premises Exchange organizations, access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-MoveRequest.md similarity index 87% rename from exchange/exchange-ps/exchange/New-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-MoveRequest.md index 85f5f280eb..315eb64fbe 100644 --- a/exchange/exchange-ps/exchange/New-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-MoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-MoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-moverequest +schema: 2.0.0 +title: New-MoveRequest --- # New-MoveRequest @@ -283,6 +284,9 @@ This example creates a batch move request for all mailboxes on the database DB01 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - GUID @@ -297,7 +301,6 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c Type: MailboxOrMailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -307,6 +310,9 @@ Accept wildcard characters: False ``` ### -Outbound + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Outbound switch specifies that this mailbox move is a cross-forest move and is being initiated from the source forest. You don't need to specify a value with this switch. You can't use this switch with the Remote switch. @@ -315,7 +321,6 @@ You can't use this switch with the Remote switch. Type: SwitchParameter Parameter Sets: MigrationOutbound, MigrationOutboundCrossTenant Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -325,6 +330,9 @@ Accept wildcard characters: False ``` ### -Remote + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Remote switch specifies that the move is outside of your organization and is being initiated from the target forest. You don't need to specify a value with this switch. You can't use this switch with the Outbound switch. @@ -333,7 +341,6 @@ You can't use this switch with the Outbound switch. Type: SwitchParameter Parameter Sets: MigrationRemote, MigrationRemoteCrossTenant Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -343,15 +350,17 @@ Accept wildcard characters: False ``` ### -RemoteCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoteCredential parameter specifies the username and password of an administrator who has permission to perform the mailbox move. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential -Parameter Sets: MigrationRemoteLegacy +Parameter Sets: MigrationRemoteLegacy, MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -360,27 +369,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: PSCredential -Parameter Sets: MigrationOutbound, MigrationRemote -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -RemoteGlobalCatalog -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -RemoteGlobalCatalog The RemoteGlobalCatalog parameter specifies the fully qualified domain name (FQDN) of the global catalog server for the remote forest. ```yaml Type: Fqdn -Parameter Sets: MigrationRemoteLegacy +Parameter Sets: MigrationRemoteLegacy, MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -389,27 +387,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Fqdn -Parameter Sets: MigrationOutbound, MigrationRemote -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -RemoteHostName -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -RemoteHostName The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. ```yaml Type: Fqdn Parameter Sets: MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -419,6 +406,9 @@ Accept wildcard characters: False ``` ### -RemoteLegacy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoteLegacy switch specifies that this mailbox move is from a remote forest that has only Exchange 2010 servers installed. You don't need to specify a value with this switch. @@ -427,7 +417,6 @@ The RemoteLegacy switch specifies that this mailbox move is from a remote forest Type: SwitchParameter Parameter Sets: MigrationRemoteLegacy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -437,13 +426,15 @@ Accept wildcard characters: False ``` ### -TargetDeliveryDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the move request is complete. This parameter is allowed only when performing remote moves with the Remote, RemoteLegacy, or Outbound parameter. ```yaml Type: Fqdn -Parameter Sets: MigrationOutboundCrossTenant, MigrationRemoteCrossTenant +Parameter Sets: MigrationOutboundCrossTenant, MigrationRemoteCrossTenant, MigrationOutbound, MigrationRemote, MigrationRemoteLegacy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -452,20 +443,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Fqdn -Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -AcceptLargeDataLoss -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -AcceptLargeDataLoss The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later or Exchange Online, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -476,7 +457,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -486,6 +466,9 @@ Accept wildcard characters: False ``` ### -AllowLargeItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AllowLargeItems switch specifies that items larger than the target mailbox limits are copied without failure. You don't need to specify a value with this switch. @@ -496,7 +479,6 @@ You can't use this switch with the LargeItemLimit parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -506,13 +488,15 @@ Accept wildcard characters: False ``` ### -ArchiveDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ArchiveDomain parameter specifies the FQDN of the external domain to which you're moving the archive. This parameter is used for moving the archive to a cloud-based service. ```yaml Type: String Parameter Sets: MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -522,6 +506,9 @@ Accept wildcard characters: False ``` ### -ArchiveOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ArchiveOnly switch specifies that you're moving only the personal archive associated with the mailbox. You don't need to specify a value with this switch. You can't use this switch with the PrimaryOnly switch. @@ -530,7 +517,6 @@ You can't use this switch with the PrimaryOnly switch. Type: SwitchParameter Parameter Sets: MigrationOutbound, MigrationRemote, MigrationLocal Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -540,6 +526,9 @@ Accept wildcard characters: False ``` ### -ArchiveTargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArchiveTargetDatabase parameter specifies the destination mailbox database for the personal archive. You can use any value that uniquely identifies the database. For example: @@ -554,7 +543,6 @@ If you don't use this parameter, the archive is moved to the same database as th Type: DatabaseIdParameter Parameter Sets: MigrationRemote, MigrationLocal, MigrationRemoteCrossTenant Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -564,6 +552,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -576,7 +567,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -586,13 +576,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter specifies a descriptive name for moving a batch of mailboxes. You can then use the name in the BatchName parameter as a search string when you use the Get-MoveRequest cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -602,6 +594,9 @@ Accept wildcard characters: False ``` ### -CompleteAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CompleteAfter parameter specifies a delay before the request is completed. The request is started, but not completed until the date/time you specify with this parameter. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -617,7 +612,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -627,13 +621,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -643,6 +639,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -652,7 +651,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -662,6 +660,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -670,7 +671,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -680,6 +680,9 @@ Accept wildcard characters: False ``` ### -DoNotPreserveMailboxSignature + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DoNotPreserveMailboxSignature switch specifies that the move doesn't preserve the mailbox mapping signature. You don't need to specify a value with this switch. @@ -690,7 +693,6 @@ We recommend that you use this switch only if the move request fails because the Type: SwitchParameter Parameter Sets: MigrationLocal Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -700,6 +702,9 @@ Accept wildcard characters: False ``` ### -ForceOffline + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForceOffline switch forces the mailbox move to be performed in offline mode. You don't need to specify a value with this switch. Moving a mailbox in offline mode means the user will have no access to email during the mailbox move. @@ -708,7 +713,6 @@ Moving a mailbox in offline mode means the user will have no access to email dur Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -718,6 +722,9 @@ Accept wildcard characters: False ``` ### -ForcePull + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ForcePull switch specifies that the type of local move should be a Pull move. You don't need to specify a value with this switch. @@ -728,7 +735,6 @@ You use this parameter only for local moves. Type: SwitchParameter Parameter Sets: MigrationLocal Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -738,6 +744,9 @@ Accept wildcard characters: False ``` ### -ForcePush + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ForcePush switch specifies that the type of local move should be a Push move. You don't need to specify a value with this switch. @@ -748,7 +757,6 @@ You use this parameter only for local moves. Type: SwitchParameter Parameter Sets: MigrationLocal Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -758,6 +766,9 @@ Accept wildcard characters: False ``` ### -IgnoreRuleLimitErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013 The IgnoreRuleLimitErrors switch specifies that the command doesn't move the user's rules to the target server running Exchange. You don't need to specify a value with this switch. @@ -766,7 +777,6 @@ The IgnoreRuleLimitErrors switch specifies that the command doesn't move the use Type: SwitchParameter Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy, MigrationLocal Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -776,6 +786,9 @@ Accept wildcard characters: False ``` ### -IncrementalSyncInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -786,7 +799,6 @@ Valid values are from 00:00:00 to 120.00:00:00 (120 days). The default value is Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -796,6 +808,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -804,7 +819,6 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -814,6 +828,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -831,7 +848,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -841,6 +857,9 @@ Accept wildcard characters: False ``` ### -MoveOptions + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The MoveOptions parameter specifies the stages of the move that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. Don't use this parameter with the SkipMoving parameter. @@ -849,7 +868,6 @@ Don't use this parameter with the SkipMoving parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -859,6 +877,9 @@ Accept wildcard characters: False ``` ### -MRSServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSServer parameter specifies the FQDN of the Client Access server on which the instance of the Microsoft Exchange Mailbox Replication service (MRS) is running. This parameter is used for debugging purposes only. Use this parameter only if directed by support personnel. @@ -867,7 +888,6 @@ The MRSServer parameter specifies the FQDN of the Client Access server on which Type: Fqdn Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy, MigrationLocal Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -877,6 +897,9 @@ Accept wildcard characters: False ``` ### -PreventCompletion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PreventCompletion switch specifies whether to run the move request, but not allow it to complete. You don't need to specify a value with this switch. Instead of this switch, we recommend using the CompleteAfter parameter. @@ -885,7 +908,6 @@ Instead of this switch, we recommend using the CompleteAfter parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -895,6 +917,9 @@ Accept wildcard characters: False ``` ### -PrimaryOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PrimaryOnly switch specifies that the command should only move the primary mailbox (the personal archive isn't moved). You don't need to specify a value with this switch. You use this switch only if the user has a personal archive that you don't want to move. If the user doesn't have personal archive, don't use this switch. @@ -905,7 +930,6 @@ You can't use this switch with the ArchiveOnly sitch. Type: SwitchParameter Parameter Sets: MigrationOutbound, MigrationRemote, MigrationLocal Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -915,6 +939,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -932,7 +959,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -942,6 +968,9 @@ Accept wildcard characters: False ``` ### -Protect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -950,7 +979,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -960,6 +988,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter specifies the move destination by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -979,7 +1010,6 @@ The ProxyToMailbox parameter specifies the move destination by the location of t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -989,6 +1019,9 @@ Accept wildcard characters: False ``` ### -RemoteArchiveTargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoteArchiveTargetDatabase parameter specifies the name of the target database in the remote forest to which you're moving the personal archive. Use this parameter when moving users with archives from the local forest to a remote forest. For moves from a remote forest to the local forest, use the ArchiveTargetDatabase parameter. If you use this parameter, you must specify the Remote or RemoteLegacy parameter. @@ -997,7 +1030,6 @@ If you use this parameter, you must specify the Remote or RemoteLegacy parameter Type: String Parameter Sets: MigrationOutbound Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1007,13 +1039,15 @@ Accept wildcard characters: False ``` ### -RemoteOrganizationName + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1023,6 +1057,9 @@ Accept wildcard characters: False ``` ### -RemoteTargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoteTargetDatabase parameter specifies the name of the target database in the remote forest. Use this parameter when moving mailboxes from the local forest to a remote forest. For moves from a remote forest to the local forest, use the TargetDatabase parameter. If you use this parameter, you must specify the Remote or RemoteLegacy parameter. @@ -1031,7 +1068,6 @@ If you use this parameter, you must specify the Remote or RemoteLegacy parameter Type: String Parameter Sets: MigrationOutbound, MigrationRemote Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1041,6 +1077,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -1054,7 +1093,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1064,6 +1102,9 @@ Accept wildcard characters: False ``` ### -SkipMoving + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -1072,7 +1113,6 @@ The SkipMoving parameter specifies the stages of the move that you want to skip Type: SkippableMoveComponent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1082,6 +1122,9 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SourceEndpoint Description }} @@ -1090,7 +1133,6 @@ This parameter is available only in the cloud-based service. Type: MigrationEndpointIdParameter Parameter Sets: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy, MigrationLocal, MigrationRemoteCrossTenant Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1100,6 +1142,9 @@ Accept wildcard characters: False ``` ### -StartAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartAfter parameter specifies a delay before the request is started. The request isn't started until the date/time you specify with this parameter. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -1115,7 +1160,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1125,6 +1169,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. @@ -1133,7 +1180,6 @@ If you use this switch, the request is queued, but the request won't reach the s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1143,13 +1189,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1159,6 +1207,9 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendWhenReadyToComplete switch specifies whether to suspend the move request before it reaches the status of CompletionInProgress. You don't need to specify a value with this switch. Instead of this switch, we recommend that you use the CompleteAfter parameter. @@ -1167,7 +1218,6 @@ Instead of this switch, we recommend that you use the CompleteAfter parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1177,6 +1227,9 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The TargetDatabase parameter specifies the destination mailbox database for the mailbox. You can use any value that uniquely identifies the database. For example: @@ -1191,7 +1244,6 @@ If you don't use this parameter, the automatic distribution logic will select a Type: DatabaseIdParameter Parameter Sets: MigrationRemote, MigrationRemoteLegacy, MigrationLocal, MigrationRemoteCrossTenant Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1201,6 +1253,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. You can use this switch to test a mailbox's readiness to be moved, and to view any errors that will occur without adding the mailbox to the move request queue. @@ -1209,7 +1264,6 @@ You can use this switch to test a mailbox's readiness to be moved, and to view a Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1219,6 +1273,9 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1227,7 +1284,6 @@ This parameter is reserved for internal Microsoft use. Type: RequestWorkloadType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OMEConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/New-OMEConfiguration.md similarity index 94% rename from exchange/exchange-ps/exchange/New-OMEConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/New-OMEConfiguration.md index 8be7fb364c..42c85225eb 100644 --- a/exchange/exchange-ps/exchange/New-OMEConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OMEConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-omeconfiguration applicable: Exchange Online -title: New-OMEConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-omeconfiguration +schema: 2.0.0 +title: New-OMEConfiguration --- # New-OMEConfiguration @@ -53,13 +54,15 @@ This example creates a new OME configuration named "Contoso Marketing" with the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies a unique name for the OME configuration object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -BackgroundColor + +> Applicable: Exchange Online + The BackgroundColor parameter specifies the background color. Valid values are: - An available HTML hexadecimal (hex triplet) color code value (for example, `0x000000` is white). @@ -81,7 +87,6 @@ For more information, see [Add your organization's brand to your encrypted messa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -DisclaimerText + +> Applicable: Exchange Online + The DisclaimerText parameter specifies the disclaimer text in the email that contains the encrypted message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -EmailText + +> Applicable: Exchange Online + The EmailText parameter specifies the default text that accompanies encrypted email messages. The default text appears above the instructions for viewing encrypted messages. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -139,6 +150,9 @@ Accept wildcard characters: False ``` ### -ExternalMailExpiryInDays + +> Applicable: Exchange Online + This parameter is available only with a Microsoft 365 Advanced Message Encryption subscription. The ExternalMailExpiryInDays parameter specifies the number of days that the encrypted message is available to external recipients in the Microsoft 365 portal. A valid value is an integer from 0 to 730. The value 0 means the messages will never expire. The default value is 0. @@ -149,7 +163,6 @@ In the output of the Get-OMEConfiguration cmdlet, the value of this parameter is Type: String Parameter Sets: Int32 Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -159,6 +172,9 @@ Accept wildcard characters: False ``` ### -Image + +> Applicable: Exchange Online + The Image parameter identifies and uploads an image that will be displayed in the email message and in the Microsoft 365 admin center. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -171,7 +187,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -181,13 +196,15 @@ Accept wildcard characters: False ``` ### -IntroductionText + +> Applicable: Exchange Online + The IntroductionText parameter specifies the default text that accompanies encrypted email messages. The default text appears below the recipient email address for viewing the encrypted message. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -197,6 +214,9 @@ Accept wildcard characters: False ``` ### -OTPEnabled + +> Applicable: Exchange Online + The OTPEnabled parameter specifies whether to allow recipients to use a one-time passcode to view encrypted messages. Valid values are: - $true: Recipients can use a one-time passcode to view encrypted messages. This is the default value. @@ -206,7 +226,6 @@ The OTPEnabled parameter specifies whether to allow recipients to use a one-time Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,13 +235,15 @@ Accept wildcard characters: False ``` ### -PortalText + +> Applicable: Exchange Online + The PortalText parameter specifies the text that appears at the top of the encrypted email viewing portal. The maximum length is 128 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -232,13 +253,15 @@ Accept wildcard characters: False ``` ### -PrivacyStatementUrl + +> Applicable: Exchange Online + {{ Fill PrivacyStatementUrl Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,13 +271,15 @@ Accept wildcard characters: False ``` ### -ReadButtonText + +> Applicable: Exchange Online + The ReadButtonText parameter specifies the text that appears on the "Read Message" button. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -264,6 +289,9 @@ Accept wildcard characters: False ``` ### -SocialIdSignIn + +> Applicable: Exchange Online + The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Microsoft 365 admin center using their own social network id (Google, Yahoo, etc). Valid values are: - $true: Social network ID sign in is allowed. This is the default value. @@ -273,7 +301,6 @@ The SocialIdSignIn parameter specifies whether a user is allowed to view an encr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -283,13 +310,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-OabVirtualDirectory.md similarity index 88% rename from exchange/exchange-ps/exchange/New-OabVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-OabVirtualDirectory.md index 7732f3db5a..6b565f5cfd 100644 --- a/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OabVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-oabvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-OabVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-oabvirtualdirectory +schema: 2.0.0 +title: New-OabVirtualDirectory --- # New-OabVirtualDirectory @@ -58,6 +59,9 @@ This example creates an OAB virtual directory on CASServer01 and configures the ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -67,7 +71,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -105,7 +113,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -124,7 +134,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -146,7 +158,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +167,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -PollInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PollInterval parameter specifies the time interval in minutes that the distribution service polls the offline address book generation server for updates. The default value is 480 minutes (8 hours). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,13 +239,15 @@ Accept wildcard characters: False ``` ### -Recovery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +257,9 @@ Accept wildcard characters: False ``` ### -RequireSSL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireSSL parameter specifies whether the client connection to the virtual directory requires Secure Sockets Layer (SSL) encryption. Valid values are: - $true: SSL encryption is required to connect to the virtual directory. This is the default value. @@ -245,7 +269,6 @@ The RequireSSL parameter specifies whether the client connection to the virtual Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +278,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -266,7 +292,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,6 +301,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -287,7 +315,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,13 +324,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,13 +342,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/New-OfflineAddressBook.md similarity index 92% rename from exchange/exchange-ps/exchange/New-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/New-OfflineAddressBook.md index cc267ae497..d0e3db120c 100644 --- a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OfflineAddressBook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-OfflineAddressBook -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-offlineaddressbook +schema: 2.0.0 +title: New-OfflineAddressBook --- # New-OfflineAddressBook @@ -89,13 +90,15 @@ If you configure OABs to use public folder distribution, but your organization d ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name of the OAB. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -AddressLists + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AddressLists parameter specifies the address lists or global address lists that are included in the OAB. You can use any value that uniquely identifies the address list. For example: - Name @@ -119,7 +125,6 @@ You can find the identify values of address lists and global address lists by us Type: AddressBookBaseIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -129,6 +134,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -138,7 +146,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -148,13 +155,15 @@ Accept wildcard characters: False ``` ### -DiffRetentionPeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DiffRetentionPeriod parameter specifies the number of days that the OAB difference files are stored on the server. Valid values are integers from 7 to 1825, or the value unlimited. The default value is 30. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -172,7 +184,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -GeneratingMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The GeneratingMailbox parameter specifies the arbitration mailbox where the OAB is generated. Specifically, the arbitration mailbox must contain the OrganizationCapabilityOABGen value for the PersistedCapability property. An arbitration mailbox with this capability is also known as an organization mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -205,7 +219,6 @@ A single organization mailbox can generate multiple OABs (you can use the same v Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,6 +228,9 @@ Accept wildcard characters: False ``` ### -GlobalWebDistributionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The GlobalWebDistributionEnabled parameter specifies whether all OAB virtual directories in the organization can accept requests to download the OAB. These locations are advertised by the Autodiscover service. Valid values are: @@ -228,7 +244,6 @@ In Exchange 2013 CU7 or later, we recommend that you use the value $true for thi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,6 +253,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault parameter specifies whether the OAB is used by all mailboxes and mailbox databases that don't have an OAB specified. Valid values are: - $true: The OAB is the default OAB. @@ -247,7 +265,6 @@ The IsDefault parameter specifies whether the OAB is used by all mailboxes and m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -257,6 +274,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabase + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The PublicFolderDatabase parameter specifies the public folder database that's used to distribute the OAB. You can use any value that uniquely identifies the database. For example: @@ -271,7 +291,6 @@ To use this parameter, the PublicFolderDistributionEnabled parameter must be set Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -281,6 +300,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDistributionEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The PublicFolderDistributionEnabled parameter specifies whether the OAB is distributed via public folders. If the value of the PublicFolderDistributionEnabled parameter is $true, the OAB is distributed via public folders. @@ -289,7 +311,6 @@ The PublicFolderDistributionEnabled parameter specifies whether the OAB is distr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -299,6 +320,9 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Schedule parameter specifies the interval for generating the OAB in Exchange 2010 or earlier. @@ -327,7 +351,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -337,6 +360,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -352,7 +378,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -362,6 +387,9 @@ Accept wildcard characters: False ``` ### -ShadowMailboxDistributionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ShadowMailboxDistributionEnabled parameter specifies whether a read only copy of the OAB (also known as a shadow copy) is distributed to all other OAB generation mailboxes (also known as organization mailboxes). This allows additional Mailbox servers to be endpoints for requests to download the OAB, which can help prevent users from downloading the OAB across slow WAN links. Valid values are: @@ -375,7 +403,6 @@ The value of this parameter is only meaningful if you have multiple organization Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -385,6 +412,9 @@ Accept wildcard characters: False ``` ### -SkipPublicFolderInitialization + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The SkipPublicFolderInitialization switch specifies whether to skip the immediate creation of the OAB public folders if you're creating an OAB that uses public folder distribution. You don't need to specify a value with this switch. @@ -395,7 +425,6 @@ The OAB isn't available for download until the next site folder maintenance cycl Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -405,6 +434,9 @@ Accept wildcard characters: False ``` ### -Versions + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Versions parameter specifies the OAB versions that are generated for client download. Valid values are: @@ -417,7 +449,6 @@ The Versions parameter specifies the OAB versions that are generated for client Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -427,6 +458,9 @@ Accept wildcard characters: False ``` ### -VirtualDirectories + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The VirtualDirectories parameter specifies the OAB virtual directories that accept requests to download the OAB. These locations are advertised in the Autodiscover service. @@ -449,7 +483,6 @@ In Exchange 2013 CU7 or later, we recommend that you set the GlobalWebDistributi Type: VirtualDirectoryIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -459,13 +492,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md b/exchange/exchange-ps/ExchangePowerShell/New-OnPremisesOrganization.md similarity index 92% rename from exchange/exchange-ps/exchange/New-OnPremisesOrganization.md rename to exchange/exchange-ps/ExchangePowerShell/New-OnPremisesOrganization.md index bca7a914de..07fd386992 100644 --- a/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OnPremisesOrganization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-onpremisesorganization applicable: Exchange Online, Exchange Online Protection -title: New-OnPremisesOrganization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-onpremisesorganization +schema: 2.0.0 +title: New-OnPremisesOrganization --- # New-OnPremisesOrganization @@ -47,13 +48,15 @@ This example creates the OnPremisesOrganization object ExchangeMail in a Microso ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a friendly name for the on-premises Exchange organization object in the Microsoft 365 organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -HybridDomains + +> Applicable: Exchange Online, Exchange Online Protection + The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between a Microsoft 365 organization and an on-premises Exchange organization. The domains specified in this parameter must match the domains listed in the HybridConfiguration object for the on-premises Exchange organization configured by the Hybrid Configuration wizard. Multiple domains may be listed and must be separated by a comma, for example, "contoso.com, sales.contoso.com". ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -InboundConnector + +> Applicable: Exchange Online, Exchange Online Protection + The InboundConnector parameter specifies the name of the inbound connector configured in Microsoft 365 for a hybrid deployment configured with an on-premises Exchange organization. ```yaml Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -95,13 +102,15 @@ Accept wildcard characters: False ``` ### -OrganizationGuid + +> Applicable: Exchange Online, Exchange Online Protection + The OrganizationGuid parameter specifies the globally unique identifier (GUID) of the on-premises Exchange organization object in the Microsoft 365 organization. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -111,13 +120,15 @@ Accept wildcard characters: False ``` ### -OutboundConnector + +> Applicable: Exchange Online, Exchange Online Protection + The OutboundConnector parameter specifies the name of the outbound connector configured on the EOP service for a hybrid deployment configured with an on-premises Exchange organization. ```yaml Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -127,13 +138,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -143,6 +156,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -152,7 +168,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -162,13 +177,15 @@ Accept wildcard characters: False ``` ### -OrganizationName + +> Applicable: Exchange Online, Exchange Online Protection + The OrganizationName parameter specifies the Active Directory object name of the on-premises Exchange organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -178,13 +195,15 @@ Accept wildcard characters: False ``` ### -OrganizationRelationship + +> Applicable: Exchange Online, Exchange Online Protection + The OrganizationRelationship parameter specifies the organization relationship configured by the Hybrid Configuration wizard on the Microsoft 365 organization as part of a hybrid deployment with an on-premises Exchange organization. This organization relationship defines the federated sharing features enabled on the Microsoft 365 organization. ```yaml Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -194,13 +213,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OrganizationRelationship.md b/exchange/exchange-ps/ExchangePowerShell/New-OrganizationRelationship.md similarity index 86% rename from exchange/exchange-ps/exchange/New-OrganizationRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/New-OrganizationRelationship.md index 3e6caf94c5..770257916d 100644 --- a/exchange/exchange-ps/exchange/New-OrganizationRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OrganizationRelationship.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-organizationrelationship applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-OrganizationRelationship -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-organizationrelationship +schema: 2.0.0 +title: New-OrganizationRelationship --- # New-OrganizationRelationship @@ -91,13 +92,15 @@ The requesting organization only receives free/busy information with the time. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the organization relationship. The maximum length is 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -DomainNames + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DomainNames parameter specifies the SMTP domains of the external organization. You can specify multiple domains separated by commas (for example, "contoso.com","northamerica.contoso.com"), limited to 238 domains in one request. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -ArchiveAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + 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. @@ -132,7 +140,6 @@ The ArchiveAccessEnabled parameter specifies whether the organization relationsh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -151,7 +161,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -161,6 +170,9 @@ Accept wildcard characters: False ``` ### -DeliveryReportEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DeliveryReportEnabled parameter specifies whether Delivery Reports should be shared over the organization relationship. Valid values are: - $true: Delivery Reports should be shared over the organization relationship. This value means the organization has agreed to share all Delivery Reports with the external organization, and the organization relationship should be used to retrieve Delivery Report information from the external organization. @@ -172,7 +184,6 @@ For message tracking to work in a cross-premises Exchange scenario, this paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -190,7 +204,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,6 +213,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether to enable the organization relationship. Valid values are: - $true: The organization relationship is enabled. This is the default value. @@ -209,7 +225,6 @@ The Enabled parameter specifies whether to enable the organization relationship. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FreeBusyAccessEnabled parameter specifies whether the organization relationship should be used to retrieve free/busy information from the external organization. Valid values are: - $true: Free/busy information is retrieved from the external organization. @@ -230,7 +248,6 @@ You control the free/busy access level and scope by using the FreeBusyAccessLeve Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -240,6 +257,9 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization. Valid values are: - None: No free/busy access. @@ -252,7 +272,6 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: FreeBusyAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -262,6 +281,9 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FreeBusyAccessScope parameter specifies a mail-enabled security group in the internal organization that contains users whose free/busy information is accessible by an external organization. You can use any value that uniquely identifies the group. For example: - Name @@ -275,7 +297,6 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -285,6 +306,9 @@ Accept wildcard characters: False ``` ### -MailboxMoveCapability + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The MailboxMoveCapability parameter is used in cross-tenant mailbox migrations. Valid values are: @@ -300,7 +324,6 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MailboxMoveCapability Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -310,6 +333,9 @@ Accept wildcard characters: False ``` ### -MailboxMoveEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailboxMoveEnabled parameter specifies whether the organization relationship enables moving mailboxes to or from the external organization. Valid values are: - $true: Mailbox moves to or from the external organization are allowed. @@ -319,7 +345,6 @@ The MailboxMoveEnabled parameter specifies whether the organization relationship Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -329,6 +354,9 @@ Accept wildcard characters: False ``` ### -MailboxMovePublishedScopes + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The MailboxMovePublishedScopes parameter is used in cross-tenant mailbox migrations to specify the mail-enabled security groups whose members are allowed to migrate. You can use any value that uniquely identifies the group. For example: @@ -346,7 +374,6 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -356,6 +383,9 @@ Accept wildcard characters: False ``` ### -MailTipsAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTipsAccessEnabled parameter specifies whether MailTips for users in this organization are returned over this organization relationship. Valid values are: - $true: MailTips for users in this organization are returned over the organization relationship. @@ -367,7 +397,6 @@ You control the MailTips access level by using the MailTipsAccessLevel parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -377,6 +406,9 @@ Accept wildcard characters: False ``` ### -MailTipsAccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTipsAccessLevel parameter specifies the level of MailTips data that's externally shared over this organization relationship. This parameter can have the following values: - All: All MailTips are returned, but the recipients in the remote organization are considered external. For the Auto Reply MailTip, the external Auto Reply message is returned. @@ -389,7 +421,6 @@ This parameter is only meaningful when the MailTipsAccessEnabled parameter value Type: MailTipsAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -399,6 +430,9 @@ Accept wildcard characters: False ``` ### -MailTipsAccessScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTipsAccessScope parameter specifies a mail-enabled security group in the internal organization that contains users whose free/busy information is accessible by an external organization. You can use any value that uniquely identifies the group. For example: - Name @@ -422,7 +456,6 @@ This restriction only applies to mailboxes, mail users, and mail contacts. It do Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -432,6 +465,9 @@ Accept wildcard characters: False ``` ### -OAuthApplicationId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the application ID of the mailbox migration app that you consented to. For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). @@ -440,7 +476,6 @@ The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -450,13 +485,15 @@ Accept wildcard characters: False ``` ### -OrganizationContact + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationContact parameter specifies the email address that can be used to contact the external organization (for example, administrator@fourthcoffee.com). ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -466,6 +503,9 @@ Accept wildcard characters: False ``` ### -PhotosEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PhotosEnabled parameter specifies whether photos for users in the internal organization are returned over the organization relationship. Valid values are: - $true: Photos for users in this organization are returned over the organization relationship. @@ -475,7 +515,6 @@ The PhotosEnabled parameter specifies whether photos for users in the internal o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -485,13 +524,15 @@ Accept wildcard characters: False ``` ### -TargetApplicationUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TargetApplicationUri parameter specifies the target Uniform Resource Identifier (URI) of the external organization. The TargetApplicationUri parameter is specified by Exchange when requesting a delegated token for the external organization to fetch free and busy information, for example, mail.contoso.com. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -501,13 +542,15 @@ Accept wildcard characters: False ``` ### -TargetAutodiscoverEpr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, `https://contoso.com/autodiscover/autodiscover.svc/wssecurity`. Exchange uses the Autodiscover service to automatically detect the correct Exchange server endpoint to use for external requests. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -517,13 +560,15 @@ Accept wildcard characters: False ``` ### -TargetOwaURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TargetOwaURL parameter specifies the Outlook on the web (formerly Outlook Web App) URL of the external organization defined in the organization relationship. It's used for Outlook on the web redirection in a cross-premise Exchange scenario. Configuring this attribute enables users in the organization to use their current Outlook on the web URL to access Outlook on the web in the external organization. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -533,6 +578,9 @@ Accept wildcard characters: False ``` ### -TargetSharingEpr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services for the external organization. If you use this parameter, this URL is always used to reach the external Exchange server. The URL that's specified by the TargetAutodiscoverEpr parameter isn't used to locate the external Exchange server. @@ -541,7 +589,6 @@ If you use this parameter, this URL is always used to reach the external Exchang Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -551,13 +598,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OrganizationSegment.md b/exchange/exchange-ps/ExchangePowerShell/New-OrganizationSegment.md similarity index 96% rename from exchange/exchange-ps/exchange/New-OrganizationSegment.md rename to exchange/exchange-ps/ExchangePowerShell/New-OrganizationSegment.md index a8a7015875..ec027b30d2 100644 --- a/exchange/exchange-ps/exchange/New-OrganizationSegment.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OrganizationSegment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-organizationsegment applicable: Security & Compliance -title: New-OrganizationSegment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-organizationsegment +schema: 2.0.0 +title: New-OrganizationSegment --- # New-OrganizationSegment @@ -58,13 +59,15 @@ In this example, we defined a segment called LocalFTE that includes people who a ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the organization segment. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -UserGroupFilter + +> Applicable: Security & Compliance + The UserGroupFilter parameter uses OPATH filter syntax to specify the members of the organization segment. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"MemberOf -eq 'Engineering Department'"` or `"ExtensionAttribute1 -eq 'DayTrader'"`). - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -108,7 +116,6 @@ Use the same property for all of your segments, and verify that your segments do Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OutboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-OutboundConnector.md similarity index 92% rename from exchange/exchange-ps/exchange/New-OutboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-OutboundConnector.md index 2121c66207..69dd558e8e 100644 --- a/exchange/exchange-ps/exchange/New-OutboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OutboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-outboundconnector applicable: Exchange Online, Exchange Online Protection -title: New-OutboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-outboundconnector +schema: 2.0.0 +title: New-OutboundConnector --- # New-OutboundConnector @@ -63,13 +64,15 @@ This example creates the Outbound connector named Contoso Outbound Connector wit ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name for the connector. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AllAcceptedDomains + +> Applicable: Exchange Online, Exchange Online Protection + The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: - $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. This setting requires OnPremises for the ConnectorType value. @@ -90,7 +96,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -113,7 +121,6 @@ Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -148,7 +160,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -158,6 +169,9 @@ Accept wildcard characters: False ``` ### -ConnectorSource + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorSource parameter specifies how the connector is created. Valid values are: - Default: The connector is manually created. This is the default value when you use this cmdlet, and we recommend that you don't change this value. @@ -168,7 +182,6 @@ The ConnectorSource parameter specifies how the connector is created. Valid valu Type: TenantConnectorSource Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid values are: - Partner: The connector services domains that are external to your organization. @@ -187,7 +203,6 @@ The ConnectorType parameter specifies a category for the domains that are servic Type: TenantConnectorType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -197,6 +212,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether to enable or disable the Outbound connector. Valid values are: - $true: The connector is enabled. This is the default value. @@ -206,7 +224,6 @@ The Enabled parameter specifies whether to enable or disable the Outbound connec Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -216,6 +233,9 @@ Accept wildcard characters: False ``` ### -IsTransportRuleScoped + +> Applicable: Exchange Online, Exchange Online Protection + The IsTransportRuleScoped parameter specifies whether the Outbound connector is associated with a transport rule (also known as a mail flow rule). Valid values are: - $true: The connector is associated with a transport rule. @@ -227,7 +247,6 @@ You scope a transport rule to an Outbound connector by using the RouteMessageOut Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -237,13 +256,15 @@ Accept wildcard characters: False ``` ### -LinkForModifiedConnector + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,6 +274,9 @@ Accept wildcard characters: False ``` ### -RecipientDomains + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomains parameter specifies the domains that the Outbound connector routes mail to. You can specify multiple domains separated by commas. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. @@ -261,7 +285,6 @@ You can use a wildcard character to specify all subdomains of a specified domain Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -271,6 +294,9 @@ Accept wildcard characters: False ``` ### -RouteAllMessagesViaOnPremises + +> Applicable: Exchange Online, Exchange Online Protection + The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises email system in hybrid organizations. Valid values are: - $true: Messages are routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. @@ -282,7 +308,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -292,6 +317,9 @@ Accept wildcard characters: False ``` ### -SenderRewritingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SenderRewritingEnabled parameter specifies that all messages that normally qualify for SRS rewriting are rewritten for routing through the on-premises email system. Valid values are: - $true: Messages are rewritten by SRS as needed before being routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. @@ -303,7 +331,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,6 +340,9 @@ Accept wildcard characters: False ``` ### -SmartHosts + +> Applicable: Exchange Online, Exchange Online Protection + The SmartHosts parameter specifies the smart host that the Outbound connector uses to route mail. Valid values are: - FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record: For example, mail.contoso.com. @@ -327,7 +357,6 @@ This parameter is required if you use the value $false for the UseMxRecord param Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,6 +366,9 @@ Accept wildcard characters: False ``` ### -TestMode + +> Applicable: Exchange Online, Exchange Online Protection + The TestMode parameter specifies whether you want to enabled or disable test mode for the Outbound connector. Valid values are: - $true: Test mode is enabled. @@ -346,7 +378,6 @@ The TestMode parameter specifies whether you want to enabled or disable test mod Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -356,6 +387,9 @@ Accept wildcard characters: False ``` ### -TlsDomain + +> Applicable: Exchange Online, Exchange Online Protection + The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. A valid value for this parameter is an SMTP domain. Wildcards are supported to specify all subdomains of a domain (for example, \*.contoso.com), but you can't embed the wildcard character within the domain (for example, domain.\*.contoso.com). @@ -366,7 +400,6 @@ This parameter meaningful only when the TlsSettings value is DomainValidation. Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -376,6 +409,9 @@ Accept wildcard characters: False ``` ### -TlsSettings + +> Applicable: Exchange Online, Exchange Online Protection + The TlsSettings parameter specifies the TLS authentication level that's used for outbound TLS connections established by this Outbound connector. Valid values are: - EncryptionOnly: TLS is used only to encrypt the communication channel. No certificate authentication is performed. @@ -387,7 +423,6 @@ The TlsSettings parameter specifies the TLS authentication level that's used for Type: TlsAuthLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -397,6 +432,9 @@ Accept wildcard characters: False ``` ### -UseMXRecord + +> Applicable: Exchange Online, Exchange Online Protection + The UseMXRecord parameter enables or disables DNS routing for the connector. Valid values are: - $true: The connector uses DNS routing (MX records in DNS) to deliver email. This is the default value. @@ -406,7 +444,6 @@ The UseMXRecord parameter enables or disables DNS routing for the connector. Val Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -416,13 +453,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/New-OutlookProtectionRule.md similarity index 85% rename from exchange/exchange-ps/exchange/New-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-OutlookProtectionRule.md index 871a1233f5..264a04ed65 100644 --- a/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-OutlookProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-outlookprotectionrule +schema: 2.0.0 +title: New-OutlookProtectionRule --- # New-OutlookProtectionRule @@ -58,13 +59,15 @@ This example applies the AD RMS template named Template-Contoso to messages sent ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a name for the rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApplyRightsProtectionTemplate parameter specifies the AD RMS template to apply to the message. An AD RMS template can be specified using the template name. Use the Get-RMSTemplate cmdlet to retrieve templates from your AD RMS server. ```yaml Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -99,7 +107,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -117,7 +127,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter specifies whether the Outlook protection rules are enabled. New Outlook protection rules are enabled by default. To create a rule without enabling it, set the Enabled parameter to $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you create rules without any conditions (rules without conditions apply to all messages). @@ -151,7 +165,6 @@ Use this switch to hide the confirmation prompt when you create rules without an Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -161,13 +174,15 @@ Accept wildcard characters: False ``` ### -FromDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FromDepartment parameter specifies the sender's department as a condition. The user's department property is compared with the value specified. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -177,13 +192,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Priority parameter specifies whether to set the order of processing of Outlook protection rules. Rules with a lower priority value are executed first. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -193,6 +210,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SentTo parameter specifies one or more recipients as a rule condition. You can use any value that uniquely identifies the internal recipient. For example: - Name @@ -214,7 +234,6 @@ This parameter doesn't accept wildcard characters. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -224,6 +243,9 @@ Accept wildcard characters: False ``` ### -SentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SentToScope parameter specifies the message scope as a condition. You can use one of the following values: - InOrganization: This value is for messages sent to recipients within the organization. @@ -233,7 +255,6 @@ The SentToScope parameter specifies the message scope as a condition. You can us Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -243,13 +264,15 @@ Accept wildcard characters: False ``` ### -UserCanOverride + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UserCanOverride parameter specifies whether users can override actions taken by Outlook protection rules. By default, users can override actions taken by Outlook protection rules. When set to $false, the UserCanOverride parameter prevents the user from overriding the rule when sending the message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -259,13 +282,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OutlookProvider.md b/exchange/exchange-ps/ExchangePowerShell/New-OutlookProvider.md similarity index 90% rename from exchange/exchange-ps/exchange/New-OutlookProvider.md rename to exchange/exchange-ps/ExchangePowerShell/New-OutlookProvider.md index 8552c51259..af0e3feeb6 100644 --- a/exchange/exchange-ps/exchange/New-OutlookProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OutlookProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-outlookprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-OutlookProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-outlookprovider +schema: 2.0.0 +title: New-OutlookProvider --- # New-OutlookProvider @@ -52,13 +53,15 @@ This example creates the AutoDiscoverConfig object Autodiscover1 and the specifi ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter provides the common name of the AutoDiscoverConfig object. This can be a user-friendly name for identification. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-OwaMailboxPolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-OwaMailboxPolicy.md index b25a96ccdb..0ea3a13dbb 100644 --- a/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OwaMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-owamailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-OwaMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-owamailboxpolicy +schema: 2.0.0 +title: New-OwaMailboxPolicy --- # New-OwaMailboxPolicy @@ -48,13 +49,15 @@ This example creates the Outlook on the web mailbox policy named Corporate. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a name for the new policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -91,7 +99,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IsDefault switch specifies whether the policy is the default policy. You don't need to specify a value with this switch. @@ -111,7 +121,6 @@ If another policy is currently set as the default, using this switch replaces th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-OwaVirtualDirectory.md similarity index 89% rename from exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-OwaVirtualDirectory.md index 703e02a8bd..291b08b57f 100644 --- a/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-OwaVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-owavirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-OwaVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-owavirtualdirectory +schema: 2.0.0 +title: New-OwaVirtualDirectory --- # New-OwaVirtualDirectory @@ -58,6 +59,9 @@ This example creates the Outlook on the web virtual directory in an IIS website ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -66,7 +70,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -ApplicationRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ApplicationRoot parameter specifies the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -AppPoolId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AppPoolId parameter specifies the IIS application pool in which the virtual directory runs. We recommend that you leave this parameter at its default setting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -117,7 +127,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -155,7 +169,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,6 +178,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -174,7 +190,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +199,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -196,7 +214,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -ExternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalAuthenticationMethods parameter restricts the authentication methods that can be used to connect to the virtual directory from outside the firewall. Valid values are: - Adfs @@ -235,7 +255,6 @@ Although you can specify any of these values, whether or not the authentication Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,13 +264,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,13 +282,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is important when SSL is used. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,13 +300,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +318,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -304,7 +332,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -314,6 +341,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -325,7 +355,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -335,13 +364,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -351,13 +382,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PartnerApplication.md b/exchange/exchange-ps/ExchangePowerShell/New-PartnerApplication.md similarity index 89% rename from exchange/exchange-ps/exchange/New-PartnerApplication.md rename to exchange/exchange-ps/ExchangePowerShell/New-PartnerApplication.md index d0ef93326f..f78ea97f86 100644 --- a/exchange/exchange-ps/exchange/New-PartnerApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PartnerApplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-partnerapplication applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PartnerApplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-partnerapplication +schema: 2.0.0 +title: New-PartnerApplication --- # New-PartnerApplication @@ -73,13 +74,15 @@ This example creates a new HRApp partner application named HRApp. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a name for the partner application. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -ApplicationIdentifier + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApplicationIdentifier parameter specifies a unique application identifier for the partner application that uses an authorization server. When specifying a value for the ApplicationIdentifier parameter, you must also use the UseAuthServer parameter. ```yaml Type: String Parameter Sets: ACSTrustApplication Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -AuthMetadataUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuthMetadataUrl parameter specifies the URL that Exchange can retrieve the AuthMetadata document from for a partner application that doesn't use an authorization server. When specifying the AuthMetadataUrl parameter for a partner application, you can't specify the ApplicationIdentifier and UseAuthServer parameters. @@ -113,7 +121,6 @@ The AuthMetadataUrl parameter specifies the URL that Exchange can retrieve the A Type: String Parameter Sets: AuthMetadataUrl Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -AcceptSecurityIdentifierInformation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptSecurityIdentifierInformation parameter specifies whether Exchange should accept security identifiers (SIDs) from another trusted Active Directory forest for the partner application. By default, new partner applications are configured to not accept SIDs from another forest. If you're in deployment with a trusted forest, set the parameter to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -AccountType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AccountType parameter specifies the type of Microsoft account that's required for the partner application. Valid values are: - OrganizationalAccount (This is the default value) @@ -148,7 +160,6 @@ The AccountType parameter specifies the type of Microsoft account that's require Type: SupportedAccountType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -158,6 +169,9 @@ Accept wildcard characters: False ``` ### -ActAsPermissions + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -166,7 +180,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -176,6 +189,9 @@ Accept wildcard characters: False ``` ### -AppOnlyPermissions + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -184,7 +200,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -194,6 +209,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -203,7 +221,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -213,6 +230,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -221,7 +241,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -231,13 +250,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter specifies whether the partner application is enabled. By default, new partner applications are enabled. Set the parameter to $false to create the application configuration in a disabled state. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,6 +268,9 @@ Accept wildcard characters: False ``` ### -IssuerIdentifier + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -255,7 +279,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -265,13 +288,15 @@ Accept wildcard characters: False ``` ### -LinkedAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LinkedAccount parameter specifies a linked Active Directory user account for the application. Exchange evaluates Role Based Access Control (RBAC) permissions for the linked account when authorizing a token used to perform a task. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -281,6 +306,9 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Realm parameter specifies a security realm for the partner application. If the token is from a domain that's not an accepted domain, Exchange checks the realm specified in the token. In such a scenario, only tokens with the same realm specified in the partner application can access Exchange resources. @@ -289,7 +317,6 @@ The Realm parameter specifies a security realm for the partner application. If t Type: String Parameter Sets: ACSTrustApplication Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -299,6 +326,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. @@ -309,7 +339,6 @@ We don't recommend using this switch in a production environment. Type: SwitchParameter Parameter Sets: AuthMetadataUrl Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -319,13 +348,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-PhishSimOverridePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-PhishSimOverridePolicy.md index cf3415db3c..3edf56b20a 100644 --- a/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PhishSimOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-phishsimoverridepolicy applicable: Exchange Online -title: New-PhishSimOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-phishsimoverridepolicy +schema: 2.0.0 +title: New-PhishSimOverridePolicy --- # New-PhishSimOverridePolicy @@ -46,13 +47,15 @@ This example creates the phishing simulation override policy named PhishSimOverr ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the name for the phishing simulation override policy. Regardless of the value you specify, the name will be PhishSimOverridePolicy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -87,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -97,13 +104,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -113,6 +122,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -122,7 +134,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,6 +143,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -140,7 +154,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -150,6 +163,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + In Exchange Online PowerShell, the WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. The WhatIf switch doesn't work in Security & Compliance PowerShell. @@ -158,7 +174,6 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PolicyTipConfig.md b/exchange/exchange-ps/ExchangePowerShell/New-PolicyTipConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/New-PolicyTipConfig.md rename to exchange/exchange-ps/ExchangePowerShell/New-PolicyTipConfig.md index c32359ad77..bb9efbeb94 100644 --- a/exchange/exchange-ps/exchange/New-PolicyTipConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PolicyTipConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-policytipconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PolicyTipConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-policytipconfig +schema: 2.0.0 +title: New-PolicyTipConfig --- # New-PolicyTipConfig @@ -54,6 +55,9 @@ This example sets the informational URL in Policy Tips to the value `https://www ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the custom Policy Tip you want to modify. Valid input for this parameter is one of the following values: - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. @@ -65,7 +69,6 @@ There can be only one custom Policy Tip with the value Url for the Name paramete Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -Value + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Value parameter specifies the text that's displayed by the Policy Tip. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -100,7 +108,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -118,7 +128,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-PowerShellVirtualDirectory.md similarity index 90% rename from exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-PowerShellVirtualDirectory.md index fd597096d0..6314ea56c9 100644 --- a/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PowerShellVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-powershellvirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-PowerShellVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-powershellvirtualdirectory +schema: 2.0.0 +title: New-PowerShellVirtualDirectory --- # New-PowerShellVirtualDirectory @@ -55,13 +56,15 @@ This example creates a Windows PowerShell virtual directory and configures it to ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the new PowerShell virtual directory. The name you provide will have the name of the website it's created under appended to it. If the name you provide contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the PowerShell virtual directory. The valid values are $true and $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -96,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -134,7 +146,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +155,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -153,7 +167,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +176,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -175,7 +191,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,13 +200,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalUrl parameter specifies the external URL that the PowerShell virtual directory points to. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,13 +218,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalUrl parameter specifies the internal URL that the PowerShell virtual directory points to. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,13 +236,15 @@ Accept wildcard characters: False ``` ### -RequireSSL + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireSSL parameter specifies whether the PowerShell virtual directory should require that the client connection be made using Secure Sockets Layer (SSL). The valid values are $true and $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,6 +254,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -244,7 +268,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,6 +277,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -265,7 +291,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,13 +300,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -291,13 +318,15 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the PowerShell virtual directory. The valid values are $true and $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ProtectionAlert.md b/exchange/exchange-ps/ExchangePowerShell/New-ProtectionAlert.md similarity index 94% rename from exchange/exchange-ps/exchange/New-ProtectionAlert.md rename to exchange/exchange-ps/ExchangePowerShell/New-ProtectionAlert.md index f0b41f21ed..1174020b1c 100644 --- a/exchange/exchange-ps/exchange/New-ProtectionAlert.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ProtectionAlert.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-protectionalert applicable: Security & Compliance -title: New-ProtectionAlert -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-protectionalert +schema: 2.0.0 +title: New-ProtectionAlert --- # New-ProtectionAlert @@ -77,6 +78,9 @@ This example creates an alert policy that triggers an alert whenever anyone in t ## PARAMETERS ### -Category + +> Applicable: Security & Compliance + The Category parameter specifies a category for the alert policy. Valid values are: - AccessGovernance @@ -94,7 +98,6 @@ When an activity occurs that matches the conditions of the alert policy, the ale Type: AlertRuleCategory Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -104,13 +107,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -NotifyUser + +> Applicable: Security & Compliance + The NotifyUser parameter specifies the SMTP address of the user who receives notification messages for the alert policy. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -ThreatType + +> Applicable: Security & Compliance + The ThreatType parameter specifies the type of activities that are monitored by the alert policy. Valid values are: - Activity @@ -149,7 +159,6 @@ You can't change this value after you create the alert policy. Type: ThreatAlertType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -AggregationType + +> Applicable: Security & Compliance + The AggregationType parameter specifies the how the alert policy triggers alerts for multiple occurrences of monitored activity. Valid values are: - None: Alerts are triggered for every occurrence of the activity. @@ -169,7 +181,6 @@ The AggregationType parameter specifies the how the alert policy triggers alerts Type: AlertAggregationType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -179,6 +190,9 @@ Accept wildcard characters: False ``` ### -AlertBy + +> Applicable: Security & Compliance + The AlertBy parameter specifies the scope for aggregated alert policies. Valid values are determined by the ThreatType parameter value: - Activity: Valid values are User or $null (blank, which is the default value). If you don't use the value User, the scope of the alert policy is the entire organization. @@ -192,7 +206,6 @@ You can't use this parameter when the AggregationType parameter value is None (a Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -202,13 +215,15 @@ Accept wildcard characters: False ``` ### -AlertFor + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -218,13 +233,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -234,6 +251,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -243,7 +263,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -253,13 +272,15 @@ Accept wildcard characters: False ``` ### -CorrelationPolicyId + +> Applicable: Security & Compliance + {{ Fill CorrelationPolicyId Description }} ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -269,13 +290,15 @@ Accept wildcard characters: False ``` ### -CustomProperties + +> Applicable: Security & Compliance + {{ Fill CustomProperties Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -285,13 +308,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies descriptive text for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -301,6 +326,9 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter enables or disables the alert policy. Valid values are: - $true: The alert policy is disabled. @@ -310,7 +338,6 @@ The Disabled parameter enables or disables the alert policy. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -320,6 +347,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Security & Compliance + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -378,7 +408,6 @@ Malware Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -388,13 +417,15 @@ Accept wildcard characters: False ``` ### -LogicalOperationName + +> Applicable: Security & Compliance + {{ Fill LogicalOperationName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -404,6 +435,9 @@ Accept wildcard characters: False ``` ### -NotificationCulture + +> Applicable: Security & Compliance + The NotificationCulture parameter specifies the language or locale that's used for notifications. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -412,7 +446,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -422,13 +455,15 @@ Accept wildcard characters: False ``` ### -NotificationEnabled + +> Applicable: Security & Compliance + {{ Fill NotificationEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -438,6 +473,9 @@ Accept wildcard characters: False ``` ### -NotifyUserOnFilterMatch + +> Applicable: Security & Compliance + The NotifyUserOnFilterMatch parameter specifies whether to trigger an alert for a single event when the alert policy is configured for aggregated activity. Valid values are: - $true: Even though the alert is configured for aggregated activity, a notification is triggered during a match for the activity (basically, an early warning). @@ -449,7 +487,6 @@ You can't use this parameter when the AggregationType parameter value is None (a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -459,6 +496,9 @@ Accept wildcard characters: False ``` ### -NotifyUserSuppressionExpiryDate + +> Applicable: Security & Compliance + The NotifyUserSuppressionExpiryDate parameter specifies whether to temporarily suspend notifications for the alert policy. Until the specified date-time, no notifications are sent for detected activities. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -467,7 +507,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -477,6 +516,9 @@ Accept wildcard characters: False ``` ### -NotifyUserThrottleThreshold + +> Applicable: Security & Compliance + The NotifyUserThrottleThreshold parameter specifies the maximum number of notifications for the alert policy within the time period specified by the NotifyUserThrottleWindow parameter. Once the maximum number of notifications has been reached in the time period, no more notifications are sent for the alert. Valid values are: - An integer. @@ -486,7 +528,6 @@ The NotifyUserThrottleThreshold parameter specifies the maximum number of notifi Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -496,6 +537,9 @@ Accept wildcard characters: False ``` ### -NotifyUserThrottleWindow + +> Applicable: Security & Compliance + The NotifyUserThrottleWindow parameter specifies the time interval in minutes that's used by the NotifyUserThrottleThreshold parameter. Valid values are: - An integer. @@ -505,7 +549,6 @@ The NotifyUserThrottleWindow parameter specifies the time interval in minutes th Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -515,6 +558,9 @@ Accept wildcard characters: False ``` ### -Operation + +> Applicable: Security & Compliance + The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. @@ -525,7 +571,6 @@ You can only use this parameter when the ThreatType parameter has the value Acti Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -535,13 +580,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypes + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -551,13 +598,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypesForCounting + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypesForCounting Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -567,13 +616,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypesThreshold + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypesThreshold Description }} ```yaml Type: System.UInt64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -583,6 +634,9 @@ Accept wildcard characters: False ``` ### -Severity + +> Applicable: Security & Compliance + The Severity parameter specifies the severity of the detection. Valid values are: - Low (This is the default value) @@ -593,7 +647,6 @@ The Severity parameter specifies the severity of the detection. Valid values are Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -603,6 +656,9 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: Security & Compliance + The Threshold parameter specifies the number of detections that trigger the alert policy within the time period specified by the TimeWindow parameter. A valid value is an integer that's greater than or equal to 3. You can only use this parameter when the AggregationType parameter value is SimpleAggregation. @@ -611,7 +667,6 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -621,6 +676,9 @@ Accept wildcard characters: False ``` ### -TimeWindow + +> Applicable: Security & Compliance + The TimeWindow parameter specifies the time interval in minutes for number of detections specified by the Threshold parameter. A valid value is an integer that's greater than 60 (one hour). You can only use this parameter when the AggregationType parameter value is SimpleAggregation. @@ -629,7 +687,6 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -639,13 +696,15 @@ Accept wildcard characters: False ``` ### -UseCreatedDateTime + +> Applicable: Security & Compliance + {{ Fill UseCreatedDateTime Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -655,13 +714,15 @@ Accept wildcard characters: False ``` ### -VolumeThreshold + +> Applicable: Security & Compliance + {{ Fill VolumeThreshold Description }} ```yaml Type: System.UInt64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -671,13 +732,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolder.md similarity index 89% rename from exchange/exchange-ps/exchange/New-PublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/New-PublicFolder.md index 71c11a5ab5..8f7f1f561f 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-publicfolder +schema: 2.0.0 +title: New-PublicFolder --- # New-PublicFolder @@ -68,13 +69,15 @@ This example creates the public folder Support in the North\_America hierarchy p ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name for the public folder. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -93,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -111,7 +119,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -EformsLocaleId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the hierarchy public folder mailbox where you want this public folder created. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -154,7 +166,6 @@ The Mailbox parameter specifies the hierarchy public folder mailbox where you wa Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Path parameter specifies the location of the folder in the folder hierarchy, for example, \\Legal\\Cases. ```yaml Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Mailbox server where you want to create the new public folder. You can use any value that uniquely identifies the server. For example: @@ -195,7 +211,6 @@ If you don't use this parameter, the command is run on the local server if the s Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -205,13 +220,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabase.md similarity index 94% rename from exchange/exchange-ps/exchange/New-PublicFolderDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabase.md index 992f21daac..4b6ccdc335 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfolderdatabase applicable: Exchange Server 2010 -title: New-PublicFolderDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-publicfolderdatabase +schema: 2.0.0 +title: New-PublicFolderDatabase --- # New-PublicFolderDatabase @@ -47,13 +48,15 @@ This example creates the public folder database PFDB01. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the name of the new public folder database. The name must be unique to your entire organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Mailbox server where you want to create the new public folder database. You can use any value that uniquely identifies the server. For example: - Name @@ -76,7 +82,6 @@ A server can have only one public folder database. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -EdbFilePath + +> Applicable: Exchange Server 2010 + The EdbFilePath parameter specifies the full path of the public folder database files. The default location is `%ExchangeInstallPath%Mailbox\\.edb` ```yaml Type: EdbFilePath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -137,13 +148,15 @@ Accept wildcard characters: False ``` ### -LogFolderPath + +> Applicable: Exchange Server 2010 + The LogFolderPath parameter specifies the folder location for log files. The default location is `%ExchangeInstallPath%Mailbox\`. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -153,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabaseRepairRequest.md similarity index 94% rename from exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabaseRepairRequest.md index 332ac3deec..231d0ed6c1 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabaseRepairRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfolderdatabaserepairrequest applicable: Exchange Server 2010 -title: New-PublicFolderDatabaseRepairRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-publicfolderdatabaserepairrequest +schema: 2.0.0 +title: New-PublicFolderDatabaseRepairRequest --- # New-PublicFolderDatabaseRepairRequest @@ -55,6 +56,9 @@ This example only detects and reports on replication issues on public folder dat ## PARAMETERS ### -Database + +> Applicable: Exchange Server 2010 + The Database parameter specifies the public folder database that you want to repair. You can use any value that uniquely identifies the database. For example: - Name @@ -65,7 +69,6 @@ The Database parameter specifies the public folder database that you want to rep Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -CorruptionType + +> Applicable: Exchange Server 2010 + The CorruptionType parameter specifies the type of corruption that you want to detect and repair. The only available value is ReplState. ```yaml Type: PublicFolderDatabaseCorruptionType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -100,7 +108,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -DetectOnly + +> Applicable: Exchange Server 2010 + The DetectOnly switch specifies that you want this command to report errors, but not fix them. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMigrationRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMigrationRequest.md index 8707577d81..6cc054734f 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfoldermigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-PublicFolderMigrationRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-publicfoldermigrationrequest +schema: 2.0.0 +title: New-PublicFolderMigrationRequest --- # New-PublicFolderMigrationRequest @@ -63,13 +64,15 @@ This example creates a public folder migration request from the Exchange 2010 so ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the public folder migration request. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceDatabase parameter specifies the target database for the public folders. You can use any value that uniquely identifies the database. For example: - Name @@ -89,7 +95,6 @@ The SourceDatabase parameter specifies the target database for the public folder Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -107,7 +115,6 @@ You need to use this switch if you set the LargeItemLimit parameter to a value o Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -125,7 +135,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BatchName parameter specifies a descriptive name for the public folder migration batch. You can use the BatchName parameter as a search string when you use the Get-PublicFolderMigrationRequest cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,6 +180,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -176,7 +192,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,6 +201,9 @@ Accept wildcard characters: False ``` ### -CSVData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CSVData parameter specifies the mapping file output generated by the PublicFoldertoMailboxMapGenerator.ps1 script. Use this parameter for local migrations. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -196,7 +214,6 @@ You can't use this parameter with the CSVStream parameter, but you need to use i Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -CSVStream + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CSVStream parameter specifies the mapping file output generated by the PublicFoldertoMailboxMapGenerator.ps1 script. Use this parameter for remote migrations. You can't use this parameter with the CSVData parameter, but you need to use it if you don't use CSVData parameter. @@ -214,7 +234,6 @@ You can't use this parameter with the CSVData parameter, but you need to use it Type: Stream Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,13 +243,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -240,13 +261,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -256,6 +279,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -271,7 +297,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,13 +306,15 @@ Accept wildcard characters: False ``` ### -MigrationMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,6 +324,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: - Lowest @@ -312,7 +342,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,6 +351,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -335,7 +367,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -345,13 +376,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipMerging parameter specifies whether certain stages of a public folder migration are skipped for debugging purposes. Don't use this parameter unless directed to do so by a Microsoft Customer Service and Support or specific documentation. ```yaml Type: SkippableMergeComponent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -361,13 +394,15 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -377,6 +412,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. @@ -385,7 +423,6 @@ If you use this switch, the request is queued, but the request won't reach the s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -395,13 +432,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -411,13 +450,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -427,13 +468,15 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: RequestWorkloadType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMoveRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMoveRequest.md index 435cac68b3..03c3853697 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfoldermoverequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-PublicFolderMoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-publicfoldermoverequest +schema: 2.0.0 +title: New-PublicFolderMoveRequest --- # New-PublicFolderMoveRequest @@ -80,13 +81,15 @@ This example moves all public folders from public folder mailbox Pub1 to public ## PARAMETERS ### -Folders + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Folders parameter specifies the public folders that you want to move. If the public folder has child public folders, these child public folders won't be moved unless you explicitly state them in the command. You can move multiple public folders by separating them with a comma, for example, \\Dev\\CustomerEngagements,\\Dev\\RequestsforChange,\\Dev\\Usability. ```yaml Type: PublicFolderIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetMailbox parameter specifies the target public folder mailbox that you want to move the public folders to. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -113,7 +119,6 @@ The TargetMailbox parameter specifies the target public folder mailbox that you Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptLargeDataLoss switch specifies that the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -131,7 +139,6 @@ You need to use this switch if you set the LargeItemLimit parameter to a value o Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -AllowLargeItems + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowLargeItems switch specifies that you can move large items only when they're encountered. You don't need to specify a value with this switch. Large items are email messages with a maximum of 1,023 attachments. @@ -149,7 +159,6 @@ Large items are email messages with a maximum of 1,023 attachments. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to be completed. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means that the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so that the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and then try the request again. @@ -167,7 +179,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -177,13 +188,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has been completed before being automatically removed. The default value for this parameter is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -202,7 +218,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -220,7 +238,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,13 +247,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,13 +265,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the public folder move request. If you don't specify a name, the default name is PublicFolderMove. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,6 +283,9 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Organization Description }} @@ -270,7 +294,6 @@ This parameter is available only in the cloud-based service. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 7 @@ -280,6 +303,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: - Lowest @@ -295,7 +321,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -305,6 +330,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -318,7 +346,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -328,6 +355,9 @@ Accept wildcard characters: False ``` ### -Suspend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. @@ -336,7 +366,6 @@ If you use this switch, the request is queued, but the request won't reach the s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -346,13 +375,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -362,6 +393,9 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SuspendWhenReadyToComplete switch specifies whether to suspend the request before it reaches the status of CompletionInProgress. You don't need to specify a value with this switch. @@ -372,7 +406,6 @@ After the move is suspended, it has a status of AutoSuspended. You can then manu Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -382,13 +415,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -398,13 +433,15 @@ Accept wildcard characters: False ``` ### -WorkloadType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WorkloadType parameter is reserved for internal Microsoft use. ```yaml Type: RequestWorkloadType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-QuarantinePermissions.md b/exchange/exchange-ps/ExchangePowerShell/New-QuarantinePermissions.md similarity index 94% rename from exchange/exchange-ps/exchange/New-QuarantinePermissions.md rename to exchange/exchange-ps/ExchangePowerShell/New-QuarantinePermissions.md index 2ce42db98f..a5f3e8220a 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePermissions.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-QuarantinePermissions.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-quarantinepermissions applicable: Exchange Online, Exchange Online Protection -title: New-QuarantinePermissions -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-quarantinepermissions +schema: 2.0.0 +title: New-QuarantinePermissions --- # New-QuarantinePermissions @@ -72,6 +73,9 @@ In the same PowerShell session, you can use `$FullAccess` for the _EndUserQuaran ## PARAMETERS ### -PermissionToAllowSender + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToAllowSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are: - $true: Allow sender is available for affected messages in quarantine. @@ -81,7 +85,6 @@ The PermissionToAllowSender parameter specifies whether users are allowed to add Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -PermissionToBlockSender + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are: - $true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine. @@ -100,7 +106,6 @@ The PermissionToBlockSender parameter specifies whether users are allowed to add Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 2 @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -PermissionToDelete + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are: - $true: Delete messages and Delete from quarantine are available for affected messages in quarantine. @@ -119,7 +127,6 @@ The PermissionToDelete parameter specifies whether users are allowed to delete m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 3 @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -PermissionToDownload + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToDownload parameter specifies whether users are allowed to download messages from quarantine. Valid values are: - $true: The permission is enabled. @@ -140,7 +150,6 @@ Currently, this value has no effect on the available actions in quarantine notif Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 4 @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -PermissionToPreview + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are: - $true: Preview message is available for affected messages in quarantine. @@ -159,7 +171,6 @@ The PermissionToPreview parameter specifies whether users are allowed to preview Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 5 @@ -169,6 +180,9 @@ Accept wildcard characters: False ``` ### -PermissionToRelease + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are: - $true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine. @@ -180,7 +194,6 @@ Don't set this parameter and the _PermissionToRequestRelease_ parameter to $true Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 6 @@ -190,6 +203,9 @@ Accept wildcard characters: False ``` ### -PermissionToRequestRelease + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are: - $true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine. @@ -201,7 +217,6 @@ Don't set this parameter and the _PermissionRelease_ parameter to $true. Set one Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 7 @@ -211,6 +226,9 @@ Accept wildcard characters: False ``` ### -PermissionToViewHeader + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToViewHeader parameter specifies whether users are allowed to view the message headers of quarantined messages. Valid values are: - $true: The permission is enabled. @@ -222,7 +240,6 @@ Currently, this value has no effect on the available actions in quarantine notif Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 8 diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-QuarantinePolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/New-QuarantinePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-QuarantinePolicy.md index 1d12b70c98..8a7e07202b 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-QuarantinePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-quarantinepolicy applicable: Exchange Online, Exchange Online Protection -title: New-QuarantinePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-quarantinepolicy +schema: 2.0.0 +title: New-QuarantinePolicy --- # New-QuarantinePolicy @@ -66,13 +67,15 @@ To assign Limited access permissions, use the value 27. To assign Full access pe ## PARAMETERS ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the quarantine policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the quarantine policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -AdminNotificationFrequencyInDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -AdminNotificationLanguage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml @@ -121,7 +131,6 @@ Type: EsnLanguage Parameter Sets: (All) Aliases: Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -AdminNotificationsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -AdminQuarantinePermissionsList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -CustomDisclaimer + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -195,6 +212,9 @@ Accept wildcard characters: False ``` ### -EndUserQuarantinePermissions + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: To set permissions in quarantine policies, we recommend using the EndUserQuarantinePermissionsValue parameter. The EndUserQuarantinePermissions specifies the end-user permissions for the quarantine policy by using a variable from the output of a New-QuarantinePermissions or Set-QuarantinePermissions command. @@ -205,7 +225,6 @@ For example, run the following command to store the required permissions in a va Type: QuarantinePermissions Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +234,9 @@ Accept wildcard characters: False ``` ### -EndUserQuarantinePermissionsValue + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy. This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1): @@ -242,7 +264,6 @@ For custom permissions, get the binary value that corresponds to the permissions Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -252,6 +273,9 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. If you don't use this parameter, the default sender is quarantine@messaging.microsoft.com. @@ -260,7 +284,6 @@ If you don't use this parameter, the default sender is quarantine@messaging.micr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -270,6 +293,9 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserSpamNotificationFrequency parameter specifies how often quarantine notifications are sent to users. Valid values are: - 04:00:00 (4 hours) @@ -280,7 +306,6 @@ The EndUserSpamNotificationFrequency parameter specifies how often quarantine no Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -290,13 +315,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequencyInDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -306,6 +333,9 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLanguage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml @@ -313,7 +343,6 @@ Type: EsnLanguage Parameter Sets: (All) Aliases: Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,6 +352,9 @@ Accept wildcard characters: False ``` ### -EsnCustomSubject + +> Applicable: Exchange Online, Exchange Online Protection + The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications. You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. @@ -335,7 +367,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: MultiValuedProperty Parameter Sets: (All) Aliases: MultiValuedProperty -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -345,6 +376,9 @@ Accept wildcard characters: False ``` ### -ESNEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: - $true: Quarantine notifications are enabled. @@ -356,7 +390,6 @@ The ESNEnabled parameter specifies whether to enable quarantine notifications (f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -366,6 +399,9 @@ Accept wildcard characters: False ``` ### -IncludeMessagesFromBlockedSenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send quarantine notifications for quarantined messages from blocked sender addresses. Valid values are: - $true: Recipients get quarantine notifications for affected messages from blocked senders. @@ -375,7 +411,6 @@ The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -385,13 +420,15 @@ Accept wildcard characters: False ``` ### -MultiLanguageCustomDisclaimer + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -401,13 +438,15 @@ Accept wildcard characters: False ``` ### -MultiLanguageSenderName + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -417,13 +456,15 @@ Accept wildcard characters: False ``` ### -MultiLanguageSetting + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -433,13 +474,15 @@ Accept wildcard characters: False ``` ### -OrganizationBrandingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -449,13 +492,15 @@ Accept wildcard characters: False ``` ### -QuarantineRetentionDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -465,6 +510,9 @@ Accept wildcard characters: False ``` ### -QuarantinePolicyType + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml @@ -472,7 +520,6 @@ Type: QuarantinePolicyType Parameter Sets: (All) Aliases: Accepted values: QuarantinePolicy, GlobalQuarantinePolicy -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ReceiveConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-ReceiveConnector.md similarity index 90% rename from exchange/exchange-ps/exchange/New-ReceiveConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-ReceiveConnector.md index a053087232..72b383e6a6 100644 --- a/exchange/exchange-ps/exchange/New-ReceiveConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ReceiveConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-receiveconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ReceiveConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-receiveconnector +schema: 2.0.0 +title: New-ReceiveConnector --- # New-ReceiveConnector @@ -401,13 +402,15 @@ It accepts incoming SMTP connections only from the IP range 192.168.0.1-192.168. ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name for the Receive connector. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -417,6 +420,9 @@ Accept wildcard characters: False ``` ### -Bindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax `"IPv4Address:TCPPort","IPv6Address:TCPPort"`. You can specify an IPv4 address and port, an IPv6 address and port, or both. The IP address values 0.0.0.0 or `[::]` indicate that the Receive connector uses all available local IPv4 or all IPv6 addresses. You need to specify a valid local IP address from the network adapters of the Exchange server. If you specify an invalid local IP address, the Microsoft Exchange Transport service might fail to start when the service is restarted. @@ -439,9 +445,8 @@ The values for this parameter must satisfy one of the following uniqueness requi ```yaml Type: MultiValuedProperty -Parameter Sets: Custom, Internet, Partner +Parameter Sets: Custom, Internet, Partner, Internal, Client, UsageType Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -450,20 +455,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MultiValuedProperty -Parameter Sets: Internal, Client, UsageType -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Client -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Client The Client switch specifies the Client usage type for the Receive connector. You don't need to specify a value with this switch. This usage type assigns the following default permission groups and authentication methods: @@ -479,7 +474,6 @@ You can't use this switch with any other usage type parameters (Internal, Intern Type: SwitchParameter Parameter Sets: Client Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -489,6 +483,9 @@ Accept wildcard characters: False ``` ### -Internal + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Internal switch specifies the Internal usage type for the Receive connector. You don't need to specify a value with this switch. This usage type assigns the following default permission groups and authentication methods: @@ -504,7 +501,6 @@ You can't use this switch with any other usage type parameters (Client, Internet Type: SwitchParameter Parameter Sets: Internal Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -514,6 +510,9 @@ Accept wildcard characters: False ``` ### -Internet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Internet switch specifies the Internet usage type for the Receive connector. You don't need to specify a value with this switch. This usage type assigns the following default permission groups and authentication methods: @@ -529,7 +528,6 @@ You can't use this switch with any other usage type parameters (Client, Internal Type: SwitchParameter Parameter Sets: Internet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -539,6 +537,9 @@ Accept wildcard characters: False ``` ### -Partner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Partner switch specifies the Partner usage type for the Receive connector. You don't need to specify a value with this switch. This usage type assigns the following default permission groups and authentication methods: @@ -554,7 +555,6 @@ You can't use this switch with any other usage type parameters (Client, Internal Type: SwitchParameter Parameter Sets: Partner Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -564,6 +564,9 @@ Accept wildcard characters: False ``` ### -RemoteIPRanges + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoteIPRanges parameter specifies the remote IP addresses that the Receive connector accepts messages from. Valid values are: - Single IP address: For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11. @@ -591,9 +594,8 @@ You can't use this parameter with the Internet usage type (the default value is ```yaml Type: MultiValuedProperty -Parameter Sets: Custom, Partner, Internal, Client +Parameter Sets: Custom, Partner, Internal, Client, Internet, UsageType Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -602,20 +604,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MultiValuedProperty -Parameter Sets: Internet, UsageType -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Usage -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Usage The Usage parameter specifies the default permission groups and authentication methods that are assigned to the Receive connector. Valid values are: - Client @@ -645,7 +637,6 @@ You can't use this parameter with any other usage type switches (Client, Interna Type: UsageType Parameter Sets: UsageType Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -655,6 +646,9 @@ Accept wildcard characters: False ``` ### -AdvertiseClientSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AdvertiseClientSettings parameter specifies whether the SMTP server name, port number, and authentication settings for the Receive connector are displayed to users in the options of Outlook on the web. Valid values are: - $true: The SMTP values are displayed in Outlook on the web. Typically, you would only use this setting for a Receive connector with the usage type Client (authenticated SMTP connections on TCP port 587 for POP3 and IMAP4 clients). @@ -664,7 +658,6 @@ The AdvertiseClientSettings parameter specifies whether the SMTP server name, po Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -674,6 +667,9 @@ Accept wildcard characters: False ``` ### -AuthMechanism + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AuthMechanism parameter specifies the advertised and accepted authentication mechanisms for the Receive connector. Valid values are: - None @@ -696,7 +692,6 @@ You can specify multiple values separated by commas, but some values have depend Type: AuthMechanisms Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -706,6 +701,9 @@ Accept wildcard characters: False ``` ### -AuthTarpitInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The AuthTarpitInterval parameter specifies the period of time to delay responses to failed authentication attempts from remote servers that may be abusing the connection. The default value is 5 seconds. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -718,7 +716,6 @@ You can configure the delay for other SMTP failure responses by using the Tarpit Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -728,6 +725,9 @@ Accept wildcard characters: False ``` ### -Banner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Banner parameter specifies a custom SMTP 220 banner that's displayed to remote messaging servers that connect to the Receive connector. When you specify a value, enclose the value in quotation marks, and start the value with 220 (the default "Service ready" SMTP response code). The default value of this parameter is blank ($null), which uses the following SMTP banner: @@ -738,7 +738,6 @@ The default value of this parameter is blank ($null), which uses the following S Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -748,6 +747,9 @@ Accept wildcard characters: False ``` ### -BinaryMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BinaryMimeEnabled parameter specifies whether the BINARYMIME Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: BINARYMIME is enabled and is advertised in the EHLO response. This setting requires that the ChunkingEnabled parameter is also set to the value $true. This is the default value. @@ -759,7 +761,6 @@ The binary MIME extension is defined in RFC 3030. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -769,6 +770,9 @@ Accept wildcard characters: False ``` ### -ChunkingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ChunkingEnabled parameter specifies whether the CHUNKING Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: CHUNKING is enabled and is advertised in the EHLO response. This is the default value. @@ -780,7 +784,6 @@ Chunking is defined in RFC 3030. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -790,13 +793,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -806,6 +811,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -815,7 +823,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -825,6 +832,9 @@ Accept wildcard characters: False ``` ### -ConnectionInactivityTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectionInactivityTimeout parameter specifies the maximum amount of idle time before a connection to the Receive connector is closed. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -839,7 +849,6 @@ The value of this parameter must be less than the value of the ConnectionTimeout Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -849,6 +858,9 @@ Accept wildcard characters: False ``` ### -ConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectionTimeout parameter specifies the maximum time that the connection to the Receive connector can remain open, even if the connection is actively transmitting data. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -863,7 +875,6 @@ The value of this parameter must be greater than the value of the ConnectionInac Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -873,6 +884,9 @@ Accept wildcard characters: False ``` ### -Custom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Custom switch specifies the Custom usage type for the Receive connector. You don't need to specify a value with this switch. This usage type assigns the following default permission groups and authentication methods: @@ -890,7 +904,6 @@ You can't use this switch with any other usage type parameters (Client, Internal Type: SwitchParameter Parameter Sets: Custom Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -900,6 +913,9 @@ Accept wildcard characters: False ``` ### -DefaultDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DefaultDomain parameter specifies the default accepted domain to use for the Exchange organization. You can use any value that uniquely identifies the accepted domain. For example: - Name @@ -916,7 +932,6 @@ Although you can configure any accepted domain as the default domain, you typica Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -926,6 +941,9 @@ Accept wildcard characters: False ``` ### -DeliveryStatusNotificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeliveryStatusNotificationEnabled parameter specifies whether the DSN (delivery status notification) Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: DSN is enabled and is advertised in the EHLO response. This is the default value. @@ -937,7 +955,6 @@ Delivery status notifications are defined in RFC 3461. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -947,6 +964,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -955,7 +975,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -965,6 +984,9 @@ Accept wildcard characters: False ``` ### -DomainSecureEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainSecureEnabled parameter specifies whether to enable or disable mutual Transport Layer Security (TLS) authentication (also known as Domain Secure) for the domains that are serviced by the Receive connector. Valid values are: - $true: Mutual TLS authentication is enabled. @@ -982,7 +1004,6 @@ Note that setting this parameter to the value $true is only part of the requirem Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -992,6 +1013,9 @@ Accept wildcard characters: False ``` ### -EightBitMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EightBitMimeEnabled parameter specifies whether the 8BITMIME Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: 8BITMIME is enabled and is advertised in the EHLO response. This is the default value. @@ -1003,7 +1027,6 @@ The EightBitMimeEnabled parameter specifies whether the 8BITMIME Extended SMTP e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1013,6 +1036,9 @@ Accept wildcard characters: False ``` ### -EnableAuthGSSAPI + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnableAuthGSSAPI parameter enables or disables Kerberos when Integrated Windows authentication is available on the Receive connector (the AuthMechanism parameter contains the value Integrated). Valid values are: - $true: Kerberos is enabled. The Extended SMTP keyword AUTH GSSAPI NTLM is advertised in the EHLO response. Clients can use Kerberos or NTLM for Integrated Windows authentication. @@ -1024,7 +1050,6 @@ The Generic Security Services application programming interface (GSSAPI) is an I Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1034,6 +1059,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether to enable or disable the Receive connector. Valid values are: - $true: The Receive connector is enabled. This is the default value. @@ -1043,7 +1071,6 @@ The Enabled parameter specifies whether to enable or disable the Receive connect Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1053,6 +1080,9 @@ Accept wildcard characters: False ``` ### -EnhancedStatusCodesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnhancedStatusCodesEnabled parameter specifies whether the ENHANCEDSTATUSCODES Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: ENHANCEDSTATUSCODES is enabled and is advertised in the EHLO response. This is the default value. @@ -1064,7 +1094,6 @@ Enhanced status codes are defined in RFC 2034. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1074,6 +1103,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionPolicy parameter specifies how Extended Protection for Authentication is implemented on the Receive connector. Valid values are: - None: Extended Protection for Authentication isn't used. This is the default value. @@ -1086,7 +1118,6 @@ Extended Protection for Authentication enhances the protection and handling of c Type: ExtendedProtectionPolicySetting Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1096,6 +1127,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Fqdn parameter specifies the destination FQDN that's shown to connected messaging servers. This value is used in the following locations: - In the default SMTP banner of the Receive connector. @@ -1109,7 +1143,6 @@ The default value is the FQDN of theExchange server that contains the Receive co Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1119,6 +1152,9 @@ Accept wildcard characters: False ``` ### -LongAddressesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LongAddressesEnabled parameter specifies whether the Receive connector accepts long X.400 email addresses. The X.400 email addresses are encapsulated in SMTP email addresses by using the Internet Mail Connector Encapsulated Address (IMCEA) encapsulation method. Valid values are - $true: X.400 email addresses can be up to 1,860 characters long after IMCEA encapsulation. @@ -1136,7 +1172,6 @@ You can only configure this parameter on Receive connectors in the Transport ser Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1146,6 +1181,9 @@ Accept wildcard characters: False ``` ### -MaxAcknowledgementDelay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The MaxAcknowledgementDelay parameter specifies the maximum period the transport server delays acknowledgment until it verifies that the message has been successfully delivered to all recipients. When receiving messages from a host that doesn't support shadow redundancy, an Exchange Server 2010 transport server will delay issuing an acknowledgment until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server will time out and issue an acknowledgment anyway. @@ -1158,7 +1196,6 @@ The default value is 30 seconds. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1168,6 +1205,9 @@ Accept wildcard characters: False ``` ### -MaxHeaderSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxHeaderSize parameter specifies the maximum size of the SMTP message header before the Receive connector closes the connection. The default value is 256 kilobytes (262144 bytes). When you enter a value, qualify the value with one of the following units: @@ -1185,7 +1225,6 @@ A valid value is from 1 to 2147483647 bytes. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1195,6 +1234,9 @@ Accept wildcard characters: False ``` ### -MaxHopCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxHopCount parameter specifies the maximum number of hops that a message can take before the message is rejected by the Receive connector. The maximum number of hops is determined by the number of Received header fields that exist in a submitted message. A valid value is from 1 to 500. The default value is 30. @@ -1203,7 +1245,6 @@ A valid value is from 1 to 500. The default value is 30. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1213,6 +1254,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxInboundConnection parameter specifies the maximum number of inbound connections that this Receive connector serves at the same time. A valid value is from 1 to 2147483647, or the value unlimited. The default value is 5000. @@ -1223,7 +1267,6 @@ To disable the inbound connection limit on a Receive connector, enter a value of Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1233,6 +1276,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnectionPercentagePerSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxInboundConnectionPercentagePerSource parameter specifies the maximum number of connections that a Receive connector serves at the same time from a single IP address, expressed as the percentage of available remaining connections on a Receive connector. A valid value is from 1 to 100 without the percent sign (%). The default value is 2 percent. @@ -1241,7 +1287,6 @@ A valid value is from 1 to 100 without the percent sign (%). The default value i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1251,6 +1296,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnectionPerSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxInboundConnectionPerSource parameter specifies the maximum number of connections that this Receive connector serves at the same time from a single IP address. A valid value is from 1 to 10000, or the value unlimited. The default value is 20. @@ -1261,7 +1309,6 @@ To disable the inbound connection per source limit on a Receive connector, enter Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1271,6 +1318,9 @@ Accept wildcard characters: False ``` ### -MaxLocalHopCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxLocalHopCount parameter specifies the maximum number of local hops that a message can take before the message is rejected by the Receive connector. The maximum number of local hops is determined by the number of Received headers with local server addresses in a submitted message. A valid value is from 0 to 50. The default value is 8. @@ -1281,7 +1331,6 @@ When you specify the value 0, the message is never rejected based on the number Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1291,6 +1340,9 @@ Accept wildcard characters: False ``` ### -MaxLogonFailures + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxLogonFailures parameter specifies the number of logon failures that the Receive connector retries before it closes the connection. A valid value is from 0 to 10. The default value is 3. @@ -1301,7 +1353,6 @@ When you specify the value 0, the connection is never closed because of logon fa Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1311,6 +1362,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxMessageSize parameter specifies the maximum size of a message that's allowed through the Receive connector. The default value is 36 MB, which results in a realistic maximum message size of 25 MB. When you enter a value, qualify the value with one of the following units: @@ -1330,7 +1384,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1340,6 +1393,9 @@ Accept wildcard characters: False ``` ### -MaxProtocolErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxProtocolErrors parameter specifies the maximum number of SMTP protocol errors that the Receive connector accepts before closing the connection. A valid value is from 0 to 2147483647, or the value unlimited. The default value is 5. @@ -1350,7 +1406,6 @@ When you specify the value unlimited, a connection is never closed because of pr Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1360,6 +1415,9 @@ Accept wildcard characters: False ``` ### -MaxRecipientsPerMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxRecipientsPerMessage parameter specifies the maximum number of recipients per message that the Receive connector accepts before closing the connection. A valid value is from 1 to 512000. The default value is 200. @@ -1368,7 +1426,6 @@ A valid value is from 1 to 512000. The default value is 200. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1378,6 +1435,9 @@ Accept wildcard characters: False ``` ### -MessageRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRateLimit parameter specifies the maximum number of messages that can be sent by a single client IP address per minute. A valid value is from 1 to 2147483647, or the value unlimited. @@ -1390,7 +1450,6 @@ The default value for Receive connectors on Mailbox servers is unlimited. The de Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1400,6 +1459,9 @@ Accept wildcard characters: False ``` ### -MessageRateSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRateSource parameter specifies how the message submission rate is calculated. Valid values are: - None: The message submission rate isn't calculated. @@ -1411,7 +1473,6 @@ The MessageRateSource parameter specifies how the message submission rate is cal Type: MessageRateSourceFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1421,6 +1482,9 @@ Accept wildcard characters: False ``` ### -OrarEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OrarEnabled parameter enables or disables Originator Requested Alternate Recipient (ORAR) on the Receive connector. Valid values are: - $true: ORAR is enabled and is advertised in the XORAR keyword in the EHLO response. The actual ORAR information is transmitted in the RCPT TO SMTP command. @@ -1432,7 +1496,6 @@ If the email address specified in the ORAR information is a long X.400 email add Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1442,6 +1505,9 @@ Accept wildcard characters: False ``` ### -PermissionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PermissionGroups parameter specifies the well-known security principals who are authorized to use the Receive connector, and the permissions that are assigned to them. Valid values are: - None @@ -1462,7 +1528,6 @@ For more information about the default permissions and security principals for p Type: PermissionGroups Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1472,6 +1537,9 @@ Accept wildcard characters: False ``` ### -PipeliningEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipeliningEnabled parameter specifies whether the PIPELINING Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: PIPELINING is enabled and is advertised in the EHLO response. This is the default value. @@ -1483,7 +1551,6 @@ Pipelining is defined in RFC 2920. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1493,6 +1560,9 @@ Accept wildcard characters: False ``` ### -ProtocolLoggingLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProtocolLoggingLevel parameter specifies whether to enable or disable protocol logging for the Receive connector. Valid values are: - None: Protocol logging is disabled on the Receive connector. This is the default value. @@ -1504,7 +1574,6 @@ For more information about protocol logging, see [Protocol logging](https://lear Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1514,6 +1583,9 @@ Accept wildcard characters: False ``` ### -RejectReservedSecondLevelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RejectReservedSecondLevelRecipientDomains parameter specifies whether to reject connections that contain recipients in reserved second-level domains as specified in RFC 2606 (example.com, example.net, or example.org). Valid value are: - $true: RCPT TO commands that contain reserved second-level domains are rejected. @@ -1523,7 +1595,6 @@ The RejectReservedSecondLevelRecipientDomains parameter specifies whether to rej Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1533,6 +1604,9 @@ Accept wildcard characters: False ``` ### -RejectReservedTopLevelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RejectReservedTopLevelRecipientDomains parameter specifies whether to reject connections that contain recipients in reserved top-level domains (TLDs) as specified in RFC 2606 (.test, .example, .invalid, or .localhost). Valid value are: - $true: RCPT TO commands that contain reserved TLDs are rejected. @@ -1542,7 +1616,6 @@ The RejectReservedTopLevelRecipientDomains parameter specifies whether to reject Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1552,6 +1625,9 @@ Accept wildcard characters: False ``` ### -RejectSingleLabelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RejectSingleLabelRecipientDomains parameter specifies whether to reject connections that contain recipients in single-label domains (for example, chris@contoso instead of chris@contoso.com). Valid values are: - $true: RCPT TO commands that contain single-label domains are rejected. @@ -1561,7 +1637,6 @@ The RejectSingleLabelRecipientDomains parameter specifies whether to reject conn Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1571,6 +1646,9 @@ Accept wildcard characters: False ``` ### -RequireEHLODomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireEHLODomain parameter specifies whether the client must provide a domain name in the EHLO handshake after the SMTP connection is established. Valid values are: - $true: The client must provide a domain name in the EHLO handshake. If it doesn't, the SMTP connection is closed. @@ -1580,7 +1658,6 @@ The RequireEHLODomain parameter specifies whether the client must provide a doma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1590,6 +1667,9 @@ Accept wildcard characters: False ``` ### -RequireTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireTLS parameter specifies whether to require TLS transmission for inbound messages on the Receive connector. Valid values are: - $true: Inbound messages on the Receive connector require TLS transmission. @@ -1599,7 +1679,6 @@ The RequireTLS parameter specifies whether to require TLS transmission for inbou Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1609,6 +1688,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -1622,7 +1704,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1632,13 +1713,15 @@ Accept wildcard characters: False ``` ### -ServiceDiscoveryFqdn + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ServiceDiscoveryFqdn parameter specifies the service discovery fully-qualified domain name (FQDN) for the Receive connector. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1648,6 +1731,9 @@ Accept wildcard characters: False ``` ### -SizeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SizeEnabled parameter specifies how the SIZE Extended SMTP extension is used on the Receive connector. Valid values are: - Enabled: SIZE is enabled and is advertised in the EHLO response along with the value of the MaxMessageSize parameter. If the size of the inbound message exceeds the specified value, the Receive connector closes the connection with an error code. This is the default value. @@ -1660,7 +1746,6 @@ SIZE is defined in RFC 1870. Type: SizeMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1670,6 +1755,9 @@ Accept wildcard characters: False ``` ### -SuppressXAnonymousTls + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuppressXAnonymousTls parameter specifies whether the X-ANONYMOUSTLS Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: X-ANONYMOUSTLS is disabled and isn't advertised in the EHLO response. This setting also requires that you set the UseDownGradedExchangeServerAuth parameter to the value $true on the Set-TransportService cmdlet on the server. @@ -1681,7 +1769,6 @@ The X-ANONYMOUSTLS extension is important when the AuthMechanism parameter conta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1691,6 +1778,9 @@ Accept wildcard characters: False ``` ### -TarpitInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TarpitInterval parameter specifies the amount of time to delay an SMTP response to a remote server that may be abusing the connection. The default value is 00:00:05 (5 seconds.). To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1703,7 +1793,6 @@ You can configure the delay for authentication failure responses by using the Au Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1713,13 +1802,15 @@ Accept wildcard characters: False ``` ### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1729,6 +1820,9 @@ Accept wildcard characters: False ``` ### -TlsDomainCapabilities + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsDomainCapabilities parameter specifies the capabilities that the Receive connector makes available to specific hosts outside of the organization. Remote hosts are authenticated with TLS with certificate validation before these capabilities are offered. This parameter uses the following syntax: @@ -1750,7 +1844,6 @@ For example, `"contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptCloudServices Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1760,6 +1853,9 @@ Accept wildcard characters: False ``` ### -TransportRole + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransportRole parameter specifies the transport service on the Mailbox server where the Receive connector is created. Valid values are: - FrontendTransport: The Front End Transport service where client or external SMTP connections occur. @@ -1769,7 +1865,6 @@ The TransportRole parameter specifies the transport service on the Mailbox serve Type: ServerRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1779,13 +1874,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RemoteDomain.md b/exchange/exchange-ps/ExchangePowerShell/New-RemoteDomain.md similarity index 89% rename from exchange/exchange-ps/exchange/New-RemoteDomain.md rename to exchange/exchange-ps/ExchangePowerShell/New-RemoteDomain.md index d482738214..23e939498a 100644 --- a/exchange/exchange-ps/exchange/New-RemoteDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RemoteDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-remotedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-RemoteDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-remotedomain +schema: 2.0.0 +title: New-RemoteDomain --- # New-RemoteDomain @@ -43,13 +44,15 @@ This example creates the remote domain named Contoso for the domain contoso.com ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a unique name for the remote domain object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DomainName parameter specifies the SMTP domain that you want to establish as a remote domain. A valid value is an SMTP domain (for example, contoso.com). The maximum length is 256 characters. You can use the wildcard character (\*) to specify a domain and all subdomains (for example: \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com). @@ -67,7 +73,6 @@ You can use the wildcard character (\*) to specify a domain and all subdomains ( Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -77,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -86,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -106,7 +116,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/New-RemoteMailbox.md similarity index 88% rename from exchange/exchange-ps/exchange/New-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/New-RemoteMailbox.md index 2647a103bb..f82e91d586 100644 --- a/exchange/exchange-ps/exchange/New-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-RemoteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-remotemailbox +schema: 2.0.0 +title: New-RemoteMailbox --- # New-RemoteMailbox @@ -194,13 +195,15 @@ As in Example 1, this example assumes that mail flow and directory synchronizati ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name of the on-premises mail user and the associated mailbox in the service. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -210,13 +213,15 @@ Accept wildcard characters: False ``` ### -AccountDisabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AccountDisabled switch specifies whether to create the mail user in a disabled state. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AccountDisabled Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -226,6 +231,9 @@ Accept wildcard characters: False ``` ### -Equipment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox. You don't need to specify a value with this switch. Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers). @@ -236,7 +244,6 @@ You can't use this switch with the Room switch. Type: SwitchParameter Parameter Sets: Equipment Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -246,6 +253,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Password parameter specifies the password used by the mail user to secure his or her account and associated mailbox in the service. You can use the following methods as a value for this parameter: @@ -256,9 +266,8 @@ You can use the following methods as a value for this parameter: ```yaml Type: SecureString -Parameter Sets: AccountDisabled, Equipment, Room, Shared +Parameter Sets: Default, AccountDisabled, Equipment, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -267,20 +276,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecureString -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Room -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Room The Room switch specifies that the mailbox in the service should be created as a room resource mailbox. You don't need to specify a value with this switch. You can't use the Room switch if you specified the Equipment switch. @@ -289,7 +288,6 @@ You can't use the Room switch if you specified the Equipment switch. Type: SwitchParameter Parameter Sets: Room Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -299,6 +297,9 @@ Accept wildcard characters: False ``` ### -Shared + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + **Note**: This switch is available only in Exchange 2013 CU21 or later and Exchange 2016 CU10 or later. To use this switch, you also need to run setup.exe /PrepareAD. For more information, see [KB4133605](https://support.microsoft.com/help/4133605). The Shared switch specifies that the mailbox in the service should be created as a shared mailbox. You don't need to specify a value with this switch. @@ -309,7 +310,6 @@ You can't use this switch with the Room or Equipment switches. Type: SwitchParameter Parameter Sets: Shared Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -319,13 +319,15 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. ```yaml Type: String -Parameter Sets: AccountDisabled, Equipment, Room, Shared +Parameter Sets: Default, AccountDisabled, Equipment, Room, Shared Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -334,27 +336,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -ACLableSyncedObjectEnabled -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -ACLableSyncedObjectEnabled The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -364,6 +355,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -388,7 +382,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -398,13 +391,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Archive switch specifies whether to also create an archive mailbox in the service. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -414,6 +409,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -423,7 +421,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +430,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DisplayName parameter specifies the display name of the mail user and the associated mailbox in the service. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -441,7 +441,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -451,13 +450,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -467,13 +468,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -483,6 +486,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -491,7 +497,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -501,13 +506,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -517,13 +524,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -533,6 +542,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -550,7 +562,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -560,6 +571,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -571,7 +585,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -581,6 +594,9 @@ Accept wildcard characters: False ``` ### -OnPremisesOrganizationalUnit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OnPremisesOrganizationalUnit parameter specifies the organizational unit (OU) in the on-premises organization in which the new mailbox is added (for example, redmond.contoso.com/Users). Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -596,7 +612,6 @@ This parameter has no effect on the mailbox in the service. Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -606,13 +621,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -622,6 +639,9 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: - $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value. @@ -635,7 +655,6 @@ A user's experience in any of these management interfaces is still controlled by Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -645,6 +664,9 @@ Accept wildcard characters: False ``` ### -RemoteRoutingAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoteRoutingAddress parameter specifies the SMTP address of the mailbox in the service that this user is associated with. This address is created automatically when the service is initially configured in the format of `.mail.onmicrosoft.com`. If you've configured mail flow between the on-premises organization and the service, such as in a hybrid deployment, you don't need to specify this parameter. The remote routing address is calculated automatically and assigned to the email address policy for the on-premises organization by the Hybrid Configuration wizard. @@ -653,7 +675,6 @@ If you've configured mail flow between the on-premises organization and the serv Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -663,6 +684,9 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -672,7 +696,6 @@ The ResetPasswordOnNextLogon parameter specifies whether the user must change th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -682,13 +705,15 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -698,6 +723,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -710,7 +738,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -720,13 +747,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionPolicy.md index 1f7d59a1bc..b692122c77 100644 --- a/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-reportsubmissionpolicy applicable: Exchange Online -title: New-ReportSubmissionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-reportsubmissionpolicy +schema: 2.0.0 +title: New-ReportSubmissionPolicy --- # New-ReportSubmissionPolicy @@ -144,6 +145,9 @@ This example creates the report submission policy with the following values: rep ## PARAMETERS ### -DisableQuarantineReportingOption + +> Applicable: Exchange Online + The DisableQuarantineReportingOption parameter allows or prevents users from reporting messages in quarantine. Valid values are: - $true: Users can't report quarantined messages from quarantine. @@ -155,7 +159,6 @@ This parameter is meaningful only reporting in Outlook is enabled as described i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -165,13 +168,15 @@ Accept wildcard characters: False ``` ### -DisableUserSubmissionOptions + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -181,13 +186,15 @@ Accept wildcard characters: False ``` ### -EnableCustomizedMsg + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -197,6 +204,9 @@ Accept wildcard characters: False ``` ### -EnableCustomNotificationSender + +> Applicable: Exchange Online + The EnableCustomNotificationSender parameter specifies whether a custom sender email address is used for result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Use a custom Microsoft 365 sender email address. @@ -208,7 +218,6 @@ You specify the sender email address using the NotificationSenderAddress paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -218,6 +227,9 @@ Accept wildcard characters: False ``` ### -EnableOrganizationBranding + +> Applicable: Exchange Online + The EnableOrganizationBranding parameter specifies whether to show the company logo in the footer of result messages that users receive after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Use the company logo in the footer text instead of the Microsoft logo. @@ -229,7 +241,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -239,6 +250,9 @@ Accept wildcard characters: False ``` ### -EnableReportToMicrosoft + +> Applicable: Exchange Online + The EnableReportToMicrosoft parameter specifies whether Microsoft integrated reporting experience is enabled or disabled. Valid values are $true or $false. The value $true for this parameter enables reporting in Outlook. The following configurations are possible: @@ -257,7 +271,6 @@ This parameter is required to create the report submission policy only if you se Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -267,6 +280,9 @@ Accept wildcard characters: False ``` ### -EnableThirdPartyAddress + +> Applicable: Exchange Online + The EnableThirdPartyAddress parameter specifies whether you're using non-Microsoft reporting tools in Outlook instead of Microsoft tools to send messages to the reporting mailbox in Exchange Online. Valid values are: - $true: Reporting in Outlook is enabled, but non-Microsoft tools in Outlook send reported messages to the reporting mailbox in Exchange Online. You also need to set the EnableReportToMicrosoft parameter value to $false. To create the policy, use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. @@ -278,7 +294,6 @@ This parameter is required to create the report submission policy only if you se Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -288,6 +303,9 @@ Accept wildcard characters: False ``` ### -EnableUserEmailNotification + +> Applicable: Exchange Online + The EnableUserEmailNotification parameter species whether users receive result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Customized admin review result messages are sent. @@ -303,7 +321,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -313,6 +330,9 @@ Accept wildcard characters: False ``` ### -JunkReviewResultMessage + +> Applicable: Exchange Online + The JunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as junk. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -325,7 +345,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -335,6 +354,9 @@ Accept wildcard characters: False ``` ### -NotJunkReviewResultMessage + +> Applicable: Exchange Online + The NotJunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as not junk. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -347,7 +369,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -357,6 +378,9 @@ Accept wildcard characters: False ``` ### -NotificationFooterMessage + +> Applicable: Exchange Online + The NotificationFooterMessage parameter specifies the custom footer text to use in email notifications after an admin reviews and marks the reported messages as junk, not junk, or phishing. If the value contains spaces, enclose the value in quotation marks. You can use the EnableOrganizationBranding parameter to include your company logo in the message footer. @@ -367,7 +391,6 @@ This parameter is meaningful only when the value of the EnableUserEmailNotificat Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -377,6 +400,9 @@ Accept wildcard characters: False ``` ### -NotificationSenderAddress + +> Applicable: Exchange Online + The NotificationSenderAddress parameter specifies the sender email address to use in result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. The email address must be in Exchange Online. This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -385,7 +411,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -395,13 +420,15 @@ Accept wildcard characters: False ``` ### -NotificationsForCleanSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -411,13 +438,15 @@ Accept wildcard characters: False ``` ### -NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -427,13 +456,15 @@ Accept wildcard characters: False ``` ### -NotificationsForSpamSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -443,13 +474,15 @@ Accept wildcard characters: False ``` ### -NotificationsForSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -459,13 +492,15 @@ Accept wildcard characters: False ``` ### -OnlyShowPhishingDisclaimer + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -475,6 +510,9 @@ Accept wildcard characters: False ``` ### -PhishingReviewResultMessage + +> Applicable: Exchange Online + The PhishingReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as phishing. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -487,7 +525,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -497,6 +534,9 @@ Accept wildcard characters: False ``` ### -PostSubmitMessage + +> Applicable: Exchange Online + The PostSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message title using the PostSubmitMessageTitle parameter. @@ -507,7 +547,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -517,13 +556,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageEnabled + +> Applicable: Exchange Online + {{ Fill PostSubmitMessageEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -533,13 +574,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -549,13 +592,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -565,13 +610,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -581,6 +628,9 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitle + +> Applicable: Exchange Online + The PostSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message text using the PostSubmitMessage parameter. @@ -591,7 +641,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -601,13 +650,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -617,13 +668,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -633,13 +686,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -649,6 +704,9 @@ Accept wildcard characters: False ``` ### -PreSubmitMessage + +> Applicable: Exchange Online + The PreSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message title using the PreSubmitMessageTitle parameter. @@ -659,7 +717,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -669,13 +726,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageEnabled + +> Applicable: Exchange Online + {{ Fill PreSubmitMessageEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -685,13 +744,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -701,13 +762,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -717,13 +780,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -733,6 +798,9 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitle + +> Applicable: Exchange Online + The PreSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the pop-up message text using the PreSubmitMessage parameter. @@ -743,7 +811,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -753,13 +820,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -769,13 +838,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -785,13 +856,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -801,13 +874,15 @@ Accept wildcard characters: False ``` ### -ReportChatMessageEnabled + +> Applicable: Exchange Online + {{ Fill ReportChatMessageEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -817,13 +892,15 @@ Accept wildcard characters: False ``` ### -ReportChatMessageToCustomizedAddressEnabled + +> Applicable: Exchange Online + {{ Fill ReportChatMessageToCustomizedAddressEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -833,6 +910,9 @@ Accept wildcard characters: False ``` ### -ReportJunkAddresses + +> Applicable: Exchange Online + The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. This parameter is required to create the report submission policy if the ReportJunkToCustomizedAddress parameter value is $true. @@ -845,7 +925,6 @@ You also need to specify the same email address in the SentTo parameter on the N Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -855,6 +934,9 @@ Accept wildcard characters: False ``` ### -ReportJunkToCustomizedAddress + +> Applicable: Exchange Online + The ReportJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. @@ -868,7 +950,6 @@ This parameter is required to create the report submission policy if you're usin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -878,6 +959,9 @@ Accept wildcard characters: False ``` ### -ReportNotJunkAddresses + +> Applicable: Exchange Online + The ReportNotJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. This parameter is required to create the report submission policy if the ReportNotJunkToCustomizedAddress parameter value is $true. @@ -890,7 +974,6 @@ You also need to specify the same email address in the SentTo parameter on the N Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -900,6 +983,9 @@ Accept wildcard characters: False ``` ### -ReportNotJunkToCustomizedAddress + +> Applicable: Exchange Online + The ReportNotJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. @@ -913,7 +999,6 @@ This parameter is required to create the report submission policy if you're usin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -923,6 +1008,9 @@ Accept wildcard characters: False ``` ### -ReportPhishAddresses + +> Applicable: Exchange Online + The ReportPhishAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. This parameter is required to create the report submission policy if the ReportPhishToCustomizedAddress parameter value is $true. @@ -935,7 +1023,6 @@ You also need to specify the same email address in the SentTo parameter on the N Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -945,6 +1032,9 @@ Accept wildcard characters: False ``` ### -ReportPhishToCustomizedAddress + +> Applicable: Exchange Online + The ReportPhishToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. @@ -958,7 +1048,6 @@ This parameter is required to create the report submission policy if you're usin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -968,6 +1057,9 @@ Accept wildcard characters: False ``` ### -ThirdPartyReportAddresses + +> Applicable: Exchange Online + Use the ThirdPartyReportAddresses parameter to specify the email address of the reporting mailbox in Exchange Online when you're using a non-Microsoft product for user submissions instead of reporting in Outlook. This parameter is required to create the report submission policy if you've disabled reporting in Outlook (`-EnableReportToMicrosoft $false`) and you're using the reporting mailbox with non-Microsoft tools (`-EnableThirdPartyAddress $true`). @@ -976,7 +1068,6 @@ This parameter is required to create the report submission policy if you've disa Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -986,13 +1077,15 @@ Accept wildcard characters: False ``` ### -UserSubmissionOptions + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1002,13 +1095,15 @@ Accept wildcard characters: False ``` ### -UserSubmissionOptionsMessage + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionRule.md similarity index 96% rename from exchange/exchange-ps/exchange/New-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionRule.md index 4a81e082a0..e15468aa90 100644 --- a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-reportsubmissionrule applicable: Exchange Online -title: New-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-reportsubmissionrule +schema: 2.0.0 +title: New-ReportSubmissionRule --- # New-ReportSubmissionRule @@ -61,13 +62,15 @@ This example creates the report submission rule. The reporting mailbox is userre ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the name of the report submission rule. When the rule is automatically created, the name of the rule is DefaultReportSubmissionRule. We recommend using this value to avoid confusion. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -ReportSubmissionPolicy + +> Applicable: Exchange Online + The ReportSubmissionPolicy parameter specifies the report submission policy that's associated with this rule. The only available policy is named DefaultReportSubmissionPolicy. ```yaml Type: ReportSubmissionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -118,7 +128,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the rule is enabled or disabled. Valid values are: - $true: The rule is enabled. This is the default value. @@ -139,7 +151,6 @@ After you create the rule, use the Enable-ReportSubmissionRule and Disable-Repor Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies the email address of the reporting mailbox in Exchange Online where user reported messages are sent. The value of this parameter is meaningful only if reporting in Outlook is enabled, and user reported messages are sent to a reporting mailbox as configured in the \*-ReportSubmissionPolicy cmdlets (either of the following scenarios): @@ -167,7 +181,6 @@ When you use this cmdlet to set the email address of the reporting mailbox, the Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-RetentionCompliancePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-RetentionCompliancePolicy.md index cacf15afbe..b7d58bc239 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-retentioncompliancepolicy applicable: Security & Compliance -title: New-RetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-retentioncompliancepolicy +schema: 2.0.0 +title: New-RetentionCompliancePolicy --- # New-RetentionCompliancePolicy @@ -88,7 +89,7 @@ New-RetentionCompliancePolicy [-Name] -AdaptiveScopeLocation Applicable: Security & Compliance + The Name parameter specifies the unique name of the retention policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -131,6 +134,9 @@ Accept wildcard characters: False ``` ### -AdaptiveScopeLocation + +> Applicable: Security & Compliance + The AdaptiveScopeLocation parameter specifies the adaptive scope location to include in the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -141,7 +147,6 @@ The AdaptiveScopeLocation parameter specifies the adaptive scope location to inc Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -151,6 +156,9 @@ Accept wildcard characters: False ``` ### -Applications + +> Applicable: Security & Compliance + The Applications parameter specifies the target when Microsoft 365 Groups are included in the policy (the ModernGroups parameter is set). Valid values are: - `Group:Exchange` for the mailbox that's connected to the Microsoft 365 Group. @@ -162,7 +170,6 @@ The Applications parameter specifies the target when Microsoft 365 Groups are in Type: MultiValuedProperty Parameter Sets: Default, AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,13 +179,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -188,6 +197,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -197,7 +209,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -207,6 +218,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -216,7 +230,6 @@ The Enabled parameter specifies whether the policy is enabled or disabled. Valid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -226,6 +239,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - A mailbox @@ -247,7 +263,6 @@ If no mailboxes are specified, then no mailboxes are placed on hold. Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -257,6 +272,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocationException + +> Applicable: Security & Compliance + The ExchangeLocationException parameter specifies the mailboxes to exclude from the policy when you use the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -275,7 +293,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -285,6 +302,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -293,7 +313,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -303,6 +322,9 @@ Accept wildcard characters: False ``` ### -IsSimulation + +> Applicable: Security & Compliance + The IsSimulation switch specifies the policy is created in simulation mode. You don't need to specify a value with this switch. For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). @@ -311,7 +333,6 @@ For more information about simulation mode, see [Learn about simulation mode](ht Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -321,6 +342,9 @@ Accept wildcard characters: False ``` ### -ModernGroupLocation + +> Applicable: Security & Compliance + The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. Valid values are: - A Microsoft 365 Group @@ -339,7 +363,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -349,6 +372,9 @@ Accept wildcard characters: False ``` ### -ModernGroupLocationException + +> Applicable: Security & Compliance + The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude from the policy when you use the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -364,7 +390,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -374,6 +399,9 @@ Accept wildcard characters: False ``` ### -OneDriveLocation + +> Applicable: Security & Compliance + The OneDriveLocation parameter specifies the OneDrive sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -382,7 +410,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -392,6 +419,9 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException + +> Applicable: Security & Compliance + This parameter specifies the OneDrive sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -400,7 +430,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -410,6 +439,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + **Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. @@ -420,7 +452,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -430,13 +461,15 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -446,6 +479,9 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + The PriorityCleanup switch specifies whether to create a Priority cleanup policy. You don't need to specify a value with this switch. Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). @@ -454,7 +490,6 @@ Priority cleanup policies expedite the deletion of sensitive content by overridi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -464,13 +499,15 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + The PublicFolderLocation parameter specifies that you want to include all public folders in the retention policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -480,6 +517,9 @@ Accept wildcard characters: False ``` ### -RestrictiveRetention + +> Applicable: Security & Compliance + The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: - $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. @@ -493,7 +533,6 @@ Therefore, before you lock a retention policy, it's critical that you understand Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -503,6 +542,9 @@ Accept wildcard characters: False ``` ### -RetainCloudAttachment + +> Applicable: Security & Compliance + **Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. The RetainCloudAttachment parameter specifies that this is a cloud attachment policy. Valid values are: @@ -524,7 +566,6 @@ The RetainCloudAttachment parameter is not available on the Set-RetentionComplia Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -534,6 +575,9 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -544,7 +588,6 @@ SharePoint sites can't be added to the policy until they have been indexed. If n Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -554,6 +597,9 @@ Accept wildcard characters: False ``` ### -SharePointLocationException + +> Applicable: Security & Compliance + This parameter specifies the SharePoint sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -562,7 +608,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -572,13 +617,15 @@ Accept wildcard characters: False ``` ### -SkipPriorityCleanupConfirmation + +> Applicable: Security & Compliance + {{ Fill SkipPriorityCleanupConfirmation Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -588,6 +635,9 @@ Accept wildcard characters: False ``` ### -SkypeLocation + +> Applicable: Security & Compliance + The SkypeLocation parameter specifies the Skype for Business Online users to include in the policy. You can use any value that uniquely identifies the user. For example: @@ -603,7 +653,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -613,13 +662,15 @@ Accept wildcard characters: False ``` ### -SkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -629,6 +680,9 @@ Accept wildcard characters: False ``` ### -TeamsChannelLocation + +> Applicable: Security & Compliance + The TeamsChannelLocation parameter specifies the Teams to include in the policy. You can use any value that uniquely identifies the team. For example: @@ -643,7 +697,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -653,6 +706,9 @@ Accept wildcard characters: False ``` ### -TeamsChannelLocationException + +> Applicable: Security & Compliance + The TeamsChannelLocationException parameter specifies the Teams to exclude when you use the value All for the TeamsChannelLocation parameter. You can use any value that uniquely identifies the team. For example: - Name @@ -665,7 +721,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -675,6 +730,9 @@ Accept wildcard characters: False ``` ### -TeamsChatLocation + +> Applicable: Security & Compliance + The TeamsChatLocation parameter specifies the Teams users to include in the policy. You can use any value that uniquely identifies the user. For example: @@ -690,7 +748,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -700,6 +757,9 @@ Accept wildcard characters: False ``` ### -TeamsChatLocationException + +> Applicable: Security & Compliance + The TeamsChatLocationException parameter specifies the Teams users to exclude when you use the value All for the TeamsChatLocation parameter. You can use any value that uniquely identifies the user. For example: - Name @@ -713,7 +773,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -723,13 +782,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/New-RetentionComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/New-RetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-RetentionComplianceRule.md index fa75892cc2..70672338c9 100644 --- a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-retentioncompliancerule applicable: Security & Compliance -title: New-RetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-retentioncompliancerule +schema: 2.0.0 +title: New-RetentionComplianceRule --- # New-RetentionComplianceRule @@ -86,6 +87,9 @@ This example creates a new retention rule named SeptOneYear and adds it to the e ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the retention rule. If the value contains spaces, enclose the value in quotation marks. You can't use this parameter with the ApplyComplianceTag or PublishComplianceTag parameters. @@ -94,7 +98,6 @@ You can't use this parameter with the ApplyComplianceTag or PublishComplianceTag Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -ApplyComplianceTag + +> Applicable: Security & Compliance + The ApplyComplianceTag parameter specifies the label that's applied to email messages or documents by the rule (which affects how long the content is retained). A valid value for this parameter is the name of an existing label. If the value contains spaces, enclose the value in quotation marks. You view and create labels by using the Get-ComplianceTag and New-ComplianceTag cmdlets. @@ -116,7 +122,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -126,13 +131,15 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the policy to contain the rule. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + The PriorityCleanup switch specifies whether to create a rule associated with a Priority cleanup policy. You don't need to specify a value with this switch. Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). @@ -150,7 +160,6 @@ Priority cleanup policies expedite the deletion of sensitive content by overridi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -PublishComplianceTag + +> Applicable: Security & Compliance + The PublishComplianceTag parameter specifies the label that's published for the rule, which makes the label visible to users in apps (for example, Outlook, SharePoint, and OneDrive). A valid value for this parameter is the name of an existing label. If the value contains spaces, enclose the value in quotation marks. You view and create labels by using the Get-ComplianceTag and New-ComplianceTag cmdlets. @@ -174,7 +186,6 @@ You can't use this parameter in the following scenarios: Type: String Parameter Sets: PublishComplianceTag Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -184,13 +195,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -200,6 +213,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -209,7 +225,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -233,7 +251,6 @@ You can't use this parameter for Teams retention rules. Type: PswsHashtable[] Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -243,6 +260,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -253,7 +273,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: ComplianceTag, Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -263,6 +282,9 @@ Accept wildcard characters: False ``` ### -ExcludedItemClasses + +> Applicable: Security & Compliance + The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter 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 @@ -284,7 +306,6 @@ You can't use this parameter for Teams retention rules. Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -294,6 +315,9 @@ Accept wildcard characters: False ``` ### -ExpirationDateOption + +> Applicable: Security & Compliance + The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: - CreationAgeInDays @@ -305,7 +329,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -315,13 +338,15 @@ Accept wildcard characters: False ``` ### -IRMRiskyUserProfiles + +> Applicable: Security & Compliance + {{ Fill IRMRiskyUserProfiles Description }} ```yaml Type: String Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -331,13 +356,15 @@ Accept wildcard characters: False ``` ### -MachineLearningModelIDs + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: ComplianceTag Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -347,6 +374,9 @@ Accept wildcard characters: False ``` ### -RetentionComplianceAction + +> Applicable: Security & Compliance + The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - Delete @@ -359,7 +389,6 @@ If you don't use this parameter, the retention policy is created as an "UniH" po Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -369,6 +398,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - An integer: The hold duration in days. @@ -378,7 +410,6 @@ The RetentionDuration parameter specifies the hold duration for the retention ru Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -388,6 +419,9 @@ Accept wildcard characters: False ``` ### -RetentionDurationDisplayHint + +> Applicable: Security & Compliance + The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are: - Days @@ -402,7 +436,6 @@ You can't use this parameter for Teams retention rules. Type: HoldDurationHint Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -412,13 +445,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/New-RetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicy.md index a6a970985e..68bc9f02ec 100644 --- a/exchange/exchange-ps/exchange/New-RetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-retentionpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-RetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-retentionpolicy +schema: 2.0.0 +title: New-RetentionPolicy --- # New-RetentionPolicy @@ -58,13 +59,15 @@ The second retention tag, which is named Legal, is also enclosed in quotation ma ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the policy name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -101,7 +109,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IsDefault switch specifies that this retention policy is the default retention policy. You don't need to specify a value with this switch. @@ -130,7 +140,6 @@ Changes to the default retention policy that affect existing mailboxes can poten Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -IsDefaultArbitrationMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. You don't need to specify a value with this switch. @@ -148,7 +160,6 @@ The IsDefaultArbitrationMailbox switch configures this policy as the default ret Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -158,13 +169,15 @@ Accept wildcard characters: False ``` ### -RetentionId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionId parameter specifies the identity of the retention policy to ensure mailboxes moved from an on-premises Exchange deployment to the cloud continue to have the same retention policy applied to them. The RetentionId parameter is used in cross-premises deployments. You don't need to specify this parameter in on-premises-only deployments. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -RetentionPolicyTagLinks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionPolicyTagLinks parameter specifies the names of retention policy tags to be associated with this policy. ```yaml Type: RetentionPolicyTagIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -190,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md b/exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicyTag.md similarity index 88% rename from exchange/exchange-ps/exchange/New-RetentionPolicyTag.md rename to exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicyTag.md index a320464cfa..f38d4c2f54 100644 --- a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RetentionPolicyTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-retentionpolicytag applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-RetentionPolicyTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-retentionpolicytag +schema: 2.0.0 +title: New-RetentionPolicyTag --- # New-RetentionPolicyTag @@ -99,13 +100,15 @@ This example creates the retention tag Business Critical of type Personal. When ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the tag. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -115,6 +118,9 @@ Accept wildcard characters: False ``` ### -AddressForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -123,7 +129,6 @@ This parameter is reserved for internal Microsoft use. Type: RecipientIdParameter Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -133,13 +138,15 @@ Accept wildcard characters: False ``` ### -AgeLimitForRetention + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml Type: EnhancedTimeSpan Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -149,13 +156,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Comment parameter specifies a comment for the tag. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,6 +174,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -174,7 +186,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -192,7 +206,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +215,9 @@ Accept wildcard characters: False ``` ### -IsDefaultAutoGroupPolicyTag + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -210,7 +226,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -220,6 +235,9 @@ Accept wildcard characters: False ``` ### -IsDefaultModeratedRecipientsPolicyTag + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -228,7 +246,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -238,6 +255,9 @@ Accept wildcard characters: False ``` ### -JournalingEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -246,7 +266,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -256,6 +275,9 @@ Accept wildcard characters: False ``` ### -LabelForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -264,7 +286,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -274,13 +295,15 @@ Accept wildcard characters: False ``` ### -LocalizedComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LocalizedComment parameter specifies localized comments and their languages. When the user's language setting matches a language specified for this parameter, Microsoft Outlook and Outlook on the web display the corresponding localized comment. Comments are specified in the form of ISO Language Code:Comment, for example, LocalizedComment EN-US:"This is a localized comment in U.S. English". ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -290,13 +313,15 @@ Accept wildcard characters: False ``` ### -LocalizedRetentionPolicyTagName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LocalizedRetentionPolicyTagName parameter specifies localized tag names and their languages. When the user's language setting matches a language specified for this parameter, Outlook and Outlook on the web display the corresponding localized tag name. Names are specified in the form of ISO Language Code:Name, for example, LocalizedRetentionPolicyTagName EN-US:"Business Critical". ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -306,6 +331,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderToUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ManagedFolderToUpgrade parameter specifies the name of a managed folder to use as a template for a retention tag. @@ -314,7 +342,6 @@ The ManagedFolderToUpgrade parameter specifies the name of a managed folder to u Type: ELCFolderIdParameter Parameter Sets: UpgradeManagedFolder Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,6 +351,9 @@ Accept wildcard characters: False ``` ### -MessageClass + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MessageClass parameter specifies the message type to which the tag applies. If not specified, the default value is set to \*. With the exception of a default policy tag (DPT) for voicemail, Exchange doesn't support retention tags for different message types. Only tags with a MessageClass of \* are supported, and they apply to all message types. @@ -336,7 +366,6 @@ A DPT for voice mail messages applies only to Microsoft Exchange Unified Messagi Type: String Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -346,6 +375,9 @@ Accept wildcard characters: False ``` ### -MessageFormatForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -354,7 +386,6 @@ This parameter is reserved for internal Microsoft use. Type: JournalingFormat Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -364,13 +395,15 @@ Accept wildcard characters: False ``` ### -MustDisplayCommentEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -380,6 +413,9 @@ Accept wildcard characters: False ``` ### -RetentionAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionAction parameter specifies the action for the retention policy. Valid values are: - DeleteAndAllowRecovery: Deletes a message and allows recovery from the Recoverable Items folder. @@ -395,7 +431,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionAction Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -405,6 +440,9 @@ Accept wildcard characters: False ``` ### -RetentionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionEnabled parameter specifies whether the tag is enabled. When set to $false, the tag is disabled, and no retention action is taken on messages that have the tag applied. Messages with a disabled tag are still considered tagged, so any tags of the same type as the disabled tag in the user's retention policy aren't applied to such messages. @@ -415,7 +453,6 @@ When you set the RetentionEnabled parameter to $false, the retention period for Type: Boolean Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -425,13 +462,15 @@ Accept wildcard characters: False ``` ### -RetentionId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionId parameter specifies an alternate tag ID to make sure the retention tag found on mailbox items tagged in an on-premises deployment matches the tag when the mailbox is moved to the cloud, or mailbox items tagged in the cloud match the tag when the mailbox is moved to an on-premises Exchange server. The parameter is used in cross-premises deployments. You don't need to specify this parameter in on-premises-only deployments. ```yaml Type: Guid Parameter Sets: RetentionPolicy Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -441,13 +480,15 @@ Accept wildcard characters: False ``` ### -SystemTag + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SystemTag parameter specifies that the tag is created for internal Exchange functionality. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -457,6 +498,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Type parameter specifies the type of retention tag being created. Valid values include: - All @@ -487,7 +531,6 @@ To create a default policy tag (DPT), specify type All. For tags of type Recover Type: ElcFolderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -497,13 +540,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-RoleAssignmentPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-RoleAssignmentPolicy.md index 37d991b855..d3ed1851f8 100644 --- a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RoleAssignmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-roleassignmentpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-RoleAssignmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-roleassignmentpolicy +schema: 2.0.0 +title: New-RoleAssignmentPolicy --- # New-RoleAssignmentPolicy @@ -74,13 +75,15 @@ Because setting the new role assignment as default applies only to new mailboxes ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the new assignment policy. If the assignment policy name contains spaces, enclose the name in quotation marks ("). The maximum length of the name is 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -99,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Description parameter specifies the description that's displayed when the role assignment policy is viewed using the Get-RoleAssignmentPolicy cmdlet. Enclose the description in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -135,7 +145,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The IsDefault switch makes the assignment policy the default assignment policy. You don't need to specify a value with this switch. New mailboxes or mailboxes moved from previous versions of Exchange are assigned the default assignment policy when an explicit assignment policy isn't provided. @@ -155,7 +167,6 @@ Setting an assignment policy as default doesn't change the role assignment on ex Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -165,6 +176,9 @@ Accept wildcard characters: False ``` ### -Roles + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Roles parameter specifies the management roles to assign to the role assignment policy when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. For a list of built-in management roles that you can assign to a role group, see [Built-in management roles](https://learn.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). @@ -173,7 +187,6 @@ For a list of built-in management roles that you can assign to a role group, see Type: RoleIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RoleGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-RoleGroup.md similarity index 88% rename from exchange/exchange-ps/exchange/New-RoleGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-RoleGroup.md index 308719a319..c73a9903bb 100644 --- a/exchange/exchange-ps/exchange/New-RoleGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RoleGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-rolegroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: New-RoleGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-rolegroup +schema: 2.0.0 +title: New-RoleGroup --- # New-RoleGroup @@ -127,6 +128,9 @@ This example removes the role assignment between the Distribution Groups managem ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Name parameter specifies the name of the new role group. The name can have a maximum of 64 characters. If the name contains spaces, enclose the name in quotation marks ("). **Note**: If you create a linked role group, we recommend that you include the name of the foreign forest in the name of the role group so that you can more easily associate the linked role group and the associated foreign forest. This is especially important if you have multiple forests. @@ -135,7 +139,6 @@ The Name parameter specifies the name of the new role group. The name can have a Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -145,6 +148,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the fully qualified domain name (FQDN) or IP address of the domain controller in the forest where the foreign USG resides. The domain controller you specify is used to get security information for the foreign USG specified by the LinkedForeignGroup parameter. @@ -155,7 +161,6 @@ If you use the LinkedDomainController parameter, you must specify a foreign USG Type: String Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -165,6 +170,9 @@ Accept wildcard characters: False ``` ### -LinkedForeignGroup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedForeignGroup parameter specifies the name of the foreign USG you want to link this role group to. If the foreign USG name contains spaces, enclose the name in quotation marks ("). @@ -175,7 +183,6 @@ If you use the LinkedForeignGroup parameter, you must specify a domain controlle Type: UniversalSecurityGroupIdParameter Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -185,6 +192,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -194,7 +204,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -204,6 +213,9 @@ Accept wildcard characters: False ``` ### -CustomConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CustomConfigWriteScope parameter specifies the existing configuration-based management scope to associate with management role assignments created with this role group. If the management scope name contains spaces, enclose the name in quotation marks ("). Use the Get-ManagementScope cmdlet to retrieve a list of existing management scopes. @@ -212,7 +224,6 @@ The CustomConfigWriteScope parameter specifies the existing configuration-based Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +233,9 @@ Accept wildcard characters: False ``` ### -CustomRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomRecipientWriteScope parameter specifies the existing recipient-based management scope to associate with management role assignments created with this role group. If the management scope name contains spaces, enclose the name in quotation marks ("). Use the Get-ManagementScope cmdlet to retrieve a list of existing management scopes. @@ -232,7 +246,6 @@ If you use the CustomRecipientWriteScope parameter, you can't use the RecipientO Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -242,13 +255,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Description parameter specifies the description that's displayed when the role group is viewed using the Get-RoleGroup cmdlet. Enclose the description in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -258,13 +273,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter has a maximum length of 256 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -274,6 +291,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -282,7 +302,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -292,6 +311,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -302,7 +324,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -312,6 +333,9 @@ Accept wildcard characters: False ``` ### -Id + +> Applicable: Security & Compliance + This parameter is available only in Security & Compliance PowerShell. This parameter is reserved for internal Microsoft use. @@ -320,7 +344,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -330,6 +353,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. @@ -340,7 +366,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -350,6 +375,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies the users or USGs who can modify the configuration of a role group or add and remove members to or from a role group. You can use the name, distinguished name (DN), or primary SMTP address of the user or USG that you want to add. If the name of the user or USG contains spaces, enclose the name in quotation marks ("). @@ -360,7 +388,6 @@ If you want to add more than one user or USG, separate them using commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -370,6 +397,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Members parameter specifies the mailboxes or mail-enabled USGs to add as a member of the role group. You can identify the user or group by the name, DN, or primary SMTP address value. You can specify multiple members separated by commas (`Value1,Value2,...ValueN`). If the value contains spaces, enclose the value in quotation marks (`"Value 1","Value 2",..."Value N"`). If you use the Members parameter, you can't use the LinkedForeignGroup, LinkedDomainController or LinkedCredential parameters. @@ -378,7 +408,6 @@ If you use the Members parameter, you can't use the LinkedForeignGroup, LinkedDo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -388,6 +417,9 @@ Accept wildcard characters: False ``` ### -RecipientOrganizationalUnitScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecipientOrganizationalUnitScope parameter specifies the organizational unit (OU) scope added to the role assignments created when the role group is created. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope parameter. To specify an OU, use the syntax: domain/ou. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). @@ -396,7 +428,6 @@ The RecipientOrganizationalUnitScope parameter specifies the organizational unit Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,6 +437,9 @@ Accept wildcard characters: False ``` ### -Roles + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Roles parameter specifies the management roles to assign to the role group when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. For a list of built-in management roles that you can assign to a role group, see [Built-in management roles](https://learn.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). @@ -414,7 +448,6 @@ For a list of built-in management roles that you can assign to a role group, see Type: RoleIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -424,6 +457,9 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. @@ -432,7 +468,6 @@ The SamAccountName parameter (also known as the pre-Windows 2000 user account or Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -442,6 +477,9 @@ Accept wildcard characters: False ``` ### -WellKnownObject + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill WellKnownObject Description }} @@ -450,7 +488,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -460,6 +497,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -468,7 +508,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-RoutingGroupConnector.md similarity index 95% rename from exchange/exchange-ps/exchange/New-RoutingGroupConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-RoutingGroupConnector.md index 4fd4b16fbf..353c3f4107 100644 --- a/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RoutingGroupConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-routinggroupconnector applicable: Exchange Server 2010 -title: New-RoutingGroupConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-routinggroupconnector +schema: 2.0.0 +title: New-RoutingGroupConnector --- # New-RoutingGroupConnector @@ -55,13 +56,15 @@ This example creates the routing group connector Interop RGC with the following ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the name to assign to the routing group connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010 + The SourceTransportServers parameter specifies the host name or fully qualified domain name (FQDN) of the transport servers used to send messages to the target transport servers. You can specify more than one server by separating each entry with a comma. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -TargetTransportServers + +> Applicable: Exchange Server 2010 + The TargetTransportServers parameter specifies the host name or FQDN of the transport servers that receive messages from the source transport servers. You can specify more than one server by separating each entry with a comma. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -BiDirectional + +> Applicable: Exchange Server 2010 + The BiDirectional parameter specifies whether this is a one-way or two-way connector. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -128,7 +140,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -Cost + +> Applicable: Exchange Server 2010 + The Cost parameter specifies a cost to the connector. Transport servers use the connector cost to determine the least cost routing path from a source server to the destination server for message delivery. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -170,13 +185,15 @@ Accept wildcard characters: False ``` ### -PublicFolderReferralsEnabled + +> Applicable: Exchange Server 2010 + The PublicFolderReferralsEnabled parameter specifies whether users can use this routing group connector to access a public folder replica located in the routing group of the target servers when an instance of that public folder isn't available in the same routing group as the user's mailbox. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -186,13 +203,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-RpcClientAccess.md b/exchange/exchange-ps/ExchangePowerShell/New-RpcClientAccess.md similarity index 95% rename from exchange/exchange-ps/exchange/New-RpcClientAccess.md rename to exchange/exchange-ps/ExchangePowerShell/New-RpcClientAccess.md index 183a022952..0cfc7ea229 100644 --- a/exchange/exchange-ps/exchange/New-RpcClientAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-RpcClientAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-rpcclientaccess applicable: Exchange Server 2010 -title: New-RpcClientAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-rpcclientaccess +schema: 2.0.0 +title: New-RpcClientAccess --- # New-RpcClientAccess @@ -48,6 +49,9 @@ This example creates configuration information for the Exchange RPC Client Acces ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Client Access server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -59,7 +63,6 @@ The Server parameter specifies the Client Access server where you want to run th Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -BlockedClientVersions + +> Applicable: Exchange Server 2010 + The BlockedClientVersions parameter specifies which versions of Microsoft Outlook are restricted from connecting. The Exchange RPC Client Access service rejects Outlook connections if versions are in the range specified. This setting affects MAPI and Outlook Anywhere client connections. The value must be less than 256 characters in length. Versions should be single numbers in the format X.Y.Z where X is a major version number, Y is the minor revision number, and Z specifies the build, and ranges should be delimited by semicolons (for example, 0.0.0-5.9.9; 7.0.0-65535.65535.65535). @@ -77,7 +83,6 @@ Versions should be single numbers in the format X.Y.Z where X is a major version Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -96,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -EncryptionRequired + +> Applicable: Exchange Server 2010 + The EncryptionRequired parameter specifies whether to require Outlook connections to be encrypted. The Exchange RPC Client Access service rejects unencrypted Outlook connections if this parameter is set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -MaximumConnections + +> Applicable: Exchange Server 2010 + The MaximumConnections parameter specifies the maximum number of concurrent connections allowed. The Exchange RPC Client Access service reads and limits connections based on this property. This parameter has a range from 1 through 65535. @@ -148,7 +162,6 @@ Although you can configure a non-default value for this parameter, changes to th Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -158,13 +171,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentPolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentPolicy.md index 7bd53126c9..7830f1bf89 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-safeattachmentpolicy applicable: Exchange Online -title: New-SafeAttachmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-safeattachmentpolicy +schema: 2.0.0 +title: New-SafeAttachmentPolicy --- # New-SafeAttachmentPolicy @@ -61,13 +62,15 @@ This example creates a new safe attachment policy named Marketing Block Attachme ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the safe attachment policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online + The Action parameter specifies the action for the safe attachment policy. Valid values are: - Allow: Deliver the message if malware is detected in the attachment and track scanning results. This value corresponds to **Monitor** for the **Safe Attachments unknown malware response** property of the policy in the Microsoft Defender portal. @@ -93,7 +99,6 @@ The results of all actions are available in message trace. Type: SafeAttachmentAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -128,7 +138,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: Exchange Online + The Enable parameter works with the Action parameter to specify the action for the safe attachment policy. Valid values are: - $true: The Action parameter specifies the action for the Safe Attachment policy. @@ -149,7 +161,6 @@ To enable or disable a complete Safe Attachments policy in the Microsoft Defende Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -159,13 +170,15 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection + +> Applicable: Exchange Online + The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this switch yourself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -175,6 +188,9 @@ Accept wildcard characters: False ``` ### -QuarantineTag + +> Applicable: Exchange Online + The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware by Safe Attachments. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -191,7 +207,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -201,13 +216,15 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online + The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -217,6 +234,9 @@ Accept wildcard characters: False ``` ### -Redirect + +> Applicable: Exchange Online + The Redirect parameter specifies whether to deliver messages to an alternate email address if malware is detected in an attachment. Valid values are: - $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is meaningful only when the value of the Action parameter is Allow. @@ -226,7 +246,6 @@ The Redirect parameter specifies whether to deliver messages to an alternate ema Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -236,6 +255,9 @@ Accept wildcard characters: False ``` ### -RedirectAddress + +> Applicable: Exchange Online + The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. The value of this parameter is meaningful only when value of the Redirect parameter is $true and the value of the Action parameter is Allow. @@ -244,7 +266,6 @@ The value of this parameter is meaningful only when value of the Redirect parame Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -254,13 +275,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentRule.md similarity index 95% rename from exchange/exchange-ps/exchange/New-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentRule.md index 373513e1c0..31aa541218 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-safeattachmentrule applicable: Exchange Online -title: New-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-safeattachmentrule +schema: 2.0.0 +title: New-SafeAttachmentRule --- # New-SafeAttachmentRule @@ -64,13 +65,15 @@ This example creates a new safe attachment rule named Research Department Attach ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the safe attachment rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -SafeAttachmentPolicy + +> Applicable: Exchange Online + The SafeAttachmentPolicy parameter specifies the safe attachment policy that's associated with this safe attachment rule. The rule defines the conditions, and the policy defines the actions. You can use any value that uniquely identifies the policy. For example: @@ -94,7 +100,6 @@ You can't specify a safe attachment policy that's already associated with anothe Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -129,7 +139,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the rule is enabled. Valid values are: - $true: The rule is enabled. This is the default value. @@ -150,7 +162,6 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -176,6 +189,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -191,7 +207,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -201,6 +216,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -218,7 +236,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -242,7 +262,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -252,13 +271,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -268,6 +289,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -283,7 +307,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -293,6 +316,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -310,7 +336,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -320,13 +345,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-SafeLinksPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/New-SafeLinksPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-SafeLinksPolicy.md index 07d98d9dab..0528b6b005 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SafeLinksPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-safelinkspolicy applicable: Exchange Online -title: New-SafeLinksPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-safelinkspolicy +schema: 2.0.0 +title: New-SafeLinksPolicy --- # New-SafeLinksPolicy @@ -66,13 +67,15 @@ This example creates a new Safe Links policy named Marketing Block URL with the ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the Safe Links policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -AllowClickThrough + +> Applicable: Exchange Online + The AllowClickThrough parameter specifies whether users are allowed to click through to the original URL on warning pages. Valid values are: - $true: The user is allowed to click through to the original URL. @@ -109,7 +117,6 @@ In PowerShell, the default value is $false. In new Safe Links policies created i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -128,7 +138,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -CustomNotificationText + +> Applicable: Exchange Online + The custom notification text specifies the customized notification text to show to users. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -DeliverMessageAfterScan + +> Applicable: Exchange Online + The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: - $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. This is the default value. @@ -163,7 +177,6 @@ The DeliverMessageAfterScan parameter specifies whether to deliver email message Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -173,6 +186,9 @@ Accept wildcard characters: False ``` ### -DisableUrlRewrite + +> Applicable: Exchange Online + The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: - $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). @@ -184,7 +200,6 @@ In PowerShell, the default value is $false. In new Safe Links policies created i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -194,6 +209,9 @@ Accept wildcard characters: False ``` ### -DoNotRewriteUrls + +> Applicable: Exchange Online + The DoNotRewriteUrls parameter specifies the URLs that are not rewritten by Safe Links scanning. The list of entries allows users who are included in the policy to access the specified URLs that would otherwise be blocked by Safe Links. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -206,7 +224,6 @@ For details about the entry syntax, see [Entry syntax for the "Do not rewrite th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,6 +233,9 @@ Accept wildcard characters: False ``` ### -EnableForInternalSenders + +> Applicable: Exchange Online + The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: - $true: The policy is applied to internal and external senders. This is the default value. @@ -225,7 +245,6 @@ The EnableForInternalSenders parameter specifies whether the Safe Links policy i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -235,6 +254,9 @@ Accept wildcard characters: False ``` ### -EnableOrganizationBranding + +> Applicable: Exchange Online + The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: - $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. @@ -244,7 +266,6 @@ The EnableOrganizationBranding parameter specifies whether your organization's l Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -254,6 +275,9 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForEmail + +> Applicable: Exchange Online + The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: - $true: Safe Links is enabled for email. This is the default value. When a user clicks a link in an email, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. @@ -263,7 +287,6 @@ The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links pro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -273,6 +296,9 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForOffice + +> Applicable: Exchange Online + The EnableSafeLinksForOffice parameter specifies whether to enable Safe Links protection for supported Office desktop, mobile, or web apps. Valid values are: - $true: Safe Links scanning is enabled in Office apps. This is the default value. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. @@ -284,7 +310,6 @@ Note that this protection applies to links in Office documents, not links in ema Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -294,6 +319,9 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForTeams + +> Applicable: Exchange Online + The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: - $true: Safe Links is enabled for Teams. This is the default value. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. @@ -303,7 +331,6 @@ The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -313,13 +340,15 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection + +> Applicable: Exchange Online + The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this switch yourself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -329,13 +358,15 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType + +> Applicable: Exchange Online + The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -345,6 +376,9 @@ Accept wildcard characters: False ``` ### -ScanUrls + +> Applicable: Exchange Online + The ScanUrls parameter specifies whether to enable or disable real-time scanning of clicked links in email messages. Valid values are: - $true: Real-time scanning of clicked links, including links that point to files, is enabled. This is the default value. @@ -354,7 +388,6 @@ The ScanUrls parameter specifies whether to enable or disable real-time scanning Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -364,6 +397,9 @@ Accept wildcard characters: False ``` ### -TrackClicks + +> Applicable: Exchange Online + The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links. Valid values are: - $true: User clicks messages are tracked. This is the default value. @@ -373,7 +409,6 @@ The TrackClicks parameter specifies whether to track user clicks related to Safe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -383,6 +418,9 @@ Accept wildcard characters: False ``` ### -UseTranslatedNotificationText + +> Applicable: Exchange Online + The UseTranslatedNotificationText specifies whether to use Microsoft Translator to automatically localize the custom notification text that you specified with the CustomNotificationText parameter. Valid values are: - $true: Translate custom notification text to the user's language. @@ -392,7 +430,6 @@ The UseTranslatedNotificationText specifies whether to use Microsoft Translator Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -402,13 +439,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/New-SafeLinksRule.md similarity index 96% rename from exchange/exchange-ps/exchange/New-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-SafeLinksRule.md index 33a08f67c7..f0bcda85ea 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-safelinksrule applicable: Exchange Online -title: New-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-safelinksrule +schema: 2.0.0 +title: New-SafeLinksRule --- # New-SafeLinksRule @@ -87,13 +88,15 @@ This example is similar to Example 2, but in this example, the rule applies to r ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the Safe Links rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -SafeLinksPolicy + +> Applicable: Exchange Online + The SafeLinksPolicy parameter specifies the Safe Links policy that's associated with this Safe Links rule. The rule defines the conditions and the policy defines the actions. You can use any value that uniquely identifies the policy. For example: @@ -117,7 +123,6 @@ You can't specify a Safe Links policy that's already associated with another Saf Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -127,13 +132,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -143,6 +150,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -152,7 +162,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the rule is enabled. Valid values are: - $true: The rule is enabled. This is the default value. @@ -173,7 +185,6 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -183,13 +194,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -199,6 +212,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -214,7 +230,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -224,6 +239,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -241,7 +259,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -265,7 +285,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -275,13 +294,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -291,6 +312,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -306,7 +330,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -316,6 +339,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -333,7 +359,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -343,13 +368,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md b/exchange/exchange-ps/ExchangePowerShell/New-SearchDocumentFormat.md similarity index 89% rename from exchange/exchange-ps/exchange/New-SearchDocumentFormat.md rename to exchange/exchange-ps/ExchangePowerShell/New-SearchDocumentFormat.md index 2f54d72235..bc6b60fcfa 100644 --- a/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SearchDocumentFormat.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-searchdocumentformat applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SearchDocumentFormat -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-searchdocumentformat +schema: 2.0.0 +title: New-SearchDocumentFormat --- # New-SearchDocumentFormat @@ -46,13 +47,15 @@ This example creates a new search document format with an extension of .sct and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter uniquely identifies the new search document format. For example, an identity of "PropSCT" might specify a proprietary document format which is supported by a custom IFilter. The Identity parameter must be unique within the search document formats. ```yaml Type: SearchDocumentFormatId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Extension parameter specifies the file type to be processed by the filter and is designated by the common file extension associated with the file type. Examples include .MP3, .JPG and .PNG. Note the leading period. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -MimeType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MimeType parameter specifies the MIME type of the format. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name specifies a friendly name for the format, but does not need to be unique. For example, you might have several different formats (supported by custom IFilters) that are used to index output from a proprietary system called "My Business Output". You could use the Name parameter to create a category of formats called "My Business Output Formats" and uniquely identify each format within that group using the Identity parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -110,6 +119,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -119,7 +131,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +140,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the new format is enabled at creation. Valid input for this parameter is $true or $false. The default is $true. @@ -137,7 +151,6 @@ Valid input for this parameter is $true or $false. The default is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,6 +160,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -160,7 +176,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,13 +185,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-SecOpsOverridePolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-SecOpsOverridePolicy.md index dcdcdca10f..1cdb8d8f17 100644 --- a/exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SecOpsOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-secopsoverridepolicy applicable: Exchange Online -title: New-SecOpsOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-secopsoverridepolicy +schema: 2.0.0 +title: New-SecOpsOverridePolicy --- # New-SecOpsOverridePolicy @@ -46,13 +47,15 @@ This example creates the SecOps mailbox override policy with the specified setti ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the name for the SecOps mailbox override policy. Regardless of the value you specify, the name will be SecOpsOverridePolicy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies the email address of the SecOps mailbox. Groups are not allowed. You can specify multiple email addresses separated by commas. @@ -70,7 +76,6 @@ You can specify multiple email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -105,7 +115,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -131,6 +142,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -140,7 +154,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -150,6 +163,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -158,7 +174,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -168,13 +183,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SendConnector.md b/exchange/exchange-ps/ExchangePowerShell/New-SendConnector.md similarity index 89% rename from exchange/exchange-ps/exchange/New-SendConnector.md rename to exchange/exchange-ps/ExchangePowerShell/New-SendConnector.md index 0b08ca8a40..25a2ec45c2 100644 --- a/exchange/exchange-ps/exchange/New-SendConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SendConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-sendconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SendConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-sendconnector +schema: 2.0.0 +title: New-SendConnector --- # New-SendConnector @@ -137,13 +138,15 @@ To assign a specific authentication credential for the Send connector, you must ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a descriptive name for the connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -153,6 +156,9 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. - AddressSpaceType: On an Edge server, the address space type must be SMTP. In the Transport service on a Mailbox server, the address space type may be SMTP, X400, or any other text string. If you omit the address space type, SMTP is assumed. @@ -179,7 +185,6 @@ Although you can configure non-SMTP address spaces on a Send connector in the Tr Type: MultiValuedProperty Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -189,6 +194,9 @@ Accept wildcard characters: False ``` ### -AuthenticationCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AuthenticationCredential parameter specifies the username and password that's required to use the connector. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -197,7 +205,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +214,9 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -220,7 +230,6 @@ Valid values are: Type: Boolean Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,13 +239,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,6 +257,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -255,7 +269,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -265,6 +278,9 @@ Accept wildcard characters: False ``` ### -ConnectionInactivityTimeOut + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectionInactivityTimeOut parameter specifies the maximum time an idle connection can remain open. The default value is ten minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -275,7 +291,6 @@ For example, to specify fifteen minutes, set it to 00:15:00. The valid input ran Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -285,6 +300,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ConnectorType parameter specifies whether the connector is used in hybrid deployments to send messages to Microsoft 365. Valid values are: - Default: The connector isn't used to send messages to Microsoft 365. This is the default value. @@ -294,7 +312,6 @@ The ConnectorType parameter specifies whether the connector is used in hybrid de Type: TenantConnectorType Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,6 +321,9 @@ Accept wildcard characters: False ``` ### -Custom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Custom switch specifies the Custom usage type. You don't need to specify a value with this switch. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Custom switch, you can't use any of the following parameters: @@ -319,7 +339,6 @@ For more information about Send connector usage types, permissions, and authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -329,13 +348,15 @@ Accept wildcard characters: False ``` ### -DNSRoutingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DNSRoutingEnabled parameter specifies whether the Send connector uses Domain Name System (DNS) to route mail. Valid values for this parameter are $true or $false. The default value is $true. If you specify a SmartHosts parameter, the DNSRoutingEnabled parameter must be $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -345,6 +366,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -353,7 +377,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -363,6 +386,9 @@ Accept wildcard characters: False ``` ### -DomainSecureEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainSecureEnabled parameter enables mutual Transport Layer Security (TLS) authentication for the domains serviced by the Send connector when set to $true. Mutual TLS authentication functions correctly only if the following conditions are met: - DomainSecureEnabled is set to $true. @@ -382,7 +408,6 @@ The default value is $true for a default Send connector defined on an Edge serve Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -392,13 +417,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether to enable the Send connector to process email messages. Valid values are $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -408,6 +435,9 @@ Accept wildcard characters: False ``` ### -ErrorPolicies + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ErrorPolicies parameter specifies how communication errors are treated. Possible values are the following: - Default: A non-delivery report (NDR) is generated for communication errors. @@ -423,7 +453,6 @@ Specify a value other than Default for this parameter only if this Send connecto Type: ErrorPolicies Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +462,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -441,7 +473,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -451,13 +482,15 @@ Accept wildcard characters: False ``` ### -ForceHELO + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ForceHELO parameter specifies whether HELO is sent instead of the default EHLO. Valid values are $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -467,6 +500,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Fqdn parameter specifies the FQDN used as the source server for connected messaging servers that use the Send connector to receive outgoing messages. The value of this parameter is displayed to connected messaging servers whenever a source server name is required, as in the following examples: - In the EHLO/HELO command when the Send connector communicates with the next hop messaging server @@ -479,7 +515,6 @@ The default value of the Fqdn parameter is $null. This means the default FQDN va Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -489,13 +524,15 @@ Accept wildcard characters: False ``` ### -FrontendProxyEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FrontendProxyEnabled parameter routes outbound messages through the CAS server, where destination specific routing, such as DNS or IP address, is set, when the parameter is set to $true. ```yaml Type: Boolean Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -505,13 +542,15 @@ Accept wildcard characters: False ``` ### -IgnoreSTARTTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreSTARTTLS parameter specifies whether to ignore the StartTLS option offered by a remote sending server. This parameter is used with remote domains. This parameter must be set to $false if the RequireTLS parameter is set to $true. Valid values for this parameter are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -521,6 +560,9 @@ Accept wildcard characters: False ``` ### -Internal + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Internal switch specifies the Internal usage type. You don't need to specify a value with this switch. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internal switch, you can't use any of the following parameters: @@ -536,7 +578,6 @@ For more information about Send connector usage types, permissions, and authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -546,6 +587,9 @@ Accept wildcard characters: False ``` ### -Internet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Internet switch specifies the Internet usage type. You don't need to specify a value with this switch. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internet switch, you can't use any of the following parameters: @@ -561,7 +605,6 @@ For more information about Send connector usage types, permissions, and authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -571,6 +614,9 @@ Accept wildcard characters: False ``` ### -IsCoexistenceConnector + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IsCoexistenceConnector parameter specifies whether this Send connector is used for secure mail flow between your on-premises deployment and your Microsoft 365 organization. The default value is $false. @@ -579,7 +625,6 @@ The IsCoexistenceConnector parameter specifies whether this Send connector is us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -589,13 +634,15 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers with the Transport service. When the value of this parameter is $false, the connector can be used by all Mailbox servers in the Exchange organization. When the value of this parameter is $true, the connector can only be used by Transport service on Mailbox servers in the same Active Directory site. The default value is $false. ```yaml Type: Boolean Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -605,6 +652,9 @@ Accept wildcard characters: False ``` ### -LinkedReceiveConnector + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The LinkedReceiveConnector parameter specifies whether to force all messages received by the specified Receive connector out through this Send connector. The value of LinkedReceivedConnector can use any of the following identifiers to specify the Receive connector: @@ -626,7 +676,6 @@ When you use the LinkedReceiveConnector parameter, you can't use the AddressSpac Type: ReceiveConnectorIdParameter Parameter Sets: LinkedReceiveConnector Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -636,6 +685,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxMessageSize parameter specifies the maximum size of a message that can pass through a connector. The default value is 25 MB. When you enter a value, qualify the value with one of the following units: @@ -654,7 +706,6 @@ Values entered in bytes are rounded up to nearest kilobyte. The valid input rang Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -664,6 +715,9 @@ Accept wildcard characters: False ``` ### -Partner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Partner switch specifies the Partner usage type. You don't need to specify a value with this switch. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Partner switch, you can't use any of the following parameters: @@ -679,7 +733,6 @@ For more information about Send connector usage types, permissions, and authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -689,13 +742,15 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Port parameter specifies the port number for smart host forwarding, if you specify a value in the SmartHosts parameter. The valid input range is an integer from 0 through 65535. The default value is 25. In most organizations, the port number is set to 25. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -705,13 +760,15 @@ Accept wildcard characters: False ``` ### -ProtocolLoggingLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProtocolLoggingLevel parameter specifies whether to enable protocol logging. Verbose enables protocol logging. None disables protocol logging. The location of the Send connector protocol logs for all Send connectors configured in the Transport service on a Mailbox server or on an Edge server is specified with the SendProtocolLogPath parameter of the Set-TransportService cmdlet. ```yaml Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -721,13 +778,15 @@ Accept wildcard characters: False ``` ### -RequireOorg + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -737,13 +796,15 @@ Accept wildcard characters: False ``` ### -RequireTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireTLS parameter specifies whether all messages sent through this connector must be transmitted using TLS. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -753,13 +814,15 @@ Accept wildcard characters: False ``` ### -SmartHostAuthMechanism + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SmartHostAuthMechanism parameter specifies the smart host authentication mechanism to use for authentication with a remote server. Use this parameter only when a smart host is configured and the DNSRoutingEnabled parameter is set to $false. Valid values are None, BasicAuth, BasicAuthRequireTLS, ExchangeServer, and ExternalAuthoritative. All values are mutually exclusive. If you select BasicAuth or BasicAuthRequireTLS, you must use the AuthenticationCredential parameter to specify the authentication credential. ```yaml Type: AuthMechanisms Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -769,6 +832,9 @@ Accept wildcard characters: False ``` ### -SmartHosts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameter is required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart host server. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -777,7 +843,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -787,13 +852,15 @@ Accept wildcard characters: False ``` ### -SmtpMaxMessagesPerConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SmtpMaxMessagesPerConnection parameter specifies the maximum number of messages the server can send per connection. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -803,13 +870,15 @@ Accept wildcard characters: False ``` ### -SourceIPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceIPAddress parameter specifies the local IP address to use as the endpoint for an SMTP connection to a remote messaging server. The default IP address is 0.0.0.0. This value means that the server can use any available local IP address. This parameter is valid only for Send connectors configured on an Edge server. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -819,6 +888,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceTransportServers parameter specifies the names of the Mailbox servers that can use this Send connector. This parameter isn't valid for Send connectors configured on an Edge server. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -827,7 +899,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -837,6 +908,9 @@ Accept wildcard characters: False ``` ### -TlsAuthLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsAuthLevel parameter specifies the TLS authentication level that is used for outbound TLS connections established by this Send connector. Valid values are: - EncryptionOnly: TLS is used only to encrypt the communication channel. No certificate authentication is performed. @@ -849,7 +923,6 @@ You can't specify a value for this parameter if the IgnoreSTARTTLS parameter is Type: TlsAuthLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -859,13 +932,15 @@ Accept wildcard characters: False ``` ### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier Parameter Sets: AddressSpaces Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -875,6 +950,9 @@ Accept wildcard characters: False ``` ### -TlsDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsDomain parameter specifies the domain name that the Send connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is used only if the TlsAuthLevel parameter is set to DomainValidation. @@ -888,7 +966,6 @@ A value for this parameter is required if: Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -898,6 +975,9 @@ Accept wildcard characters: False ``` ### -Usage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Usage parameter specifies the default permissions and authentication methods assigned to the Send connector. The valid values are as follows: Custom, Internal, Internet, or Partner. The default is Custom. If you use the Usage parameter, you can't use any of the following parameters: @@ -913,7 +993,6 @@ For more information about Send connector usage types, permissions, and authenti Type: UsageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -923,13 +1002,15 @@ Accept wildcard characters: False ``` ### -UseExternalDNSServersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UseExternalDNSServersEnabled parameter specifies whether this Send connector uses the external DNS list specified by the ExternalDNSServers parameter of the Set-TransportService cmdlet. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -939,13 +1020,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ServicePrincipal.md b/exchange/exchange-ps/ExchangePowerShell/New-ServicePrincipal.md similarity index 91% rename from exchange/exchange-ps/exchange/New-ServicePrincipal.md rename to exchange/exchange-ps/ExchangePowerShell/New-ServicePrincipal.md index 6e59edbe3e..57d018af70 100644 --- a/exchange/exchange-ps/exchange/New-ServicePrincipal.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ServicePrincipal.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-serviceprincipal applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: New-ServicePrincipal -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-serviceprincipal +schema: 2.0.0 +title: New-ServicePrincipal --- # New-ServicePrincipal @@ -49,6 +50,9 @@ This example create a new service principal in Exchange Online with the specifie ## PARAMETERS ### -AppId + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The AppId parameter specifies the unique AppId GUID value for the service principal. For example, ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1. A valid value for this parameter is available in the following locations: @@ -60,7 +64,6 @@ A valid value for this parameter is available in the following locations: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -ObjectId + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ObjectId parameter specifies the unique ObjectId GUID value for the service principal. For example, 7c7599b2-23af-45e3-99ff-0025d148e929. A valid value for this parameter is available in the following locations: @@ -81,7 +87,6 @@ A valid value for this parameter is available in the following locations: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -ServiceId + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is being deprecated. Use the ObjectId parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -116,7 +126,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The DisplayName parameter specifies the friendly name of the service principal. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -158,13 +171,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SettingOverride.md b/exchange/exchange-ps/ExchangePowerShell/New-SettingOverride.md similarity index 90% rename from exchange/exchange-ps/exchange/New-SettingOverride.md rename to exchange/exchange-ps/ExchangePowerShell/New-SettingOverride.md index 6ffa158c1c..7ed4d11a9f 100644 --- a/exchange/exchange-ps/exchange/New-SettingOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SettingOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-settingoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SettingOverride -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-settingoverride +schema: 2.0.0 +title: New-SettingOverride --- # New-SettingOverride @@ -62,13 +63,15 @@ For more information, see the topic [Change the offline address book generation ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name of the setting override. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Component + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Component parameter specifies the component that the setting override is applied to. For example: - TimeBasedAssistants @@ -87,7 +93,6 @@ The Component parameter specifies the component that the setting override is app Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Parameters parameter specifies one or more parameters for the override that are available for the combination of the Component and Section parameter values. This parameter uses the syntax: `@("Parameter1=Value1","Parameter2=Value2"...)`. For example: - `@("Enabled=true")` @@ -106,7 +114,6 @@ The Parameters parameter specifies one or more parameters for the override that Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -Reason + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Reason parameter specifies why you are creating the setting override. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -Section + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Section parameter specifies the name of the section for which the override is created. The available values for this parameter depend on the value of the Component parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -148,6 +159,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -157,7 +171,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,13 +180,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,6 +198,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -191,7 +209,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,6 +218,9 @@ Accept wildcard characters: False ``` ### -MaxVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxVersion parameter specifies the latest version of Exchange 2016 that this override applies to (up to and including the specified value). Valid input for this parameter is an Exchange 2016 version value in the format 15.1.xxx.xx. You can use values with leading zeros, but the leading zeros are removed from the results. For example, 15.01.0225.042 is stored as 15.1.225.42. @@ -211,7 +231,6 @@ The default value is blank ($null), which means the override applies to all vers Type: Version Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -221,6 +240,9 @@ Accept wildcard characters: False ``` ### -MinVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MinVersion parameter specifies the earliest version of Exchange 2016 that this override applies to (up to and including the specified value). Valid input for this parameter is an Exchange 2016 version value in the format 15.1.xxx.xx. You can use values with leading zeros, but the leading zeros are removed from the results. For example, 15.01.0225.042 is stored as 15.1.225.42. @@ -231,7 +253,6 @@ The default value is blank ($null), which means the override applies to all vers Type: Version Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +262,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the name of the Exchange 2016 server where you want the override applied. You can specify a single Exchange 2016 server name, or an array of Exchange 2016 server name wildcards. For example, if you have three Exchange 2016 servers named Exchange01, Exchange02 and Exchange03, specify the value Exchange\* to apply the override to all of them. If you don't use this parameter to specify a server, the override applies to all Exchange 2016 servers in the Active Directory forest. @@ -249,7 +273,6 @@ If you don't use this parameter to specify a server, the override applies to all Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,13 +282,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SharingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-SharingPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/New-SharingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-SharingPolicy.md index c955830dfd..677c2045d7 100644 --- a/exchange/exchange-ps/exchange/New-SharingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SharingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-sharingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-SharingPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-sharingpolicy +schema: 2.0.0 +title: New-SharingPolicy --- # New-SharingPolicy @@ -54,13 +55,15 @@ This example creates a default sharing policy, which is applied to all mailboxes ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the new sharing policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Domains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Domains parameter specifies the domains and the associated sharing options for those domains in the sharing policy. Values for this parameter use the basic syntax: `'Domain: SharingPolicyAction'`. You can use the following values for `Domain`: @@ -91,7 +97,6 @@ You can specify multiple `'Domain: SharingPolicyAction'` values separated by com Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -110,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Default switch specifies that this sharing policy is the default sharing policy for all mailboxes. You don't need to specify a value with this switch. If no sharing policy has been applied to a mailbox, the default policy is automatically applied. If you want to disable sharing across your organization, you can set the default policy as disabled. @@ -128,7 +138,6 @@ If no sharing policy has been applied to a mailbox, the default policy is automa Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -146,7 +158,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter specifies whether to enable the new sharing policy. Valid input for this parameter is $true or $false. The default is $true. When the sharing policy is disabled, users who are provisioned to use this policy continue to share information until the sharing policy assistant runs and removes the permissions on the shared folder. The frequency with which the sharing policy assistant runs is assigned in the Set-MailboxServer cmdlet using the SharingPolicySchedule parameter. @@ -164,7 +178,6 @@ When the sharing policy is disabled, users who are provisioned to use this polic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SiteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/New-SiteMailbox.md similarity index 88% rename from exchange/exchange-ps/exchange/New-SiteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/New-SiteMailbox.md index 21fd001892..6519e1a622 100644 --- a/exchange/exchange-ps/exchange/New-SiteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SiteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-sitemailbox applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SiteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-sitemailbox +schema: 2.0.0 +title: New-SiteMailbox --- # New-SiteMailbox @@ -51,13 +52,15 @@ You can't run this cmdlet from the Exchange Management Shell. Use SharePoint to ## PARAMETERS ### -DisplayName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DisplayName parameter specifies the display name that displays in the user's global address list and on SharePoint. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -SharePointUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SharePointUrl parameter specifies the SharePoint URL where the site mailbox is hosted, for example, "https://myserver/teams/edu". ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Alias parameter specifies the alias of the site mailbox. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -108,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Database parameter specifies the mailbox database that holds the mailbox data for the site mailbox. You can use any value that uniquely identifies the database. For example: - Name @@ -128,7 +140,6 @@ The Database parameter specifies the mailbox database that holds the mailbox dat Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,6 +167,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. This switch tests that site mailbox provisioning is working independently of the SharePoint deployment. We recommend that you never use this switch for production site mailboxes. @@ -162,7 +178,6 @@ This switch tests that site mailbox provisioning is working independently of the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +187,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the site mailbox. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +205,15 @@ Accept wildcard characters: False ``` ### -OrganizationalUnit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OrganizationalUnit parameter specifies the organizational unit in which the site mailbox resides. ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,13 +223,15 @@ Accept wildcard characters: False ``` ### -OverrideRecipientQuotas + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,13 +241,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-SiteMailboxProvisioningPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-SiteMailboxProvisioningPolicy.md index 2766674f44..1c8207891f 100644 --- a/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SiteMailboxProvisioningPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-sitemailboxprovisioningpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SiteMailboxProvisioningPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-sitemailboxprovisioningpolicy +schema: 2.0.0 +title: New-SiteMailboxProvisioningPolicy --- # New-SiteMailboxProvisioningPolicy @@ -71,13 +72,15 @@ This example creates the default provisioning policy named SM\_DefaultPolicy and ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name of the site mailbox provisioning policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -AliasPrefix + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -96,7 +102,6 @@ The AliasPrefix parameter specifies the custom text prefix to add to the aliases Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -115,7 +123,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -DefaultAliasPrefixEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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`). @@ -136,7 +146,6 @@ The value of this parameter is related to the value of the AliasPrefix parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsDefault switch specifies that the site mailbox provisioning policy is the default policy. You don't need to specify a value with this switch. You can have multiple policies, but only the default policy is followed when users create site mailboxes. @@ -170,7 +184,6 @@ You can have multiple policies, but only the default policy is followed when use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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: @@ -200,7 +216,6 @@ The default value is 49 GB. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +225,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the site mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -227,7 +245,6 @@ A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the val Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,6 +254,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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: @@ -257,7 +277,6 @@ The default value is 50 GB. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -267,13 +286,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewPolicyV2.md similarity index 92% rename from exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md rename to exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewPolicyV2.md index ed8687d950..7d1af9bad2 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewPolicyV2.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-supervisoryreviewpolicyv2 applicable: Security & Compliance -title: New-SupervisoryReviewPolicyV2 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-supervisoryreviewpolicyv2 +schema: 2.0.0 +title: New-SupervisoryReviewPolicyV2 --- # New-SupervisoryReviewPolicyV2 @@ -48,13 +49,15 @@ This example creates a new supervisory review policy named EU Brokers Policy. ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the supervisory review policy. The name can't exceed 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -Reviewers + +> Applicable: Security & Compliance + The Reviewers parameter specifies the SMTP addresses of the reviewers for the supervisory review policy. You can specify multiple email addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -105,7 +115,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + {{ Fill Enabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -131,6 +142,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -139,7 +153,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -149,13 +162,15 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + {{ Fill PolicyRBACScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -165,13 +180,15 @@ Accept wildcard characters: False ``` ### -PreservationPeriodInDays + +> Applicable: Security & Compliance + {{ Fill PreservationPeriodInDays Description }} ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -181,13 +198,15 @@ Accept wildcard characters: False ``` ### -UserReportingWorkloads + +> Applicable: Security & Compliance + {{ Fill UserReportingWorkloads Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -197,13 +216,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md b/exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewRule.md similarity index 92% rename from exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewRule.md index c4b9d1a57f..c9b43118c5 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SupervisoryReviewRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-supervisoryreviewrule applicable: Security & Compliance -title: New-SupervisoryReviewRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-supervisoryreviewrule +schema: 2.0.0 +title: New-SupervisoryReviewRule --- # New-SupervisoryReviewRule @@ -67,13 +68,15 @@ This example creates a new supervisory review rule named EU Brokers Rule with th ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name for the supervisory review rule. The name can't exceed 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Policy + +> Applicable: Security & Compliance + The Policy parameter specifies the supervisory review policy that's assigned to the rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -93,7 +99,6 @@ The Policy parameter specifies the supervisory review policy that's assigned to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -AdvancedRule + +> Applicable: Security & Compliance + {{ Fill AdvancedRule Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -CcsiDataModelOperator + +> Applicable: Security & Compliance + {{ Fill CcsiDataModelOperator Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -Condition + +> Applicable: Security & Compliance + The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: - User or group communications to supervise: `"((Reviewee:) -OR (Reviewee:)...)"`. Exceptions use the syntax `"(NOT((Reviewee:) -OR (Reviewee:)...))"`. @@ -151,7 +163,6 @@ The Condition parameter specifies the conditions and exceptions for the rule. Th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -170,7 +184,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -180,13 +193,15 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + {{ Fill ContentContainsSensitiveInformation Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -196,13 +211,15 @@ Accept wildcard characters: False ``` ### -ContentMatchesDataModel + +> Applicable: Security & Compliance + {{ Fill ContentMatchesDataModel Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -212,13 +229,15 @@ Accept wildcard characters: False ``` ### -ContentSources + +> Applicable: Security & Compliance + {{ Fill ContentSources Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -228,13 +247,15 @@ Accept wildcard characters: False ``` ### -DayXInsights + +> Applicable: Security & Compliance + {{ Fill DayXInsights Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -244,13 +265,15 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + {{ Fill ExceptIfFrom Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -260,13 +283,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfRecipientDomainIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -276,13 +301,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRevieweeIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfRevieweeIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -292,13 +319,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfSenderDomainIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -308,13 +337,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + {{ Fill ExceptIfSentTo Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -324,13 +355,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Security & Compliance + {{ Fill ExceptIfSubjectOrBodyContainsWords Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -340,13 +373,15 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + {{ Fill From Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -356,13 +391,15 @@ Accept wildcard characters: False ``` ### -IncludeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill IncludeAdaptiveScopes Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -372,13 +409,15 @@ Accept wildcard characters: False ``` ### -InPurviewFilter + +> Applicable: Security & Compliance + {{ Fill InPurviewFilter Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -388,13 +427,15 @@ Accept wildcard characters: False ``` ### -Ocr + +> Applicable: Security & Compliance + {{ Fill Ocr Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -404,13 +445,15 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + {{ Fill PolicyRBACScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -420,13 +463,15 @@ Accept wildcard characters: False ``` ### -SamplingRate + +> Applicable: Security & Compliance + The SamplingRate parameter specifies the percentage of communications for review. If you want reviewers to review all detected items, use the value 100. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -436,13 +481,15 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + {{ Fill SentTo Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -452,13 +499,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/New-SweepRule.md similarity index 91% rename from exchange/exchange-ps/exchange/New-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-SweepRule.md index 6aa53c55aa..8b8cb8b880 100644 --- a/exchange/exchange-ps/exchange/New-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SweepRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-SweepRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-sweeprule +schema: 2.0.0 +title: New-SweepRule --- # New-SweepRule @@ -66,13 +67,15 @@ This example creates a new Sweep rule named "From Jeff" in Felipe Apodaca's mail ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the Sweep rule. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Provider + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Provider parameter specifies the provider for the Sweep rule. If the value contains spaces, enclose the value in quotation marks. For Sweep rules that you create in Outlook on the web, the default value is Exchange16. @@ -90,7 +96,6 @@ For Sweep rules that you create in Outlook on the web, the default value is Exch Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -109,7 +117,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -DestinationFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -140,7 +150,6 @@ Example values for this parameter are `john@contoso.com:\Unimportant` or `John:\ Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -158,7 +170,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +179,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter specifies whether the Sweep rule is enabled or disabled. Valid values are: - $true: The rule is enabled. This is the default value. @@ -179,7 +193,6 @@ After you create the rule, you can enable or disable it by using the Enable-Swee Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -189,6 +202,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFlagged + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ExceptIfFlagged parameter specifies an exception for the Sweep rule that looks messages with a message flag applied. Valid values are: @@ -214,7 +230,6 @@ The typical message flag values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,6 +239,9 @@ Accept wildcard characters: False ``` ### -ExceptIfPinned + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PinMessage parameter specifies an exception for the Sweep rule that looks for pinned messages. Valid values are: @@ -235,7 +253,6 @@ The PinMessage parameter specifies an exception for the Sweep rule that looks fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,6 +262,9 @@ Accept wildcard characters: False ``` ### -KeepForDays + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The KeepForDays parameter specifies an action for the Sweep rule that specifies the number of days to keep messages that match the conditions of the rule. After the number of days have passed, the messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). You can't use this parameter with the KeepLatest parameter and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. @@ -253,7 +273,6 @@ You can't use this parameter with the KeepLatest parameter and the Sweep rule mu Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -263,6 +282,9 @@ Accept wildcard characters: False ``` ### -KeepLatest + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The KeepLatest parameter specifies an action for the Sweep rule that specifies the number of messages to keep that match the conditions of the rule. After the number of messages is exceeded, the oldest messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). You can't use this parameter with the KeepForDays parameter and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. @@ -271,7 +293,6 @@ You can't use this parameter with the KeepForDays parameter and the Sweep rule m Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -281,6 +302,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox where you want to create the Sweep rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -298,7 +322,6 @@ The Mailbox parameter specifies the mailbox where you want to create the Sweep r Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -308,6 +331,9 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Sender parameter specifies a condition for the Sweep rule that looks for the specified sender in messages. For internal senders, you can use any value that uniquely identifies the sender. For example: - Name @@ -323,7 +349,6 @@ For external senders, use their email address. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -333,6 +358,9 @@ Accept wildcard characters: False ``` ### -SourceFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -354,7 +382,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -364,6 +391,9 @@ Accept wildcard characters: False ``` ### -SystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SystemCategory parameter specifies a condition for the sweep rule that looks for messages with the specified system category. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -395,7 +425,6 @@ The SystemCategory parameter specifies a condition for the sweep rule that looks Type: SystemCategoryType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -405,13 +434,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/New-SyncMailPublicFolder.md similarity index 90% rename from exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/New-SyncMailPublicFolder.md index 8084e8b744..41a1745507 100644 --- a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SyncMailPublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-syncmailpublicfolder applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: New-SyncMailPublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-syncmailpublicfolder +schema: 2.0.0 +title: New-SyncMailPublicFolder --- # New-SyncMailPublicFolder @@ -76,6 +77,9 @@ This cmdlet is only used by the Import-MailPublicFoldersForMigration.ps1 and Syn ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name of the mail-enabled public folder. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). This value is also used for the DisplayName property if you don't use the DisplayName parameter. @@ -84,7 +88,6 @@ This value is also used for the DisplayName property if you don't use the Displa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -118,7 +124,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -128,13 +133,15 @@ Accept wildcard characters: False ``` ### -EntryId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -165,7 +175,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: DeliveryRecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -175,6 +184,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -184,7 +196,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -194,6 +205,9 @@ Accept wildcard characters: False ``` ### -Contacts + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Contacts parameter specifies the contacts for the public folder. Contacts are persons about whom you can save several types of information, such as addresses, telephone numbers, and web page URLs. Valid values for this parameter are recipients in your organization. You can use any value that uniquely identifies the recipient. For example: @@ -211,7 +225,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -221,13 +234,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -237,13 +252,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -253,13 +270,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -269,13 +288,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -285,13 +306,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -301,13 +324,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -317,13 +342,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -333,13 +360,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -349,13 +378,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -365,13 +396,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -381,13 +414,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -397,13 +432,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -413,13 +450,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -429,13 +468,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -445,13 +486,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -461,6 +504,9 @@ Accept wildcard characters: False ``` ### -DeliverToMailboxAndForward + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeliverToMailboxAndForward parameter specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress parameter. Valid values are: - $true: Messages are delivered to this mail-enabled public folder and forwarded to the specified recipient or email address. @@ -472,7 +518,6 @@ The default value is $false. This parameter is meaningful only if you configure Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -482,6 +527,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The DisplayName parameter specifies the display name of the mail-enabled public folder. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. @@ -490,7 +538,6 @@ If you don't use the DisplayName parameter, the value of the Name parameter is u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -500,6 +547,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -508,7 +558,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -518,6 +567,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -539,7 +591,6 @@ To specify the primary SMTP email address, you can use any of the following meth Type: ProxyAddress[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -549,13 +600,15 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalEmailAddress parameter specifies an email address outside the organization. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -565,6 +618,9 @@ Accept wildcard characters: False ``` ### -ForwardingAddress + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForwardingAddress parameter specifies a forwarding address for messages that are sent to this mail-enabled public folder. A valid value for this parameter is a recipient in your organization. You can use any value that uniquely identifies the recipient. For example: - Name @@ -585,7 +641,6 @@ The default value is blank ($null), which means no forwarding recipient is confi Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -595,6 +650,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mail-enabled public folder. Although messages send on behalf of the public folder clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the public folder, not the sender. The sender you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the sender. For example: @@ -614,7 +672,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -624,13 +681,15 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HiddenFromAddressListsEnabled switch specifies that this recipient is not visible in address lists. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -640,6 +699,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail-enabled public folder. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -659,7 +721,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -669,6 +730,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail-enabled public folder. When you enter a value, qualify the value with one of the following units: @@ -688,7 +752,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -698,13 +761,15 @@ Accept wildcard characters: False ``` ### -OnPremisesObjectId + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The OnPremisesObjectId parameter specifies the GUID of the on-premises mail-enabled public folder that's used to create the mail-enabled public folder object in Exchange Online. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -714,13 +779,15 @@ Accept wildcard characters: False ``` ### -OverrideRecipientQuotas + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -730,6 +797,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -751,7 +821,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: DeliveryRecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -761,6 +830,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -770,7 +842,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -780,13 +851,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -796,6 +869,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -807,7 +883,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SystemMessage.md b/exchange/exchange-ps/ExchangePowerShell/New-SystemMessage.md similarity index 93% rename from exchange/exchange-ps/exchange/New-SystemMessage.md rename to exchange/exchange-ps/ExchangePowerShell/New-SystemMessage.md index 05d97b7970..66b63211c0 100644 --- a/exchange/exchange-ps/exchange/New-SystemMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-SystemMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-systemmessage applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-SystemMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-systemmessage +schema: 2.0.0 +title: New-SystemMessage --- # New-SystemMessage @@ -62,6 +63,9 @@ This example creates a custom English quota message for mailboxes that exceed th ## PARAMETERS ### -DsnCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DsnCode parameter specifies the enhanced status code for the custom system message. Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. You can specify a default code that's included with Exchange, or you can specify a custom code. @@ -76,7 +80,6 @@ You can't use this parameter with the QuotaMessageType parameter. Type: EnhancedStatusCode Parameter Sets: Dsn Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Internal + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Internal parameter specifies whether the system message is displayed to internal or external users. Valid values are: - $true: The NDR is displayed to internal senders. @@ -99,7 +105,6 @@ You can't use this parameter with the QuotaMessageType parameter. Type: Boolean Parameter Sets: Dsn Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Language parameter specifies the language of the message (for example, en for English or ja for Japanese). For the list of supported language codes, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). You need to use this parameter with the DsnCode or QuotaMessageType parameters. @@ -117,7 +125,6 @@ You need to use this parameter with the DsnCode or QuotaMessageType parameters. Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -QuotaMessageType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QuotaMessageType parameter specifies the quota for the custom system message. Valid values are: Mailbox size quotas: @@ -171,7 +181,6 @@ You can't use this parameter with the DsnCode or Internal parameters. Type: QuotaMessageType Parameter Sets: Quota Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -Text + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Text parameter specifies the text in the custom system message. The text should explain why the system message was sent, and any actions that the user should take. You need to use this parameter with the DsnCode or QuotaMessageType parameters. @@ -210,7 +222,6 @@ Here's an example value for this parameter that uses HTML tags and special chara Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -220,6 +231,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -229,7 +243,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,6 +252,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -247,7 +263,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,13 +272,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicy.md index 18775fc30b..bfee67b53a 100644 --- a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-teamsprotectionpolicy applicable: Exchange Online -title: New-TeamsProtectionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-teamsprotectionpolicy +schema: 2.0.0 +title: New-TeamsProtectionPolicy --- # New-TeamsProtectionPolicy @@ -48,13 +49,15 @@ This example creates the Teams protection policy with the default values. ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the unique name of the Teams protection policy. If the value contains spaces, enclose the value in quotation marks. The default name of the Teams protection policy in an organization is Teams Protection Policy. We recommend using this value. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -64,6 +67,12 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,8 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online -Applicable: Exchange Online Required: False Position: Named @@ -84,6 +91,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishQuarantineTag + +> Applicable: Exchange Online + The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as high confidence phishing by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -98,7 +108,6 @@ If you don't use this parameter, the default quarantine policy that's used is na Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,6 +117,9 @@ Accept wildcard characters: False ``` ### -MalwareQuarantineTag + +> Applicable: Exchange Online + The MalwareQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as malware by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -122,7 +134,6 @@ If you don't use this parameter, the default quarantine policy that's used is na Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,13 +143,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -148,13 +161,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named @@ -164,6 +179,9 @@ Accept wildcard characters: False ``` ### -ZapEnabled + +> Applicable: Exchange Online + The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware and high confidence phishing messages in Teams messages. Valid values are: - $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This is the default value. @@ -173,7 +191,6 @@ The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicyRule.md similarity index 95% rename from exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicyRule.md index b2a9f0c731..e9a52ab70d 100644 --- a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-TeamsProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-teamsprotectionpolicyrule applicable: Exchange Online -title: New-TeamsProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-teamsprotectionpolicyrule +schema: 2.0.0 +title: New-TeamsProtectionPolicyRule --- # New-TeamsProtectionPolicyRule @@ -58,13 +59,15 @@ This example creates the Teams protection policy rule with members of the group ## PARAMETERS ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the unique name of the Teams protection policy rule. If the value contains spaces, enclose the value in quotation marks. The default name of the Teams protection policy rule in an organization is Teams Protection Policy Rule. We recommend using this value. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -TeamsProtectionPolicy + +> Applicable: Exchange Online + The TeamsProtectionPolicy parameter specifies the Teams protection policy that's associated with this rule. The only available policy is named Teams Protection Policy. ```yaml Type: TeamsProtectionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -115,7 +125,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -141,13 +152,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +170,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -172,7 +188,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -182,6 +197,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception to ZAP for Teams protection that looks for Teams messages sent to members of distribution groups or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -199,7 +217,6 @@ If you remove the group after you create the rule, no exception is made for Team Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -225,13 +244,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListItems.md similarity index 91% rename from exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md rename to exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListItems.md index bd3cf8d4ad..0c72896810 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-tenantallowblocklistitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: New-TenantAllowBlockListItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-tenantallowblocklistitems +schema: 2.0.0 +title: New-TenantAllowBlockListItems --- # New-TenantAllowBlockListItems @@ -86,6 +87,9 @@ For URLs identified as malware or high-confidence phishing, you need to submit t ## PARAMETERS ### -Entries + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Entries parameter specifies the values that you want to add to the Tenant Allow/Block List based on the ListType parameter value: - FileHash: Use the SHA256 hash value of the file. You can find the SHA256 hash value by running the following command in PowerShell: `Get-FileHash -Path "\" -Algorithm SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. @@ -117,7 +121,6 @@ In most cases, you can't modify the sender, URL, file, or IP address values afte Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -127,6 +130,9 @@ Accept wildcard characters: False ``` ### -ExpirationDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ExpirationDate parameter set the expiration date of the entry in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -140,7 +146,6 @@ You can't use this parameter with the NoExpiration or RemoveAfter parameters. Type: DateTime Parameter Sets: Expiration Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -150,6 +155,9 @@ Accept wildcard characters: False ``` ### -ListType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListType parameter specifies the type of entry to add. Valid values are: - FileHash @@ -161,7 +169,6 @@ The ListType parameter specifies the type of entry to add. Valid values are: Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -171,6 +178,9 @@ Accept wildcard characters: False ``` ### -NoExpiration + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. This switch is available to use in the following scenarios: @@ -185,7 +195,6 @@ You can't use this switch with the ExpirationDate or RemoveAfter parameter. Type: SwitchParameter Parameter Sets: NoExpiration Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -195,6 +204,9 @@ Accept wildcard characters: False ``` ### -Allow + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Allow switch specifies that you're creating an allow entry. You don't need to specify a value with this switch. You can't use this switch with the Block switch. @@ -207,7 +219,6 @@ You can also use allow entries for non-Microsoft phishing simulation URLs with n Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -217,6 +228,9 @@ Accept wildcard characters: False ``` ### -Block + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Allow switch specifies that you're creating a block entry. You don't need to specify a value with this switch. You can't use this switch with the Allow switch. @@ -225,7 +239,6 @@ You can't use this switch with the Allow switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -235,6 +248,9 @@ Accept wildcard characters: False ``` ### -ListSubType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListSubType parameter specifies the subtype for this entry. Valid values are: - AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the advanced delivery policy for non-Microsoft phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). @@ -244,7 +260,6 @@ The ListSubType parameter specifies the subtype for this entry. Valid values are Type: ListSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -254,13 +269,15 @@ Accept wildcard characters: False ``` ### -LogExtraDetails + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill LogExtraDetails Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -270,13 +287,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -286,6 +305,9 @@ Accept wildcard characters: False ``` ### -RemoveAfter + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RemoveAfter parameter enables the **Remove on** \> **45 days after last used date** feature for an allow entry. The LastUsedDate property is populated when the bad entity in the allow entry is encountered by the filtering system during mail flow or time of click. The allow entry is kept for 45 days after the filtering system determines that the entity is clean. The only valid value for this parameter is 45. @@ -298,7 +320,6 @@ You can't use this parameter with the ExpirationDate or NoExpirationDate paramet Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -308,6 +329,9 @@ Accept wildcard characters: False ``` ### -OutputJson + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The OutputJson switch specifies whether to return all entries in a single JSON value. You don't need to specify a value with this switch. You use this switch to prevent the command from halting on the first entry that contains a syntax error. @@ -316,7 +340,6 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -326,13 +349,15 @@ Accept wildcard characters: False ``` ### -SubmissionID + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListSpoofItems.md similarity index 89% rename from exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md rename to exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListSpoofItems.md index 48976dd565..dcb4b1d95f 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-TenantAllowBlockListSpoofItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-tenantallowblocklistspoofitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: New-TenantAllowBlockListSpoofItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-tenantallowblocklistspoofitems +schema: 2.0.0 +title: New-TenantAllowBlockListSpoofItems --- # New-TenantAllowBlockListSpoofItems @@ -44,13 +45,15 @@ This example creates an allow entry for the sender bob@contoso.com from the sour ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter uses the value Default. ```yaml Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -SendingInfrastructure + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SendingInfrastructure parameter specifies the source of the messages sent by the spoofed sender that's defined in the SpoofedUser parameter. Valid values are: - An email domain (for example contoso.com). The domain is found in the reverse DNS lookup (PTR record) of the source email server's IP address. @@ -70,7 +76,6 @@ The SendingInfrastructure parameter specifies the source of the messages sent by Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: True ``` ### -SpoofedUser + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SpoofedUser parameter specifies the email address or domain for the spoofed sender entry. - For domains outside your organization (cross-org), use the domain of the email address that appears in the From field of the message. @@ -91,7 +99,6 @@ For spoofed senders, the maximum number of entries is 1024. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: True ``` ### -SpoofType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The SpoofType parameter specifies whether this is an internal or external spoofed sender entry. Valid values are: - External @@ -110,7 +120,6 @@ The SpoofType parameter specifies whether this is an internal or external spoofe Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Action parameter specifies whether is an allowed or blocked spoofed sender entry. Valid values are: - Allow @@ -129,7 +141,6 @@ The Action parameter specifies whether is an allowed or blocked spoofed sender e Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -139,6 +150,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -148,7 +162,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -158,13 +171,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-ThrottlingPolicy.md similarity index 87% rename from exchange/exchange-ps/exchange/New-ThrottlingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-ThrottlingPolicy.md index 4b540a9784..17b477043c 100644 --- a/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-ThrottlingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-throttlingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-ThrottlingPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-throttlingpolicy +schema: 2.0.0 +title: New-ThrottlingPolicy --- # New-ThrottlingPolicy @@ -233,13 +234,15 @@ This example creates a throttling policy that restricts a user to be able to onl ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the object in Active Directory. The default policy is named `DefaultThrottlingPolicy`. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -249,13 +252,15 @@ Accept wildcard characters: False ``` ### -AnonymousCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnonymousCutoffBalance parameter specifies the resource consumption limits for an anonymous user before the user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -265,13 +270,15 @@ Accept wildcard characters: False ``` ### -AnonymousMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnonymousMaxBurst parameter specifies the amount of time that an anonymous user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,13 +288,15 @@ Accept wildcard characters: False ``` ### -AnonymousMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnonymousMaxConcurrency parameter specifies how many anonymous connections can be made to a user's calendar data at the same time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If anonymous users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The AnonymousMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 1. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,6 +306,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInAD parameter specifies the percentage of a minute that anonymous users can spend executing LDAP requests (PercentTimeInAD) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -305,7 +317,6 @@ The AnonymousPercentTimeInAD parameter specifies the percentage of a minute that Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -315,6 +326,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInCAS parameter specifies the percentage of a minute that anonymous users can spend executing CAS code (PercentTimeInCAS) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -323,7 +337,6 @@ The AnonymousPercentTimeInCAS parameter specifies the percentage of a minute tha Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -333,6 +346,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInMailboxRPC parameter specifies the percentage of a minute that anonymous users can spend executing mailbox RPC requests (PercentTimeInMailboxRPC) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -341,7 +357,6 @@ The AnonymousPercentTimeInMailboxRPC parameter specifies the percentage of a min Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -351,13 +366,15 @@ Accept wildcard characters: False ``` ### -AnonymousRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnonymousRechargeRate parameter specifies the rate at which an anonymous user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -367,13 +384,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -383,13 +402,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -399,13 +420,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -415,13 +438,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -431,13 +456,15 @@ Accept wildcard characters: False ``` ### -ComplianceMaxExpansionDGRecipients + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ComplianceMaxExpansionDGRecipients parameter specifies the maximum number of recipients to expand in distribution groups when a discovery search is looking for a specified recipient. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -447,13 +474,15 @@ Accept wildcard characters: False ``` ### -ComplianceMaxExpansionNestedDGs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ComplianceMaxExpansionNestedDGs parameter specifies the maximum number of nested distribution groups to expand when a discovery search is looking for a specified recipient. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -463,6 +492,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -472,7 +504,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -482,13 +513,15 @@ Accept wildcard characters: False ``` ### -ConsensusCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -498,13 +531,15 @@ Accept wildcard characters: False ``` ### -ConsensusMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -514,13 +549,15 @@ Accept wildcard characters: False ``` ### -ConsensusMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -530,13 +567,15 @@ Accept wildcard characters: False ``` ### -ConsensusRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -546,13 +585,15 @@ Accept wildcard characters: False ``` ### -CpaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CpaCutoffBalance parameter specifies the resource consumption limits for a cross-premises user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -562,13 +603,15 @@ Accept wildcard characters: False ``` ### -CpaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CpaMaxBurst parameter specifies the amount of time that a cross-premises user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -578,13 +621,15 @@ Accept wildcard characters: False ``` ### -CPAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CpaMaxConcurrency parameter specifies how many concurrent connections a cross-premises user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The CpaMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -594,13 +639,15 @@ Accept wildcard characters: False ``` ### -CPAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + The CPAPercentTimeInCAS parameter specifies the percentage of a minute that a cross-premises user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -610,6 +657,9 @@ Accept wildcard characters: False ``` ### -CPAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CPAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that a cross-premises user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -618,7 +668,6 @@ The CPAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -628,13 +677,15 @@ Accept wildcard characters: False ``` ### -CpaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CpaRechargeRate parameter specifies the rate at which a cross premises user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -644,6 +695,9 @@ Accept wildcard characters: False ``` ### -CPUStartPercent + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CPUStartPercent parameter specifies the per-process CPU percentage at which users governed by this policy begin to be backed off. Valid values are from 0 through 100. Use $null to turn off CPU percentage-based throttling for this policy. @@ -652,7 +706,6 @@ The CPUStartPercent parameter specifies the per-process CPU percentage at which Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -662,13 +715,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxConcurrency parameter specifies the number of concurrent discovery search executions that a user can have at the same time. To modify the discovery throttling parameters, create a new policy and name it "DiscoveryThrottlingPolicy". ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -678,13 +733,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxKeywords -The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchange/search-mailbox). + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchangepowershell/search-mailbox). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -694,13 +751,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxKeywordsPerPage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxKeywordsPerPage parameter specifies the number of keywords for which to show statistics on a single page in the EAC. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -710,13 +769,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxMailboxes parameter specifies the maximum number of source mailboxes that a user can include in a discovery search. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -726,13 +787,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxPreviewSearchMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxPreviewSearchMailboxes parameter specifies the maximum number of mailboxes that a user can include in eDiscovery Search Preview. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -742,13 +805,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxRefinerResults + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter isn't used and will be removed. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -758,13 +823,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxSearchQueueDepth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxSearchQueueDepth parameter specifies the maximum number of concurrent discovery search threads that can be active at the same time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -774,13 +841,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxStatsSearchMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxStatsSearchMailboxes parameter specifies the maximum number of mailboxes that a user can search in an In-Place eDiscovery search without being able to view the statistics. When the number of mailboxes configured with the DiscoveryMaxStatsSearchMailboxes parameter is exceeded, the user must copy the search results to a discovery mailbox to view the statistics for the discovery search. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -790,13 +859,15 @@ Accept wildcard characters: False ``` ### -DiscoveryPreviewSearchResultsPageSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryPreviewSearchResultsPageSize parameter specifies the number of messages displayed on a single page in eDiscovery Search Preview. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -806,13 +877,15 @@ Accept wildcard characters: False ``` ### -DiscoverySearchTimeoutPeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoverySearchTimeoutPeriod parameter specifies the number of minutes that a discovery search will run before it times out. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -822,6 +895,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -830,7 +906,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -840,13 +915,15 @@ Accept wildcard characters: False ``` ### -EasCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasCutoffBalance parameter specifies the resource consumption limits for an Exchange ActiveSync user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -856,13 +933,15 @@ Accept wildcard characters: False ``` ### -EasMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasMaxBurst parameter specifies the amount of time that an Exchange ActiveSync user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -872,13 +951,15 @@ Accept wildcard characters: False ``` ### -EASMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasMaxConcurrency parameter specifies how many concurrent connections an Exchange ActiveSync user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The EasMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 10. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -888,13 +969,15 @@ Accept wildcard characters: False ``` ### -EASMaxDeviceDeletesPerMonth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasMaxDeviceDeletesPerMonth parameter specifies a limit to the number of Exchange ActiveSync partnerships that a user can delete per month. By default, each user can delete a maximum of 20 partnerships per calendar month. When the limit is reached, the partnership deletion attempt fails and an error message is displayed to the user. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -904,13 +987,15 @@ Accept wildcard characters: False ``` ### -EASMaxDevices + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasMaxDevices parameter specifies a limit to the number of Exchange ActiveSync partnerships that a user can have at one time. By default, each user can create 100 Exchange ActiveSync partnerships with their Exchange account. After users exceed the limit, they must delete one of their existing partnerships before they can create any more new partnerships. An email error message describing the limitation is sent to the user when the limit is exceeded. Additionally, an event is logged in the Application log when a user exceeds the limit. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -920,13 +1005,15 @@ Accept wildcard characters: False ``` ### -EasMaxInactivityForDeviceCleanup + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasMaxInactivityForDeviceCleanup parameter specifies the length of time that a user's device partnerships will remain active. By default, there is no limit to the number of days that a user's device partnerships will remain active. Use this value if you want to minimize the amount of inactive device partnerships in your organization. To use this setting, specify a value in days since the user's last sync time to cause the device partnership to be removed. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -936,6 +1023,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInAD parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -944,7 +1034,6 @@ The EASPercentTimeInAD parameter specifies the percentage of a minute that an Ex Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -954,6 +1043,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInCAS parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -962,7 +1054,6 @@ The EASPercentTimeInCAS parameter specifies the percentage of a minute that an E Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -972,6 +1063,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -980,7 +1074,6 @@ The EASPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -990,13 +1083,15 @@ Accept wildcard characters: False ``` ### -EasRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasRechargeRate parameter specifies the rate at which an Exchange ActiveSync user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1006,13 +1101,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1022,13 +1119,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1038,13 +1137,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1054,13 +1155,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1070,13 +1173,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1086,13 +1191,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1102,13 +1209,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1118,13 +1227,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1134,13 +1245,15 @@ Accept wildcard characters: False ``` ### -EwsCostThreshold + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The EwsCostThreshold parameter specifies the cost threshold for Exchange Web Services users. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1150,13 +1263,15 @@ Accept wildcard characters: False ``` ### -EwsCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EwsCutoffBalance parameter specifies the resource consumption limits for an Exchange Web Services user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1166,13 +1281,15 @@ Accept wildcard characters: False ``` ### -EwsMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EwsMaxBurst parameter specifies the amount of time that an Exchange Web Services user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1182,6 +1299,9 @@ Accept wildcard characters: False ``` ### -EWSFastSearchTimeoutInSeconds + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSFastSearchTimeoutInSeconds parameter specifies the amount of time that searches made using Exchange Web Services continue before they time out. If the search takes more than the time indicated by the policy value, the search stops and an error is returned. The default value of this setting is 60 seconds. @@ -1190,7 +1310,6 @@ The EWSFastSearchTimeoutInSeconds parameter specifies the amount of time that se Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1200,6 +1319,9 @@ Accept wildcard characters: False ``` ### -EWSFindCountLimit + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSFindCountLimit parameter specifies the maximum result size of FindItem or FindFolder calls that can exist in memory on the Client Access server at the same time for this user in this current process. If an attempt is made to find more items or folders than your policy limit allows, an error is returned. However, the limit isn't strictly enforced if the call is made within the context of an indexed page view. Specifically, in this scenario, the search results are truncated to include the number of items and folders that fit within the policy limit. You can then continue paging into your results set via further FindItem or FindFolder calls. @@ -1208,7 +1330,6 @@ The EWSFindCountLimit parameter specifies the maximum result size of FindItem or Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1218,13 +1339,15 @@ Accept wildcard characters: False ``` ### -EWSMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EwsMaxConcurrency parameter specifies how many concurrent connections an Exchange Web Services user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The EwsMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 10. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1234,13 +1357,15 @@ Accept wildcard characters: False ``` ### -EWSMaxSubscriptions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EwsMaxSubscriptions parameter specifies the maximum number of active push and pull subscriptions that an Exchange Web Services user can have on a specified Exchange server at the same time. If a user tries to create more subscriptions than the configured maximum, the subscription fails, and an event is logged in Event Viewer. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1250,6 +1375,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInAD parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1258,7 +1386,6 @@ The EWSPercentTimeInAD parameter specifies the percentage of a minute that an Ex Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1268,6 +1395,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInCAS parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1276,7 +1406,6 @@ The EWSPercentTimeInCAS parameter specifies the percentage of a minute that an E Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1286,6 +1415,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1294,7 +1426,6 @@ The EWSPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1304,13 +1435,15 @@ Accept wildcard characters: False ``` ### -EwsRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EwsRechargeRate parameter specifies the rate at which an Exchange Web Services user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1320,6 +1453,9 @@ Accept wildcard characters: False ``` ### -ExchangeMaxCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExchangeMaxCmdlets parameter specifies the number of cmdlets that can be executed within a specific time period before their execution is slowed down. The value specified by this parameter should be less than the value specified by the PowerShellMaxCmdlets parameter. The time period used for this limit is specified by the PowerShellMaxCmdletsTimePeriod parameter. We recommend that you set values for both parameters at the same time. @@ -1328,7 +1464,6 @@ The time period used for this limit is specified by the PowerShellMaxCmdletsTime Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1338,13 +1473,15 @@ Accept wildcard characters: False ``` ### -ForwardeeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ForwardeeLimit parameter specifies the limits for the number of recipients that can be configured in Inbox Rules when using the forward or redirect action. This parameter doesn't limit the number of messages that can be forwarded or redirected to the recipients that are configured. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1354,13 +1491,15 @@ Accept wildcard characters: False ``` ### -ImapCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ImapCutoffBalance parameter specifies the resource consumption limits for an IMAP user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1370,13 +1509,15 @@ Accept wildcard characters: False ``` ### -ImapMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ImapMaxBurst parameter specifies the amount of time that an IMAP user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1386,13 +1527,15 @@ Accept wildcard characters: False ``` ### -IMAPMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ImapMaxConcurrency parameter specifies how many concurrent connections an IMAP user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The ImapMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1402,6 +1545,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInAD parameter specifies the percentage of a minute that an IMAP user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1410,7 +1556,6 @@ The IMAPPercentTimeInAD parameter specifies the percentage of a minute that an I Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1420,6 +1565,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInCAS parameter specifies the percentage of a minute that an IMAP user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1428,7 +1576,6 @@ The IMAPPercentTimeInCAS parameter specifies the percentage of a minute that an Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1438,6 +1585,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an IMAP user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1446,7 +1596,6 @@ The IMAPPercentTimeInMailboxRPC parameter specifies the percentage of a minute t Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1456,13 +1605,15 @@ Accept wildcard characters: False ``` ### -ImapRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ImapRechargeRate parameter specifies the rate at which the IMAP user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1472,6 +1623,9 @@ Accept wildcard characters: False ``` ### -IsServiceAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsServiceAccount switch specifies that the user accounts associated with this policy are moderated by per-user thresholds and the health of system resources (for example, overall CPU usage). You don't need to specify a value with this switch. You might want to use this switch if you intend to associate this policy with user accounts that require higher throttling limits (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). @@ -1482,7 +1636,6 @@ By using this switch, work done by these accounts is moderated by the higher use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1492,13 +1645,15 @@ Accept wildcard characters: False ``` ### -MessageRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRateLimit parameter specifies the number of messages per minute that can be submitted to transport by POP3 or IMAP4 clients that use SMTP. Clients receive a transient error if they submit messages at a rate that exceeds the value of this parameter. Exchange attempts to connect and send the messages at a later time. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1508,13 +1663,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1524,13 +1681,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1540,13 +1699,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1556,13 +1717,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSocketConnectionsPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1572,13 +1735,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSocketConnectionsPerUser + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1588,13 +1753,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSubscriptions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1604,13 +1771,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1620,13 +1789,15 @@ Accept wildcard characters: False ``` ### -OwaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaCutoffBalance parameter specifies the resource consumption limits for an Outlook on the web user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1636,13 +1807,15 @@ Accept wildcard characters: False ``` ### -OwaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaMaxBurst parameter specifies the amount of time that an Outlook on the web user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1652,6 +1825,9 @@ Accept wildcard characters: False ``` ### -OWAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaMaxConcurrency parameter specifies how many concurrent connections an Outlook on the web user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. A valid value for this parameter is an integer from 0 through 2147483647 inclusive. The default value is 5. To indicate that the number of concurrent connections should be unthrottled (no limit), use the value $null. @@ -1662,7 +1838,6 @@ A valid value for this parameter is an integer from 0 through 2147483647 inclusi Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1672,6 +1847,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInAD parameter specifies the percentage of a minute that an Outlook Web App user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1680,7 +1858,6 @@ The OWAPercentTimeInAD parameter specifies the percentage of a minute that an Ou Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1690,6 +1867,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInCAS parameter specifies the percentage of a minute that an Outlook Web App user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1698,7 +1878,6 @@ The OWAPercentTimeInCAS parameter specifies the percentage of a minute that an O Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1708,6 +1887,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Outlook Web App user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1716,7 +1898,6 @@ The OWAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1726,13 +1907,15 @@ Accept wildcard characters: False ``` ### -OwaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaRechargeRate parameter specifies the rate at which an Outlook on the web user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1742,13 +1925,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaVoiceCutoffBalance parameter specifies the resource consumption limits for an Outlook on the web voice user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1758,13 +1943,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaVoiceMaxBurst parameter specifies the amount of time that an Outlook on the web voice user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1774,13 +1961,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaVoiceMaxConcurrency parameter specifies how many concurrent connections an Outlook on the web voice user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The OwaVoiceMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 5. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1790,13 +1979,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaVoiceRechargeRate parameter specifies the rate at which an Outlook on the web voice user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1806,13 +1997,15 @@ Accept wildcard characters: False ``` ### -PopCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PopCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1822,13 +2015,15 @@ Accept wildcard characters: False ``` ### -PopMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PopMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1838,13 +2033,15 @@ Accept wildcard characters: False ``` ### -POPMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PopMaxConcurrency parameter specifies how many concurrent connections a POP user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The PopMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 20. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1854,6 +2051,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInAD parameter specifies the percentage of a minute a POP user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1862,7 +2062,6 @@ The POPPercentTimeInAD parameter specifies the percentage of a minute a POP user Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1872,6 +2071,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInCAS parameter specifies the percentage of a minute a POP user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1880,7 +2082,6 @@ The POPPercentTimeInCAS parameter specifies the percentage of a minute a POP use Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1890,6 +2091,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInMailboxRPC parameter specifies the percentage of a minute a POP user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1898,7 +2102,6 @@ The POPPercentTimeInMailboxRPC parameter specifies the percentage of a minute a Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1908,13 +2111,15 @@ Accept wildcard characters: False ``` ### -PopRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PopRechargeRate parameter specifies the rate at which the user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1924,13 +2129,15 @@ Accept wildcard characters: False ``` ### -PowerShellCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1940,13 +2147,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1956,13 +2165,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdletQueueDepth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxCmdletQueueDepth parameter specifies the number of operations allowed to be executed by the user. This value directly affects the behavior of the PowerShellMaxCmdlets and PowerShellMaxConcurrency parameters. For example, the PowerShellMaxConcurrency parameter consumes at least two operations defined by the PowerShellMaxCmdletQueueDepth parameter but additional operations are also consumed per cmdlet execution. The number of operations depends on the cmdlets executed. We recommend that the value for the PowerShellMaxCmdletQueueDepth parameter be at least three times larger than the value of the PowerShellMaxConcurrency parameter. This parameter won't affect Exchange admin center operations or Exchange Web Services operations. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1972,13 +2183,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxCmdlets parameter specifies the number of cmdlets that can be executed within a specific time period before their execution is stopped. The value specified by this parameter should be more than the value specified by the ExchangeMaxCmdlets parameter. The time period used for this limit is specified by the PowerShellMaxCmdletsTimePeriod parameter. Both values should be set at the same time. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1988,13 +2201,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdletsTimePeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxCmdletsTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine whether the number of cmdlets being executed exceeds the limits specified by the PowerShellMaxCmdlets and ExchangeMaxCmdlets parameters. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2004,6 +2219,9 @@ Accept wildcard characters: False ``` ### -PowerShellMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxConcurrency parameter specifies different information depending on context: - In the context of remote PowerShell, the PowerShellMaxConcurrency parameter specifies the maximum number of remote PowerShell sessions that a remote PowerShell user can have open at the same time. @@ -2015,7 +2233,6 @@ This parameter value doesn't necessarily correlate to the number of browsers ope Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2025,6 +2242,9 @@ Accept wildcard characters: False ``` ### -PowerShellMaxDestructiveCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxDestructiveCmdlets parameter specifies the number of destructive cmdlets that can be executed within a specific time period before their execution is stopped. Destructive cmdlets are cmdlets that can make significant changes to user data and configuration settings in your Exchange organization. Throttling these cmdlets may help prevent accidental data loss. The following cmdlets are designated as destructive: - Disable-Mailbox @@ -2043,7 +2263,6 @@ The time period used for this limit is specified by the PowerShellMaxDestructive Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2053,13 +2272,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxDestructiveCmdletsTimePeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxDestructiveCmdletsTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine how many destructive cmdlets can be run. You set a value for this parameter when you set the PowerShellMaxDestructiveCmdlets parameter. Both values should be set at the same time. For more information, see the description for the PowerShellMaxDestructiveCmdlets parameter. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2069,13 +2290,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxOperations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxOperations parameter specifies the protocol-level operations that are used to send and receive data. If the execution of a cmdlet results in a significant number of operations (for example, if there is a lot of input/output occurring), throttling may occur. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2085,13 +2308,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxRunspaces + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxRunspaces parameter specifies the number of concurrent Windows PowerShell sessions that a user is allowed to have. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2101,13 +2326,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxRunspacesTimePeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxRunspacesTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine how many Windows PowerShell sessions can be run. You set this value when you set the PowerShellMaxRunspaces parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2117,6 +2344,9 @@ Accept wildcard characters: False ``` ### -PowerShellMaxTenantConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxTenantConcurrency parameter limits the number of concurrent Windows PowerShell connections per tenant organization. By default, the limit for concurrent Windows PowerShell connections per tenant organization is set to 9. If users in a tenant organization try to make more concurrent requests than the limit set by the PowerShellMaxTenantConcurrency parameter, the new connection attempt fails. However, the existing connections remain valid. This limit is enforced even if a single user hasn't exceeded the per-user limit set by the PowerShellMaxConcurrency parameter. The PowerShellMaxTenantConcurrency parameter has a valid range from 0 through 100 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. This property can only be set for the default throttling policy. @@ -2125,7 +2355,6 @@ This property can only be set for the default throttling policy. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2135,13 +2364,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxTenantRunspaces + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxTenantRunspaces parameter specifies the number of concurrent Windows PowerShell sessions that a tenant is allowed to have. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2151,13 +2382,15 @@ Accept wildcard characters: False ``` ### -PowerShellRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellRechargeRate parameter specifies the rate at which the user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2167,6 +2400,9 @@ Accept wildcard characters: False ``` ### -PswsMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PswsMaxConcurrency parameter specifies how many concurrent connections a Windows PowerShell Web Services user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The PswsMaxConcurrency parameter has a default value of 18. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. @@ -2175,7 +2411,6 @@ The PswsMaxConcurrency parameter has a default value of 18. To indicate that the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2185,13 +2420,15 @@ Accept wildcard characters: False ``` ### -PswsMaxRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PswsMaxRequest parameter specifies how many requests a Windows PowerShell Web Services user can have against an Exchange server at one time. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2201,13 +2438,15 @@ Accept wildcard characters: False ``` ### -PswsMaxRequestTimePeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PswsMaxRequestTimePeriod parameter specifies the period of time, in seconds, that the throttling policy uses to determine how many requests can be run. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2217,13 +2456,15 @@ Accept wildcard characters: False ``` ### -PushNotificationCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2233,13 +2474,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2249,13 +2492,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxBurstPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2265,13 +2510,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2281,13 +2528,15 @@ Accept wildcard characters: False ``` ### -PushNotificationRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2297,13 +2546,15 @@ Accept wildcard characters: False ``` ### -PushNotificationRechargeRatePerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2313,13 +2564,15 @@ Accept wildcard characters: False ``` ### -PushNotificationSamplingPeriodPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2329,13 +2582,15 @@ Accept wildcard characters: False ``` ### -RcaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RcaCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2345,13 +2600,15 @@ Accept wildcard characters: False ``` ### -RcaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RcaMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2361,6 +2618,9 @@ Accept wildcard characters: False ``` ### -RCAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RcaMaxConcurrency parameter specifies how many concurrent connections an RPC Client Access user can have against an Exchange server at one time. A connection is held from the moment a request is received until the connection is closed or the connection is otherwise disconnected (for example, if the user goes offline). If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. A valid value is an integer from 0 through 4294967295, or the value unlimited. The default value is 40. @@ -2371,7 +2631,6 @@ To indicate that the number of concurrent connections should be unthrottled (no Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2381,6 +2640,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInAD parameter specifies the percentage of a minute that an Outlook user can spend executing directory requests. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2389,7 +2651,6 @@ The RCAPercentTimeInAD parameter specifies the percentage of a minute that an Ou Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2399,6 +2660,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInCAS parameter specifies the percentage of a minute that an Outlook user can spend executing CAS mailbox requests. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2407,7 +2671,6 @@ The RCAPercentTimeInCAS parameter specifies the percentage of a minute that an O Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2417,6 +2680,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an RPC Client Access user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2425,7 +2691,6 @@ The RCAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2435,13 +2700,15 @@ Accept wildcard characters: False ``` ### -RcaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RcaRechargeRate parameter specifies the rate at which the budget for the user is charged (how much the budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2451,13 +2718,15 @@ Accept wildcard characters: False ``` ### -RcaSharedCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RcaSharedCutoffBalance parameter specifies the resource consumption limits for all users before they're completely blocked from performing operations on a specific component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2467,13 +2736,15 @@ Accept wildcard characters: False ``` ### -RcaSharedMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RcaShardMaxBurst parameter specifies the amount of time that all users can consume elevated amounts of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2483,6 +2754,9 @@ Accept wildcard characters: False ``` ### -RcaSharedMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RcaSharedMaxConcurrency parameter specifies how many concurrent connections all RPC Client Access users can have against an Exchange server at one time. A connection is held from the moment a request is received until the connection is closed or the connection is otherwise disconnected (for example, if users go offline). If there are more concurrent requests than the policy allows, new connection attempts fail. However, the existing connections remain valid. The default value is unlimited, which means the limit is controlled individually for each user by the RcaMaxConcurrency parameter. @@ -2491,7 +2765,6 @@ The default value is unlimited, which means the limit is controlled individually Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2501,13 +2774,15 @@ Accept wildcard characters: False ``` ### -RcaSharedRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RcaSharedRechargeRate parameter specifies the rate at which the budget for all users is charged (how much the budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2517,13 +2792,15 @@ Accept wildcard characters: False ``` ### -RecipientRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecipientRateLimit parameter specifies the limits on the number of recipients that a user can address in a 24-hour period. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2533,13 +2810,15 @@ Accept wildcard characters: False ``` ### -SchedulesCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2549,13 +2828,15 @@ Accept wildcard characters: False ``` ### -SchedulesMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2565,13 +2846,15 @@ Accept wildcard characters: False ``` ### -SchedulesMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2581,13 +2864,15 @@ Accept wildcard characters: False ``` ### -SchedulesRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2597,13 +2882,15 @@ Accept wildcard characters: False ``` ### -SuiteCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2613,13 +2900,15 @@ Accept wildcard characters: False ``` ### -SuiteMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2629,13 +2918,15 @@ Accept wildcard characters: False ``` ### -SuiteMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2645,13 +2936,15 @@ Accept wildcard characters: False ``` ### -SuiteRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2661,6 +2954,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicyScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ThrottlingPolicyScope parameter specifies the scope of the throttling policy. You can use the following values. - Regular: Specifies a custom policy that applies to specific users. @@ -2673,7 +2969,6 @@ For more information about throttling policy scopes, see [User workload manageme Type: ThrottlingPolicyScopeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2683,13 +2978,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/New-TransportRule.md similarity index 88% rename from exchange/exchange-ps/exchange/New-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-TransportRule.md index c737eb0d8d..930b4c4913 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-TransportRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: New-TransportRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-transportrule +schema: 2.0.0 +title: New-TransportRule --- # New-TransportRule @@ -231,13 +232,15 @@ This example creates a rule with the following settings: ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -247,6 +250,9 @@ Accept wildcard characters: False ``` ### -ActivationDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + 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". @@ -255,7 +261,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,6 +270,9 @@ Accept wildcard characters: False ``` ### -ADComparisonAttribute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -307,7 +315,6 @@ If you don't use the ADComparisonOperator parameter, the default comparison oper Type: ADAttribute Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -317,6 +324,9 @@ Accept wildcard characters: False ``` ### -ADComparisonOperator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -330,7 +340,6 @@ The ADComparisonOperator parameter specifies the comparison operator for the ADC Type: Evaluation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -340,6 +349,9 @@ Accept wildcard characters: False ``` ### -AddManagerAsRecipientType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -357,7 +369,6 @@ This action only works if the sender's Manager attribute is defined. Type: AddedRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -367,6 +378,9 @@ Accept wildcard characters: False ``` ### -AddToRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -386,7 +400,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -396,6 +409,9 @@ Accept wildcard characters: False ``` ### -AnyOfCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -419,7 +435,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -429,6 +444,9 @@ Accept wildcard characters: False ``` ### -AnyOfCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -452,7 +470,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -462,6 +479,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -476,7 +496,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -486,6 +505,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -500,7 +522,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -510,6 +531,9 @@ Accept wildcard characters: False ``` ### -AnyOfToCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -533,7 +557,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -543,6 +566,9 @@ Accept wildcard characters: False ``` ### -AnyOfToCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -566,7 +592,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -576,6 +601,9 @@ Accept wildcard characters: False ``` ### -AnyOfToHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -599,7 +627,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -609,6 +636,9 @@ Accept wildcard characters: False ``` ### -AnyOfToHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -632,7 +662,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -642,6 +671,9 @@ Accept wildcard characters: False ``` ### -ApplyClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -654,7 +686,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -664,6 +695,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerFallbackAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -687,7 +721,6 @@ If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the Type: DisclaimerFallbackAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -697,6 +730,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -712,7 +748,6 @@ If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the Type: DisclaimerLocation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -722,6 +757,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -762,7 +800,6 @@ You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the Type: DisclaimerText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -772,6 +809,9 @@ Accept wildcard characters: False ``` ### -ApplyOME + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -785,7 +825,6 @@ The ApplyOME parameter specifies an action that encrypts messages and their atta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -795,6 +834,9 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionCustomizationTemplate + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -805,7 +847,6 @@ The ApplyRightsProtectionCustomizationTemplate parameter specifies an action tha Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -815,6 +856,9 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -831,7 +875,6 @@ For more information, see [Transport protection rules](https://learn.microsoft.c Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -841,6 +884,9 @@ Accept wildcard characters: False ``` ### -AttachmentContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -853,7 +899,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -863,6 +908,9 @@ Accept wildcard characters: False ``` ### -AttachmentExtensionMatchesWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -875,7 +923,6 @@ The AttachmentExtensionMatchesWords parameter specifies a condition that looks f Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -885,6 +932,9 @@ Accept wildcard characters: False ``` ### -AttachmentHasExecutableContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -900,7 +950,6 @@ The system inspects the file properties rather than relying on the file's extens Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -910,6 +959,9 @@ Accept wildcard characters: False ``` ### -AttachmentIsPasswordProtected + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -923,7 +975,6 @@ The AttachmentIsPasswordProtected parameter specifies a condition that looks for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -933,6 +984,9 @@ Accept wildcard characters: False ``` ### -AttachmentIsUnsupported + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -952,7 +1006,6 @@ In Exchange 2010, to extend the list of supported file types, see [Register Filt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -962,6 +1015,9 @@ Accept wildcard characters: False ``` ### -AttachmentMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -976,7 +1032,6 @@ Only the first 150 kilobytes (KB) of the attachment is scanned when trying to ma Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -986,6 +1041,9 @@ Accept wildcard characters: False ``` ### -AttachmentNameMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -996,7 +1054,6 @@ The AttachmentNameMatchesPatterns parameter specifies a condition that looks for Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1006,6 +1063,9 @@ Accept wildcard characters: False ``` ### -AttachmentProcessingLimitExceeded + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1021,7 +1081,6 @@ You use this condition to create rules that work together with other attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1031,6 +1090,9 @@ Accept wildcard characters: False ``` ### -AttachmentPropertyContainsWords + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1060,7 +1122,6 @@ When you specify multiple properties, or multiple values for the same property, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1070,6 +1131,9 @@ Accept wildcard characters: False ``` ### -AttachmentSizeOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -1092,7 +1156,6 @@ The embedded images are treated as attachments (for example, messages with a pic Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1102,6 +1165,9 @@ Accept wildcard characters: False ``` ### -BetweenMemberOf1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1121,7 +1187,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1131,6 +1196,9 @@ Accept wildcard characters: False ``` ### -BetweenMemberOf2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1150,7 +1218,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1160,6 +1227,9 @@ Accept wildcard characters: False ``` ### -BlindCopyTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1179,7 +1249,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1189,13 +1258,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Comments parameter specifies optional descriptive text for the rule (for example, what the rule is used for, or how it has changed over time). The length of the comment can't exceed 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1205,6 +1276,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -1214,7 +1288,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1224,6 +1297,9 @@ Accept wildcard characters: False ``` ### -ContentCharacterSetContainsWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1236,7 +1312,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1246,6 +1321,9 @@ Accept wildcard characters: False ``` ### -CopyTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1265,7 +1343,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1275,6 +1352,9 @@ Accept wildcard characters: False ``` ### -DeleteMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1288,7 +1368,6 @@ The DeleteMessage parameter specifies an action that silently drops messages wit Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1298,6 +1377,9 @@ Accept wildcard characters: False ``` ### -Disconnect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -1311,7 +1393,6 @@ The Disconnect parameter specifies an action that ends the SMTP connection betwe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1321,6 +1402,9 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This parameter is functional only in on-premises Exchange. The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see [Data loss prevention in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). @@ -1329,7 +1413,6 @@ The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's a Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1339,6 +1422,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -1349,7 +1435,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1359,6 +1444,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the new rule is created as enabled or disabled. Valid values are: - $true: The new rule is enabled. This is the default value. @@ -1370,7 +1458,6 @@ To enable or disable a rule after you create it, use the Enable-TransportRule an Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1380,6 +1467,9 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonAttribute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1422,7 +1512,6 @@ If you don't use the ExceptIfADComparisonOperator parameter, the default compari Type: ADAttribute Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1432,6 +1521,9 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonOperator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1445,7 +1537,6 @@ The ExceptIfADComparisonOperator parameter specifies the comparison operator for Type: Evaluation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1455,6 +1546,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1478,7 +1572,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1488,6 +1581,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1511,7 +1607,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1521,6 +1616,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1535,7 +1633,6 @@ A match for this exception prevents the rule action from being applied to all re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1545,6 +1642,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1559,7 +1659,6 @@ A match for this exception prevents the rule action from being applied to all re Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1569,6 +1668,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1592,7 +1694,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1602,6 +1703,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1625,7 +1729,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1635,6 +1738,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1658,7 +1764,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1668,6 +1773,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1691,7 +1799,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1701,6 +1808,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1713,7 +1823,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1723,6 +1832,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentExtensionMatchesWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1735,7 +1847,6 @@ The ExceptIfAttachmentExtensionMatchesWords parameter specifies an exception tha Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1745,6 +1856,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentHasExecutableContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1760,7 +1874,6 @@ The system inspects the file properties rather than relying on the file extensio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1770,6 +1883,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsPasswordProtected + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1783,7 +1899,6 @@ The ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1793,6 +1908,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsUnsupported + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1812,7 +1930,6 @@ In Exchange 2010, to extend the list of supported file types, see [Register Filt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1822,6 +1939,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1836,7 +1956,6 @@ Only the first 150 KB of the attachment is scanned when trying to match a text p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1846,6 +1965,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentNameMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1856,7 +1978,6 @@ The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1866,6 +1987,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentProcessingLimitExceeded + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1881,7 +2005,6 @@ You use this exception to create rules that work together with other attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1891,6 +2014,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentPropertyContainsWords + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1920,7 +2046,6 @@ When you specify multiple properties, or multiple values for the same property, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1930,6 +2055,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentSizeOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1950,7 +2078,6 @@ Unqualified values are typically treated as bytes, but small values may be round Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1960,6 +2087,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1979,7 +2109,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1989,6 +2118,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2008,7 +2140,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2018,6 +2149,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2030,7 +2164,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2040,6 +2173,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2061,7 +2197,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2071,6 +2206,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2083,7 +2221,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2093,6 +2230,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2107,7 +2247,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2117,6 +2256,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2138,7 +2280,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2148,6 +2289,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2161,7 +2305,6 @@ The ExceptIfFromScope parameter specifies an exception that looks for the locati Type: FromUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2171,6 +2314,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2187,7 +2333,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2197,6 +2342,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasNoClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2210,7 +2358,6 @@ The ExceptIfHasNoClassification parameter specifies an exception that looks for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2220,6 +2367,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. @@ -2235,7 +2385,6 @@ The ExceptIfHasSenderOverride parameter specifies an exception that looks for me Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2245,6 +2394,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2255,7 +2407,6 @@ The ExceptIfHeaderContainsMessageHeader parameter specifies the name of header f Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2265,6 +2416,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2279,7 +2433,6 @@ You specify the header field to search by using the ExceptIfHeaderContainsMessag Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2289,6 +2442,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2299,7 +2455,6 @@ The ExceptIfHeaderMatchesMessageHeader parameter specifies the name of header fi Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2309,6 +2464,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2321,7 +2479,6 @@ You specify the header field to search by using the ExceptIfHeaderMatchesMessage Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2331,6 +2488,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2352,7 +2512,6 @@ You specify if you want to look for these users as managers of senders or recipi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2362,6 +2521,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerForEvaluatedUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2377,7 +2539,6 @@ You specify the users to look for by using the ExceptIfManagerAddresses paramete Type: EvaluatedUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2387,6 +2548,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageContainsDataClassifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. @@ -2403,7 +2567,6 @@ For a list of sensitive information types available, see [Sensitive information Type: Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2413,6 +2576,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2433,7 +2599,6 @@ Unqualified values are typically treated as bytes, but small values may be round Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2443,6 +2608,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2463,7 +2631,6 @@ The ExceptIfMessageTypeMatches parameter specifies an exception that looks for m Type: MessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2473,6 +2640,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2519,7 +2689,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2529,6 +2698,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2573,7 +2745,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2583,6 +2754,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2593,7 +2767,6 @@ The ExceptIfRecipientAddressContainsWords parameter specifies an exception that Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2603,6 +2776,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2615,7 +2791,6 @@ This parameter works when the recipient is an individual user. This parameter do Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2625,6 +2800,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2637,7 +2815,6 @@ This exception matches domains and subdomains. For example, "contoso.com" matche Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2647,6 +2824,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientInSenderList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2655,7 +2835,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2665,6 +2844,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2680,7 +2862,6 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2690,6 +2871,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2736,7 +2920,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2746,6 +2929,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2790,7 +2976,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2800,6 +2985,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2814,7 +3002,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2824,6 +3011,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderInRecipientList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2832,7 +3022,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2842,6 +3031,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIpRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2860,7 +3052,6 @@ In Exchange Online, the IP address that's used during evaluation of this excepti Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2870,6 +3061,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderManagementRelationship + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2883,7 +3077,6 @@ The ExceptIfSenderManagementRelationship parameter specifies an exception that l Type: ManagementRelationship Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2893,6 +3086,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2912,7 +3108,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2922,6 +3117,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: @@ -2939,7 +3137,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2949,6 +3146,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2964,7 +3164,6 @@ The ExceptIfSentToScope parameter specifies an exception that looks for the loca Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2974,6 +3173,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2988,7 +3190,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2998,6 +3199,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3008,7 +3212,6 @@ The ExceptIfSubjectMatchesPatterns parameter specifies an exception that looks f Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3018,6 +3221,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3032,7 +3238,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3042,6 +3247,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3052,7 +3260,6 @@ The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception that l Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3062,6 +3269,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -3076,7 +3286,6 @@ The ExceptIfWithImportance parameter specifies an exception that looks for messa Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3086,6 +3295,9 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. @@ -3096,7 +3308,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3106,6 +3317,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3127,7 +3341,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3137,6 +3350,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3149,7 +3365,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3159,6 +3374,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3173,7 +3391,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3183,6 +3400,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3204,7 +3424,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3214,6 +3433,9 @@ Accept wildcard characters: False ``` ### -FromScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3227,7 +3449,6 @@ The FromScope parameter specifies a condition that looks for the location of mes Type: FromUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3237,6 +3458,9 @@ Accept wildcard characters: False ``` ### -GenerateIncidentReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -3256,7 +3480,6 @@ The GenerateIncidentReport parameter specifies where to send the incident report Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3266,6 +3489,9 @@ Accept wildcard characters: False ``` ### -GenerateNotification + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -3287,7 +3513,6 @@ The maximum number of characters is 5120. Type: DisclaimerText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3297,6 +3522,9 @@ Accept wildcard characters: False ``` ### -HasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3313,7 +3541,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3323,6 +3550,9 @@ Accept wildcard characters: False ``` ### -HasNoClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3336,7 +3566,6 @@ The HasNoClassification parameter specifies a condition that looks for messages Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3346,6 +3575,9 @@ Accept wildcard characters: False ``` ### -HasSenderOverride + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. @@ -3361,7 +3593,6 @@ The HasSenderOverride parameter specifies a condition that looks for messages wh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3371,6 +3602,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3381,7 +3615,6 @@ The HeaderContainsMessageHeader parameter specifies the name of header field in Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3391,6 +3624,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3405,7 +3641,6 @@ You specify the header field to search by using the HeaderContainsMessageHeader Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3415,6 +3650,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3425,7 +3663,6 @@ The HeaderMatchesMessageHeader parameter specifies the name of header field in t Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3435,6 +3672,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3447,7 +3687,6 @@ You specify the header field to search by using the HeaderMatchesMessageHeader p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3457,6 +3696,9 @@ Accept wildcard characters: False ``` ### -IncidentReportContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -3484,7 +3726,6 @@ You use this parameter with the GenerateIncidentReport parameter. Type: IncidentReportContent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3494,6 +3735,9 @@ Accept wildcard characters: False ``` ### -IncidentReportOriginalMail + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter has been deprecated and is no longer used. Use the IncidentReportContent parameter instead. The value AttachOriginalMail on the IncidentReportContent parameter is equivalent to setting this parameter to the value IncludeOriginalMail. @@ -3511,7 +3755,6 @@ The IncidentReportOriginalMail parameter specifies whether to include the origin Type: IncidentReportOriginalMail Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -3521,6 +3764,9 @@ Accept wildcard characters: False ``` ### -LogEventText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -3539,7 +3785,6 @@ The entry contains the following information: Type: EventLogText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3549,6 +3794,9 @@ Accept wildcard characters: False ``` ### -ManagerAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3570,7 +3818,6 @@ You specify if you want to look for these users as managers of senders or recipi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3580,6 +3827,9 @@ Accept wildcard characters: False ``` ### -ManagerForEvaluatedUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3595,7 +3845,6 @@ You specify the users to look for by using the ManagerAddresses parameter. Type: EvaluatedUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3605,6 +3854,9 @@ Accept wildcard characters: False ``` ### -MessageContainsDataClassifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. @@ -3623,7 +3875,6 @@ You can specify the notification options by using the NotifySender parameter. Type: Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3633,6 +3884,9 @@ Accept wildcard characters: False ``` ### -MessageSizeOver + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3653,7 +3907,6 @@ Unqualified values are typically treated as bytes, but small values may be round Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3663,6 +3916,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3683,7 +3939,6 @@ The MessageTypeMatches parameter specifies a condition that looks for messages o Type: MessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3693,6 +3948,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Mode parameter specifies how the rule operates. Valid values are: - Audit: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport action occurs. @@ -3703,7 +3961,6 @@ The Mode parameter specifies how the rule operates. Valid values are: Type: RuleMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3713,6 +3970,9 @@ Accept wildcard characters: False ``` ### -ModerateMessageByManager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -3728,7 +3988,6 @@ This action only works if the sender's Manager attribute is defined. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3738,6 +3997,9 @@ Accept wildcard characters: False ``` ### -ModerateMessageByUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -3759,7 +4021,6 @@ You can't use a distribution group as a moderator. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3769,6 +4030,9 @@ Accept wildcard characters: False ``` ### -NotifySender + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -3793,7 +4057,6 @@ This action is applicable to messages sent by internal users only. External send Type: NotifySenderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3803,6 +4066,9 @@ Accept wildcard characters: False ``` ### -PrependSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -3815,7 +4081,6 @@ Consider ending the value for this parameter with a colon (:) and a space, or at Type: SubjectPrefix Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3825,6 +4090,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -3839,7 +4107,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3849,6 +4116,9 @@ Accept wildcard characters: False ``` ### -Quarantine + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Edge Transport servers. @@ -3864,7 +4134,6 @@ If this action is in a rule that's not the last rule in the list, rule evaluatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3874,6 +4143,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3920,7 +4192,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3930,6 +4201,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3974,7 +4248,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3984,6 +4257,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3994,7 +4270,6 @@ The RecipientAddressContainsWords parameter specifies a condition that looks for Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4004,6 +4279,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4016,7 +4294,6 @@ This parameter works when the recipient is an individual user. This parameter do Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4026,6 +4303,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressType + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecipientAddressType parameter specifies how conditions and exceptions check recipient email addresses. Valid values are: @@ -4037,7 +4317,6 @@ The RecipientAddressType parameter specifies how conditions and exceptions check Type: RecipientAddressType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4047,6 +4326,9 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4059,7 +4341,6 @@ This condition matches domains and subdomains. For example, "contoso.com" matche Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4069,6 +4350,9 @@ Accept wildcard characters: False ``` ### -RecipientInSenderList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -4077,7 +4361,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4087,6 +4370,9 @@ Accept wildcard characters: False ``` ### -RedirectMessageTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4106,7 +4392,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4116,6 +4401,9 @@ Accept wildcard characters: False ``` ### -RejectMessageEnhancedStatusCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -4132,7 +4420,6 @@ To further customize the NDR (for example, multiple languages), you need to crea Type: RejectEnhancedStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4142,6 +4429,9 @@ Accept wildcard characters: False ``` ### -RejectMessageReasonText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -4162,7 +4452,6 @@ To further customize the NDR (for example, multiple languages), you need to crea Type: RejectText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4172,6 +4461,9 @@ Accept wildcard characters: False ``` ### -RemoveHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4182,7 +4474,6 @@ The RemoveHeader parameter specifies an action that removes a header field from Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4192,6 +4483,9 @@ Accept wildcard characters: False ``` ### -RemoveOME + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4205,7 +4499,6 @@ The RemoveOME parameter specifies an action that removes the previous version of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4215,6 +4508,9 @@ Accept wildcard characters: False ``` ### -RemoveOMEv2 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4228,7 +4524,6 @@ The RemoveOMEv2 parameter specifies an action that removes Microsoft Purview Mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4238,6 +4533,9 @@ Accept wildcard characters: False ``` ### -RemoveRMSAttachmentEncryption + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4253,7 +4551,6 @@ The RemoveRMSAttachmentEncryption parameter specifies an action that removes Mic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4263,6 +4560,9 @@ Accept wildcard characters: False ``` ### -RouteMessageOutboundConnector + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4277,7 +4577,6 @@ The RouteMessageOutboundConnector parameter specifies an action that routes mess Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4287,6 +4586,9 @@ Accept wildcard characters: False ``` ### -RouteMessageOutboundRequireTls + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -4300,7 +4602,6 @@ The RouteMessageOutboundRequireTls parameter specifies an action that uses Trans Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4310,6 +4611,9 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RuleErrorAction parameter specifies what to do if rule processing can't be completed on messages. Valid values are: - Ignore: The message is sent anyway. This is the default value. @@ -4319,7 +4623,6 @@ The RuleErrorAction parameter specifies what to do if rule processing can't be c Type: RuleErrorAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4329,6 +4632,9 @@ Accept wildcard characters: False ``` ### -RuleSubType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RuleSubType parameter specifies the rule type. Valid values are: - Dlp: The rule is associated with a DLP policy. This value is meaningful only in on-premises Exchange. @@ -4338,7 +4644,6 @@ The RuleSubType parameter specifies the rule type. Valid values are: Type: RuleSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4348,6 +4653,9 @@ Accept wildcard characters: False ``` ### -SCLOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4363,7 +4671,6 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4373,6 +4680,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4419,7 +4729,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4429,6 +4738,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4473,7 +4785,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4483,6 +4794,9 @@ Accept wildcard characters: False ``` ### -SenderAddressLocation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: - Header: Only examine senders in the message headers. For example, in on-premises Exchange the From, Sender, or Reply-To fields. In Exchange Online, the From field only. This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). @@ -4501,7 +4815,6 @@ Message envelope searching is available only for the following conditions and ex Type: SenderAddressLocation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4511,6 +4824,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4525,7 +4841,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4535,6 +4850,9 @@ Accept wildcard characters: False ``` ### -SenderInRecipientList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -4543,7 +4861,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4553,6 +4870,9 @@ Accept wildcard characters: False ``` ### -SenderIpRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4571,7 +4891,6 @@ In Exchange Online, the IP address that's used during evaluation of this conditi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4581,6 +4900,9 @@ Accept wildcard characters: False ``` ### -SenderManagementRelationship + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4594,7 +4916,6 @@ The SenderManagementRelationship parameter specifies a condition that looks for Type: ManagementRelationship Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4604,6 +4925,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4623,7 +4947,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4633,6 +4956,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4654,7 +4980,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4664,6 +4989,9 @@ Accept wildcard characters: False ``` ### -SentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4679,7 +5007,6 @@ The SentToScope parameter specifies a condition that looks for the location of r Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4689,6 +5016,9 @@ Accept wildcard characters: False ``` ### -SetAuditSeverity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -4704,7 +5034,6 @@ The SetAuditSeverity parameter specifies an action that sets the severity level Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4714,6 +5043,9 @@ Accept wildcard characters: False ``` ### -SetHeaderName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4724,7 +5056,6 @@ The SetHeaderName parameter specifies an action that adds or modifies a header f Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4734,6 +5065,9 @@ Accept wildcard characters: False ``` ### -SetHeaderValue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4744,7 +5078,6 @@ The SetHeaderValue parameter specifies an action that adds or modifies a header Type: HeaderValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4754,6 +5087,9 @@ Accept wildcard characters: False ``` ### -SetSCL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4767,7 +5103,6 @@ The SetSCL parameter specifies an action that adds or modifies the SCL value of Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4777,6 +5112,9 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectStatusCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4789,7 +5127,6 @@ You can use this parameter with the SmtpRejectMessageRejectText parameter. If yo Type: RejectStatusCode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4799,6 +5136,9 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4811,7 +5151,6 @@ You can use this parameter with the SmtpRejectMessageRejectStatusCode parameter. Type: RejectText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4821,6 +5160,9 @@ Accept wildcard characters: False ``` ### -StopRuleProcessing + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4834,7 +5176,6 @@ The StopRuleProcessing parameter specifies an action that stops processing more Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4844,6 +5185,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4858,7 +5202,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4868,6 +5211,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4878,7 +5224,6 @@ The SubjectMatchesPatterns parameter specifies a condition that looks for text p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4888,6 +5233,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4902,7 +5250,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4912,6 +5259,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4922,7 +5272,6 @@ The SubjectOrBodyMatchesPatterns parameter specifies a condition that looks for Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4932,6 +5281,9 @@ Accept wildcard characters: False ``` ### -UseLegacyRegex + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The UseLegacyRegex parameter specifies whether the rule uses regular expression syntax that's compatible with Exchange Server 2010. Valid values are: - $true: Regular expression syntax that's compatible with Exchange 2010. @@ -4941,7 +5293,6 @@ The UseLegacyRegex parameter specifies whether the rule uses regular expression Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4951,13 +5302,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4967,6 +5320,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4981,7 +5337,6 @@ The WithImportance parameter specifies a condition that looks for messages with Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/New-UMAutoAttendant.md similarity index 90% rename from exchange/exchange-ps/exchange/New-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMAutoAttendant.md index 7f9922c4c4..1ce66f96fd 100644 --- a/exchange/exchange-ps/exchange/New-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: New-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-umautoattendant +schema: 2.0.0 +title: New-UMAutoAttendant --- # New-UMAutoAttendant @@ -58,13 +59,15 @@ This example creates the speech-enabled UM auto attendant MyUMAutoAttendant usin ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the UM auto attendant. The display name for the UM auto attendant can contain as many as 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan identifier for the UM dial plan to be associated with this UM auto attendant. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -99,7 +107,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -DTMFFallbackAutoAttendant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DTMFFallbackAutoAttendant parameter specifies a secondary UM auto attendant. A secondary UM auto attendant can be used only if the SpeechEnabled parameter is set to $true. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -141,13 +152,15 @@ Accept wildcard characters: False ``` ### -PilotIdentifierList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PilotIdentifierList parameter specifies a list of one or more pilot numbers. Pilot numbers route incoming calls to Mailbox servers. The calls are then answered by the UM auto attendant. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -157,13 +170,15 @@ Accept wildcard characters: False ``` ### -SpeechEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SpeechEnabled parameter specifies whether the UM auto attendant is speech-enabled. The default value is $true. If this parameter is omitted, or if the value is $false, the UM auto attendant isn't speech-enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -173,6 +188,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Status parameter specifies whether the UM auto attendant being created will be enabled. Valid values are: - Enabled @@ -182,7 +200,6 @@ The Status parameter specifies whether the UM auto attendant being created will Type: StatusEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -192,13 +209,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/New-UMCallAnsweringRule.md similarity index 93% rename from exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMCallAnsweringRule.md index 4fa9e1f46e..b90838c318 100644 --- a/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: New-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-umcallansweringrule +schema: 2.0.0 +title: New-UMCallAnsweringRule --- # New-UMCallAnsweringRule @@ -120,13 +121,15 @@ This example creates the call answering rule MyCallAnsweringRule in the mailbox ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the name of the Unified Messaging (UM) call answering rule or Call Answering Rule ID being modified. The call answering ID or name must be unique per the user's UM-enabled mailbox. The name or ID for the call answering rule can contain up to 255 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -136,13 +139,15 @@ Accept wildcard characters: False ``` ### -CallerIds + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CallerIds parameter specifies an entry for the "If the Caller is" condition. Each entry for this parameter can contain a phone number, an Active Directory contact, a personal contact, or the personal Contacts folder. The parameter can contain 50 phone numbers or contact entries and no more than one entry for specifying the default Contacts folder. If the CallerIds parameter doesn't contain a condition, the condition isn't set and is ignored. The default value is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -152,13 +157,15 @@ Accept wildcard characters: False ``` ### -CallersCanInterruptGreeting + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CallersCanInterruptGreeting parameter specifies whether a caller can interrupt the voice mail greeting while it's being played. The default is $null. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -168,13 +175,15 @@ Accept wildcard characters: False ``` ### -CheckAutomaticReplies + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CheckAutomaticReplies parameter specifies an entry for the "If My Automatic Replies are Enabled" condition. The default is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -184,6 +193,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -193,7 +205,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -203,13 +214,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -219,13 +232,15 @@ Accept wildcard characters: False ``` ### -ExtensionsDialed + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The ExtensionsDialed parameter specifies an entry for the "If the Caller Dials" condition. Each entry must be unique per call answering rule. Each extension must correspond to existing extension numbers assigned to UM-enabled users. The default is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -235,13 +250,15 @@ Accept wildcard characters: False ``` ### -KeyMappings + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The KeyMappings parameter specifies a key mapping entry for a call answering rule. The key mappings are those menu options offered to callers if the call answering rule is set to $true. You can configure a maximum of 10 entries. None of the defined key mappings can overlap. The default is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule is created. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -270,7 +290,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -280,13 +299,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Priority parameter specifies the order that the call answering rule will be evaluated against other existing call answering rules. Call answering rules are processed in order of increasing priority values. The priority must be unique between all call answering rules in the UM-enabled mailbox. The priority on the call answering rule must be between 1 (highest) and 9 (lowest). The default is 9. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -296,6 +317,9 @@ Accept wildcard characters: False ``` ### -ScheduleStatus + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The ScheduleStatus parameter specifies an entry for the "If my Schedule show that I am" condition. Users can specify their free/busy status to be checked. This parameter can be set from 0 through 15 and is interpreted as a 4-bit mask that represents the calendar status including Free, Tentative, Busy, and Out of Office. The following settings can be used to set the schedule status: - None = 0x0 @@ -310,7 +334,6 @@ The default setting is $null. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -320,13 +343,15 @@ Accept wildcard characters: False ``` ### -TimeOfDay + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The TimeOfDay parameter specifies an entry for the "If the Call Arrives During" condition for the call answering rule. You can specify working hours, non-working hours, or custom hours. The default is $null. ```yaml Type: TimeOfDay Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -336,13 +361,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMDialPlan.md b/exchange/exchange-ps/ExchangePowerShell/New-UMDialPlan.md similarity index 89% rename from exchange/exchange-ps/exchange/New-UMDialPlan.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMDialPlan.md index 5b47dbb7ad..ae5a236e98 100644 --- a/exchange/exchange-ps/exchange/New-UMDialPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMDialPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: New-UMDialPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-umdialplan +schema: 2.0.0 +title: New-UMDialPlan --- # New-UMDialPlan @@ -69,13 +70,15 @@ This example creates the unsecured UM dial plan MyUMDialPlan that supports E.164 ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name of the UM dial plan. This description is presented to the administrator when a user is enabled for Unified Messaging. The UM dial plan name field can contain as many as 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -CountryOrRegionCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is located. For example, 1 is the code used for North America and 44 is the code used for the United Kingdom. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -NumberOfDigitsInExtension + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NumberOfDigitsInExtension parameter specifies the fixed number of digits in an extension number. The range for this parameter is from 1 through 20 digits. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -AccessTelephoneNumbers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AccessTelephoneNumbers parameter specifies the telephone number or numbers used for subscriber access. These numbers are sometimes referred to as pilot or pilot ID numbers. The telephone number is limited to 32 characters. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -142,7 +154,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -DefaultLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DefaultLanguage parameter specifies the default language of the system. This default language is selected from the list of available languages. If there are no other UM language packs installed, the default value is en-US. ```yaml Type: UMLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -184,13 +199,15 @@ Accept wildcard characters: False ``` ### -FaxEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The FaxEnabled parameter specifies whether the Mailbox servers associated with the dial plan answer and process incoming fax calls. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -200,13 +217,15 @@ Accept wildcard characters: False ``` ### -GenerateUMMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The GenerateUMMailboxPolicy parameter specifies whether a default UM mailbox policy is created when the UM dial plan is created. The default setting is to create a UM mailbox when the UM dial plan is created. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -216,13 +235,15 @@ Accept wildcard characters: False ``` ### -URIType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The URIType parameter specifies the URI type to be sent and received with SIP messages from the Private Branch eXchange (PBX). ```yaml Type: UMURIType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -232,13 +253,15 @@ Accept wildcard characters: False ``` ### -VoIPSecurity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoIPSecurity parameter specifies whether the signaling channel is encrypted using mutual Transport Layer Security (TLS). The default setting is Unsecured. ```yaml Type: UMVoIPSecurityType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -248,13 +271,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMHuntGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-UMHuntGroup.md similarity index 90% rename from exchange/exchange-ps/exchange/New-UMHuntGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMHuntGroup.md index c471f60d1e..01d67f8d5e 100644 --- a/exchange/exchange-ps/exchange/New-UMHuntGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMHuntGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-umhuntgroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: New-UMHuntGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-umhuntgroup +schema: 2.0.0 +title: New-UMHuntGroup --- # New-UMHuntGroup @@ -55,13 +56,15 @@ This example creates the UM hunt group MyUMHuntGroup that has multiple pilot ide ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the UM hunt group name used for display purposes. This string can contain as many as 64 characters and it must be unique. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan used with the UM hunt group. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -UMIPGateway + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMIPGateway parameter specifies the UM IP gateway to be associated with the UM hunt group. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -112,7 +122,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -PilotIdentifier + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PilotIdentifier parameter specifies the number string used to uniquely identify the pilot access number for the specified IP gateway. This number must match the subscriber access number configured in the UM dial plan. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/New-UMIPGateway.md similarity index 91% rename from exchange/exchange-ps/exchange/New-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMIPGateway.md index 3e03d94273..16e27a7fae 100644 --- a/exchange/exchange-ps/exchange/New-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: New-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-umipgateway +schema: 2.0.0 +title: New-UMIPGateway --- # New-UMIPGateway @@ -63,13 +64,15 @@ This example creates the UM IP gateway MyUMIPGateway that enables a Mailbox serv ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the UM IP gateway. The name for the new UM IP gateway can contain up to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -Address + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Address parameter specifies the IP address configured on the IP gateway or SIP-enabled IP PBX. ```yaml Type: UMSmartHost Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -104,7 +112,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -122,7 +132,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -IPAddressFamily + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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. @@ -142,7 +154,6 @@ The IPAddressFamily parameter specifies whether the UM IP gateway will use Inter Type: IPAddressFamily Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan to be associated with the UM IP gateway. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-UMMailboxPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/New-UMMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-UMMailboxPolicy.md index 3ab4d1f26f..66e7527fc8 100644 --- a/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UMMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: New-UMMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-ummailboxpolicy +schema: 2.0.0 +title: New-UMMailboxPolicy --- # New-UMMailboxPolicy @@ -47,13 +48,15 @@ This example creates the UM mailbox policy MyUMMailboxPolicy associated with the ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the UM mailbox policy. The name for the UM mailbox policy can contain as many as 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the identifier for the UM dial plan to be associated with the UM mailbox policy. This parameter is the directory object ID for the UM dial plan. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -114,13 +123,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/New-UnifiedAuditLogRetentionPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/New-UnifiedAuditLogRetentionPolicy.md index 2196b0f833..cf6d755473 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UnifiedAuditLogRetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-unifiedauditlogretentionpolicy applicable: Security & Compliance -title: New-UnifiedAuditLogRetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-unifiedauditlogretentionpolicy +schema: 2.0.0 +title: New-UnifiedAuditLogRetentionPolicy --- # New-UnifiedAuditLogRetentionPolicy @@ -55,13 +56,15 @@ This example creates an audit log retention policy that retains all audit logs f ## PARAMETERS ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the audit log retention policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A higher integer value indicates a lower priority. The value 1 is the highest priority, and the value 10000 is the lowest priority. No two policies can have the same priority value. This parameter is required when you create an audit log retention policy, and you must use a unique priority value. @@ -81,7 +87,6 @@ Any custom audit log retention policy that you create will take precedence over Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies how long audit log records are kept. Valid values are: - ThreeMonths @@ -104,7 +112,6 @@ Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears -Applicable: Security & Compliance Required: True Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -123,7 +133,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the audit log retention policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -Operations + +> Applicable: Security & Compliance + The Operations parameter specifies the audit log operations that are retained by the policy. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -159,7 +173,6 @@ If you use this parameter, you must also use the RecordTypes parameter to specif Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -RecordTypes + +> Applicable: Security & Compliance + The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). You can specify multiple values separated by commas. If you specify more than one value, you can't use the Operations parameter. @@ -177,7 +193,6 @@ You can specify multiple values separated by commas. If you specify more than on Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Security & Compliance + The UserIds parameter specifies the audit logs that are retained by the policy based on the ID of the user who performed the action. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -195,7 +213,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -205,13 +222,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-UnifiedGroup.md b/exchange/exchange-ps/ExchangePowerShell/New-UnifiedGroup.md similarity index 93% rename from exchange/exchange-ps/exchange/New-UnifiedGroup.md rename to exchange/exchange-ps/ExchangePowerShell/New-UnifiedGroup.md index 7490a242d1..644cb77055 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-UnifiedGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup applicable: Exchange Online, Exchange Online Protection -title: New-UnifiedGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-unifiedgroup +schema: 2.0.0 +title: New-UnifiedGroup --- # New-UnifiedGroup @@ -140,6 +141,9 @@ This example creates a new Microsoft 365 Group named Engineering Department. ## PARAMETERS ### -DisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the name of the Microsoft 365 Group. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). For Microsoft 365 Groups, the DisplayName value is used in the unique Name property. However, because the DisplayName value doesn't need to be unique, the DisplayName value is appended with an underscore character (\_) and a short GUID value when it's used for the Name property. @@ -148,7 +152,6 @@ For Microsoft 365 Groups, the DisplayName value is used in the unique Name prope Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -158,6 +161,9 @@ Accept wildcard characters: False ``` ### -DlIdentity + +> Applicable: Exchange Online, Exchange Online Protection + The DlIdentity parameter specifies the distribution group (also known as a distribution list or DL) that you want to migrate to a Microsoft 365 Group. The distribution group must be a universal distribution group (the RecipientTypeDetails property value is MailUniversalDistributionGroup). You can use any value that uniquely identifies the distribution group. For example: - Name @@ -177,7 +183,6 @@ Microsoft 365 Groups don't have ReportToManager and ReportToOriginator parameter Type: DistributionGroupIdParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -187,6 +192,9 @@ Accept wildcard characters: False ``` ### -AccessType + +> Applicable: Exchange Online, Exchange Online Protection + The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Valid values are: - Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. This is the default value. @@ -200,7 +208,6 @@ You can change the privacy type at any point in the lifecycle of the group. Type: ModernGroupTypeInfo Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,6 +217,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Microsoft 365 Group. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -229,7 +239,6 @@ The Alias value is appended with the ExternalDirectoryObjectId property value an Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -239,6 +248,9 @@ Accept wildcard characters: False ``` ### -AlwaysSubscribeMembersToCalendarEvents + +> Applicable: Exchange Online, Exchange Online Protection + The AlwaysSubscribeMembersToCalendarEvents switch controls the default subscription settings of new members that are added to the Microsoft 365 Group. - If you use this switch without a value, all future members that are added to the group will have their subscriptions set to ReplyAndEvents. @@ -252,7 +264,6 @@ The AutoSubscribeNewMembers switch overrides this switch. Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -262,6 +273,9 @@ Accept wildcard characters: False ``` ### -AutoSubscribeNewMembers + +> Applicable: Exchange Online, Exchange Online Protection + The AutoSubscribeNewMembers switch specifies whether to automatically subscribe new members that are added to the Microsoft 365 Group to conversations and calendar events. You don't need to specify a value with this switch. You need to use this switch with the SubscriptionEnabled switch. @@ -270,7 +284,6 @@ You need to use this switch with the SubscriptionEnabled switch. Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,13 +293,15 @@ Accept wildcard characters: False ``` ### -Classification + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -296,6 +311,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -305,7 +323,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -315,6 +332,9 @@ Accept wildcard characters: False ``` ### -ConvertClosedDlToPrivateGroup + +> Applicable: Exchange Online, Exchange Online Protection + The ConvertClosedDlToPrivateGroup switch specifies whether to migrate the closed distribution group to a private Microsoft 365 Group. You don't need to specify a value with this switch. By default, this switch is always applied when migrating closed distribution groups, and is no longer required. @@ -327,7 +347,6 @@ You can only use this switch with the DlIdentity parameter. Type: SwitchParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,6 +356,9 @@ Accept wildcard characters: False ``` ### -DataEncryptionPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The DataEncryptionPolicy parameter specifies the data encryption policy that's applied to the Microsoft 365 Group. You can use any value that uniquely identifies the policy. For example: - Name @@ -347,7 +369,6 @@ The DataEncryptionPolicy parameter specifies the data encryption policy that's a Type: DataEncryptionPolicyIdParameter Parameter Sets: Identity, SegmentationOption, ProvisioningOptions Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -357,6 +378,9 @@ Accept wildcard characters: False ``` ### -DeleteDlAfterMigration + +> Applicable: Exchange Online, Exchange Online Protection + The DeleteDlAfterMigration switch specifies whether to delete the distribution group after it's migrated to a Microsoft 365 Group. You don't need to specify a value with this switch. You can only use this switch with the DlIdentity parameter. @@ -365,7 +389,6 @@ You can only use this switch with the DlIdentity parameter. Type: SwitchParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -375,6 +398,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the Microsoft 365 Group, including the primary SMTP address. In cloud-based organizations, the primary SMTP address and other proxy addresses for Microsoft 365 Groups are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the Microsoft 365 Group. Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -395,7 +421,6 @@ To specify the primary SMTP email address, you can use any of the following meth Type: ProxyAddressCollection Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -405,13 +430,15 @@ Accept wildcard characters: False ``` ### -ExecutingUser + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -421,6 +448,9 @@ Accept wildcard characters: False ``` ### -ExoErrorAsWarning + +> Applicable: Exchange Online, Exchange Online Protection + The ExoErrorAsWarning switch specifies that Exchange Online errors that you encounter while creating the Microsoft 365 Group are treated as warnings, not errors. You don't need to specify a value with this switch. Creating Microsoft 365 Groups involves background operations in Microsoft Entra ID and Exchange Online. Errors that you might encounter in Exchange Online don't prevent the creation of the group (and therefore aren't really errors), because the group object in Microsoft Entra ID is synchronized back to Exchange Online. @@ -429,7 +459,6 @@ Creating Microsoft 365 Groups involves background operations in Microsoft Entra Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -439,6 +468,9 @@ Accept wildcard characters: False ``` ### -HiddenGroupMembershipEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the Microsoft 365 Group from users who aren't members of the group. You don't need to specify a value with this switch. You can use this setting to help comply with regulations that require you to hide group membership from outsiders (for example, a Microsoft 365 Group that represents students enrolled in a class). @@ -449,7 +481,6 @@ You can use this setting to help comply with regulations that require you to hid Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -459,13 +490,15 @@ Accept wildcard characters: False ``` ### -IsMemberAllowedToEditContent + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill IsMemberAllowedToEditContent Description }} ```yaml Type: System.Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -475,6 +508,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Online, Exchange Online Protection + The Language parameter specifies the language preference for the Microsoft 365 Group. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -483,7 +519,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -493,13 +528,15 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online, Exchange Online Protection + The MailboxRegion parameter specifies the preferred data location (PDL) for the Microsoft 365 Group in multi-geo environments. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -509,13 +546,15 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -525,6 +564,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Online, Exchange Online Protection + The Members parameter specifies the recipients (mail-enabled objects) that are members of the Microsoft 365 Group. You can use any value that uniquely identifies the recipient. For example: - Name @@ -540,7 +582,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -550,6 +591,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. Previously, if you specified a value for this parameter, a random GUID value was added and used as the Name property value for the Microsoft 365 Group (`Name_`). Now, the value of the Name property is populated by the Alias parameter value and the ExternalDirectoryObjectId property value (`_`). @@ -558,7 +602,6 @@ Previously, if you specified a value for this parameter, a random GUID value was Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -568,13 +611,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Online, Exchange Online Protection + The Notes parameter specifies the description of the Microsoft 365 Group. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -584,6 +629,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Exchange Online, Exchange Online Protection + The Owner parameter specifies the for the Microsoft 365 Group. An owner is a group member who has certain privileges, such as the ability to edit group properties. The owner you specify for this parameter must be a mailbox or mail user (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example: @@ -599,7 +647,6 @@ The owner you specify for this parameter must be a mailbox or mail user (a mail- Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -609,13 +656,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. ```yaml Type: SmtpAddress Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -625,6 +674,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -634,7 +686,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -644,6 +695,9 @@ Accept wildcard characters: False ``` ### -SensitivityLabelId + +> Applicable: Exchange Online, Exchange Online Protection + The SensitivityLabelId parameter specifies the GUID value of the sensitivity label that's assigned to the Microsoft 365 Group. **Note**: In the output of the Get-UnifiedGroup cmdlet, this property is named SensitivityLabel, not SensitivityLabelId. @@ -652,7 +706,6 @@ The SensitivityLabelId parameter specifies the GUID value of the sensitivity lab Type: System.Guid Parameter Sets: Identity, SegmentationOption, ProvisioningOptions Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -662,13 +715,15 @@ Accept wildcard characters: False ``` ### -SubscriptionEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SubscriptionEnabled switch specifies whether subscriptions to conversations and calendar events are enabled for the Microsoft 365 Group. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -678,13 +733,15 @@ Accept wildcard characters: False ``` ### -SuppressWarmupMessage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. ```yaml Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -694,13 +751,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/New-WebServicesVirtualDirectory.md similarity index 87% rename from exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/New-WebServicesVirtualDirectory.md index f99ae64e15..8cf2548106 100644 --- a/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-WebServicesVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-webservicesvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-WebServicesVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-webservicesvirtualdirectory +schema: 2.0.0 +title: New-WebServicesVirtualDirectory --- # New-WebServicesVirtualDirectory @@ -66,13 +67,15 @@ This example creates a virtual directory under the non-default website www.conto ## PARAMETERS ### -ApplicationRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ApplicationRoot parameter specifies the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -AppPoolId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AppPoolId parameter specifies the IIS application pool in which the virtual directory runs. We recommend that you leave this parameter at its default setting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -AppPoolIdForManagement + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AppPoolIdForManagement parameter specifies the pool of programs that manages the virtual directory. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: - $true: Basic authentication is enabled. This is the default value. @@ -123,7 +133,6 @@ The BasicAuthentication parameter specifies whether Basic authentication is enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -142,7 +154,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. @@ -161,7 +175,6 @@ The DigestAuthentication parameter specifies whether Digest authentication is en Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -199,7 +217,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,6 +226,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -218,7 +238,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +247,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -240,7 +262,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -250,6 +271,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. @@ -258,7 +282,6 @@ This setting is important when Secure Sockets Layer (SSL) is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -268,6 +291,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -276,7 +302,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -286,6 +311,9 @@ Accept wildcard characters: False ``` ### -GzipLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GzipLevel parameter sets the Gzip configuration for the Exchange Web Services virtual directory. Valid values are: - Off: No compression. @@ -297,7 +325,6 @@ The GzipLevel parameter sets the Gzip configuration for the Exchange Web Service Type: GzipLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -307,6 +334,9 @@ Accept wildcard characters: False ``` ### -InternalNLBBypassUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalNLBBypassUrl parameter specifies the URL of the Exchange server that has the Client Access server role installed, regardless of whether it's behind a Network Load Balancing (NLB) array or not. When you set the InternalUrl parameter to the URL of the NLB array, you should set the InternalNLBBypassUrl parameter to the URL of the Client Access server itself. @@ -315,7 +345,6 @@ When you set the InternalUrl parameter to the URL of the NLB array, you should s Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,6 +354,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is important when SSL is used. @@ -333,7 +365,6 @@ This setting is important when SSL is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -343,13 +374,15 @@ Accept wildcard characters: False ``` ### -MRSProxyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MRSProxyEnabled parameter specifies whether to enable MRSProxy for the Mailbox server. MRSProxy is a service that runs on Mailbox servers in a remote forest and helps to proxy a mailbox move. For more information, see [Mailbox moves in Exchange Server](https://learn.microsoft.com/Exchange/recipients/mailbox-moves). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -359,6 +392,9 @@ Accept wildcard characters: False ``` ### -MRSProxyMaxConnections + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy will accept. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). @@ -367,7 +403,6 @@ The MRSProxyMaxConnections parameter specifies the maximum number of simultaneou Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -377,6 +412,9 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OAuthAuthentication parameter specifies whether OAuth authentication is enabled on the virtual directory. Valid values are: - $true: OAuth authentication is enabled. This is the default value. @@ -386,7 +424,6 @@ The OAuthAuthentication parameter specifies whether OAuth authentication is enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -396,13 +433,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Path parameter sets the path of the virtual directory in the metabase. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -412,6 +451,9 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Role parameter species the configuration for the virtual directory. Valid values are: - ClientAccess: Configure the virtual directory for the Client Access (frontend) services on the Mailbox server. @@ -423,7 +465,6 @@ Client connections are proxied from the Client Access services to the backend se Type: VirtualDirectoryRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +474,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: - Name @@ -444,7 +488,6 @@ The Server parameter specifies the Exchange server that hosts the virtual direct Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -454,13 +497,15 @@ Accept wildcard characters: False ``` ### -WebSiteName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WebSiteName parameter specifies the name of the website under which to create the virtual directory. This parameter shouldn't be used when you're creating a virtual directory under the default website. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -470,13 +515,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -486,6 +533,9 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: - $true: Integrated Windows authentication is enabled. This is the default value. @@ -495,7 +545,6 @@ The WindowsAuthentication parameter specifies whether Integrated Windows authent Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -505,6 +554,9 @@ Accept wildcard characters: False ``` ### -WSSecurityAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are: - $true: WS-Security authentication is enabled. This is the default value. @@ -514,7 +566,6 @@ The WSSecurityAuthentication parameter specifies whether WS-Security (Web Servic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md b/exchange/exchange-ps/ExchangePowerShell/New-X400AuthoritativeDomain.md similarity index 90% rename from exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md rename to exchange/exchange-ps/ExchangePowerShell/New-X400AuthoritativeDomain.md index c18e6668eb..75b1a7057a 100644 --- a/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/New-X400AuthoritativeDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-x400authoritativedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: New-X400AuthoritativeDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/new-x400authoritativedomain +schema: 2.0.0 +title: New-X400AuthoritativeDomain --- # New-X400AuthoritativeDomain @@ -85,13 +86,15 @@ This example creates an external relay domain for the X.400 namespace Europe org ## PARAMETERS ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name for the X.400 authoritative domain. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -X400DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The X400DomainName parameter specifies the X.400 namespace, which can only include the X.400 organizational components. Specifically, only the following attribute types are supported: - C (Country) @@ -118,7 +124,6 @@ Separate the address attributes with semicolons and enclose the entire address i Type: X400Domain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -137,7 +145,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -155,7 +165,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +192,15 @@ Accept wildcard characters: False ``` ### -X400ExternalRelay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The X400ExternalRelay parameter specifies authoritative domain an external relay domain. If you set the X400ExternalRelay parameter to $true, Microsoft Exchange routes email to the external address and doesn't treat resolution failures to this subdomain as an error. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/ExchangePowerShell/Preview-QuarantineMessage.md similarity index 91% rename from exchange/exchange-ps/exchange/Preview-QuarantineMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Preview-QuarantineMessage.md index 655b0da6f5..d4ecdb9cff 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Preview-QuarantineMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/preview-quarantinemessage applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Preview-QuarantineMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/preview-quarantinemessage +schema: 2.0.0 +title: Preview-QuarantineMessage --- # Preview-QuarantineMessage @@ -49,6 +50,9 @@ This example previews the quarantined message that has the specified Identity va ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the quarantined message that you want to preview. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. @@ -57,7 +61,6 @@ You can find the Identity value for a quarantined message by using the Get-Quara Type: QuarantineMessageIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -78,7 +84,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Redirect-Message.md b/exchange/exchange-ps/ExchangePowerShell/Redirect-Message.md similarity index 92% rename from exchange/exchange-ps/exchange/Redirect-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Redirect-Message.md index 1a0354a5bc..7235d9cac0 100644 --- a/exchange/exchange-ps/exchange/Redirect-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Redirect-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/redirect-message applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Redirect-Message -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/redirect-message +schema: 2.0.0 +title: Redirect-Message --- # Redirect-Message @@ -48,6 +49,9 @@ This example drains the active messages from the delivery queues on the Mailbox ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the source Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -59,7 +63,6 @@ The Server parameter specifies the source Exchange server where you want to run Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Target parameter specifies the target Mailbox server where you want to transfer the messages from the drained delivery queues. Enter the server name as a fully qualified domain name (FQDN). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -94,7 +102,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/ExchangePowerShell/Release-QuarantineMessage.md similarity index 88% rename from exchange/exchange-ps/exchange/Release-QuarantineMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Release-QuarantineMessage.md index 17f3d5590b..4e44347bf6 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Release-QuarantineMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/release-quarantinemessage applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Release-QuarantineMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/release-quarantinemessage +schema: 2.0.0 +title: Release-QuarantineMessage --- # Release-QuarantineMessage @@ -114,6 +115,9 @@ This example releases a file that was quarantined as part of Safe Attachments fo ## PARAMETERS ### -Identities + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2,...valueN`. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. @@ -122,9 +126,8 @@ When you use this parameter, the Identity parameter is required, but the value i ```yaml Type: QuarantineMessageIdentity[] -Parameter Sets: Identities +Parameter Sets: Identities, OrgReleaseToAll, OrgReleaseToUser Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -133,29 +136,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: QuarantineMessageIdentity[] -Parameter Sets: OrgReleaseToAll, OrgReleaseToUser -Aliases: -Applicable: Exchange Online, Exchange Online Protection +### -Identity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection -### -Identity The Identity parameter specifies the quarantined message that you want to release. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. ```yaml Type: QuarantineMessageIdentity -Parameter Sets: Identities, OrgReleaseToAll, OrgReleaseToUser +Parameter Sets: Identities, OrgReleaseToAll, OrgReleaseToUser, IdentityOnly Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -164,20 +156,10 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: QuarantineMessageIdentity -Parameter Sets: IdentityOnly -Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection +### -ReleaseToAll -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection -### -ReleaseToAll The ReleaseToAll switch releases the quarantined message to all original recipients. You don't need to specify a value with this switch. This switch is required for the quarantine type SPOMalware. @@ -190,7 +172,6 @@ You can't use the ReleaseToAll switch and the User parameter in the same command Type: SwitchParameter Parameter Sets: OrgReleaseToAll Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -200,6 +181,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The User parameter specifies the email address of the user to whom you want to release the quarantined message. You can specify multiple email addresses separated by commas. You can use this parameter to release the message to recipients of the original message, or to any other email addresses in the organization. @@ -210,7 +194,6 @@ If you previously used the ReleaseToAll switch to release the quarantined messag Type: String[] Parameter Sets: OrgReleaseToUser Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -220,6 +203,9 @@ Accept wildcard characters: False ``` ### -ActionType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ActionType parameter specifies the release action type. Valid values are: - Deny @@ -230,7 +216,6 @@ The ActionType parameter specifies the release action type. Valid values are: Type: ReleaseActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -240,6 +225,9 @@ Accept wildcard characters: False ``` ### -AllowSender + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + 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. @@ -248,7 +236,6 @@ If the message was quarantined because of a transport rule or blocked sender, me Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -258,6 +245,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -267,7 +257,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -277,6 +266,9 @@ Accept wildcard characters: False ``` ### -EntityType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The EntityType parameter filters the results by EntityType. Valid values are: - Email @@ -288,7 +280,6 @@ The EntityType parameter filters the results by EntityType. Valid values are: Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -298,6 +289,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch whenever you attempt to re-release previously released messages from quarantine. @@ -306,7 +300,6 @@ Use this switch whenever you attempt to re-release previously released messages Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -316,6 +309,9 @@ Accept wildcard characters: False ``` ### -ReportFalsePositive + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ReportFalsePositive switch specifies whether to report the message as a false positive to Microsoft (good message marked as bad). You don't need to specify a value with this switch. This switch is available only for quarantined spam messages. @@ -324,7 +320,6 @@ This switch is available only for quarantined spam messages. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -334,6 +329,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. The WhatIf switch doesn't work in Security & Compliance PowerShell. @@ -342,7 +340,6 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ADPermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ADPermission.md similarity index 84% rename from exchange/exchange-ps/exchange/Remove-ADPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ADPermission.md index 13ca24fb1e..ca71f92469 100644 --- a/exchange/exchange-ps/exchange/Remove-ADPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ADPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-adpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ADPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-adpermission +schema: 2.0.0 +title: Remove-ADPermission --- # Remove-ADPermission @@ -86,15 +87,17 @@ This example removes the ability for anonymous users to send messages through th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the object from which the permission should be removed. You can specify either the distinguished name (DN) of the object or the object's name if it's unique. If the DN or name contains spaces, enclose the name in quotation marks ("). ```yaml Type: ADRawEntryIdParameter -Parameter Sets: AccessRights, Owner +Parameter Sets: AccessRights, Owner, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -103,27 +106,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -```yaml -Type: ADRawEntryIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Instance -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Instance The Instance parameter enables you to pass an entire object to the command to be processed. It's mainly used in scripts where an entire object must be passed to the command. ```yaml Type: ADAcePresentationObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -133,6 +125,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The User parameter specifies whose permissions are being removed from the Active Directory object. You can specify the following types of users or groups: - Mailbox users @@ -159,9 +154,8 @@ Otherwise, you can use any value that uniquely identifies the user or group. For ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -170,20 +164,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -AccessRights -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -AccessRights The AccessRights parameter specifies the rights that you want to remove from the user on the Active Directory object. Valid values include: - CreateChild @@ -212,7 +196,6 @@ You can specify multiple values separated by commas. Type: ActiveDirectoryRights[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +205,9 @@ Accept wildcard characters: False ``` ### -ChildObjectTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ChildObjectTypes parameter specifies what type of object the permission should be removed from. The ChildObjectTypes parameter can only be used if the AccessRights parameter is set to CreateChild or DeleteChild. @@ -230,7 +216,6 @@ The ChildObjectTypes parameter can only be used if the AccessRights parameter is Type: ADSchemaObjectIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -240,6 +225,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -249,7 +237,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,13 +246,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Deny switch specifies that the permissions you're removing are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,6 +264,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -283,7 +275,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +284,15 @@ Accept wildcard characters: False ``` ### -ExtendedRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedRights parameter specifies the extended rights to remove. ```yaml Type: ExtendedRightIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,6 +302,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InheritanceType parameter specifies how permissions are inherited. Valid values are: - None @@ -321,7 +317,6 @@ The InheritanceType parameter specifies how permissions are inherited. Valid val Type: ActiveDirectorySecurityInheritance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -331,13 +326,15 @@ Accept wildcard characters: False ``` ### -InheritedObjectType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InheritedObjectType parameter specifies what kind of object inherits this access control entry (ACE). ```yaml Type: ADSchemaObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -347,6 +344,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Properties parameter specifies what properties the object contains. The Properties parameter can only be used if the AccessRights parameter is set to ReadProperty, WriteProperty, or Self. @@ -355,7 +355,6 @@ The Properties parameter can only be used if the AccessRights parameter is set t Type: ADSchemaObjectIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -365,13 +364,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ATPProtectionPolicyRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ATPProtectionPolicyRule.md index 47ada3944f..5da3e07228 100644 --- a/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-atpprotectionpolicyrule applicable: Exchange Online -title: Remove-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-atpprotectionpolicyrule +schema: 2.0.0 +title: Remove-ATPProtectionPolicyRule --- # Remove-ATPProtectionPolicyRule @@ -46,6 +47,9 @@ This example removes the existing rule for Defender for Office 365 protections i ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AcceptedDomain.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-AcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AcceptedDomain.md index 5339aa412e..63652b6d44 100644 --- a/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AcceptedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-accepteddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AcceptedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-accepteddomain +schema: 2.0.0 +title: Remove-AcceptedDomain --- # Remove-AcceptedDomain @@ -43,13 +44,15 @@ This example removes the accepted domain Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the accepted domain you want to remove. Enter either the GUID or the name of the remote domain. ```yaml Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -86,7 +94,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDevice.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDevice.md index 5ec58a6bb4..7e6cbd67b6 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDevice.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncdevice applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-ActiveSyncDevice -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-activesyncdevice +schema: 2.0.0 +title: Remove-ActiveSyncDevice --- # Remove-ActiveSyncDevice @@ -61,13 +62,15 @@ This example removes the mobile device partnership for the device named Tablet\_ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter uniquely identifies the specific device partnership to be removed. ```yaml Type: ActiveSyncDeviceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -86,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -104,7 +112,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceAccessRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceAccessRule.md index 5e56ff683d..bbd927ed8e 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncdeviceaccessrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-ActiveSyncDeviceAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-activesyncdeviceaccessrule +schema: 2.0.0 +title: Remove-ActiveSyncDeviceAccessRule --- # Remove-ActiveSyncDeviceAccessRule @@ -52,13 +53,15 @@ This example removes all device access rules that have a name that starts with C ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the device access rule. ```yaml Type: ActiveSyncDeviceAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -95,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceClass.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceClass.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceClass.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceClass.md index fee0ac4e53..a08d9400d8 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceClass.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncDeviceClass.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncdeviceclass applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ActiveSyncDeviceClass -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-activesyncdeviceclass +schema: 2.0.0 +title: Remove-ActiveSyncDeviceClass --- # Remove-ActiveSyncDeviceClass @@ -45,13 +46,15 @@ This example retrieves the list of devices connecting to Microsoft Exchange and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the group of devices on which to scope the task. ```yaml Type: ActiveSyncDeviceClassIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncMailboxPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncMailboxPolicy.md index faa170542f..2841e91d45 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncmailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-ActiveSyncMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-activesyncmailboxpolicy +schema: 2.0.0 +title: Remove-ActiveSyncMailboxPolicy --- # Remove-ActiveSyncMailboxPolicy @@ -55,6 +56,9 @@ This example removes the mobile device mailbox policy named Management and bypas ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mobile device mailbox policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the mobile device mailbox policy that you want Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -84,7 +90,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -102,7 +110,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -120,7 +130,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncVirtualDirectory.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncVirtualDirectory.md index a45a5a2bd8..5a164c4717 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ActiveSyncVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ActiveSyncVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-activesyncvirtualdirectory +schema: 2.0.0 +title: Remove-ActiveSyncVirtualDirectory --- # Remove-ActiveSyncVirtualDirectory @@ -59,6 +60,9 @@ This example removes a custom Exchange ActiveSync virtual directory from the ser ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Exchange ActiveSync virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -71,7 +75,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -90,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AdaptiveScope.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-AdaptiveScope.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AdaptiveScope.md index 6716aabc5e..45e8996990 100644 --- a/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AdaptiveScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-adaptivescope applicable: Security & Compliance -title: Remove-AdaptiveScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-adaptivescope +schema: 2.0.0 +title: Remove-AdaptiveScope --- # Remove-AdaptiveScope @@ -43,6 +44,9 @@ This example removes the adaptive scope named Project X. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the adaptive scope that you want to remove. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the adaptive scope that you want to remove. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the adaptive scope. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressBookPolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AddressBookPolicy.md index f2bac7b9a2..d68f6ae1c5 100644 --- a/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressBookPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-addressbookpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-AddressBookPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-addressbookpolicy +schema: 2.0.0 +title: Remove-AddressBookPolicy --- # Remove-AddressBookPolicy @@ -49,13 +50,15 @@ This example deletes the address book policy Murchison's Class. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the address book policy that you want to remove. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressList.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AddressList.md index a77eb38489..c74e1d44d6 100644 --- a/exchange/exchange-ps/exchange/Remove-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-AddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-addresslist +schema: 2.0.0 +title: Remove-AddressList --- # Remove-AddressList @@ -51,6 +52,9 @@ This example removes the address list named AddressList1 and all of its child ad ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the address list that you want to remove. You can use any value that uniquely identifies the address list. For example: - Name @@ -64,7 +68,6 @@ If the address list has child address lists that you also want to remove, you ne Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -101,7 +109,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Recursive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Recursive switch specifies whether to remove all child address lists. You don't need to specify a value for this switch. If you don't use this switch, and the address list has child address lists, the command will fail. @@ -119,7 +129,6 @@ If you don't use this switch, and the address list has child address lists, the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressRewriteEntry.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AddressRewriteEntry.md index 8eb9950d2e..e4e75d866f 100644 --- a/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AddressRewriteEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-addressrewriteentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AddressRewriteEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-addressrewriteentry +schema: 2.0.0 +title: Remove-AddressRewriteEntry --- # Remove-AddressRewriteEntry @@ -54,13 +55,15 @@ This example removes all address rewrite entries that include contoso.com in the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the address rewrite entry you want to remove. The Identity parameter accepts a GUID or the unique address rewrite name. You can omit the Identity parameter label. ```yaml Type: AddressRewriteEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -97,7 +105,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishPolicy.md index 6bff81fad7..62b3f8de89 100644 --- a/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-antiphishpolicy applicable: Exchange Online, Exchange Online Protection -title: Remove-AntiPhishPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-antiphishpolicy +schema: 2.0.0 +title: Remove-AntiPhishPolicy --- # Remove-AntiPhishPolicy @@ -43,6 +44,9 @@ This example removes the antiphish policy named Quarantine Policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the antiphish policy that you want to remove. Y Type: AntiPhishPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -90,7 +98,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishRule.md index 77562bbd26..2f16d1e2f0 100644 --- a/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: Remove-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-antiphishrule +schema: 2.0.0 +title: Remove-AntiPhishRule --- # Remove-AntiPhishRule @@ -42,6 +43,9 @@ This examples removes the antiphish rule named Research Department Phishing Rule ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the antiphish rule that you want to remove. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-App.md b/exchange/exchange-ps/ExchangePowerShell/Remove-App.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-App.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-App.md index c24c1658e5..87256dfcde 100644 --- a/exchange/exchange-ps/exchange/Remove-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-App.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-App -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-app +schema: 2.0.0 +title: Remove-App --- # Remove-App @@ -49,13 +50,15 @@ This example removes the Finance Test app installed for user Tony. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the AppID (GUID value) of the app that you want to remove. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. ```yaml Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -AppType + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AppType Description }} @@ -73,7 +79,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -92,7 +100,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -110,7 +120,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -137,7 +149,6 @@ The Mailbox parameter specifies the mailbox that you want to modify. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -147,6 +158,9 @@ Accept wildcard characters: False ``` ### -OrganizationApp + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OrganizationApp switch specifies that the scope of the app is organizational. You don't need to specify a value with this switch. This switch is required if the targeted app is installed for the organization. @@ -155,7 +169,6 @@ This switch is required if the targeted app is installed for the organization. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -PrivateCatalog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PrivateCatalog switch specifies that the app you want to remove is located in a private catalog. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -181,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionCompliancePolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionCompliancePolicy.md index c470a3f9f2..5be985ef9e 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-appretentioncompliancepolicy applicable: Security & Compliance -title: Remove-AppRetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-appretentioncompliancepolicy +schema: 2.0.0 +title: Remove-AppRetentionCompliancePolicy --- # Remove-AppRetentionCompliancePolicy @@ -43,6 +44,9 @@ This example removes the app retention compliance policy named Contoso Viva Enga ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the app retention compliance policy that you wa Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionComplianceRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionComplianceRule.md index 724cda7063..13b5fa09f8 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AppRetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-appretentioncompliancerule applicable: Security & Compliance -title: Remove-AppRetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-appretentioncompliancerule +schema: 2.0.0 +title: Remove-AppRetentionComplianceRule --- # Remove-AppRetentionComplianceRule @@ -43,6 +44,9 @@ This example removes the app retention compliance policy rule Contoso Viva Engag ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance rule that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the app retention compliance rule that you want Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ApplicationAccessPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ApplicationAccessPolicy.md index 9b1bae6a1a..9434a09c97 100644 --- a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ApplicationAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection -title: Remove-ApplicationAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-applicationaccesspolicy +schema: 2.0.0 +title: Remove-ApplicationAccessPolicy --- # Remove-ApplicationAccessPolicy @@ -42,13 +43,15 @@ This example removes the specified policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the application access policy that you want to remove. To find the Identity value for the policy, run the command Get-ApplicationAccessPolicy | Format-List Identity,Description,ScopeName,AccessRight,AppID. ```yaml Type: ApplicationAccessPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AttachmentFilterEntry.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AttachmentFilterEntry.md index a166c59fe8..2ba825ebe3 100644 --- a/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AttachmentFilterEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-attachmentfilterentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AttachmentFilterEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-attachmentfilterentry +schema: 2.0.0 +title: Remove-AttachmentFilterEntry --- # Remove-AttachmentFilterEntry @@ -29,7 +30,7 @@ Remove-AttachmentFilterEntry [-Identity] ``` ## DESCRIPTION -On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchangepowershell/set-attachmentfilterlistconfig). On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. @@ -52,6 +53,9 @@ This example removes the attachment filter entry that filters attachments that h ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the type of attachment that this filter entry removes. The Identity parameter accepts values in the format Type:Name, where Type is one of the following two values: - ContentType: This value matches the attachment filter entry against the MIME content type. @@ -63,7 +67,6 @@ In Type:Name, Name can be either the file name of the attachment filter entry to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -100,7 +108,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AuthRedirect.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthRedirect.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-AuthRedirect.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AuthRedirect.md index 5472c1ac64..04c48fbf3e 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthRedirect.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthRedirect.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-authredirect applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AuthRedirect -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-authredirect +schema: 2.0.0 +title: Remove-AuthRedirect --- # Remove-AuthRedirect @@ -50,13 +51,15 @@ This example removes all existing OAuth redirection objects from your organizati ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the existing OAuth redirection object that you want to remove. The object name uses the syntax `AuthRedirect-Bearer-GUID`. The easiest way to find the name of the OAuth redirection object is to run Get-AuthRedirect. ```yaml Type: AuthRedirectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AuthServer.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthServer.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-AuthServer.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AuthServer.md index 826c25a07f..95ab8e8b0d 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-authserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AuthServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-authserver +schema: 2.0.0 +title: Remove-AuthServer --- # Remove-AuthServer @@ -43,6 +44,9 @@ This example removes the authorization server named AMC. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the authorization server object that you want to remove. You can use any value that uniquely identifies the authorization server. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the authorization server object that you want t Type: AuthServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthenticationPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AuthenticationPolicy.md index 7881265a05..f401b7df8f 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AuthenticationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-authenticationpolicy applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-AuthenticationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-authenticationpolicy +schema: 2.0.0 +title: Remove-AuthenticationPolicy --- # Remove-AuthenticationPolicy @@ -51,6 +52,9 @@ In Exchange Online, this example enables legacy Exchange tokens to be issued to ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the authentication policy you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the authentication policy you want to remove. Y Type: AuthPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyExchangeTokens + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowLegacyExchangeTokens switch enables legacy Exchange tokens to be issued to Outlook add-ins for your organization. You don't need to specify a value with this switch. @@ -90,7 +96,6 @@ This switch applies to the entire organization. The Identity parameter is requir Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -109,7 +117,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill TenantId Description }} @@ -127,7 +137,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -137,13 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelPolicy.md index d6b2940550..4b08056b03 100644 --- a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelpolicy applicable: Security & Compliance -title: Remove-AutoSensitivityLabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-autosensitivitylabelpolicy +schema: 2.0.0 +title: Remove-AutoSensitivityLabelPolicy --- # Remove-AutoSensitivityLabelPolicy @@ -42,6 +43,9 @@ This example removes the policy named Marketing Group. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the auto-labeling policy that you want to remov Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelRule.md index f779597117..91e0471d61 100644 --- a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AutoSensitivityLabelRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelrule applicable: Security & Compliance -title: Remove-AutoSensitivityLabelRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-autosensitivitylabelrule +schema: 2.0.0 +title: Remove-AutoSensitivityLabelRule --- # Remove-AutoSensitivityLabelRule @@ -42,6 +43,9 @@ This example removes the rule named Social Security Rule. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the auto-labeling policy rule that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AutodiscoverVirtualDirectory.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AutodiscoverVirtualDirectory.md index 948dcc21f7..f87faad103 100644 --- a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AutodiscoverVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-autodiscovervirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-AutodiscoverVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-autodiscovervirtualdirectory +schema: 2.0.0 +title: Remove-AutodiscoverVirtualDirectory --- # Remove-AutodiscoverVirtualDirectory @@ -43,6 +44,9 @@ This example removes the Autodiscover virtual directory from the site autodiscov ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Autodiscover virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -55,7 +59,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityAddressSpace.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityAddressSpace.md index 97bf6ead5a..5f3792e4d4 100644 --- a/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityAddressSpace.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-availabilityaddressspace applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-AvailabilityAddressSpace -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-availabilityaddressspace +schema: 2.0.0 +title: Remove-AvailabilityAddressSpace --- # Remove-AvailabilityAddressSpace @@ -52,6 +53,9 @@ This example immediately removes the availability address space object named Con ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the availability address that you want to remove. You can use any value that uniquely identifies the object. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the availability address that you want to remov Type: AvailabilityAddressSpaceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityConfig.md index f51da6fded..17980f03fd 100644 --- a/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-availabilityconfig applicable: Exchange Online -title: Remove-AvailabilityConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-availabilityconfig +schema: 2.0.0 +title: Remove-AvailabilityConfig --- # Remove-AvailabilityConfig @@ -42,13 +43,15 @@ This example removes the existing availability configuration. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the availability configuration that you want to remove. You don't need to use this parameter, because there's only one availability configuration object named Availability Configuration in any organization. ```yaml Type: AvailabilityConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityReportOutage.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityReportOutage.md index 8e66eefd7a..66bd5aaed6 100644 --- a/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-AvailabilityReportOutage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-availabilityreportoutage applicable: Exchange Server 2010 -title: Remove-AvailabilityReportOutage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-availabilityreportoutage +schema: 2.0.0 +title: Remove-AvailabilityReportOutage --- # Remove-AvailabilityReportOutage @@ -45,13 +46,15 @@ This example removes a manually injected site-scoped outage for a specified day. ## PARAMETERS ### -SiteName + +> Applicable: Exchange Server 2010 + The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -ReportDate + +> Applicable: Exchange Server 2010 + The ReportDate parameter specifies the date to query for the outage report. ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -77,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -86,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -104,7 +114,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -114,13 +123,15 @@ Accept wildcard characters: False ``` ### -ReportingDatabase + +> Applicable: Exchange Server 2010 + The ReportingDatabase parameter specifies the name of the database on the reporting server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -130,13 +141,15 @@ Accept wildcard characters: False ``` ### -ReportingServer + +> Applicable: Exchange Server 2010 + The ReportingServer parameter specifies the name of the reporting database server to connect to. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -146,13 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-BlockedConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-BlockedConnector.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-BlockedConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-BlockedConnector.md index 6520e630b3..35eb04fb6e 100644 --- a/exchange/exchange-ps/exchange/Remove-BlockedConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-BlockedConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-blockedconnector applicable: Exchange Online, Exchange Online Protection -title: Remove-BlockedConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-blockedconnector +schema: 2.0.0 +title: Remove-BlockedConnector --- # Remove-BlockedConnector @@ -39,13 +40,15 @@ This unblocks the specified blocked connector. ## PARAMETERS ### -ConnectorId + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorId parameter specifies the blocked connector that you want to unblock. The value is a GUID (for example, 159eb7c4-75d7-43e2-95fe-ced44b3e0a56). You can find this value from the output of the Get-BlockedConnector command. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -55,13 +58,15 @@ Accept wildcard characters: False ``` ### -Reason + +> Applicable: Exchange Online, Exchange Online Protection + The Reason parameter specifies comments about why you're unblocking the blocked connector. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md b/exchange/exchange-ps/ExchangePowerShell/Remove-BlockedSenderAddress.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-BlockedSenderAddress.md index ce007bf146..af83a8c60a 100644 --- a/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-BlockedSenderAddress.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-blockedsenderaddress applicable: Exchange Online, Exchange Online Protection -title: Remove-BlockedSenderAddress -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-blockedsenderaddress +schema: 2.0.0 +title: Remove-BlockedSenderAddress --- # Remove-BlockedSenderAddress @@ -43,13 +44,15 @@ This example unblocks the user julia@contoso.com. ## PARAMETERS ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter specifies the email address of the user that you want to unblock. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -Reason + +> Applicable: Exchange Online, Exchange Online Protection + The Reason parameter specifies the reason the user was blocked (the Reason property value). If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-CalendarEvents.md b/exchange/exchange-ps/ExchangePowerShell/Remove-CalendarEvents.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-CalendarEvents.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-CalendarEvents.md index c199b24fec..23dd9a41c8 100644 --- a/exchange/exchange-ps/exchange/Remove-CalendarEvents.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-CalendarEvents.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-calendarevents applicable: Exchange Server 2019, Exchange Online -title: Remove-CalendarEvents -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-calendarevents +schema: 2.0.0 +title: Remove-CalendarEvents --- # Remove-CalendarEvents @@ -62,6 +63,9 @@ This example previews the meetings that would be cancelled in Jacob Berger's cal ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -79,7 +83,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -QueryWindowInDays + +> Applicable: Exchange Server 2019, Exchange Online + The QueryWindowInDays parameter specifies the number of days after the QueryStartDate parameter value to look for meetings that you want to cancel. If an instance of a recurring meeting occurs during the specified time period, the entire series is cancelled (not just the instances during the time period). @@ -99,7 +105,6 @@ If an instance of a recurring meeting occurs during the specified time period, t Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: True Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -CancelOrganizedMeetings + +> Applicable: Exchange Server 2019, Exchange Online + The CancelOrganizedMeetings switch specifies whether to cancel meetings in the mailbox. You don't need to specify a value with this switch. To cancel meetings in the mailbox, you need to use this switch. @@ -117,7 +125,6 @@ To cancel meetings in the mailbox, you need to use this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -136,7 +146,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -PreviewOnly + +> Applicable: Exchange Server 2019, Exchange Online + The PreviewOnly switch specifies whether to preview the results of the command without actually cancelling any meetings. You don't need to specify a value with this switch. You use this switch with the Verbose switch. @@ -154,7 +166,6 @@ You use this switch with the Verbose switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,6 +175,9 @@ Accept wildcard characters: False ``` ### -QueryStartDate + +> Applicable: Exchange Server 2019, Exchange Online + The QueryStartDate parameter specifies the start date to look for meetings that you want to cancel. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -176,7 +190,6 @@ You use the QueryWindowInDays parameter to specify the end date. Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +199,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -194,7 +210,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -204,13 +219,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldPolicy.md index 0a3fbdb087..57e20b4c41 100644 --- a/exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-caseholdpolicy applicable: Security & Compliance -title: Remove-CaseHoldPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-caseholdpolicy +schema: 2.0.0 +title: Remove-CaseHoldPolicy --- # Remove-CaseHoldPolicy @@ -45,6 +46,9 @@ This example removes the case hold policy named "Regulation 123 Compliance". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold policy to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the case hold policy to remove. You can use any Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-CaseHoldRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldRule.md index cb7f9417bd..b5478bff5e 100644 --- a/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-CaseHoldRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-caseholdrule applicable: Security & Compliance -title: Remove-CaseHoldRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-caseholdrule +schema: 2.0.0 +title: Remove-CaseHoldRule --- # Remove-CaseHoldRule @@ -45,6 +46,9 @@ This example removes the case hold rule named "One Year Standard". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold rule to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the case hold rule to remove. You can use any v Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ClassificationRuleCollection.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ClassificationRuleCollection.md index 9e0c0ef4af..f408d63a88 100644 --- a/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ClassificationRuleCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-classificationrulecollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-ClassificationRuleCollection -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-classificationrulecollection +schema: 2.0.0 +title: Remove-ClassificationRuleCollection --- # Remove-ClassificationRuleCollection @@ -45,13 +46,15 @@ This example removes the classification rule collection named External Classific ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the classification rule collection you want to remove. You can use any value that uniquely identifies the classification rule collection. For example, you can specify the name, rule collection name or distinguished name (DN) of the classification rule collection. ```yaml Type: ClassificationRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -88,7 +96,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ClientAccessArray.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessArray.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-ClientAccessArray.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessArray.md index 24930a04a7..8a835d7bb8 100644 --- a/exchange/exchange-ps/exchange/Remove-ClientAccessArray.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessArray.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-clientaccessarray applicable: Exchange Server 2010 -title: Remove-ClientAccessArray -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-clientaccessarray +schema: 2.0.0 +title: Remove-ClientAccessArray --- # Remove-ClientAccessArray @@ -43,6 +44,9 @@ This example removes the existing Client Access array with the FQDN value casarr ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Client Access array that you want to remove. You can use these values: - Name (if the value doesn't contain spaces) @@ -55,7 +59,6 @@ The Identity parameter specifies the Client Access array that you want to remove Type: ClientAccessArrayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessRule.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-ClientAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessRule.md index df3b17ddf9..780d8f60b7 100644 --- a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ClientAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-clientaccessrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-ClientAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-clientaccessrule +schema: 2.0.0 +title: Remove-ClientAccessRule --- # Remove-ClientAccessRule @@ -48,6 +49,9 @@ This example removes the existing client access rule named "Block Connections fr ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the client access rule that you want to remove. You can use any value that uniquely identifies the client access rule. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the client access rule that you want to remove. Type: ClientAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -95,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceCase.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCase.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-ComplianceCase.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCase.md index a636d54a72..462cc01319 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceCase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancecase applicable: Security & Compliance -title: Remove-ComplianceCase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancecase +schema: 2.0.0 +title: Remove-ComplianceCase --- # Remove-ComplianceCase @@ -43,6 +44,9 @@ This example removes the compliance case named Case 5150 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the compliance case that you want to remove. You can use any value that uniquely identifies the case. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the compliance case that you want to remove. Yo Type: ComplianceCaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -97,13 +104,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCaseMember.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCaseMember.md index 2a22dd2318..dea20c13e0 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceCaseMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancecasemember applicable: Security & Compliance -title: Remove-ComplianceCaseMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancecasemember +schema: 2.0.0 +title: Remove-ComplianceCaseMember --- # Remove-ComplianceCaseMember @@ -42,6 +43,9 @@ This example removes Jan Dryml from the eDiscovery case named Case OU812. ## PARAMETERS ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the name of the eDiscovery case that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. @@ -50,7 +54,6 @@ To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Security & Compliance + The Member parameter specifies the user that you want to remove from the eDiscovery case. You can use any value that uniquely identifies the user. For example: - Name @@ -71,7 +77,6 @@ The Member parameter specifies the user that you want to remove from the eDiscov Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -90,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceRetentionEventType.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceRetentionEventType.md index fdca44b480..3a13bfbf98 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceRetentionEventType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-complianceretentioneventtype applicable: Security & Compliance -title: Remove-ComplianceRetentionEventType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-complianceretentioneventtype +schema: 2.0.0 +title: Remove-ComplianceRetentionEventType --- # Remove-ComplianceRetentionEventType @@ -43,6 +44,9 @@ This example remove the retention event type name Fabrikam Project ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention event type that you want to remove. You can use any value that uniquely identifies the retention event type. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the retention event type that you want to remov Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the retention event type. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearch.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearch.md index 92fdcfc7a7..882cb412ba 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancesearch applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Remove-ComplianceSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancesearch +schema: 2.0.0 +title: Remove-ComplianceSearch --- # Remove-ComplianceSearch @@ -46,6 +47,9 @@ This example removes the compliance search named Case 1234 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Identity parameter specifies the compliance search that you want to remove. You can use any value that uniquely identifies the compliance search. For example: @@ -59,7 +63,6 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -96,7 +104,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearchAction.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearchAction.md index 8140168e36..8da7c36b6c 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSearchAction.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancesearchaction applicable: Security & Compliance -title: Remove-ComplianceSearchAction -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancesearchaction +schema: 2.0.0 +title: Remove-ComplianceSearchAction --- # Remove-ComplianceSearchAction @@ -42,6 +43,9 @@ This example removes the compliance search action named `Case 1234_Preview`. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the compliance search action that you want to remove. You can use any value that uniquely identifies the compliance search action. For example: - Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"` . For example, `"Case 1234_Preview"`. @@ -51,7 +55,6 @@ The Identity parameter specifies the compliance search action that you want to r Type: ComplianceSearchActionIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSecurityFilter.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSecurityFilter.md index 8b38b2ba8a..b389657e6e 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceSecurityFilter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancesecurityfilter applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Remove-ComplianceSecurityFilter -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancesecurityfilter +schema: 2.0.0 +title: Remove-ComplianceSecurityFilter --- # Remove-ComplianceSecurityFilter @@ -42,13 +43,15 @@ This example removes the compliance security filter named HR Filter. ## PARAMETERS ### -FilterName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The FilterName parameter specifies the name of the compliance security filter that you want to remove. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceTag.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-ComplianceTag.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceTag.md index 46c293ddf7..58954fa68c 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ComplianceTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancetag applicable: Security & Compliance -title: Remove-ComplianceTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-compliancetag +schema: 2.0.0 +title: Remove-ComplianceTag --- # Remove-ComplianceTag @@ -44,6 +45,9 @@ This example removes the label named HR Content. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the label that you want to remove. You can use any value that uniquely identifies the tag. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the label that you want to remove. You can use Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the label. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ContentFilterPhrase.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ContentFilterPhrase.md index 88836574db..3ae844829d 100644 --- a/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ContentFilterPhrase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-contentfilterphrase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ContentFilterPhrase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-contentfilterphrase +schema: 2.0.0 +title: Remove-ContentFilterPhrase --- # Remove-ContentFilterPhrase @@ -53,6 +54,9 @@ This example removes the custom phrase Free credit report from the list of phras ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies a custom word or phrase to remove. You must enclose the value of the Identity parameter in quotation marks ("). For this command, the Identity parameter performs the same actions as the Phrase parameter. The Identity and Phrase parameters are interchangeable. You can't use the Phrase parameter if the Identity parameter is used. @@ -61,7 +65,6 @@ For this command, the Identity parameter performs the same actions as the Phrase Type: ContentFilterPhraseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -98,7 +106,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Phrase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Phrase parameter specifies a custom word or phrase to remove. You must enclose the value of the Phrase parameter in quotation marks ("). For this command, the Phrase parameter performs the same actions as the Identity parameter. The Phrase and Identity parameters are interchangeable. You can't use the Identity parameter if the Phrase parameter is used. @@ -116,7 +126,6 @@ For this command, the Phrase parameter performs the same actions as the Identity Type: ContentFilterPhraseIdParameter Parameter Sets: Phrase Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DataClassification.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DataClassification.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-DataClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DataClassification.md index c89fd96ca0..80df1068f7 100644 --- a/exchange/exchange-ps/exchange/Remove-DataClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DataClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dataclassification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-DataClassification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dataclassification +schema: 2.0.0 +title: Remove-DataClassification --- # Remove-DataClassification @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [Remove-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. +In Exchange Online, this cmdlet has been replaced by the [Remove-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the Remove-DataClassification cmdlet to remove data classification rules that use document fingerprints. You can't use this cmdlet to remove built-in data classification rules. @@ -47,6 +48,9 @@ This example removes the data classification rule named "Contoso Confidential". ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the data classification rule that you want to remove. You can use any value that uniquely identifies the data classification rule. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the data classification rule that you want to r Type: DataClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroup.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroup.md index 2311d1505f..eee46900a9 100644 --- a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DatabaseAvailabilityGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-databaseavailabilitygroup +schema: 2.0.0 +title: Remove-DatabaseAvailabilityGroup --- # Remove-DatabaseAvailabilityGroup @@ -43,13 +44,15 @@ This example, deletes the DAG DAG1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the DAG to be removed. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupNetwork.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupNetwork.md index 2a130fd882..b27a7b0fbc 100644 --- a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupNetwork.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroupnetwork applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DatabaseAvailabilityGroupNetwork -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-databaseavailabilitygroupnetwork +schema: 2.0.0 +title: Remove-DatabaseAvailabilityGroupNetwork --- # Remove-DatabaseAvailabilityGroupNetwork @@ -43,13 +44,15 @@ This example removes the DAG network DAGNetwork04 from the DAG DAG1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the network being removed. ```yaml Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupServer.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupServer.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupServer.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupServer.md index dfb283d873..a3974b525b 100644 --- a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroupServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DatabaseAvailabilityGroupServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroupserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DatabaseAvailabilityGroupServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-databaseavailabilitygroupserver +schema: 2.0.0 +title: Remove-DatabaseAvailabilityGroupServer --- # Remove-DatabaseAvailabilityGroupServer @@ -52,13 +53,15 @@ This example removes the configuration settings for the Mailbox server MBX4 from ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the DAG from which you're removing the server. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies the Mailbox server to remove from the DAG. You can use any value that uniquely identifies the server. For example: - Name @@ -79,7 +85,6 @@ The MailboxServer parameter specifies the Mailbox server to remove from the DAG. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 2 @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConfigurationOnly switch remove the Mailbox server from the DAG object in Active Directory. You don't need to specify a value with this switch. If the Mailbox server is offline but the DAG has quorum, the Mailbox server is evicted from the DAG's cluster and removed from the DAG object in Active Directory. @@ -99,7 +107,6 @@ You should use this switch only if the Mailbox server has been lost and can no l Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -118,7 +128,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +155,15 @@ Accept wildcard characters: False ``` ### -SkipDagValidation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when removing members from the DAG. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,13 +173,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DeliveryAgentConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeliveryAgentConnector.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-DeliveryAgentConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeliveryAgentConnector.md index ff7ae195fd..3b8f0c168e 100644 --- a/exchange/exchange-ps/exchange/Remove-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeliveryAgentConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-deliveryagentconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DeliveryAgentConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-deliveryagentconnector +schema: 2.0.0 +title: Remove-DeliveryAgentConnector --- # Remove-DeliveryAgentConnector @@ -45,13 +46,15 @@ This example removes the delivery agent connector named Contoso Delivery Agent C ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the GUID or name of the delivery agent connector. ```yaml Type: DeliveryAgentConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -88,7 +96,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessPolicy.md index 12423d67fd..cc5f2d8775 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccesspolicy applicable: Security & Compliance -title: Remove-DeviceConditionalAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-deviceconditionalaccesspolicy +schema: 2.0.0 +title: Remove-DeviceConditionalAccessPolicy --- # Remove-DeviceConditionalAccessPolicy @@ -51,6 +52,9 @@ This example removes the mobile device conditional access policy named Human Res ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device conditional access policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the mobile device conditional access policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessRule.md index 08e72f3b32..8721d2db9c 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConditionalAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccessrule applicable: Security & Compliance -title: Remove-DeviceConditionalAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-deviceconditionalaccessrule +schema: 2.0.0 +title: Remove-DeviceConditionalAccessRule --- # Remove-DeviceConditionalAccessRule @@ -51,13 +52,15 @@ This example removes the mobile device conditional access rule named Secure Emai ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device conditional access rule that you want to view. The name of the rule uses the syntax `{}`. For example, `Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}`. You can find the name value by running the command: Get-DeviceConditionalAccessRule | Format-List Name. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationPolicy.md index 913547d5a2..ba392b693a 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconfigurationpolicy applicable: Security & Compliance -title: Remove-DeviceConfigurationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-deviceconfigurationpolicy +schema: 2.0.0 +title: Remove-DeviceConfigurationPolicy --- # Remove-DeviceConfigurationPolicy @@ -51,6 +52,9 @@ This example removes the mobile device configuration policy named Engineering Gr ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device configuration policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the mobile device configuration policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationRule.md index d3ab49229c..b412b6f044 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceConfigurationRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconfigurationrule applicable: Security & Compliance -title: Remove-DeviceConfigurationRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-deviceconfigurationrule +schema: 2.0.0 +title: Remove-DeviceConfigurationRule --- # Remove-DeviceConfigurationRule @@ -51,13 +52,15 @@ This example removes the mobile device configuration rule named Legal Team{58b50 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device configuration rule that you want to view. The name of the rule uses the syntax `{}`. For example, `Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}`. You can find the name values by running the command: Get-DeviceConfigurationRule | Format-List Name. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantPolicy.md index 919b43271d..f736b9a2f7 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-devicetenantpolicy applicable: Security & Compliance -title: Remove-DeviceTenantPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-devicetenantpolicy +schema: 2.0.0 +title: Remove-DeviceTenantPolicy --- # Remove-DeviceTenantPolicy @@ -50,13 +51,15 @@ This example removes your organization's mobile device tenant policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the mobile device tenant policy that you want to remove, but there's only one in your organization. The name of the policy is a GUID value. For example, a6958701-c82c-4064-ac11-64e40e7f4032. You can find this value by running the command: `Get-DeviceTenantPolicy | Format-List Name`. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantRule.md similarity index 96% rename from exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantRule.md index 0fe5232d12..bf650c0eed 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DeviceTenantRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-devicetenantrule applicable: Security & Compliance -title: Remove-DeviceTenantRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-devicetenantrule +schema: 2.0.0 +title: Remove-DeviceTenantRule --- # Remove-DeviceTenantRule @@ -51,13 +52,15 @@ This example removes the mobile device tenant rule from your organization. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the mobile device tenant rule that you want to remove, but there's only one in your organization. The name of the rule is a GUID. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. You can find the name value by running the command `Get-DeviceTenantRule | Format-List Name`. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroup.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroup.md index b35ddb9a2a..fe40250ea6 100644 --- a/exchange/exchange-ps/exchange/Remove-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-DistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-distributiongroup +schema: 2.0.0 +title: Remove-DistributionGroup --- # Remove-DistributionGroup @@ -45,6 +46,9 @@ This example removes the distribution group named Temporary Staff. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group that you want to remove. You can use any value that uniquely identifies the group. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -79,7 +85,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -139,7 +151,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroupMember.md similarity index 87% rename from exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroupMember.md index 0f323c30da..9d8ad97a3d 100644 --- a/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DistributionGroupMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-distributiongroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-DistributionGroupMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-distributiongroupmember +schema: 2.0.0 +title: Remove-DistributionGroupMember --- # Remove-DistributionGroupMember @@ -47,6 +48,9 @@ This example removes Jan Dryml from the distribution group named Technical Suppo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -81,7 +87,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -100,7 +108,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -118,7 +128,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Member parameter specifies the recipient that you want to remove from the group. You can use any value that uniquely identifies the recipient. For example: - Name @@ -141,7 +153,6 @@ The Member parameter specifies the recipient that you want to remove from the gr Type: GeneralRecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpCompliancePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpCompliancePolicy.md index 86f93677d8..02a2668fed 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpcompliancepolicy applicable: Security & Compliance -title: Remove-DlpCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpcompliancepolicy +schema: 2.0.0 +title: Remove-DlpCompliancePolicy --- # Remove-DlpCompliancePolicy @@ -49,6 +50,9 @@ This example removes a DLP policy specified by its name. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the DLP policy that you want to remove. You can Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpComplianceRule.md index cbbfa8b856..a615ba84e4 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpcompliancerule applicable: Security & Compliance -title: Remove-DlpComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpcompliancerule +schema: 2.0.0 +title: Remove-DlpComplianceRule --- # Remove-DlpComplianceRule @@ -42,6 +43,9 @@ This example removes the DLP rule named "PII SS# Custom". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the DLP rule that you want to remove. You can u Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpEdmSchema.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpEdmSchema.md index f32281feb1..3cca43e30a 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpEdmSchema.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpedmschema applicable: Security & Compliance -title: Remove-DlpEdmSchema -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpedmschema +schema: 2.0.0 +title: Remove-DlpEdmSchema --- # Remove-DlpEdmSchema @@ -42,6 +43,9 @@ This example removes the DLP EDM schema named Schema for Patient Records. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP EDM schema that you want to remove. You can use any value that uniquely identifies the schema. For example: - Name @@ -51,7 +55,6 @@ The Identity parameter specifies the DLP EDM schema that you want to remove. You Type: EdmStorageIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpKeywordDictionary.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpKeywordDictionary.md index 9497d5484f..2704bf769c 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpKeywordDictionary.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpkeyworddictionary applicable: Security & Compliance -title: Remove-DlpKeywordDictionary -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpkeyworddictionary +schema: 2.0.0 +title: Remove-DlpKeywordDictionary --- # Remove-DlpKeywordDictionary @@ -49,13 +50,15 @@ This example removes all the DLP keyword dictionaries with a Confirm on each rem ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the DLP keyword dictionary that you want to remove. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: SensitiveInformationTypeIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-DlpPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicy.md index e7591b41e1..316c9cd1a2 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlppolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-DlpPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlppolicy +schema: 2.0.0 +title: Remove-DlpPolicy --- # Remove-DlpPolicy @@ -45,6 +46,9 @@ This example removes the existing DLP policy named Contoso PII. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the DLP policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the DLP policy that you want to remove. You can Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicyTemplate.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicyTemplate.md index 6ec3166bac..1a5970540d 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpPolicyTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlppolicytemplate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-DlpPolicyTemplate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlppolicytemplate +schema: 2.0.0 +title: Remove-DlpPolicyTemplate --- # Remove-DlpPolicyTemplate @@ -43,13 +44,15 @@ This example removes the DLP policy template named External DLP Policy Template. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the DLP policy template you want to remove. You can use any value that uniquely identifies the DLP policy template. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy template. ```yaml Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationType.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationType.md index 248e930c45..309c5e9e1a 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype applicable: Security & Compliance -title: Remove-DlpSensitiveInformationType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtype +schema: 2.0.0 +title: Remove-DlpSensitiveInformationType --- # Remove-DlpSensitiveInformationType @@ -46,6 +47,9 @@ This example removes the sensitive information type rule named "Contoso Confiden ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitive information type rule that you want to remove. You can use any value that uniquely identifies the sensitive information type rule. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the sensitive information type rule that you wa Type: DataClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationTypeRulePackage.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationTypeRulePackage.md index 33e6cf6253..1bc9fb2d59 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DlpSensitiveInformationTypeRulePackage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage applicable: Security & Compliance -title: Remove-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dlpsensitiveinformationtyperulepackage +schema: 2.0.0 +title: Remove-DlpSensitiveInformationTypeRulePackage --- # Remove-DlpSensitiveInformationTypeRulePackage @@ -46,6 +47,9 @@ This example removes the non-Microsoft sensitive information type rule package n ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitive information type rule package that you want to remove. You can use any value that uniquely identifies the rule package. For example: - RuleCollectionName @@ -56,7 +60,6 @@ The Identity parameter specifies the sensitive information type rule package tha Type: SensitiveInformationTypeRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-DynamicDistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DynamicDistributionGroup.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-DynamicDistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-DynamicDistributionGroup.md index 3c76cd90a3..34d08a77f7 100644 --- a/exchange/exchange-ps/exchange/Remove-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DynamicDistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-dynamicdistributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-DynamicDistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dynamicdistributiongroup +schema: 2.0.0 +title: Remove-DynamicDistributionGroup --- # Remove-DynamicDistributionGroup @@ -44,6 +45,9 @@ This example deletes the dynamic distribution group named Test Users. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the dynamic distribution group that you want to remove. You can use any value that uniquely identifies the dynamic distribution group. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the dynamic distribution group that you want to Type: DynamicGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -117,7 +127,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-EOPProtectionPolicyRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-EOPProtectionPolicyRule.md index 9aeaf4a0cd..3581bd35c2 100644 --- a/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: Remove-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-eopprotectionpolicyrule +schema: 2.0.0 +title: Remove-EOPProtectionPolicyRule --- # Remove-EOPProtectionPolicyRule @@ -46,6 +47,9 @@ This example removes the existing rule for EOP protections in the Standard prese ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -58,7 +62,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-EcpVirtualDirectory.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-EcpVirtualDirectory.md index 07f4762142..5cecafe529 100644 --- a/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-EcpVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ecpvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-EcpVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ecpvirtualdirectory +schema: 2.0.0 +title: Remove-EcpVirtualDirectory --- # Remove-EcpVirtualDirectory @@ -45,6 +46,9 @@ This example removes the ECP virtual directory named ecp located on the default ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the ECP virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -59,7 +63,6 @@ Remote removal of an ECP virtual directory isn't supported. You need run this co Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md b/exchange/exchange-ps/ExchangePowerShell/Remove-EdgeSubscription.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-EdgeSubscription.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-EdgeSubscription.md index e792a7e0b9..b5b4a410da 100644 --- a/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-EdgeSubscription.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-edgesubscription applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-EdgeSubscription -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-edgesubscription +schema: 2.0.0 +title: Remove-EdgeSubscription --- # Remove-EdgeSubscription @@ -51,13 +52,15 @@ This example removes Edge Subscription for the Edge Transport server named Edge1 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the Edge Transport server for which you want to remove Edge Subscription. The identity is expressed as the host name of the Edge Transport server. ```yaml Type: TransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -94,7 +102,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. If you don't use this switch, the command will inform you that the removal of the replicated recipient data from AD LDS can take a long time and will give you the option to cancel the operation. @@ -112,7 +122,6 @@ If you don't use this switch, the command will inform you that the removal of th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-EmailAddressPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-EmailAddressPolicy.md index 8389a40fd5..c69eced8d4 100644 --- a/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-EmailAddressPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-emailaddresspolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-EmailAddressPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-emailaddresspolicy +schema: 2.0.0 +title: Remove-EmailAddressPolicy --- # Remove-EmailAddressPolicy @@ -43,6 +44,9 @@ This example removes the email address policy named Southwest Executives. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the email address policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the email address policy that you want to remov Type: EmailAddressPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -90,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ExchangeCertificate.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ExchangeCertificate.md index e6a35f7f1c..2d4b35d81b 100644 --- a/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ExchangeCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ExchangeCertificate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-exchangecertificate +schema: 2.0.0 +title: Remove-ExchangeCertificate --- # Remove-ExchangeCertificate @@ -67,6 +68,9 @@ This example uses the same settings, but removes the certificate from the server ## PARAMETERS ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Thumbprint parameter specifies the certificate that you want to remove. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. @@ -75,7 +79,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: String Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the certificate that you want to remove. Valid values are: - `ServerNameOrFQDN\Thumbprint` @@ -100,7 +106,6 @@ The Thumbprint parameter, not the Identity parameter, is the positional paramete Type: ExchangeCertificateIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -119,7 +127,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -137,7 +147,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,6 +156,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -162,7 +174,6 @@ You can't use this parameter with the Identity parameter, but you can use it wit Type: ServerIdParameter Parameter Sets: Thumbprint Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ExoPhishSimOverrideRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ExoPhishSimOverrideRule.md index d6d761dd66..d8fa30e9df 100644 --- a/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ExoPhishSimOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-exophishsimoverriderule applicable: Exchange Online -title: Remove-ExoPhishSimOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-exophishsimoverriderule +schema: 2.0.0 +title: Remove-ExoPhishSimOverrideRule --- # Remove-ExoPhishSimOverrideRule @@ -50,6 +51,9 @@ This example removes the specified phishing simulation override rule. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -63,7 +67,6 @@ Use the Get-ExoPhishSimOverrideRule cmdlet to find the values. The rule name syn Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ExoSecOpsOverrideRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ExoSecOpsOverrideRule.md index 4b7747e02b..38d2d1fda7 100644 --- a/exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ExoSecOpsOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-exosecopsoverriderule applicable: Exchange Online -title: Remove-ExoSecOpsOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-exosecopsoverriderule +schema: 2.0.0 +title: Remove-ExoSecOpsOverrideRule --- # Remove-ExoSecOpsOverrideRule @@ -50,6 +51,9 @@ This example removes the specified SecOps mailbox override rule. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -63,7 +67,6 @@ Use the Get-ExoSecOpsMailboxRule cmdlet to find these values. The name of the ru Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FeatureConfiguration.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FeatureConfiguration.md index d6b0f82b35..e010be3fb0 100644 --- a/exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FeatureConfiguration.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-featureconfiguration applicable: Security & Compliance -title: Remove-FeatureConfiguration +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-featureconfiguration schema: 2.0.0 +title: Remove-FeatureConfiguration --- # Remove-FeatureConfiguration @@ -45,6 +47,9 @@ This example removes the specified feature configuration. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity policy specifies the feature configuration that you want to remove. You can use any value that uniquely identifies the configuration. For example: - Name @@ -55,7 +60,6 @@ The Identity policy specifies the feature configuration that you want to remove. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -65,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FederatedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FederatedDomain.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-FederatedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FederatedDomain.md index c0cbc63696..0269e862b1 100644 --- a/exchange/exchange-ps/exchange/Remove-FederatedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FederatedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-federateddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-FederatedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-federateddomain +schema: 2.0.0 +title: Remove-FederatedDomain --- # Remove-FederatedDomain @@ -50,13 +51,15 @@ This example removes the federated domain contoso.co.uk from the federated organ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainName parameter specifies the federated domain name to be removed from the federated organization identifier. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -91,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +126,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch specifies whether to suppress warning or confirmation messages when removing a federated domain. You don't need to specify a value with this switch. You can use this switch when the removal of the federated domain from the cloud fails, but the configuration of this domain as a federated domain in Exchange should be removed regardless. @@ -125,7 +137,6 @@ You can use this switch when the removal of the federated domain from the cloud Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FederationTrust.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FederationTrust.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-FederationTrust.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FederationTrust.md index 86132d007a..69e84008a4 100644 --- a/exchange/exchange-ps/exchange/Remove-FederationTrust.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FederationTrust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-federationtrust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-FederationTrust -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-federationtrust +schema: 2.0.0 +title: Remove-FederationTrust --- # Remove-FederationTrust @@ -45,13 +46,15 @@ This example removes the federation trust Microsoft Federation Gateway. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the federation trust being removed. ```yaml Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyAuthority.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyAuthority.md index 6de6ae8679..65133d9e06 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyAuthority.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertyauthority applicable: Security & Compliance -title: Remove-FilePlanPropertyAuthority +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertyauthority schema: 2.0.0 +title: Remove-FilePlanPropertyAuthority --- # Remove-FilePlanPropertyAuthority @@ -40,6 +42,9 @@ This example removes the custom file plan property authority named Contoso Autho ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property authority that you want to remove. You can use any value that uniquely identifies the authority. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property authority that yo Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property authority. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCategory.md index e5e7d1c7fa..0653a2eb21 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertycategory applicable: Security & Compliance -title: Remove-FilePlanPropertyCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertycategory schema: 2.0.0 +title: Remove-FilePlanPropertyCategory --- # Remove-FilePlanPropertyCategory @@ -40,6 +42,9 @@ This example removes the custom file plan property category named Contoso Catego ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property category that you want to remove. You can use any value that uniquely identifies the category. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property category that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property category. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCitation.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCitation.md index 70c1f29a20..9f6392cdd1 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyCitation.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertycitation applicable: Security & Compliance -title: Remove-FilePlanPropertyCitation +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertycitation schema: 2.0.0 +title: Remove-FilePlanPropertyCitation --- # Remove-FilePlanPropertyCitation @@ -40,6 +42,9 @@ This example removes the custom file plan property citation named Contoso Citati ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property citation that you want to remove. You can use any value that uniquely identifies the citation. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property citation that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property citation. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyDepartment.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyDepartment.md index 630bbe64a4..db1ba02dff 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyDepartment.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertydepartment applicable: Security & Compliance -title: Remove-FilePlanPropertyDepartment +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertydepartment schema: 2.0.0 +title: Remove-FilePlanPropertyDepartment --- # Remove-FilePlanPropertyDepartment @@ -40,6 +42,9 @@ This example removes the custom file plan property department named Contoso HR. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property department that you want to remove. You can use any value that uniquely identifies the department. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property department that y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property department. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyReferenceId.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyReferenceId.md index 7548cc4cf3..02bbbaa8f0 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertyReferenceId.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertyreferenceid applicable: Security & Compliance -title: Remove-FilePlanPropertyReferenceId +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertyreferenceid schema: 2.0.0 +title: Remove-FilePlanPropertyReferenceId --- # Remove-FilePlanPropertyReferenceId @@ -40,6 +42,9 @@ This example removes the custom file plan property reference ID named Contoso-00 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property reference ID that you want to remove. You can use any value that uniquely identifies the reference ID. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property reference ID that Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property reference ID. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertySubCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertySubCategory.md index 5e45a1faf5..fdcb06a76b 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-FilePlanPropertySubCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertysubcategory applicable: Security & Compliance -title: Remove-FilePlanPropertySubCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-fileplanpropertysubcategory schema: 2.0.0 +title: Remove-FilePlanPropertySubCategory --- # Remove-FilePlanPropertySubCategory @@ -40,6 +42,9 @@ This example removes the custom file plan property subcategory named US Tax. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property subcategory that you want to movidy. You can use any value that uniquely identifies the subcategory. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property subcategory that Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the file plan property subcategory. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ForeignConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ForeignConnector.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-ForeignConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ForeignConnector.md index d43ea4b717..cca67c8bde 100644 --- a/exchange/exchange-ps/exchange/Remove-ForeignConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ForeignConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-foreignconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ForeignConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-foreignconnector +schema: 2.0.0 +title: Remove-ForeignConnector --- # Remove-ForeignConnector @@ -47,13 +48,15 @@ This example deletes the Foreign connector named Fax Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the GUID or connector name of a specific Foreign connector. You can also include the server name by using the format ServerName\\ConnectorName. ```yaml Type: ForeignConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -90,7 +98,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md b/exchange/exchange-ps/ExchangePowerShell/Remove-GlobalAddressList.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-GlobalAddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-GlobalAddressList.md index 2307a60bef..24d6c5a6f3 100644 --- a/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-GlobalAddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-globaladdresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-GlobalAddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-globaladdresslist +schema: 2.0.0 +title: Remove-GlobalAddressList --- # Remove-GlobalAddressList @@ -45,6 +46,9 @@ This example removes the GAL named OldGAL. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the global address list that you want to remove. You can use any value that uniquely identifies the GAL. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the global address list that you want to remove Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Remove-GlobalMonitoringOverride.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-GlobalMonitoringOverride.md index 6bdf488dfa..c8e627d480 100644 --- a/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-GlobalMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-globalmonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-GlobalMonitoringOverride -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-globalmonitoringoverride +schema: 2.0.0 +title: Remove-GlobalMonitoringOverride --- # Remove-GlobalMonitoringOverride @@ -52,13 +53,15 @@ This example removes a global monitoring override of the ExtensionAttributes pro ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the monitoring item that was overridden. The value is in the form of HealthSet\\MonitoringItem or HealthSet\\MonitoringItem\\TargetResource. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -ItemType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ItemType parameter specifies the item type that you want to remove. It can be any of the following values: - Probe @@ -78,7 +84,6 @@ The ItemType parameter specifies the item type that you want to remove. It can b Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PropertyName parameter specifies the property for the override you want to remove. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -BuildRange + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -129,7 +141,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +150,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -147,7 +161,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +170,15 @@ Accept wildcard characters: False ``` ### -Roles + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,13 +188,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HoldCompliancePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HoldCompliancePolicy.md index f4e942a974..bdefe64fb1 100644 --- a/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HoldCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-holdcompliancepolicy applicable: Security & Compliance -title: Remove-HoldCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-holdcompliancepolicy +schema: 2.0.0 +title: Remove-HoldCompliancePolicy --- # Remove-HoldCompliancePolicy @@ -47,6 +48,9 @@ This example removes the preservation policy named "Regulation 123 Compliance". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation policy to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the preservation policy to remove. You can use Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HoldComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HoldComplianceRule.md index 5b0fea9c47..377d8164f2 100644 --- a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HoldComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-holdcompliancerule applicable: Security & Compliance -title: Remove-HoldComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-holdcompliancerule +schema: 2.0.0 +title: Remove-HoldComplianceRule --- # Remove-HoldComplianceRule @@ -47,6 +48,9 @@ This example removes the preservation rule named "One Year Standard". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation rule to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the preservation rule to remove. You can use an Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterPolicy.md index b94bb23bff..1bcc3282ae 100644 --- a/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-hostedcontentfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Remove-HostedContentFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-hostedcontentfilterpolicy +schema: 2.0.0 +title: Remove-HostedContentFilterPolicy --- # Remove-HostedContentFilterPolicy @@ -44,6 +45,9 @@ This example removes the spam filter policy named Contoso Content Filter Policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the spam filter policy that you want to remove. Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterRule.md index 473b44deb4..b5601178f5 100644 --- a/exchange/exchange-ps/exchange/Remove-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection -title: Remove-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-hostedcontentfilterrule +schema: 2.0.0 +title: Remove-HostedContentFilterRule --- # Remove-HostedContentFilterRule @@ -42,6 +43,9 @@ This example removes the spam filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the spam filter rule that you want to remove. Y Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterPolicy.md index 20e3e3eb7f..ccbdb0fe1d 100644 --- a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Remove-HostedOutboundSpamFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterpolicy +schema: 2.0.0 +title: Remove-HostedOutboundSpamFilterPolicy --- # Remove-HostedOutboundSpamFilterPolicy @@ -43,6 +44,9 @@ This example removes the outbound spam filter policy named Contoso Executives. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter policy you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the outbound spam filter policy you want to rem Type: HostedOutboundSpamFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -71,7 +77,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterRule.md index cc89753dc3..48779d9ef1 100644 --- a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: Remove-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-hostedoutboundspamfilterrule +schema: 2.0.0 +title: Remove-HostedOutboundSpamFilterRule --- # Remove-HostedOutboundSpamFilterRule @@ -42,6 +43,9 @@ This example removes the outbound spam filter rule named Contoso Executives. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the outbound spam filter rule that you want to Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Remove-HybridConfiguration.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-HybridConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-HybridConfiguration.md index ed6b8d990c..678ece27dd 100644 --- a/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-HybridConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-hybridconfiguration applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-HybridConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-hybridconfiguration +schema: 2.0.0 +title: Remove-HybridConfiguration --- # Remove-HybridConfiguration @@ -44,6 +45,9 @@ This example removes the HybridConfiguration object for the hybrid deployment. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -53,7 +57,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -71,7 +77,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListEntry.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListEntry.md index 07022d05d8..1eb3678517 100644 --- a/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipallowlistentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-IPAllowListEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ipallowlistentry +schema: 2.0.0 +title: Remove-IPAllowListEntry --- # Remove-IPAllowListEntry @@ -50,13 +51,15 @@ This example removes the IP address range 192.168.0.0/24 from the IP Allow list. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the integer value of the IP Allow list entry that you want to remove. When you add an entry to the IP Allow list, the Identity value is automatically assigned. To find the Identity value of an IP Allow list entry, use the Get-IPAllowListEntry cmdlet. ```yaml Type: IPListEntryIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -100,7 +108,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListProvider.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListProvider.md index 530652a8e2..59c3544dac 100644 --- a/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-IPAllowListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipallowlistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-IPAllowListProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ipallowlistprovider +schema: 2.0.0 +title: Remove-IPAllowListProvider --- # Remove-IPAllowListProvider @@ -43,6 +44,9 @@ This example removes the IP Allow list provider named Contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the IP Allow list provider that you want to remove. You can use any value that uniquely identifies the IP Allow list provider. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the IP Allow list provider that you want to rem Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -90,7 +98,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md b/exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListEntry.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListEntry.md index 81f9179a23..6fc2815694 100644 --- a/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListEntry.md @@ -1,15 +1,16 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipblocklistentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-IPBlockListEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ipblocklistentry +schema: 2.0.0 +title: Remove-IPBlockListEntry --- -# Remove-IPBlocklistEntry +# Remove-IPBlockListEntry ## SYNOPSIS This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. @@ -21,7 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Remove-IPBlocklistEntry [-Identity] +Remove-IPBlockListEntry [-Identity] [-Confirm] [-Server ] [-WhatIf] @@ -50,13 +51,15 @@ This example removes the IP address range 192.168.0.0/24 from the IP Block list. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the integer value of the IP Block list entry that you want to remove. When you add an entry to the IP Block list, the Identity value is automatically assigned. To find the Identity value of an IP Block list entry, use the Get-IPBlockListEntry cmdlet. ```yaml Type: IPListEntryIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -100,7 +108,6 @@ You can't use this command to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListProvider.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListProvider.md index 27e5a41a87..d9de5066d9 100644 --- a/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-IPBlockListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipblocklistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-IPBlockListProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ipblocklistprovider +schema: 2.0.0 +title: Remove-IPBlockListProvider --- # Remove-IPBlockListProvider @@ -43,6 +44,9 @@ This example removes the IP Block list provider named Contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the IP Block list provider that you want to remove. You can use any value that uniquely identifies the IP Block list provider. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the IP Block list provider that you want to rem Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -90,7 +98,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-InboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-InboundConnector.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-InboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-InboundConnector.md index 643afa3df0..ab3d6ef257 100644 --- a/exchange/exchange-ps/exchange/Remove-InboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-InboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-inboundconnector applicable: Exchange Online, Exchange Online Protection -title: Remove-InboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-inboundconnector +schema: 2.0.0 +title: Remove-InboundConnector --- # Remove-InboundConnector @@ -44,13 +45,15 @@ This example deletes the Inbound connector named Contoso Inbound Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Inbound connector you want to remove. ```yaml Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-InboxRule.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-InboxRule.md index 78a9af6e7b..7fa5cb1815 100644 --- a/exchange/exchange-ps/exchange/Remove-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-InboxRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-InboxRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-inboxrule +schema: 2.0.0 +title: Remove-InboxRule --- # Remove-InboxRule @@ -55,6 +56,9 @@ This example removes all Inbox rules from the mailbox Joe@Contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Inbox rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ The Identity parameter specifies the Inbox rule that you want to remove. You can Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -101,7 +109,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -119,7 +129,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. @@ -137,7 +149,6 @@ A confirmation prompt warns you if the mailbox contains rules that were created Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -147,6 +158,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -164,7 +178,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-InformationBarrierPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-InformationBarrierPolicy.md index daac4a22b1..f8a2f0c819 100644 --- a/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-InformationBarrierPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-informationbarrierpolicy applicable: Security & Compliance -title: Remove-InformationBarrierPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-informationbarrierpolicy +schema: 2.0.0 +title: Remove-InformationBarrierPolicy --- # Remove-InformationBarrierPolicy @@ -45,6 +46,9 @@ This example removes the information barrier policy named HR-Sales. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the information barrier policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the information barrier policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the information barrier policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -128,4 +137,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-IntraOrganizationConnector.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-IntraOrganizationConnector.md index 6f4cb23daa..63bd0b6700 100644 --- a/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-IntraOrganizationConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-intraorganizationconnector applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-IntraOrganizationConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-intraorganizationconnector +schema: 2.0.0 +title: Remove-IntraOrganizationConnector --- # Remove-IntraOrganizationConnector @@ -47,6 +48,9 @@ This example removes the existing Intra-Organization connector named "Contoso On ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Intra-Organization connector that you want to remove. You can use any value that uniquely identifies the connector. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the Intra-Organization connector that you want Type: IntraOrganizationConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-JournalRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-JournalRule.md index da555a20f0..751b3b50ad 100644 --- a/exchange/exchange-ps/exchange/Remove-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-JournalRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-journalrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-JournalRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-journalrule +schema: 2.0.0 +title: Remove-JournalRule --- # Remove-JournalRule @@ -45,13 +46,15 @@ This example removes the journal rule Brokerage Communications that's no longer ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the rule you want to remove. Enter either name or the GUID of the journal rule. You can omit the parameter label. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -88,7 +96,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-Label.md b/exchange/exchange-ps/ExchangePowerShell/Remove-Label.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-Label.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-Label.md index 7b1812a00e..300aa387d9 100644 --- a/exchange/exchange-ps/exchange/Remove-Label.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-Label.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-label applicable: Security & Compliance -title: Remove-Label -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-label +schema: 2.0.0 +title: Remove-Label --- # Remove-Label @@ -42,6 +43,9 @@ This example removes the sensitivity label named Marketing Group. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitivity label that you want to remove. You can use any value that uniquely identifies the label. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the sensitivity label that you want to remove. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-LabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-LabelPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-LabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-LabelPolicy.md index 2289247216..5760314b03 100644 --- a/exchange/exchange-ps/exchange/Remove-LabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-LabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-labelpolicy applicable: Security & Compliance -title: Remove-LabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-labelpolicy +schema: 2.0.0 +title: Remove-LabelPolicy --- # Remove-LabelPolicy @@ -42,6 +43,9 @@ This example removes the policy named Marketing Group. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the policy that you want to remove. You can use Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailContact.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailContact.md index 8a14dbb711..a45da6931e 100644 --- a/exchange/exchange-ps/exchange/Remove-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailContact.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailcontact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-MailContact -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailcontact +schema: 2.0.0 +title: Remove-MailContact --- # Remove-MailContact @@ -44,6 +45,9 @@ This example removes the mail contact named John. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail contact that you want to remove. You can use any value that uniquely identifies the mail contact. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the mail contact that you want to remove. You c Type: MailContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -117,7 +127,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailUser.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailUser.md index 022d16da1d..65fa8bfa18 100644 --- a/exchange/exchange-ps/exchange/Remove-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-MailUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailuser +schema: 2.0.0 +title: Remove-MailUser --- # Remove-MailUser @@ -46,6 +47,9 @@ This example removes the mail user named Ed Meadows. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail user that you want to remove. You can use any value that uniquely identifies the mail user. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the mail user that you want to remove. You can Type: MailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -96,7 +104,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -119,7 +129,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. @@ -141,7 +153,6 @@ After you disable or remove a mailbox, you can't include it in a discovery searc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -PermanentlyDelete + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PermanentlyDelete switch immediately and permanently deletes (purges) the mail user, which prevents you from recovering or restoring the mail user. You don't need to specify a value with this switch. @@ -164,7 +178,6 @@ The PermanentlyDelete switch immediately and permanently deletes (purges) the ma Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Remove-Mailbox.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-Mailbox.md index 27447b1e7a..3aeeb163aa 100644 --- a/exchange/exchange-ps/exchange/Remove-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-Mailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailbox +schema: 2.0.0 +title: Remove-Mailbox --- # Remove-Mailbox @@ -117,6 +118,9 @@ In Exchange Online, this example removes the specified soft-deleted mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter identifies the mailbox that you want to remove. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -136,7 +140,6 @@ You can't use this parameter with the Database parameter. Type: MailboxIdParameter Parameter Sets: Identity, Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -146,6 +149,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Database parameter specifies the Exchange database that contains the mailbox that you want to remove. You can use any value that uniquely identifies the database. For example: @@ -162,7 +168,6 @@ If you've disconnected a mailbox from its associated user and want to remove the Type: DatabaseIdParameter Parameter Sets: StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -172,6 +177,9 @@ Accept wildcard characters: False ``` ### -StoreMailboxIdentity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The StoreMailboxIdentity parameter specifies the mailbox that you want to remove. When you use this parameter, you identify the mailbox by its MailboxGUID value. You can find the GUID value by using the Get-Mailbox or Get-MailboxStatistics cmdlets. @@ -184,7 +192,6 @@ If you've disconnected a mailbox from its associated user and want to remove the Type: StoreMailboxIdParameter Parameter Sets: StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -194,6 +201,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Arbitration switch is required to remove arbitration mailboxes. You don't need to specify a value with this switch. @@ -206,7 +216,6 @@ To remove arbitration mailboxes that are used to store audit log settings or dat Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -216,6 +225,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuditLog switch is required to remove audit log mailboxes. You don't need to specify a value with this switch. @@ -228,7 +240,6 @@ To remove other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,6 +249,9 @@ Accept wildcard characters: False ``` ### -AuxAuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuxAuditLog switch is required to remove auxiliary audit log mailboxes. You don't need to specify a value with this switch. @@ -250,7 +264,6 @@ To remove other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,6 +273,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -269,7 +285,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -279,6 +294,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -287,7 +305,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,6 +314,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -305,7 +325,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -315,6 +334,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -328,7 +350,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -338,6 +359,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. @@ -350,7 +374,6 @@ After you disable or remove a mailbox, you can't include it in a discovery searc Type: SwitchParameter Parameter Sets: Identity, StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -360,13 +383,15 @@ Accept wildcard characters: False ``` ### -Migration + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Migration switch is required to remove migration mailboxes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -376,6 +401,9 @@ Accept wildcard characters: False ``` ### -Permanent + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Permanent parameter specifies whether to permanently delete the mailbox from the mailbox database. Valid values are: @@ -387,7 +415,6 @@ The Permanent parameter specifies whether to permanently delete the mailbox from Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -397,6 +424,9 @@ Accept wildcard characters: False ``` ### -PermanentlyDelete + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PermanentlyDelete switch immediately and permanently deletes (purges) the mailbox, which prevents you from recovering or restoring the mailbox. You don't need to specify a value with this switch. @@ -410,7 +440,6 @@ The PermanentlyDelete switch immediately and permanently deletes (purges) the ma Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -420,6 +449,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublicFolder switch is required to remove public folder mailboxes. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -428,7 +460,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -438,6 +469,9 @@ Accept wildcard characters: False ``` ### -RemoveArbitrationMailboxWithOABsAllowed + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoveArbitrationMailboxWithOABsAllowed switch specifies whether to bypass the checks for offline address books (OABs) within the specified arbitration mailbox that is being removed. You don't need to specify a value with this switch. @@ -448,7 +482,6 @@ When you use this switch, the arbitration mailbox is removed even if OABs are pr Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -458,6 +491,9 @@ Accept wildcard characters: False ``` ### -RemoveCNFPublicFolderMailboxPermanently + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RemoveCNFPublicFolderMailboxPermanently Description }} @@ -466,7 +502,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -476,6 +511,9 @@ Accept wildcard characters: False ``` ### -RemoveLastArbitrationMailboxAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoveLastArbitrationMailboxAllowed switch specifies whether to remove the specified mailbox, even if it's the last arbitration mailbox in the organization. You don't need to specify a value with this switch. @@ -486,7 +524,6 @@ If you remove the last arbitration mailbox in the organization, you can't have u Type: SwitchParameter Parameter Sets: StoreMailboxIdentity, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -496,6 +533,9 @@ Accept wildcard characters: False ``` ### -SupervisoryReviewPolicy + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -504,7 +544,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: Identity, StoreMailboxIdentity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -514,13 +553,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabase.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-MailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabase.md index 3e424e0421..943286d523 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MailboxDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxdatabase +schema: 2.0.0 +title: Remove-MailboxDatabase --- # Remove-MailboxDatabase @@ -47,6 +48,9 @@ This example removes the mailbox database MailboxDatabase01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox database that you want to remove. You can use any value that uniquely identifies the database. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the mailbox database that you want to remove. Y Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabaseCopy.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabaseCopy.md index 6fd45481ac..e6b2cbbd4e 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxdatabasecopy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MailboxDatabaseCopy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxdatabasecopy +schema: 2.0.0 +title: Remove-MailboxDatabaseCopy --- # Remove-MailboxDatabaseCopy @@ -52,13 +53,15 @@ This example removes a copy of mailbox database DB1 from the Mailbox server MBX3 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the mailbox database whose copy is being removed. When using this parameter, specify a format of DatabaseName\\ServerName. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxExportRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxExportRequest.md index 6f850b68be..9e5d6dcdcb 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MailboxExportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxexportrequest +schema: 2.0.0 +title: Remove-MailboxExportRequest --- # Remove-MailboxExportRequest @@ -76,6 +77,9 @@ This example cancels the export request by using the RequestGuid parameter for a ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). Use the following syntax: `Alias\Name`. You can't use this parameter with the RequestGuid parameter. @@ -84,7 +88,6 @@ You can't use this parameter with the RequestGuid parameter. Type: MailboxExportRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -94,13 +97,15 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequestGuid parameter specifies the unique identifier for the export request. To find the export request GUID, use the Get-MailboxExportRequest cmdlet. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter. You can't use this parameter with the Identity parameter. ```yaml Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -122,7 +130,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -141,7 +151,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -175,7 +189,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,13 +198,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxFolderPermission.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxFolderPermission.md index 3dccb1d13c..ba7741eb85 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxFolderPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxFolderPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxfolderpermission +schema: 2.0.0 +title: Remove-MailboxFolderPermission --- # Remove-MailboxFolderPermission @@ -73,6 +74,9 @@ This example will clear any corrupted delegate information from Kim's mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the target mailbox and folder. The syntax is `Mailbox:\Folder`. For the value of Mailbox, you can use any value that uniquely identifies the mailbox. For example: - Name @@ -92,7 +96,6 @@ Example values for the Identity parameter are `john@contoso.com:\Calendar` or `J Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. For the best results, we recommend using the following values: @@ -122,7 +128,6 @@ Otherwise, you can use any value that uniquely identifies the user or group. For Type: MailboxFolderUserIdParameter Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -132,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -141,7 +149,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -151,6 +158,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -159,7 +169,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,6 +178,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -179,7 +191,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity, ResetDelegateUserCollection Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -189,6 +200,9 @@ Accept wildcard characters: False ``` ### -ResetDelegateUserCollection + +> Applicable: Exchange Server 2019, Exchange Online + The ResetDelegateUserCollection switch forces the removal of the LocalFreeBusy or the PR_FREEBUSY_ENTRYIDs files in case of corruption. You don't need to specify a value with this switch. Use this switch if you encounter problems trying add, change, or remove delegate permissions. Using this switch deletes those files and downgrades any existing delegates to Editor permissions. You'll need to grant delegate permissions again using `-SharingPermissionFlag Delegate`. @@ -199,7 +213,6 @@ When you use this switch, the value of Identity should be the user's primary cal Type: SwitchParameter Parameter Sets: ResetDelegateUserCollection Aliases: -Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,6 +222,9 @@ Accept wildcard characters: False ``` ### -SendNotificationToUser + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SendNotificationToUser parameter specifies whether to send a notification to the user when you remove their calendar permissions. Valid values are: @@ -222,7 +238,6 @@ This parameter only applies to calendar folders. Type: Boolean Parameter Sets: Identity, ResetDelegateUserCollection Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -232,13 +247,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -264,10 +281,10 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderpermission) -[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxfolderpermission) -[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxIRMAccess.md similarity index 96% rename from exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxIRMAccess.md index 688966ba55..1c949e5443 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxIRMAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxirmaccess applicable: Exchange Online -title: Remove-MailboxIRMAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxirmaccess +schema: 2.0.0 +title: Remove-MailboxIRMAccess --- # Remove-MailboxIRMAccess @@ -43,6 +44,9 @@ This example removes the restriction from IRM-protected messages in Lynette's ma ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + **Note**: Delegates that you specify with this parameter must already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). The User parameter specifies the delegate who is no longer blocked from reading IRM-protected messages in the mailbox. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: @@ -89,7 +95,6 @@ The User parameter specifies the delegate who is no longer blocked from reading Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxImportRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxImportRequest.md index e4a36d24de..88ffe57767 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxImportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxImportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboximportrequest +schema: 2.0.0 +title: Remove-MailboxImportRequest --- # Remove-MailboxImportRequest @@ -78,6 +79,9 @@ This example removes all completed import requests. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you created the request using the Name parameter, use the following syntax: `Alias\Name`. You can't use this parameter with the RequestGuid parameter. @@ -86,7 +90,6 @@ You can't use this parameter with the RequestGuid parameter. Type: MailboxImportRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestGuid parameter (together with the RequestQueue parameter) specifies the unique identifier for the import request. To find the import request GUID, use the Get-MailboxImportRequest cmdlet. @@ -106,7 +112,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -130,7 +138,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -149,7 +159,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -167,7 +179,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,6 +188,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -185,7 +199,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -195,13 +208,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxPermission.md similarity index 85% rename from exchange/exchange-ps/exchange/Remove-MailboxPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxPermission.md index b6e76be563..64516015a0 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxpermission +schema: 2.0.0 +title: Remove-MailboxPermission --- # Remove-MailboxPermission @@ -107,6 +108,9 @@ In Exchange Online, this example excludes the HR Project mailbox from auto-mappi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox where you are removing permissions. You can use any value that uniquely identifies the mailbox: For example: - Name @@ -124,7 +128,6 @@ The Identity parameter specifies the mailbox where you are removing permissions. Type: MailboxIdParameter Parameter Sets: AccessRights, Owner, ClearAutoMapping, ResetDefault Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -134,6 +137,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AccessRights parameter specifies the permission that you want to remove from the user on the mailbox. Valid values are: - FullAccess @@ -148,9 +154,8 @@ You can specify multiple values separated by commas. ```yaml Type: MailboxRights[] -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -159,33 +164,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MailboxRights[] -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: MailboxIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Instance -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -Instance This parameter is available only in on-premises Exchange. The Instance parameter enables you to pass an entire object to the command to be processed. It's mainly used in scripts where an entire object must be passed to the command. @@ -194,7 +176,6 @@ The Instance parameter enables you to pass an entire object to the command to be Type: MailboxAcePresentationObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -204,6 +185,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The User parameter specifies whose permissions are being removed from the specified mailbox. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -230,9 +214,8 @@ Otherwise, you can use any value that uniquely identifies the user or group. For ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: AccessRights +Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -241,20 +224,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -ClearAutoMapping -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -### -ClearAutoMapping This parameter is functional only in the cloud-based service. The ClearAutoMapping parameter excludes the mailbox from the auto-mapping feature in Microsoft Outlook. You don't need to specify a value with this switch. @@ -269,7 +242,6 @@ You can't use this switch with the User or AccessRights parameters. Type: SwitchParameter Parameter Sets: ClearAutoMapping Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -279,6 +251,9 @@ Accept wildcard characters: False ``` ### -ResetDefault + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The ResetDefault switch resets the default security descriptor of the mailbox. You don't need to specify a value with this switch. @@ -297,7 +272,6 @@ You can't use this switch with the User for AccessRights parameters. Type: SwitchParameter Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -307,6 +281,9 @@ Accept wildcard characters: False ``` ### -BypassMasterAccountSid + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BypassMasterAccountSid switch suppresses the following error: `Can't remove the access control entry on the object "User" for the user account because the ACE doesn't exist on the object.` You don't need to specify a value with this switch. @@ -317,7 +294,6 @@ Typically, you only need to use this switch in Office 365 Dedicated or ITAR lega Type: SwitchParameter Parameter Sets: AccessRights, Owner, ClearAutoMapping Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -327,6 +303,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -336,7 +315,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -346,13 +324,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Deny switch specifies that the permissions you're removing are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -362,6 +342,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -370,7 +353,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -380,6 +362,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to remove permissions from a Microsoft 365 Group mailbox. You don't need to specify a value with this switch. @@ -388,7 +373,6 @@ The GroupMailbox switch is required to remove permissions from a Microsoft 365 G Type: SwitchParameter Parameter Sets: AccessRights, Owner, Instance Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -398,6 +382,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -409,7 +396,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -419,6 +405,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InheritanceType parameter specifies whether permissions are inherited to folders within the mailbox. Valid values are: - None @@ -431,7 +420,6 @@ The InheritanceType parameter specifies whether permissions are inherited to fol Type: ActiveDirectorySecurityInheritance Parameter Sets: AccessRights, Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -441,6 +429,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SoftDeletedMailbox switch is required to remove permissions from a soft-deleted mailbox. You don't need to specify a value with this switch. @@ -451,7 +442,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: AccessRights Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -461,13 +451,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRepairRequest.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRepairRequest.md index c9037afa2f..714bff2d94 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRepairRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxrepairrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MailboxRepairRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxrepairrequest +schema: 2.0.0 +title: Remove-MailboxRepairRequest --- # Remove-MailboxRepairRequest @@ -63,13 +64,15 @@ This example deletes a specific mailbox repair request by specifying the unique ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox repair request to remove. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is `DatabaseGuid\RequestGuid\JobGuid`. Use the Get-MailboxRepairRequest cmdlet to find the identity of a mailbox repair request. ```yaml Type: StoreIntegrityCheckJobIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRestoreRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRestoreRequest.md index 96cc00e783..9a86971144 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxRestoreRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxRestoreRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxrestorerequest +schema: 2.0.0 +title: Remove-MailboxRestoreRequest --- # Remove-MailboxRestoreRequest @@ -72,6 +73,9 @@ This example cancels the restore request by using the RequestGuid parameter for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated a default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -80,7 +84,6 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: MailboxRestoreRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestGuid parameter specifies the unique identifier for the restore request. To find the GUID, use the Get-MailboxRestoreRequest cmdlet. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter. @@ -100,7 +106,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestQueue parameter specifies the target mailbox database on which the mailbox or archive of the request resides. You can use any value that uniquely identifies the database. For example: @@ -124,7 +132,6 @@ You must use this parameter with the RequestGuid parameter. You can't use this p Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -143,7 +153,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -161,7 +173,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +182,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -179,7 +193,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -189,13 +202,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxSearch.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxSearch.md index eca5f3db04..0c67e70f83 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxsearch +schema: 2.0.0 +title: Remove-MailboxSearch --- # Remove-MailboxSearch @@ -47,13 +48,15 @@ This example removes the mailbox search Project Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the mailbox search. ```yaml Type: SearchObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -90,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxUserConfiguration.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MailboxUserConfiguration.md index 723d1efc08..c8bd7e9dd0 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MailboxUserConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxuserconfiguration applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MailboxUserConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxuserconfiguration +schema: 2.0.0 +title: Remove-MailboxUserConfiguration --- # Remove-MailboxUserConfiguration @@ -43,6 +44,9 @@ This example removes the specified user configuration item from the mailbox juli ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the user configuration item that you want to remove. This parameter uses the syntax MailboxFolder\ItemName: - Valid values for MailboxFolder are folder names (for example, Inbox or Calendar), the value Configuration, or the value Root. Wildcards (\*) aren't supported. @@ -52,7 +56,6 @@ The Identity parameter specifies the user configuration item that you want to re Type: MailboxUserConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the user configuration items you want to remove. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -79,7 +85,6 @@ The Mailbox parameter specifies the mailbox that contains the user configuration Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MalwareFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-MalwareFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterPolicy.md index a5c3c84db4..61b270394e 100644 --- a/exchange/exchange-ps/exchange/Remove-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-malwarefilterpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-MalwareFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-malwarefilterpolicy +schema: 2.0.0 +title: Remove-MalwareFilterPolicy --- # Remove-MalwareFilterPolicy @@ -46,13 +47,15 @@ This example removes the malware filter policy named Contoso Malware Filter Poli ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter policy you want to remove. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the malware filter policy. ```yaml Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -89,7 +97,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -109,7 +119,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterRule.md index 4171ff3c01..9ef8eb5d88 100644 --- a/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MalwareFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-MalwareFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-malwarefilterrule +schema: 2.0.0 +title: Remove-MalwareFilterRule --- # Remove-MalwareFilterRule @@ -43,13 +44,15 @@ This example removes the malware filter rule named Contoso Recipients. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter rule that you want to remove. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -86,7 +94,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedContentSettings.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagedContentSettings.md index 3ec37d8684..15b27f5dc3 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedContentSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managedcontentsettings applicable: Exchange Server 2010 -title: Remove-ManagedContentSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managedcontentsettings +schema: 2.0.0 +title: Remove-ManagedContentSettings --- # Remove-ManagedContentSettings @@ -45,13 +46,15 @@ This example deletes the managed content settings MyManagedContentSettings. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed content settings. ```yaml Type: ELCContentSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagedFolder.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolder.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-ManagedFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolder.md index 7b68957f99..47dd5e5805 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagedFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managedfolder applicable: Exchange Server 2010 -title: Remove-ManagedFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managedfolder +schema: 2.0.0 +title: Remove-ManagedFolder --- # Remove-ManagedFolder @@ -45,13 +46,15 @@ This example removes the managed folder MyManagedFolder. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder. ```yaml Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolderMailboxPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolderMailboxPolicy.md index 4cd1f7a86c..4a3882a8e3 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagedFolderMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managedfoldermailboxpolicy applicable: Exchange Server 2010 -title: Remove-ManagedFolderMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managedfoldermailboxpolicy +schema: 2.0.0 +title: Remove-ManagedFolderMailboxPolicy --- # Remove-ManagedFolderMailboxPolicy @@ -46,13 +47,15 @@ This example removes the managed folder mailbox policy My Managed Folder Mailbox ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -97,6 +104,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. This switch hides the confirmation prompt when the managed folder mailbox policy that's being removed is assigned to a mailbox user. @@ -105,7 +115,6 @@ This switch hides the confirmation prompt when the managed folder mailbox policy Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRole.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRole.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-ManagementRole.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRole.md index 60ed3913e0..c55c9255c5 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRole.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementrole applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-ManagementRole -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managementrole +schema: 2.0.0 +title: Remove-ManagementRole --- # Remove-ManagementRole @@ -73,13 +74,15 @@ For more information about unscoped top-level management roles, see [Understandi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the custom role to remove. If the name of the role contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,6 +113,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -116,7 +124,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -136,7 +146,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -Recurse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Recurse switch removes the specified role and all child roles of the specified role. You don't need to specify a value with this switch. We recommend that you test the command with the WhatIf switch to confirm that the results will be correct. @@ -154,7 +166,6 @@ We recommend that you test the command with the WhatIf switch to confirm that th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -164,6 +175,9 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -176,7 +190,6 @@ Unscoped top-level management roles can only contain custom scripts or non-Excha Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleAssignment.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleAssignment.md index 7540ec48ac..41c64180c4 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleAssignment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementroleassignment applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-ManagementRoleAssignment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managementroleassignment +schema: 2.0.0 +title: Remove-ManagementRoleAssignment --- # Remove-ManagementRoleAssignment @@ -55,13 +56,15 @@ After the list of role assignments to be removed is confirmed, remove the WhatIf ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the role assignment to remove. If the role assignment name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleAssignmentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -118,7 +128,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleEntry.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleEntry.md index a6d8a1d54c..fa22bd85fe 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementRoleEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementroleentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-ManagementRoleEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managementroleentry +schema: 2.0.0 +title: Remove-ManagementRoleEntry --- # Remove-ManagementRoleEntry @@ -59,6 +60,9 @@ This example forces you to acknowledge the command before proceeding (we didn't ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the role entry that you want to remove. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). @@ -69,7 +73,6 @@ If the role entry name contains spaces, enclose the name in quotation marks ("). Type: RoleEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -106,7 +114,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -126,7 +136,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ManagementScope.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementScope.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-ManagementScope.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ManagementScope.md index ec73842594..da3e698805 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ManagementScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementscope applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-ManagementScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-managementscope +schema: 2.0.0 +title: Remove-ManagementScope --- # Remove-ManagementScope @@ -55,13 +56,15 @@ After you verify that the scopes to be removed are correct, run the command agai ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the scope to remove. You can't remove a scope if it's in use by a management role assignment. ```yaml Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -118,7 +128,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MapiVirtualDirectory.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MapiVirtualDirectory.md index 936faaf305..743e25116c 100644 --- a/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MapiVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mapivirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-MapiVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mapivirtualdirectory +schema: 2.0.0 +title: Remove-MapiVirtualDirectory --- # Remove-MapiVirtualDirectory @@ -43,6 +44,9 @@ This example removes the MAPI virtual directory from the local server named Cont ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the MAPI virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -55,7 +59,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-Message.md b/exchange/exchange-ps/ExchangePowerShell/Remove-Message.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-Message.md index ecf08727f1..f61b55fd1a 100644 --- a/exchange/exchange-ps/exchange/Remove-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-message applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-Message -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-message +schema: 2.0.0 +title: Remove-Message --- # Remove-Message @@ -58,13 +59,15 @@ This example removes all messages that meet the following criteria without gener ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -82,7 +88,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -101,7 +109,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -126,7 +136,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -WithNDR + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WithNDR parameter specifies whether a non-delivery report (NDR) is returned to the sender of a message. The default value is $true. This parameter can be used with both the Identity parameter and Filter parameter sets. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MessageClassification.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MessageClassification.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-MessageClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MessageClassification.md index 430c30d775..488a7efb2d 100644 --- a/exchange/exchange-ps/exchange/Remove-MessageClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MessageClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-messageclassification applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MessageClassification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-messageclassification +schema: 2.0.0 +title: Remove-MessageClassification --- # Remove-MessageClassification @@ -43,6 +44,9 @@ This example removes the message classification named "My Message Classification ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the message classification that you want to remove. You can use any value that uniquely identifies the message classification. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the message classification that you want to rem Type: MessageClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -92,7 +100,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -130,4 +139,6 @@ To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Ty ### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. +## NOTES + ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationBatch.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MigrationBatch.md index 7a3f08fc37..1c7dc32bba 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationBatch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MigrationBatch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-migrationbatch +schema: 2.0.0 +title: Remove-MigrationBatch --- # Remove-MigrationBatch @@ -56,13 +57,15 @@ This example removes the corrupted migration batch LocalMove1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter identifies the migration batch that you want to remove. The value for this parameter is the name that was specified when the migration batch was created. ```yaml Type: MigrationBatchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -121,7 +131,6 @@ If you use this switch to remove a corrupted migration batch, the individual use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -139,7 +151,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationEndpoint.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MigrationEndpoint.md index 9484d7d7e2..a5d4823b42 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationEndpoint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-migrationendpoint applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MigrationEndpoint -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-migrationendpoint +schema: 2.0.0 +title: Remove-MigrationEndpoint --- # Remove-MigrationEndpoint @@ -32,7 +33,7 @@ Remove-MigrationEndpoint [-Identity] ## DESCRIPTION Use the Remove-MigrationEndpoint cmdlet to remove an existing migration endpoint. -For more information about migration endpoints, see [Set-MigrationEndpoint](https://learn.microsoft.com/powershell/module/exchange/set-migrationendpoint) and [New-MigrationEndpoint](https://learn.microsoft.com/powershell/module/exchange/new-migrationendpoint). +For more information about migration endpoints, see [Set-MigrationEndpoint](https://learn.microsoft.com/powershell/module/exchangepowershell/set-migrationendpoint) and [New-MigrationEndpoint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-migrationendpoint). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -48,13 +49,15 @@ This example removes the migration endpoint CrossForestME01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the migration endpoint you want to remove. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -91,7 +99,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -109,7 +119,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MigrationUser.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationUser.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-MigrationUser.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MigrationUser.md index 61036e2269..6b633b250b 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MigrationUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-migrationuser applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MigrationUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-migrationuser +schema: 2.0.0 +title: Remove-MigrationUser --- # Remove-MigrationUser @@ -45,13 +46,15 @@ This example removes the migration user Tony Smith from a migration batch. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the user that you want to remove from the migration batch. ```yaml Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -88,7 +96,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -108,7 +118,6 @@ Use this switch to work around user or data corruption issues. Specific checks a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -126,7 +138,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -136,13 +147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MobileDevice.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MobileDevice.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-MobileDevice.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MobileDevice.md index dc6843cec8..a77fdb44ad 100644 --- a/exchange/exchange-ps/exchange/Remove-MobileDevice.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MobileDevice.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mobiledevice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MobileDevice -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mobiledevice +schema: 2.0.0 +title: Remove-MobileDevice --- # Remove-MobileDevice @@ -52,6 +53,9 @@ This example removes the mobile device partnership for the specified device and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mobile device partnership that you want to remove. You can use the following values that uniquely identifies the mobile device: - Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) @@ -62,7 +66,6 @@ The Identity parameter specifies the mobile device partnership that you want to Type: MobileDeviceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MobileDeviceMailboxPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MobileDeviceMailboxPolicy.md index 24f850cef1..ca89c8284e 100644 --- a/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MobileDeviceMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-mobiledevicemailboxpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MobileDeviceMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mobiledevicemailboxpolicy +schema: 2.0.0 +title: Remove-MobileDeviceMailboxPolicy --- # Remove-MobileDeviceMailboxPolicy @@ -60,6 +61,9 @@ This example removes the mobile device mailbox policy named Management and bypas ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mobile device mailbox policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the mobile device mailbox policy that you want Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -89,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -107,7 +115,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -125,7 +135,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-MoveRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-MoveRequest.md index ff8f5e3203..ba85c16ce2 100644 --- a/exchange/exchange-ps/exchange/Remove-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-MoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-MoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-moverequest +schema: 2.0.0 +title: Remove-MoveRequest --- # Remove-MoveRequest @@ -71,6 +72,9 @@ The MailboxGuid and MoveRequestQueue parameters are for debugging purposes only. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - GUID @@ -87,7 +91,6 @@ You can't use this parameter with the MailboxGuid or MoveRequestQueue parameters Type: MoveRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -MailboxGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MailboxGuid parameter specifies the GUID of the mailbox for which you want to remove the move request. If you specify the MailboxGuid parameter, you must also specify the MoveRequestQueue parameter. @@ -107,7 +113,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -MoveRequestQueue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MoveRequestQueue parameter specifies the database on which the move request is queued. You can use any value that uniquely identifies the database. For example: @@ -131,7 +139,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationMoveRequestQueue Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -150,7 +160,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -168,7 +180,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,6 +189,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -186,7 +200,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter specifies the move destination by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -215,7 +231,6 @@ The ProxyToMailbox parameter specifies the move destination by the location of t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -225,13 +240,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OMEConfiguration.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-OMEConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OMEConfiguration.md index 20d726ee54..b883db3f6a 100644 --- a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OMEConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-omeconfiguration applicable: Exchange Online -title: Remove-OMEConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-omeconfiguration +schema: 2.0.0 +title: Remove-OMEConfiguration --- # Remove-OMEConfiguration @@ -42,13 +43,15 @@ This example removes the custom OME configuration named Contoso Marketing. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the custom OME configuration that you want to remove. You can use the Get-OMEConfiguration cmdlet to see the available values. If the value contains spaces, enclose the value in quotation marks ```yaml Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OabVirtualDirectory.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OabVirtualDirectory.md index 24791b7b37..9fbb317d05 100644 --- a/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OabVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-oabvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-OabVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-oabvirtualdirectory +schema: 2.0.0 +title: Remove-OabVirtualDirectory --- # Remove-OabVirtualDirectory @@ -53,6 +54,9 @@ This example removes the default OAB virtual directory from Server1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the OAB virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -65,7 +69,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -84,7 +90,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -118,7 +128,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OfflineAddressBook.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OfflineAddressBook.md index b9d780e4f5..ae2cf79c53 100644 --- a/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OfflineAddressBook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-OfflineAddressBook -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-offlineaddressbook +schema: 2.0.0 +title: Remove-OfflineAddressBook --- # Remove-OfflineAddressBook @@ -48,6 +49,9 @@ This example removes the OAB named Contoso Executives. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the OAB that you want to remove. You can use any value that uniquely identifies the OAB. For example: - Name or \\Name @@ -58,7 +62,6 @@ The Identity parameter specifies the OAB that you want to remove. You can use an Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -95,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +112,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -113,7 +123,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OnPremisesOrganization.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OnPremisesOrganization.md index a6196d357b..02de5ee8ee 100644 --- a/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OnPremisesOrganization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-onpremisesorganization applicable: Exchange Online -title: Remove-OnPremisesOrganization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-onpremisesorganization +schema: 2.0.0 +title: Remove-OnPremisesOrganization --- # Remove-OnPremisesOrganization @@ -44,6 +45,9 @@ This example removes the ExchangeMail OnPremisesOrganization object in a Microso ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - Canonical name @@ -54,7 +58,6 @@ The Identity parameter specifies the identity of the on-premises organization ob Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationRelationship.md similarity index 88% rename from exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationRelationship.md index 0598e9d220..006af945f7 100644 --- a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationRelationship.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-organizationrelationship applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-OrganizationRelationship -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-organizationrelationship +schema: 2.0.0 +title: Remove-OrganizationRelationship --- # Remove-OrganizationRelationship @@ -45,6 +46,9 @@ This example removes the organization relationship Contoso using the Identity pa ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the organization relationship that you want to remove. You can use one of the following values: - Canonical name @@ -55,7 +59,6 @@ The Identity parameter specifies the identity of the organization relationship t Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OrganizationSegment.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationSegment.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-OrganizationSegment.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationSegment.md index 0d1f0c04fb..04629a5b84 100644 --- a/exchange/exchange-ps/exchange/Remove-OrganizationSegment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OrganizationSegment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-organizationsegment applicable: Security & Compliance -title: Remove-OrganizationSegment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-organizationsegment +schema: 2.0.0 +title: Remove-OrganizationSegment --- # Remove-OrganizationSegment @@ -42,6 +43,9 @@ This example removes the organization segment named Engineering Group. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the organization segment that you want to remove. You can use any value that uniquely identifies the segment. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the organization segment that you want to remov Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -111,4 +118,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Remove-OutboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OutboundConnector.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-OutboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OutboundConnector.md index 7cfabaff38..c2852cf820 100644 --- a/exchange/exchange-ps/exchange/Remove-OutboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OutboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-outboundconnector applicable: Exchange Online, Exchange Online Protection -title: Remove-OutboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-outboundconnector +schema: 2.0.0 +title: Remove-OutboundConnector --- # Remove-OutboundConnector @@ -44,13 +45,15 @@ This example deletes the Outbound connector named Contoso Outbound Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the connector you want to remove. ```yaml Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProtectionRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProtectionRule.md index 2fd3e45e05..dcfd7ccd4c 100644 --- a/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-OutlookProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-outlookprotectionrule +schema: 2.0.0 +title: Remove-OutlookProtectionRule --- # Remove-OutlookProtectionRule @@ -54,13 +55,15 @@ This example removes all Outlook protection rules from the organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the Outlook protection rule that you want to remove. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -97,7 +105,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OutlookProvider.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProvider.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-OutlookProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProvider.md index 1d6410cdd9..ca4e1e331e 100644 --- a/exchange/exchange-ps/exchange/Remove-OutlookProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OutlookProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-outlookprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-OutlookProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-outlookprovider +schema: 2.0.0 +title: Remove-OutlookProvider --- # Remove-OutlookProvider @@ -45,13 +46,15 @@ This example deletes the AutoDiscoverConfig object named Test Object from Active ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the AutoDiscoverConfig object to remove from Active Directory. ```yaml Type: OutlookProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OwaMailboxPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OwaMailboxPolicy.md index b9f7e4ee5e..0bd84f979a 100644 --- a/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OwaMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-owamailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-OwaMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-owamailboxpolicy +schema: 2.0.0 +title: Remove-OwaMailboxPolicy --- # Remove-OwaMailboxPolicy @@ -60,6 +61,9 @@ This example removes the mailbox policy named Corporate for the tenant Contoso i ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the mailbox policy that you want to remove. You Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -89,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -107,7 +115,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -125,7 +135,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-OwaVirtualDirectory.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-OwaVirtualDirectory.md index f97d5d7436..8eb57c6379 100644 --- a/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-OwaVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-owavirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-OwaVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-owavirtualdirectory +schema: 2.0.0 +title: Remove-OwaVirtualDirectory --- # Remove-OwaVirtualDirectory @@ -50,6 +51,9 @@ This example removes the specified Outlook on the web virtual directory from the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the OWA virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -62,7 +66,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PartnerApplication.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PartnerApplication.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-PartnerApplication.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PartnerApplication.md index 2eb9caf5e4..1badd61959 100644 --- a/exchange/exchange-ps/exchange/Remove-PartnerApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PartnerApplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-partnerapplication applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PartnerApplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-partnerapplication +schema: 2.0.0 +title: Remove-PartnerApplication --- # Remove-PartnerApplication @@ -47,13 +48,15 @@ This command removes the HRApp partner application. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the partner application. ```yaml Type: PartnerApplicationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -90,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PhishSimOverridePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PhishSimOverridePolicy.md index 9cece99ddf..eef6fba7a1 100644 --- a/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PhishSimOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-phishsimoverridepolicy applicable: Exchange Online -title: Remove-PhishSimOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-phishsimoverridepolicy +schema: 2.0.0 +title: Remove-PhishSimOverridePolicy --- # Remove-PhishSimOverridePolicy @@ -44,6 +45,9 @@ This example removes the phishing simulation override policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ Use the Get-PhishSimOverridePolicy cmdlet to find the values. The only available Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Exchange Online + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + In Exchange Online PowerShell, the WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. The WhatIf switch doesn't work in Security & Compliance PowerShell. @@ -126,7 +138,6 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PolicyTipConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PolicyTipConfig.md index 45d9e9b72c..e2011f2ab5 100644 --- a/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PolicyTipConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-policytipconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PolicyTipConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-policytipconfig +schema: 2.0.0 +title: Remove-PolicyTipConfig --- # Remove-PolicyTipConfig @@ -50,6 +51,9 @@ This example removes all the custom Russian Policy Tips. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the custom Policy Tip you want to remove. You can use any value that uniquely identifies the custom Policy Tip. For example: - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. @@ -61,7 +65,6 @@ The Identity parameter specifies the custom Policy Tip you want to remove. You c Type: PolicyTipConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PowerShellVirtualDirectory.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PowerShellVirtualDirectory.md index 56801944fd..2174fd682c 100644 --- a/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PowerShellVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-powershellvirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-PowerShellVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-powershellvirtualdirectory +schema: 2.0.0 +title: Remove-PowerShellVirtualDirectory --- # Remove-PowerShellVirtualDirectory @@ -47,6 +48,9 @@ Be careful when using the Remove-PowerShellVirtualDirectory cmdlet without confi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the PowerShell virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -59,7 +63,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ProtectionAlert.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-ProtectionAlert.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ProtectionAlert.md index f4edc74c13..130ac00c79 100644 --- a/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ProtectionAlert.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-protectionalert applicable: Security & Compliance -title: Remove-ProtectionAlert -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-protectionalert +schema: 2.0.0 +title: Remove-ProtectionAlert --- # Remove-ProtectionAlert @@ -43,6 +44,9 @@ This example removes the specified alert policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the alert policy that you want to remove. You can use any value that uniquely identifies the alert policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the alert policy that you want to remove. You c Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the alert policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolder.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-PublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolder.md index 036d6a15da..c1eeb1b2cd 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfolder +schema: 2.0.0 +title: Remove-PublicFolder --- # Remove-PublicFolder @@ -55,13 +56,15 @@ This example deletes the public folder Directory Folder and all its child public ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name and path of the public folder you want to remove. A valid value uses the syntax: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. ```yaml Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Mailbox Description }} @@ -116,7 +126,6 @@ This parameter is available only in the cloud-based service. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -Recurse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Recurse switch specifies whether all subfolders of the specified folder should also be removed. You don't need to specify a value with this switch. If you don't use this switch and the public folder has subfolders, the command doesn't run and an error message is returned. @@ -134,7 +146,6 @@ If you don't use this switch and the public folder has subfolders, the command d Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -144,6 +155,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -159,7 +173,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -169,13 +182,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderAdministrativePermission.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderAdministrativePermission.md index b1b0afb2e2..23f93a12d8 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderAdministrativePermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolderadministrativepermission applicable: Exchange Server 2010 -title: Remove-PublicFolderAdministrativePermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfolderadministrativepermission +schema: 2.0.0 +title: Remove-PublicFolderAdministrativePermission --- # Remove-PublicFolderAdministrativePermission @@ -61,6 +62,9 @@ This example removes the ViewInformationStore permission from the user Chris on ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -69,7 +73,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010 + The AccessRights parameter specifies the rights being removed. Valid values include: - None The administrator doesn't have any rights to modify public folder attributes. @@ -96,9 +102,8 @@ You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty -Parameter Sets: Identity +Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -107,40 +112,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: MultiValuedProperty -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 +### -Instance -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -Instance The Instance parameter specifies whether to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command. ```yaml Type: PublicFolderAdministrativeAceObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -150,6 +131,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010 + The User parameter specifies whose admin permissions are being removed from the specified public folder. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -171,9 +155,8 @@ You can use any value that uniquely identifies the user or group. For example: ```yaml Type: SecurityPrincipalIdParameter -Parameter Sets: Identity +Parameter Sets: Identity, Instance Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -182,20 +165,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SecurityPrincipalIdParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2010 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -205,7 +178,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -215,13 +187,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Server 2010 + The Deny switch specifies that the permissions you're removing are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -231,13 +205,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -247,6 +223,9 @@ Accept wildcard characters: False ``` ### -InheritanceType + +> Applicable: Exchange Server 2010 + The InheritanceType parameter specifies the type of inheritance. Valid values are: - None @@ -259,7 +238,6 @@ The InheritanceType parameter specifies the type of inheritance. Valid values ar Type: ActiveDirectorySecurityInheritance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -269,6 +247,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -282,7 +263,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -292,13 +272,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderClientPermission.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderClientPermission.md index 726354e79b..89687cc43f 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderClientPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolderclientpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PublicFolderClientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfolderclientpermission +schema: 2.0.0 +title: Remove-PublicFolderClientPermission --- # Remove-PublicFolderClientPermission @@ -51,6 +52,9 @@ This example removes permission for the user Chris to the public folder My Publi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path by using the format \\TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -59,7 +63,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AccessRights parameter specifies the rights that you want to remove from the user on the public folder. @@ -104,7 +110,6 @@ In addition to the access rights, you can create rights based upon roles, which Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The User parameter specifies the user whose permissions are being removed. For the best results, we recommend using the following values: @@ -125,7 +133,6 @@ For the best results, we recommend using the following values: Type: PublicFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -144,7 +154,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -162,7 +174,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +183,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -187,7 +201,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -197,13 +210,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderDatabase.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderDatabase.md index 1da34f3a54..bdd0ea1ad5 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolderdatabase applicable: Exchange Server 2010 -title: Remove-PublicFolderDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfolderdatabase +schema: 2.0.0 +title: Remove-PublicFolderDatabase --- # Remove-PublicFolderDatabase @@ -46,6 +47,9 @@ This example removes the database Public Folder Database after all the prerequis ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the public folder database that you want to remove. You can use any value that uniquely identifies the database. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the public folder database that you want to rem Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -RemoveLastAllowed + +> Applicable: Exchange Server 2010 + The RemoveLastAllowed switch allows the removal of the last public folder database in the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMailboxMigrationRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMailboxMigrationRequest.md index 647e00554d..72b59a29e3 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMailboxMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfoldermailboxmigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PublicFolderMailboxMigrationRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfoldermailboxmigrationrequest +schema: 2.0.0 +title: Remove-PublicFolderMailboxMigrationRequest --- # Remove-PublicFolderMailboxMigrationRequest @@ -68,6 +69,9 @@ This example returns duplicate public folder migration requests (requests create ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the public folder mailbox migration request that you want to remove. This value uses the syntax `\PublicFolderMailboxMigration` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). You can't use this parameter with the RequestGuid or RequestQueue parameters. @@ -76,7 +80,6 @@ You can't use this parameter with the RequestGuid or RequestQueue parameters. Type: PublicFolderMailboxMigrationRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestGuid parameter specifies the unique RequestGuid identifier of the request. To find the RequestGuid value, use the Get-PublicFolderMailboxMigrationRequest cmdlet. @@ -96,7 +102,6 @@ If you use this parameter, you also need to use the RequestQueue parameter. You Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: @@ -120,7 +128,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -139,7 +149,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -157,7 +169,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -175,7 +189,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -185,13 +198,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMigrationRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMigrationRequest.md index c85f9d9a62..23185321d3 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfoldermigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-PublicFolderMigrationRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfoldermigrationrequest +schema: 2.0.0 +title: Remove-PublicFolderMigrationRequest --- # Remove-PublicFolderMigrationRequest @@ -67,6 +68,9 @@ The RequestGuid and RequestQueue parameters are for debugging purposes only. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the migration request that you want to remove. You can use the following values: - Name @@ -78,7 +82,6 @@ You can't use this parameter with the RequestGuid or RequestQueue parameters. Type: PublicFolderMigrationRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequestGuid parameter identifies the migration request to remove by its RequestGUID value. This parameter also requires the RequestQueue parameter. You can't use this parameter with the Identity parameter. @@ -96,7 +102,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequestQueue parameter identifies the migration request by the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -120,7 +128,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -139,7 +149,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,13 +158,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,6 +176,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -173,7 +187,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMoveRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMoveRequest.md index b32e757add..9f98237964 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-PublicFolderMoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfoldermoverequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-PublicFolderMoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-publicfoldermoverequest +schema: 2.0.0 +title: Remove-PublicFolderMoveRequest --- # Remove-PublicFolderMoveRequest @@ -65,6 +66,9 @@ The RequestGuid and RequestQueue parameters are for debugging purposes only. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the public folder move request. The default identity is \\PublicFolderMove. You can't use this parameter with the RequestGuid or RequestQueue parameter. @@ -73,7 +77,6 @@ You can't use this parameter with the RequestGuid or RequestQueue parameter. Type: PublicFolderMoveRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -RequestGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestGuid parameter specifies the GUID of the public folder move request. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter. You can't use this parameter with the Identity parameter. @@ -91,7 +97,6 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -RequestQueue + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example: - Name @@ -113,7 +121,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -132,7 +142,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -150,7 +162,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -168,7 +182,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-QuarantinePolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-QuarantinePolicy.md index 6c828f12bb..3eb8f8cf88 100644 --- a/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-QuarantinePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-quarantinepolicy applicable: Exchange Online, Exchange Online Protection -title: Remove-QuarantinePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-quarantinepolicy +schema: 2.0.0 +title: Remove-QuarantinePolicy --- # Remove-QuarantinePolicy @@ -43,6 +44,9 @@ This example removes the quarantine policy named Contoso Engineering. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the quarantine policy you want to remove. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the quarantine policy you want to remove. You c Type: QuarantineTagIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ReceiveConnector.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-ReceiveConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ReceiveConnector.md index 16d1194f04..1bacd5e932 100644 --- a/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ReceiveConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-receiveconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ReceiveConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-receiveconnector +schema: 2.0.0 +title: Remove-ReceiveConnector --- # Remove-ReceiveConnector @@ -45,6 +46,9 @@ This example removes the Receive connector named Contoso.com Receive Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Receive connector that you want to remove. You can use any value that uniquely identifies the Receive connector. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the Receive connector that you want to remove. Type: ReceiveConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -93,7 +101,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RecipientPermission.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RecipientPermission.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-RecipientPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RecipientPermission.md index 2b1a383994..5532764950 100644 --- a/exchange/exchange-ps/exchange/Remove-RecipientPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RecipientPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-recipientpermission applicable: Exchange Online -title: Remove-RecipientPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-recipientpermission +schema: 2.0.0 +title: Remove-RecipientPermission --- # Remove-RecipientPermission @@ -49,6 +50,9 @@ This example removes the SendAs permission from the user Ayla Kol for the mailbo ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the target recipient. The user or group specified by the Trustee parameter can no longer operate on this recipient. You can specify any type of recipient, for example: @@ -72,7 +76,6 @@ You can use any value that uniquely identifies the recipient. For example: Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Online + The AccessRights parameter specifies the permission that you want to remove from the trustee on the target recipient. The only valid value for this parameter is SendAs. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Trustee + +> Applicable: Exchange Online + The Trustee parameter specifies whose Send As permissions are being removing from the specified target recipient. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -121,7 +129,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -140,7 +150,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -Deny + +> Applicable: Exchange Online + {{ Fill Deny Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,13 +177,15 @@ Accept wildcard characters: False ``` ### -MultiTrustees + +> Applicable: Exchange Online + {{ Fill MultiTrustees Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -182,13 +195,15 @@ Accept wildcard characters: False ``` ### -SkipDomainValidationForMailContact + +> Applicable: Exchange Online + The SkipDomainValidationForMailContact switch skips the check that confirms the proxy addresses of the external contact specified by the Identity parameter are in an accepted domain of the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -198,13 +213,15 @@ Accept wildcard characters: False ``` ### -SkipDomainValidationForMailUser + +> Applicable: Exchange Online + The SkipDomainValidationForMailUser switch skips the check that confirms the proxy addresses of the mail user specified by the Identity parameter are in an accepted domain of the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -214,13 +231,15 @@ Accept wildcard characters: False ``` ### -SkipDomainValidationForSharedMailbox + +> Applicable: Exchange Online + The SkipDomainValidationForSharedMailbox switch skips the check that confirms the proxy addresses of the shared mailbox specified by the Identity parameter are in an accepted domain of the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -230,13 +249,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RemoteDomain.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RemoteDomain.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-RemoteDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RemoteDomain.md index bc7601b802..77c88b69b1 100644 --- a/exchange/exchange-ps/exchange/Remove-RemoteDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RemoteDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-remotedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-RemoteDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-remotedomain +schema: 2.0.0 +title: Remove-RemoteDomain --- # Remove-RemoteDomain @@ -43,6 +44,9 @@ This example removes the remote domain object named Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the remote domain that you want to remove. You can use any value that uniquely identifies the remote domain. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the remote domain that you want to remove. You Type: RemoteDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -92,7 +100,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RemoteMailbox.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RemoteMailbox.md index 1795e792f9..8b72bc15ab 100644 --- a/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-RemoteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-remotemailbox +schema: 2.0.0 +title: Remove-RemoteMailbox --- # Remove-RemoteMailbox @@ -49,6 +50,9 @@ This example removes the on-premises mail-enabled user Kim Akers and the associa ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter identifies the mail-enabled user and the associated mailbox in the service that you want to remove. You can use one of the following values: - ADObjectID @@ -64,7 +68,6 @@ The Identity parameter identifies the mail-enabled user and the associated mailb Type: RemoteMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -120,7 +130,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreLegalHold switch ignores the legal hold status of the remote user. You don't need to specify a value with this switch. This switch removes the instance of the remote object in the on-premises organization, and the request to remove the mailbox is synchronized to the cloud. The Microsoft Entra object is removed, but if the mailbox is on hold, the mailbox is converted into an inactive mailbox and remains on hold. @@ -138,7 +150,6 @@ This switch removes the instance of the remote object in the on-premises organiz Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionPolicy.md index bdcd81de21..68777847fb 100644 --- a/exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-reportsubmissionpolicy applicable: Exchange Online -title: Remove-ReportSubmissionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-reportsubmissionpolicy +schema: 2.0.0 +title: Remove-ReportSubmissionPolicy --- # Remove-ReportSubmissionPolicy @@ -41,13 +42,15 @@ This example removes the report submission policy from your organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission policy that you want to remove. The only available policy is named DefaultReportSubmissionPolicy. ```yaml Type: ReportSubmissionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 diff --git a/exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionRule.md index 7c7b4a7d97..fabd608925 100644 --- a/exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-reportsubmissionrule applicable: Exchange Online -title: Remove-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-reportsubmissionrule +schema: 2.0.0 +title: Remove-ReportSubmissionRule --- # Remove-ReportSubmissionRule @@ -44,13 +45,15 @@ This example removes the report submission rule from your organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission rule that you want to remove. The default rule is named DefaultReportSubmissionRule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ResubmitRequest.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ResubmitRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-ResubmitRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ResubmitRequest.md index 6b01e58449..73733485fe 100644 --- a/exchange/exchange-ps/exchange/Remove-ResubmitRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ResubmitRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-resubmitrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ResubmitRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-resubmitrequest +schema: 2.0.0 +title: Remove-ResubmitRequest --- # Remove-ResubmitRequest @@ -50,13 +51,15 @@ This example removes all resubmit requests. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the resubmit request you want to remove. Each resubmit request is identified by an incremented integer value. ```yaml Type: ResubmitRequestIdentityParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -98,7 +106,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionCompliancePolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RetentionCompliancePolicy.md index e4883a0012..05ea204006 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentioncompliancepolicy applicable: Security & Compliance -title: Remove-RetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-retentioncompliancepolicy +schema: 2.0.0 +title: Remove-RetentionCompliancePolicy --- # Remove-RetentionCompliancePolicy @@ -44,6 +45,9 @@ This example removes the retention policy named "Regulation 123 Compliance". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the retention policy that you want to remove. Y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + The PriorityCleanup switch specifies whether to remove a Priority cleanup policy. You don't need to specify a value with this switch. Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). @@ -107,7 +117,6 @@ Priority cleanup policies expedite the deletion of sensitive content by overridi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RetentionComplianceRule.md index f3478c2835..a48e83973e 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentioncompliancerule applicable: Security & Compliance -title: Remove-RetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-retentioncompliancerule +schema: 2.0.0 +title: Remove-RetentionComplianceRule --- # Remove-RetentionComplianceRule @@ -46,6 +47,9 @@ This example removes the retention rule named "One Year Standard". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention rule to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the retention rule to remove. You can use any v Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + The PriorityCleanup switch specifies whether to remove the rule associated with a Priority cleanup policy. You don't need to specify a value with this switch. Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). @@ -109,7 +119,6 @@ Priority cleanup policies expedite the deletion of sensitive content by overridi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-RetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicy.md index 3606e9995c..c8d5021c8d 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentionpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-RetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-retentionpolicy +schema: 2.0.0 +title: Remove-RetentionPolicy --- # Remove-RetentionPolicy @@ -62,13 +63,15 @@ This example removes the retention policy Business Critical, which is assigned t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the retention policy name. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -87,7 +93,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -105,7 +113,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you remove a retention policy that's assigned to users. Removing a policy that's assigned to users results in those users not having any retention policy. @@ -123,7 +133,6 @@ Use this switch to hide the confirmation prompt when you remove a retention poli Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicyTag.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicyTag.md index 03f3e9a59f..782489d23e 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RetentionPolicyTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentionpolicytag applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-RetentionPolicyTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-retentionpolicytag +schema: 2.0.0 +title: Remove-RetentionPolicyTag --- # Remove-RetentionPolicyTag @@ -49,13 +50,15 @@ This example removes the retention tag Finance-DeletedItems. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the retention policy tag. ```yaml Type: RetentionPolicyTagIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleAssignmentPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RoleAssignmentPolicy.md index 30fc9c2297..20586d4cb2 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleAssignmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-roleassignmentpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-RoleAssignmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-roleassignmentpolicy +schema: 2.0.0 +title: Remove-RoleAssignmentPolicy --- # Remove-RoleAssignmentPolicy @@ -67,13 +68,15 @@ For more information about the Where cmdlet and pipelining, see [Working with co ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the assignment policy to remove. If the assignment policy name has spaces, enclose the name in quotation marks ("). ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -92,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -112,7 +120,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RoleGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroup.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-RoleGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroup.md index ed3cddf995..f23147c627 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-rolegroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Remove-RoleGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-rolegroup +schema: 2.0.0 +title: Remove-RoleGroup --- # Remove-RoleGroup @@ -60,13 +61,15 @@ This example removes the Vancouver Recipient Administrators role group. Because ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group to remove. If the role group name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -87,7 +93,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -106,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -124,7 +134,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -144,7 +156,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -162,7 +176,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroupMember.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-RoleGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroupMember.md index 34807f1679..7abb07e98f 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RoleGroupMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-rolegroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Remove-RoleGroupMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-rolegroupmember +schema: 2.0.0 +title: Remove-RoleGroupMember --- # Remove-RoleGroupMember @@ -73,13 +74,15 @@ This example removes the Training Assistants USG from the Training Administrator ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group that you want to remove a member from. If the role group name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Member parameter specifies who to remove from the role group. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -113,7 +119,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -134,7 +142,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -153,7 +163,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -171,7 +183,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -189,7 +203,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RoutingGroupConnector.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RoutingGroupConnector.md index e34b39e341..32f6baf648 100644 --- a/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RoutingGroupConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-routinggroupconnector applicable: Exchange Server 2010 -title: Remove-RoutingGroupConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-routinggroupconnector +schema: 2.0.0 +title: Remove-RoutingGroupConnector --- # Remove-RoutingGroupConnector @@ -47,13 +48,15 @@ This example removes the routing group connector Ex2010 to Ex2003 RGC. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name or GUID of the routing group connector. The name is expressed as [[Administrative Group Name\\]Routing Group Name\\]Routing Group Connector Name. ```yaml Type: RoutingGroupConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md b/exchange/exchange-ps/ExchangePowerShell/Remove-RpcClientAccess.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-RpcClientAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-RpcClientAccess.md index 869e6560c5..0735dc06c7 100644 --- a/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-RpcClientAccess.md @@ -1,15 +1,16 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-rpcclientaccess applicable: Exchange Server 2010 -title: Remove-RpcClientAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-rpcclientaccess +schema: 2.0.0 +title: Remove-RpcClientAccess --- -# Remove-RPCClientAccess +# Remove-RpcClientAccess ## SYNOPSIS This cmdlet is available only in Exchange Server 2010. @@ -21,7 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Remove-RPCClientAccess -Server +Remove-RpcClientAccess -Server [-Confirm] [-DomainController ] [-WhatIf] @@ -45,6 +46,9 @@ This example removes the configuration information for the Exchange RPC Client A ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Client Access server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -56,7 +60,6 @@ The Server parameter specifies the Client Access server where you want to run th Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentPolicy.md index 857607a82b..d79cf3b777 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-safeattachmentpolicy applicable: Exchange Online -title: Remove-SafeAttachmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-safeattachmentpolicy +schema: 2.0.0 +title: Remove-SafeAttachmentPolicy --- # Remove-SafeAttachmentPolicy @@ -45,6 +46,9 @@ This example removes the safe attachment policy named Block Attachments Policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment policy that you want to remove. You can use any value that uniquely identifies the policy. For example: @@ -57,7 +61,6 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -94,7 +102,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentRule.md index e442e79efb..74fae37eb9 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-safeattachmentrule applicable: Exchange Online -title: Remove-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-safeattachmentrule +schema: 2.0.0 +title: Remove-SafeAttachmentRule --- # Remove-SafeAttachmentRule @@ -44,6 +45,9 @@ This examples removes the safe attachment rule named Research Department Attachm ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment rule that you want to remove. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksPolicy.md index 287856fcc5..e4fcd71186 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-safelinkspolicy applicable: Exchange Online -title: Remove-SafeLinksPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-safelinkspolicy +schema: 2.0.0 +title: Remove-SafeLinksPolicy --- # Remove-SafeLinksPolicy @@ -47,6 +48,9 @@ This example remove the Safe Links policy named Engineering Department URL Polic ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links policy that you want to remove. You can use any value that uniquely identifies the policy. For example: @@ -59,7 +63,6 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -96,7 +104,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksRule.md index 472e9e9324..a8c412145f 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-safelinksrule applicable: Exchange Online -title: Remove-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-safelinksrule +schema: 2.0.0 +title: Remove-SafeLinksRule --- # Remove-SafeLinksRule @@ -44,6 +45,9 @@ This examples removes the Safe Links rule named Research Department URL Rule. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links rule that you want to remove. You can use any value that uniquely identifies the rule. For example: @@ -56,7 +60,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SearchDocumentFormat.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SearchDocumentFormat.md index b15bec5d2b..fd539a83c6 100644 --- a/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SearchDocumentFormat.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-searchdocumentformat applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SearchDocumentFormat -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-searchdocumentformat +schema: 2.0.0 +title: Remove-SearchDocumentFormat --- # Remove-SearchDocumentFormat @@ -45,13 +46,15 @@ This example removes the search document format with an identity equal to "sct". ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter uniquely identifies the format to be removed. You can use the Get-SearchDocumentFormat cmdlet to view the identities of the installed formats. ```yaml Type: SearchDocumentFormatId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -93,7 +101,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SecOpsOverridePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SecOpsOverridePolicy.md index 6974d66c3b..878683aaa8 100644 --- a/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SecOpsOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-secopsoverridepolicy applicable: Exchange Online -title: Remove-SecOpsOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-secopsoverridepolicy +schema: 2.0.0 +title: Remove-SecOpsOverridePolicy --- # Remove-SecOpsOverridePolicy @@ -44,6 +45,9 @@ This example removes the SecOps mailbox override policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the SecOps override policy that you want to rem Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Exchange Online + The ForceDeletion switch forces the removal of the SecOps override policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SendConnector.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SendConnector.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-SendConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SendConnector.md index e1ce45ac63..ef7ec0522d 100644 --- a/exchange/exchange-ps/exchange/Remove-SendConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SendConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-sendconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SendConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-sendconnector +schema: 2.0.0 +title: Remove-SendConnector --- # Remove-SendConnector @@ -47,13 +48,15 @@ This example deletes the Send connector named Contoso.com Send Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name, or GUID of the Send connector. If the Identity name contains spaces, enclose the name in quotation marks ("). You can omit the Identity parameter label. You can also include the server name by using the format ServerName\\ConnectorName. ```yaml Type: SendConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -90,7 +98,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ServerMonitoringOverride.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ServerMonitoringOverride.md index dff6213508..8797d26742 100644 --- a/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ServerMonitoringOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-servermonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ServerMonitoringOverride -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-servermonitoringoverride +schema: 2.0.0 +title: Remove-ServerMonitoringOverride --- # Remove-ServerMonitoringOverride @@ -49,13 +50,15 @@ This example removes a server monitoring override of the ExtensionAttributes pro ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the monitoring item that was overridden. The value is in the form of HealthSet\\MonitoringItem or HealthSet\\MonitoringItem\\TargetResource. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -ItemType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ItemType parameter specifies the item type of the override that you want to remove. It can be any of the following values: - Probe @@ -75,7 +81,6 @@ The ItemType parameter specifies the item type of the override that you want to Type: MonitoringItemTypeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PropertyName parameter specifies the property for the override you want to remove. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server that contains the override that you want to remove. You can use any value that uniquely identifies the server. For example: - Name @@ -112,7 +122,6 @@ The Server parameter specifies the Exchange server that contains the override th Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -131,7 +143,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,13 +152,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ServicePrincipal.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-ServicePrincipal.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ServicePrincipal.md index 855f9df7b6..720e5bb4b6 100644 --- a/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ServicePrincipal.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-serviceprincipal applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Remove-ServicePrincipal -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-serviceprincipal +schema: 2.0.0 +title: Remove-ServicePrincipal --- # Remove-ServicePrincipal @@ -42,6 +43,9 @@ This example removes the specified service principal. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the service principal that you want to remove. You can use any value that uniquely identifies the service principal. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the service principal that you want to remove. Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SettingOverride.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SettingOverride.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-SettingOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SettingOverride.md index c3488fbb4e..f1f2727920 100644 --- a/exchange/exchange-ps/exchange/Remove-SettingOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SettingOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-settingoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SettingOverride -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-settingoverride +schema: 2.0.0 +title: Remove-SettingOverride --- # Remove-SettingOverride @@ -47,6 +48,9 @@ This example removes the setting override named IM Server Integration. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the setting override that you want to remove. You can use any value that uniquely identifies the override. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the setting override that you want to remove. Y Type: SettingOverrideIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SharingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SharingPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-SharingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SharingPolicy.md index ac9dbb8159..2422bc4285 100644 --- a/exchange/exchange-ps/exchange/Remove-SharingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SharingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-sharingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-SharingPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-sharingpolicy +schema: 2.0.0 +title: Remove-SharingPolicy --- # Remove-SharingPolicy @@ -50,6 +51,9 @@ This example removes the sharing policy Contoso and suppresses the confirmation ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the sharing policy that you want to remove. You can use one of the following values: - ADObjectID @@ -61,7 +65,6 @@ The Identity parameter specifies the identity of the sharing policy that you wan Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SiteMailboxProvisioningPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SiteMailboxProvisioningPolicy.md index 3b226be32b..f896036b30 100644 --- a/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SiteMailboxProvisioningPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-sitemailboxprovisioningpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SiteMailboxProvisioningPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-sitemailboxprovisioningpolicy +schema: 2.0.0 +title: Remove-SiteMailboxProvisioningPolicy --- # Remove-SiteMailboxProvisioningPolicy @@ -47,6 +48,9 @@ This example deletes the site mailbox policy named Default that was created when ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the site mailbox provisioning policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the site mailbox provisioning policy that you w Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-StoreMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Remove-StoreMailbox.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-StoreMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-StoreMailbox.md index 4faccccab2..eced30b9b1 100644 --- a/exchange/exchange-ps/exchange/Remove-StoreMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-StoreMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-storemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-StoreMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-storemailbox +schema: 2.0.0 +title: Remove-StoreMailbox --- # Remove-StoreMailbox @@ -64,6 +65,9 @@ This example permanently purges all soft-deleted mailboxes from mailbox database ## PARAMETERS ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Database parameter specifies the mailbox database that contains the mailbox to remove. You can use any value that uniquely identifies the database. For example: - Name @@ -74,7 +78,6 @@ The Database parameter specifies the mailbox database that contains the mailbox Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the mailbox that you want to remove. Use the mailbox GUID as the value for this parameter. Run the following command to obtain the mailbox GUID and other information for all mailboxes in your organization: Get-MailboxDatabase | Get-MailboxStatistics | Format-List DisplayName,MailboxGuid,Database,DisconnectReason,DisconnectDate. @@ -92,7 +98,6 @@ Run the following command to obtain the mailbox GUID and other information for a Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -MailboxState + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxState parameter specifies the mailbox state on the source mailbox database. This parameter accepts the following values: - Disabled @@ -111,7 +119,6 @@ The MailboxState parameter specifies the mailbox state on the source mailbox dat Type: MailboxStateParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -130,7 +140,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SupervisoryReviewPolicyV2.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SupervisoryReviewPolicyV2.md index 1bbb2eaf31..1be5daac3b 100644 --- a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SupervisoryReviewPolicyV2.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-supervisoryreviewpolicyv2 applicable: Security & Compliance -title: Remove-SupervisoryReviewPolicyV2 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-supervisoryreviewpolicyv2 +schema: 2.0.0 +title: Remove-SupervisoryReviewPolicyV2 --- # Remove-SupervisoryReviewPolicyV2 @@ -43,6 +44,9 @@ This example removes the supervisory review policy named EU Brokers Policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the supervisory review policy that you want to remove. You can use any value that uniquely identifies the policy. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the supervisory review policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SweepRule.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SweepRule.md index 5a20fe05fc..35879232b1 100644 --- a/exchange/exchange-ps/exchange/Remove-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SweepRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-SweepRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-sweeprule +schema: 2.0.0 +title: Remove-SweepRule --- # Remove-SweepRule @@ -51,6 +52,9 @@ This example removes all Sweep rules in the specified mailbox. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Sweep rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). @@ -61,7 +65,6 @@ The Identity parameter specifies the Sweep rule that you want to remove. You can Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the rule you want to remove. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +135,6 @@ The Mailbox parameter specifies the mailbox that contains the rule you want to r Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SyncMailPublicFolder.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SyncMailPublicFolder.md index b48470c51b..76b893ba88 100644 --- a/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SyncMailPublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-syncmailpublicfolder applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Remove-SyncMailPublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-syncmailpublicfolder +schema: 2.0.0 +title: Remove-SyncMailPublicFolder --- # Remove-SyncMailPublicFolder @@ -45,6 +46,9 @@ This cmdlet is only used by the Sync-MailPublicFolders.ps1 script. Don't run thi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mail-enabled public folder object that you want to remove from Exchange Online. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the mail-enabled public folder object that you Type: MailPublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -93,7 +101,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SystemMessage.md b/exchange/exchange-ps/ExchangePowerShell/Remove-SystemMessage.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-SystemMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-SystemMessage.md index c61753f2b5..0ee365aefb 100644 --- a/exchange/exchange-ps/exchange/Remove-SystemMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-SystemMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-systemmessage applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-SystemMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-systemmessage +schema: 2.0.0 +title: Remove-SystemMessage --- # Remove-SystemMessage @@ -52,6 +53,9 @@ This example removes the specified custom quota message (combination of language ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the custom system message that you want to remove. You can use any value that uniquely identifies the system message. For example: - Identity @@ -107,7 +111,6 @@ Maximum number of levels (depth) in a mailbox folder: Type: SystemMessageIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -117,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -126,7 +132,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -144,7 +152,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +161,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md b/exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListItems.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListItems.md index 5a329a28e1..7bf6419833 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Remove-TenantAllowBlockListItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-tenantallowblocklistitems +schema: 2.0.0 +title: Remove-TenantAllowBlockListItems --- # Remove-TenantAllowBlockListItems @@ -58,6 +59,9 @@ This example removes the URL allow entry for the specified non-Microsoft phishin ## PARAMETERS ### -Entries + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Entries parameter specifies the entries that you want to remove based on the ListType parameter value. Valid values are: - FileHash: The exact SHA256 file hash value. @@ -75,7 +79,6 @@ You can't use this parameter with the Ids parameter. Type: String[] Parameter Sets: Entries Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Ids + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Ids parameter specifies the entries that you want to remove. This value is shown in the Identity property in the output of the Get-TenantAllowBlockListItems cmdlet. An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. @@ -95,7 +101,6 @@ You can't use this parameter with the Entries parameter. Type: String[] Parameter Sets: Ids Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -ListType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListType parameter specifies the type of entry that you want to remove. Valid values are: - FileHash @@ -116,7 +124,6 @@ The ListType parameter specifies the type of entry that you want to remove. Vali Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -ListSubType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListSubType specifies further specifies the type of entry that you want to remove. Valid values are: - AdvancedDelivery: Use this value for phishing simulation URLs. @@ -135,7 +145,6 @@ The ListSubType specifies further specifies the type of entry that you want to r Type: ListSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -OutputJson + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The OutputJson switch specifies whether to return all entries in a single JSON value. You don't need to specify a value with this switch. You use this switch to prevent the command from halting on the first entry that contains a syntax error. @@ -153,7 +165,6 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListSpoofItems.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListSpoofItems.md index dffc5da8d0..be8e893e78 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-TenantAllowBlockListSpoofItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistspoofitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Remove-TenantAllowBlockListSpoofItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-tenantallowblocklistspoofitems +schema: 2.0.0 +title: Remove-TenantAllowBlockListSpoofItems --- # Remove-TenantAllowBlockListSpoofItems @@ -44,13 +45,15 @@ This example removes the specified spoofed sender. You get the Ids parameter val ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + Use the value `domain.com\Default` for this parameter. The spoofed sender that you want to remove is really identified by the Ids parameter. ```yaml Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -Ids + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Ids parameter specifies the spoof pair that you want to remove. A valid value for this parameter is the Identity property value from the output of the Get-TenantAllowBlockListSpoofItems cmdlet. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -76,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -85,7 +93,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -95,13 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-ThrottlingPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-ThrottlingPolicy.md index 98949a3787..13919e09b3 100644 --- a/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-ThrottlingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-throttlingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-ThrottlingPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-throttlingpolicy +schema: 2.0.0 +title: Remove-ThrottlingPolicy --- # Remove-ThrottlingPolicy @@ -63,13 +64,15 @@ You can't remove a policy that's associated with any users. This example reassig ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter identifies the throttling policy you want to remove. Use the name that matches the name of the policy in Active Directory. ```yaml Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -106,7 +114,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -124,7 +134,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-TransportRule.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-TransportRule.md index 110d9f1322..974d3d827d 100644 --- a/exchange/exchange-ps/exchange/Remove-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-TransportRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Remove-TransportRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-transportrule +schema: 2.0.0 +title: Remove-TransportRule --- # Remove-TransportRule @@ -47,6 +48,9 @@ This example removes the rule named "Redirect messages from kim@contoso.com to l ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the rule that you want to remove. You can use a Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -96,7 +104,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMAutoAttendant.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMAutoAttendant.md index 902c636055..0d1717b887 100644 --- a/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Remove-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-umautoattendant +schema: 2.0.0 +title: Remove-UMAutoAttendant --- # Remove-UMAutoAttendant @@ -47,13 +48,15 @@ This example deletes the UM auto attendant MyUMAutoAttendant. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM auto attendant being deleted. This is the directory object ID for the UM auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMCallAnsweringRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMCallAnsweringRule.md index 85003d4509..493243ce17 100644 --- a/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: Remove-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-umcallansweringrule +schema: 2.0.0 +title: Remove-UMCallAnsweringRule --- # Remove-UMCallAnsweringRule @@ -55,13 +56,15 @@ This example removes the call answering rule MyUMCallAnsweringRule from the mail ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for a call answering rule being removed. ```yaml Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule is changed. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +135,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMDialPlan.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMDialPlan.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-UMDialPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMDialPlan.md index 15968a4562..9891da4d6d 100644 --- a/exchange/exchange-ps/exchange/Remove-UMDialPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMDialPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Remove-UMDialPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-umdialplan +schema: 2.0.0 +title: Remove-UMDialPlan --- # Remove-UMDialPlan @@ -47,13 +48,15 @@ This example deletes the existing UM dial plan MyUMDialPlan. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM dial plan being deleted. This is the directory object ID for the UM dial plan. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMHuntGroup.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-UMHuntGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMHuntGroup.md index 0923af3a69..5a6e163d62 100644 --- a/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMHuntGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-umhuntgroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Remove-UMHuntGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-umhuntgroup +schema: 2.0.0 +title: Remove-UMHuntGroup --- # Remove-UMHuntGroup @@ -47,13 +48,15 @@ This example deletes the UM hunt group MyUMHuntGroup. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM hunt group being deleted. This is the directory object ID for the UM hunt group object. ```yaml Type: UMHuntGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMIPGateway.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMIPGateway.md index e19873e3a1..f0bb270293 100644 --- a/exchange/exchange-ps/exchange/Remove-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Remove-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-umipgateway +schema: 2.0.0 +title: Remove-UMIPGateway --- # Remove-UMIPGateway @@ -49,13 +50,15 @@ This example deletes the UM IP gateway MyUMIPGateway. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM IP gateway being deleted. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UMMailboxPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UMMailboxPolicy.md index 56d19d3378..6e1dbd4616 100644 --- a/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UMMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Remove-UMMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ummailboxpolicy +schema: 2.0.0 +title: Remove-UMMailboxPolicy --- # Remove-UMMailboxPolicy @@ -47,13 +48,15 @@ This example deletes the UM mailbox policy MyUMMailboxPolicy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM mailbox policy being deleted. This parameter is the directory object ID for the UM mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedAuditLogRetentionPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedAuditLogRetentionPolicy.md index ed810f1d9c..ca5df022a4 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedAuditLogRetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedauditlogretentionpolicy applicable: Security & Compliance -title: Remove-UnifiedAuditLogRetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-unifiedauditlogretentionpolicy +schema: 2.0.0 +title: Remove-UnifiedAuditLogRetentionPolicy --- # Remove-UnifiedAuditLogRetentionPolicy @@ -46,6 +47,9 @@ This example deletes the audit log retention policy named "SearchQueryPerformed ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the audit log retention policy that you want to delete. You can use any value that uniquely identifies the policy. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the audit log retention policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -ForceDeletion + +> Applicable: Security & Compliance + The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroup.md similarity index 93% rename from exchange/exchange-ps/exchange/Remove-UnifiedGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroup.md index 8c186032fb..cbccda7b2c 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedgroup applicable: Exchange Online, Exchange Online Protection -title: Remove-UnifiedGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-unifiedgroup +schema: 2.0.0 +title: Remove-UnifiedGroup --- # Remove-UnifiedGroup @@ -47,6 +48,9 @@ This example removes the Microsoft 365 Group named Research Department. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to remove. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to remove Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -97,7 +105,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroupLinks.md similarity index 94% rename from exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroupLinks.md index f6ae947e09..afdf8598ab 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UnifiedGroupLinks.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedgrouplinks applicable: Exchange Online, Exchange Online Protection -title: Remove-UnifiedGroupLinks -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-unifiedgrouplinks +schema: 2.0.0 +title: Remove-UnifiedGroupLinks --- # Remove-UnifiedGroupLinks @@ -47,6 +48,9 @@ This example removes members `laura@contoso.com` and `julia@contoso.com` from th ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to modify. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -60,7 +64,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to modify Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Links + +> Applicable: Exchange Online, Exchange Online Protection + The Links parameter specifies the recipients to remove from the Microsoft 365 Group. You specify whether these recipients were members, owners, or subscribers by using the LinkType parameter. You can use any value that uniquely identifies the recipient. For example: @@ -89,7 +95,6 @@ You must use this parameter with the LinkType parameter, which means the specifi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -LinkType + +> Applicable: Exchange Online, Exchange Online Protection + The LinkType parameter specifies the recipient's role in the Microsoft 365 Group that you want to remove. Valid values are: - Members: Participate in conversations, create Teams channels, collaborate on files, and edit the connected SharePoint site. @@ -111,7 +119,6 @@ You must use this parameter with the Links parameter. Type: LinkType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -130,7 +140,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-UserPhoto.md b/exchange/exchange-ps/ExchangePowerShell/Remove-UserPhoto.md similarity index 92% rename from exchange/exchange-ps/exchange/Remove-UserPhoto.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-UserPhoto.md index fa074e42db..ab41f0e36c 100644 --- a/exchange/exchange-ps/exchange/Remove-UserPhoto.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-UserPhoto.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-userphoto applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-UserPhoto -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-userphoto +schema: 2.0.0 +title: Remove-UserPhoto --- # Remove-UserPhoto @@ -65,6 +66,9 @@ This example deletes the photo associated with Ann Beebe's user account. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the user. You can use any value that uniquely identifies the user. For example: - Name @@ -82,7 +86,6 @@ The Identity parameter specifies the identity of the user. You can use any value Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -ClearMailboxPhotoRecord + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ClearMailboxPhoto switch specifies that a deleted mailbox photo is considered blank instead of deleted. You don't need to specify a value with this switch. By default, when a user deletes their mailbox photo, a flag is set on the mailbox that causes subsequent photo requests to: @@ -105,7 +111,6 @@ Using this switch allows photo requests to search Active Directory for a photo. Type: SwitchParameter Parameter Sets: ClearMailboxPhoto Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -124,7 +132,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ClearMailboxPhoto Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -177,7 +191,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,13 +200,15 @@ Accept wildcard characters: False ``` ### -PhotoType + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: ClearMailboxPhoto Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,13 +218,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Remove-VivaModuleFeaturePolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-VivaModuleFeaturePolicy.md index e263889a41..fd0cb8ce9c 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-VivaModuleFeaturePolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivamodulefeaturepolicy applicable: Exchange Online -title: Remove-VivaModuleFeaturePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-vivamodulefeaturepolicy +schema: 2.0.0 +title: Remove-VivaModuleFeaturePolicy --- # Remove-VivaModuleFeaturePolicy @@ -56,6 +56,9 @@ This example deletes the specified policy for the Reflection feature in Viva Ins ## PARAMETERS ### -FeatureId + +> Applicable: Exchange Online + The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. @@ -64,7 +67,6 @@ To view details about the features in a Viva module that support feature access Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -74,13 +76,15 @@ Accept wildcard characters: False ``` ### -ModuleId + +> Applicable: Exchange Online + The ModuleId parameter specifies the Viva module of the feature that you want to remove the policy from. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -90,6 +94,9 @@ Accept wildcard characters: False ``` ### -PolicyId + +> Applicable: Exchange Online + The PolicyId parameter specifies the policy for the feature in the Viva module that you want to remove. To view details about the added policies for a feature in a Viva module, refer to the Get-VivaModuleFeaturePolicy cmdlet. The details provided by the Get-VivaModuleFeaturePolicy cmdlet include the policy identifier. @@ -98,7 +105,6 @@ To view details about the added policies for a feature in a Viva module, refer t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -108,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -117,7 +126,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -127,13 +135,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -143,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/ExchangePowerShell/Remove-VivaOrgInsightsDelegatedRole.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-VivaOrgInsightsDelegatedRole.md index 037e2a9216..e23790f4ae 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-VivaOrgInsightsDelegatedRole.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivaorginsightsdelegatedrole -title: Remove-VivaOrgInsightsDelegatedRole -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-vivaorginsightsdelegatedrole +schema: 2.0.0 +title: Remove-VivaOrgInsightsDelegatedRole --- # Remove-VivaOrgInsightsDelegatedRole @@ -49,6 +49,9 @@ This example removes the organization insights viewing capability of the specifi ## PARAMETERS ### -Delegate + +> Applicable: Exchange Online + The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). A valid value for this parameter is the Microsoft Entra ObjectId value of the delegate account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. @@ -57,7 +60,6 @@ A valid value for this parameter is the Microsoft Entra ObjectId value of the de Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -67,6 +69,9 @@ Accept wildcard characters: False ``` ### -Delegator + +> Applicable: Exchange Online + The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is delegated to the account specified by the Delegate parameter. A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. @@ -75,7 +80,6 @@ A valid value for this parameter is the ObjectID value of the delegator account. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -85,13 +89,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Remove-WebServicesVirtualDirectory.md similarity index 89% rename from exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-WebServicesVirtualDirectory.md index f4f42ba089..4a2b358ce1 100644 --- a/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-WebServicesVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-webservicesvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-WebServicesVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-webservicesvirtualdirectory +schema: 2.0.0 +title: Remove-WebServicesVirtualDirectory --- # Remove-WebServicesVirtualDirectory @@ -46,6 +47,9 @@ This example removes the Exchange Web Services virtual directory named Sales fro ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the EWS virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -58,7 +62,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -111,7 +121,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md b/exchange/exchange-ps/ExchangePowerShell/Remove-X400AuthoritativeDomain.md similarity index 90% rename from exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-X400AuthoritativeDomain.md index f6c5c5dddd..4e966c4f48 100644 --- a/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-X400AuthoritativeDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-x400authoritativedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Remove-X400AuthoritativeDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-x400authoritativedomain +schema: 2.0.0 +title: Remove-X400AuthoritativeDomain --- # Remove-X400AuthoritativeDomain @@ -43,13 +44,15 @@ This example removes the X.400 authoritative domain object for the X.400 authori ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies a string value for the X.400 authoritative domain. Enter either the GUID or the name of the X.400 authoritative domain. ```yaml Type: X400AuthoritativeDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -86,7 +94,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/ExchangePowerShell/Remove-eDiscoveryCaseAdmin.md similarity index 95% rename from exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md rename to exchange/exchange-ps/ExchangePowerShell/Remove-eDiscoveryCaseAdmin.md index 828137cfb4..aa6488dbbb 100644 --- a/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-eDiscoveryCaseAdmin.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-ediscoverycaseadmin applicable: Security & Compliance -title: Remove-eDiscoveryCaseAdmin -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-ediscoverycaseadmin +schema: 2.0.0 +title: Remove-eDiscoveryCaseAdmin --- # Remove-eDiscoveryCaseAdmin @@ -46,6 +47,9 @@ This example removes an eDiscovery Administrator. ## PARAMETERS ### -User + +> Applicable: Security & Compliance + The User parameter specifies the user that you want to remove from the list of eDiscovery Administrators. You can use any value that uniquely identifies the user. For example: - Name @@ -57,7 +61,6 @@ The User parameter specifies the user that you want to remove from the list of e Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md b/exchange/exchange-ps/ExchangePowerShell/Reset-ProvisioningCache.md similarity index 91% rename from exchange/exchange-ps/exchange/Reset-ProvisioningCache.md rename to exchange/exchange-ps/ExchangePowerShell/Reset-ProvisioningCache.md index 0c541d75c8..6eda0f1f75 100644 --- a/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md +++ b/exchange/exchange-ps/ExchangePowerShell/Reset-ProvisioningCache.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/reset-provisioningcache applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Reset-ProvisioningCache -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/reset-provisioningcache +schema: 2.0.0 +title: Reset-ProvisioningCache --- # Reset-ProvisioningCache @@ -67,13 +68,15 @@ This example runs in a multi-tenant deployment by a data center administrator to ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the fully qualified domain name (FQDN) of the server that the application you want to reset is running on. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Application + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Application parameter specifies the specific administrative application to reset the provisioning cache for. You can use the following values: - Powershell @@ -96,7 +102,6 @@ The Application parameter specifies the specific administrative application to r Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -GlobalCache + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GlobalCache switch clears all cache keys. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: GlobalCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -122,6 +129,9 @@ Accept wildcard characters: False ``` ### -CacheKeys + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CacheKeys parameter specifies the value for the cache key that you want to clear. The format for the values should contain 32 digits separated by four dashes: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Use the Dump-ProvisioningCache cmdlet to return a list of cache keys. @@ -130,7 +140,6 @@ Use the Dump-ProvisioningCache cmdlet to return a list of cache keys. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -149,7 +161,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,13 +170,15 @@ Accept wildcard characters: False ``` ### -CurrentOrganization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CurrentOrganization switch resets the provision cache for the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: OrganizationCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,13 +188,15 @@ Accept wildcard characters: False ``` ### -Organizations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Organizations parameter specifies the organizations that the provisioning cache will be reset. This parameter is used in multi-tenant deployments. ```yaml Type: MultiValuedProperty Parameter Sets: OrganizationCache Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +206,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Restore-DatabaseAvailabilityGroup.md similarity index 90% rename from exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Restore-DatabaseAvailabilityGroup.md index e7ed934cf1..ae01926758 100644 --- a/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Restore-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/restore-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Restore-DatabaseAvailabilityGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/restore-databaseavailabilitygroup +schema: 2.0.0 +title: Restore-DatabaseAvailabilityGroup --- # Restore-DatabaseAvailabilityGroup @@ -65,13 +66,15 @@ This example activates member servers in the DAG DAG1 for the Active Directory s ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the DAG being manipulated. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectorySite + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveDirectorySite parameter specifies the site containing the DAG members to be restored. ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -AlternateWitnessDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AlternateWitnessDirectory parameter specifies the name of an alternate directory used to store witness data. The specified directory must not be in use by any other DAGs or used for any other purpose. This value can be populated ahead by using the Set-DatabaseAvailabilityGroup cmdlet. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -AlternateWitnessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AlternateWitnessServer parameter specifies the name of a new witness server for the DAG as part of a site activation process. This value can be populated ahead by using the Set-DatabaseAvailabilityGroup cmdlet. ```yaml Type: FileShareWitnessServerName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -140,7 +152,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -UsePrimaryWitnessServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UsePrimaryWitnessServer switch specifies that the DAG's currently configured witness server should be used if a witness is needed by the DAG members that are being activated. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,13 +197,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Restore-DetailsTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Restore-DetailsTemplate.md similarity index 90% rename from exchange/exchange-ps/exchange/Restore-DetailsTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Restore-DetailsTemplate.md index c064436cf5..bfb2fae14f 100644 --- a/exchange/exchange-ps/exchange/Restore-DetailsTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Restore-DetailsTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/restore-detailstemplate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Restore-DetailsTemplate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/restore-detailstemplate +schema: 2.0.0 +title: Restore-DetailsTemplate --- # Restore-DetailsTemplate @@ -45,6 +46,9 @@ This example restores the default attributes to the User details template for th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the GUID or specifies the details template type and language separated by a backslash, for example, en-us\\User. Details template types include: - User @@ -58,7 +62,6 @@ The Identity parameter specifies the GUID or specifies the details template type Type: DetailsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Restore-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Restore-Mailbox.md similarity index 94% rename from exchange/exchange-ps/exchange/Restore-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Restore-Mailbox.md index 8e775b1697..acdecb4511 100644 --- a/exchange/exchange-ps/exchange/Restore-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Restore-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/restore-mailbox applicable: Exchange Server 2010 -title: Restore-Mailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/restore-mailbox +schema: 2.0.0 +title: Restore-Mailbox --- # Restore-Mailbox @@ -83,6 +84,9 @@ This example bulk restores all the mailboxes in the MyDatabase mailbox database ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the mailbox that you want to restore. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -100,7 +104,6 @@ The Identity parameter specifies the mailbox that you want to restore. You can u Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -RecoveryDatabase + +> Applicable: Exchange Server 2010 + The RecoveryDatabase parameter specifies the recovery database where you are restoring the mailbox from. You can use any value that uniquely identifies the database. For example: - Name @@ -120,7 +126,6 @@ The RecoveryDatabase parameter specifies the recovery database where you are res Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -RecoveryMailbox + +> Applicable: Exchange Server 2010 + The RecoveryMailbox parameter specifies the mailbox to be used as the source mailbox. This parameter is required if the source mailbox is different from the target mailbox. You identify the mailbox by its GUID value. You can find the GUID value by using the Get-Mailbox or Get-MailboxStatistics cmdlets. @@ -138,7 +146,6 @@ You identify the mailbox by its GUID value. You can find the GUID value by using Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -148,13 +155,15 @@ Accept wildcard characters: False ``` ### -TargetFolder + +> Applicable: Exchange Server 2010 + The TargetFolder parameter specifies the mailbox folder that's created on the mailbox specified. This parameter is required if the mailbox being restored is different from the target mailbox. (For example, the value specified with the Identity parameter isn't the same as the value specified with the RecoveryMailbox parameter.) In this case, the Restore-Mailbox command performs a merge. If the values are the same, the TargetFolder parameter isn't required. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -AllowDuplicates + +> Applicable: Exchange Server 2010 + The AllowDuplicates switch copies mail items without checking if they're duplicates of existing items and without removing duplicate items. You don't need to specify a value with this switch. We recommend that you use this switch with the IncludeFolders parameter. @@ -172,7 +184,6 @@ We recommend that you use this switch with the IncludeFolders parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -AllContentKeywords + +> Applicable: Exchange Server 2010 + The AllContentKeywords parameter specifies the filters for all of the following: - Subject @@ -194,7 +208,6 @@ This allows an OR search of all these fields. If your search criteria are part o Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -204,13 +217,15 @@ Accept wildcard characters: False ``` ### -AttachmentFilenames + +> Applicable: Exchange Server 2010 + The AttachmentFilenames parameter specifies the filter for the attachment file name. You can use wildcard characters in the string. For example, you can use \*.txt to export items that have a .txt extension. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -220,13 +235,15 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010 + The BadItemLimit parameter specifies the number of corrupted items in a mailbox to skip before the export operation fails. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -245,7 +265,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -255,13 +274,15 @@ Accept wildcard characters: False ``` ### -ContentKeywords + +> Applicable: Exchange Server 2010 + The ContentKeywords parameter specifies the keyword filters for the message body and content of attachments in the source mailbox. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -271,13 +292,15 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010 + The EndDate parameter specifies the end date for filtering content that will be exported from the source mailbox. Only items in the mailbox whose date is prior to the end date are exported. When you enter a specific date, use the short date format defined in the Regional Options settings configured on the local computer. For example, if your computer is configured to use the short date format MM/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -287,13 +310,15 @@ Accept wildcard characters: False ``` ### -ExcludeFolders + +> Applicable: Exchange Server 2010 + The ExcludeFolders parameter specifies the list of folders to exclude during the export. Folders are excluded as they're entered. They aren't localized. For example, excluding calendar only excludes calendar in English because calendar in other languages is a different word. ```yaml Type: MapiFolderPath[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -303,13 +328,15 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Exchange Server 2010 + The GlobalCatalog parameter specifies the global catalog to use to search for the target mailbox. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -319,13 +346,15 @@ Accept wildcard characters: False ``` ### -IncludeFolders + +> Applicable: Exchange Server 2010 + The IncludeFolders parameter specifies the list of folders to include during the export. Folders are included as they're entered. They aren't localized. For example, including calendar only includes calendar in English because calendar in other languages is a different word. ```yaml Type: MapiFolderPath[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -335,13 +364,15 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2010 + The Locale parameter specifies the locale setting on a message to restore. With this filter set, only messages with the specified locale setting are extracted. ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -351,13 +382,15 @@ Accept wildcard characters: False ``` ### -MaxThreads + +> Applicable: Exchange Server 2010 + The MaxThreads parameter specifies the maximum number of threads to use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -367,13 +400,15 @@ Accept wildcard characters: False ``` ### -RecipientKeywords + +> Applicable: Exchange Server 2010 + The RecipientKeywords parameter specifies the keyword filters for recipients of items in the source mailbox. This filter finds the search string even if it's part of a word. This isn't a whole word search. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -383,13 +418,15 @@ Accept wildcard characters: False ``` ### -SenderKeywords + +> Applicable: Exchange Server 2010 + The SenderKeywords parameter specifies the keyword filters for senders of items in the source mailbox. This filter finds the search string even if it's part of a word. This isn't a whole word search. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -399,13 +436,15 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010 + The StartDate parameter specifies the start date. The start date must be before the end date. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -415,13 +454,15 @@ Accept wildcard characters: False ``` ### -SubjectKeywords + +> Applicable: Exchange Server 2010 + The SubjectKeywords parameter specifies the keyword filters for subjects of items in the source mailbox. This filter finds the search string even if it's part of a word. This isn't a whole word search. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -431,6 +472,9 @@ Accept wildcard characters: False ``` ### -ValidateOnly + +> Applicable: Exchange Server 2010 + The ValidateOnly switch tells the command to evaluate the conditions and requirements necessary to perform the operation, and then report whether the operation will succeed or fail. You don't need to specify a value with this switch. No changes are made when you use this switch. @@ -439,7 +483,6 @@ No changes are made when you use this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -449,13 +492,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/ExchangePowerShell/Restore-RecoverableItems.md similarity index 92% rename from exchange/exchange-ps/exchange/Restore-RecoverableItems.md rename to exchange/exchange-ps/ExchangePowerShell/Restore-RecoverableItems.md index 5132660f97..cd4e7247c4 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Restore-RecoverableItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/restore-recoverableitems applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Restore-RecoverableItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/restore-recoverableitems +schema: 2.0.0 +title: Restore-RecoverableItems --- # Restore-RecoverableItems @@ -119,6 +120,9 @@ This example bulk restores all the recoverable items for administrator. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox that contains the deleted items that you want to restore. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -136,9 +140,8 @@ In Exchange Online, you can specify multiple mailboxes separated by commas. If t ```yaml Type: GeneralMailboxOrMailUserIdParameter -Parameter Sets: OnPremises +Parameter Sets: OnPremises, Cloud Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -147,20 +150,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: GeneralMailboxOrMailUserIdParameter[] -Parameter Sets: Cloud -Aliases: -Applicable: Exchange Online +### -EntryID -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -### -EntryID The EntryID parameter specifies the deleted item that you want to restore. The EntryID value for the deleted item is unique in the mailbox. You can find the EntryID for specific items by using other search filters on the Get-RecoverableItems cmdlet (subject, date range, etc.). @@ -169,7 +162,6 @@ You can find the EntryID for specific items by using other search filters on the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -179,6 +171,9 @@ Accept wildcard characters: False ``` ### -FilterEndTime + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The FilterEndTime specifies the end date/time of the date range. This parameter uses the LastModifiedTime value of the item. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -187,7 +182,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,6 +191,9 @@ Accept wildcard characters: False ``` ### -FilterItemType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example: - IPM.Appointment (Meetings and appointments) @@ -209,7 +206,6 @@ The FilterItemType parameter filters the results by the specified MessageClass ( Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +215,9 @@ Accept wildcard characters: False ``` ### -FilterStartTime + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The FilterStartTime specifies the start date/time of the date range. This parameter uses the LastModifiedTime value of the item. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -227,7 +226,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -237,13 +235,15 @@ Accept wildcard characters: False ``` ### -LastParentFolderID + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -253,6 +253,9 @@ Accept wildcard characters: False ``` ### -MaxParallelSize + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MaxParallelSize parameter specifies the maximum number of mailboxes that are processed by the command in parallel. A valid value is an integer from 1 to 10. Typically, a higher value decreases the amount of time it takes to complete the command on multiple mailboxes. @@ -263,7 +266,6 @@ The value of this parameter has no effect when the Identity parameter specifies Type: Int32 Parameter Sets: Cloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -273,6 +275,9 @@ Accept wildcard characters: False ``` ### -NoOutput + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The NoOutput switch restores the deleted items directly without any command output in the console. You don't need to specify a value with this switch. @@ -281,7 +286,6 @@ The NoOutput switch restores the deleted items directly without any command outp Type: SwitchParameter Parameter Sets: Cloud Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -291,6 +295,9 @@ Accept wildcard characters: False ``` ### -PolicyTag + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill PolicyTag Description }} @@ -299,7 +306,6 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -309,6 +315,9 @@ Accept wildcard characters: False ``` ### -RestoreTargetFolder + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. @@ -327,7 +336,6 @@ The preceding or trailing `/` will be ignored. Then, it will be treated as the r Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -337,13 +345,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -353,6 +363,9 @@ Accept wildcard characters: False ``` ### -SourceFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: - DeletedItems: The Deleted Items folder. @@ -367,7 +380,6 @@ If you don't use this parameter, the command searches those three folders. Type: RecoverableItemsFolderType Parameter Sets: OnPrem Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -377,13 +389,15 @@ Accept wildcard characters: False ``` ### -SubjectContains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SubjectContains parameter filters the deleted items by the specified text value in the Subject field. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxDatabaseCopy.md similarity index 89% rename from exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-MailboxDatabaseCopy.md index fd5c0c4ae9..1403d54b10 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboxdatabasecopy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-MailboxDatabaseCopy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-mailboxdatabasecopy +schema: 2.0.0 +title: Resume-MailboxDatabaseCopy --- # Resume-MailboxDatabaseCopy @@ -65,13 +66,15 @@ This example resumes replication and replay activity for the copy of the databas ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the database whose copying is being resumed. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -90,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -DisableReplayLag + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DisableReplayLag switch disables any configured replay lag time for the database copy when the passive copy is resumed. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: DisableReplayLag Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -DisableReplayLagReason + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DisableReplayLagReason parameter is used with the DisableReplayLag parameter to specify an administrative reason for disabling replay lag time for a passive copy. ```yaml Type: String Parameter Sets: DisableReplayLag Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -ReplicationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReplicationOnly switch resumes replication without affecting the activation setting (for example, the ActivationSuspended property for the database copy remains set to True). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +177,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxExportRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-MailboxExportRequest.md index 48f67e84d6..e8b277aa9d 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-MailboxExportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-mailboxexportrequest +schema: 2.0.0 +title: Resume-MailboxExportRequest --- # Resume-MailboxExportRequest @@ -54,13 +55,15 @@ This example resumes any failed export move requests. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). Use the following syntax: `Alias\Name`. ```yaml Type: MailboxExportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxImportRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-MailboxImportRequest.md index f1d190bae5..298495c2a6 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxImportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Resume-MailboxImportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-mailboximportrequest +schema: 2.0.0 +title: Resume-MailboxImportRequest --- # Resume-MailboxImportRequest @@ -56,13 +57,15 @@ This example resumes all failed import requests. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you created the request using the Name parameter, use the following syntax: `Alias\Name`. ```yaml Type: MailboxImportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxRestoreRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-MailboxRestoreRequest.md index b7faf00b00..83322f5be6 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-MailboxRestoreRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Resume-MailboxRestoreRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-mailboxrestorerequest +schema: 2.0.0 +title: Resume-MailboxRestoreRequest --- # Resume-MailboxRestoreRequest @@ -50,6 +51,9 @@ This example resumes any restore request with the status of Failed. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -58,7 +62,6 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: MailboxRestoreRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -77,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -95,7 +103,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-Message.md b/exchange/exchange-ps/ExchangePowerShell/Resume-Message.md similarity index 91% rename from exchange/exchange-ps/exchange/Resume-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-Message.md index 3015c97f9a..2f95ea5a15 100644 --- a/exchange/exchange-ps/exchange/Resume-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-message applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-Message -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-message +schema: 2.0.0 +title: Resume-Message --- # Resume-Message @@ -58,13 +59,15 @@ This example resumes delivery of all messages in a suspended state and for which ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -82,7 +88,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -101,7 +109,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -126,7 +136,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-MoveRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Resume-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-MoveRequest.md index 81384c86be..f03468c869 100644 --- a/exchange/exchange-ps/exchange/Resume-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-MoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Resume-MoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-moverequest +schema: 2.0.0 +title: Resume-MoveRequest --- # Resume-MoveRequest @@ -59,6 +60,9 @@ This example resumes any move requests that have the suspend comment "Resume aft ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - GUID @@ -73,7 +77,6 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c Type: MoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -92,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -110,7 +118,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter specifies the move destination by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -139,7 +149,6 @@ The ProxyToMailbox parameter specifies the move destination by the location of t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendWhenReadyToComplete switch suspends the move request before it reaches the status of CompletionInProgress. You don't need to specify a value with this switch. Instead of this switch, we recommend using the Set-MoveRequest cmdlet with the CompleteAfter parameter. @@ -157,7 +169,6 @@ Instead of this switch, we recommend using the Set-MoveRequest cmdlet with the C Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMigrationRequest.md similarity index 92% rename from exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMigrationRequest.md index 42768b7cfb..0ed306d912 100644 --- a/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-publicfoldermigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-PublicFolderMigrationRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-publicfoldermigrationrequest +schema: 2.0.0 +title: Resume-PublicFolderMigrationRequest --- # Resume-PublicFolderMigrationRequest @@ -52,6 +53,9 @@ This example resumes any failed migration requests. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the migration request that you want to resume. You can use the following values: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the migration request that you want to resume. Type: PublicFolderMigrationRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMoveRequest.md similarity index 92% rename from exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMoveRequest.md index af943a8370..7fa861fda1 100644 --- a/exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderMoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-publicfoldermoverequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-PublicFolderMoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-publicfoldermoverequest +schema: 2.0.0 +title: Resume-PublicFolderMoveRequest --- # Resume-PublicFolderMoveRequest @@ -57,13 +58,15 @@ This example resumes a move request that has the suspend comment "Resume after 1 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the public folder move request. The default identity is \\PublicFolderMove. ```yaml Type: PublicFolderMoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderReplication.md similarity index 95% rename from exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderReplication.md index a781b34c89..fdedc6a3ae 100644 --- a/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-PublicFolderReplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-publicfolderreplication applicable: Exchange Server 2010 -title: Resume-PublicFolderReplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-publicfolderreplication +schema: 2.0.0 +title: Resume-PublicFolderReplication --- # Resume-PublicFolderReplication @@ -42,6 +43,9 @@ This example resumes content replication for the entire organization. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -51,7 +55,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-Queue.md b/exchange/exchange-ps/ExchangePowerShell/Resume-Queue.md similarity index 91% rename from exchange/exchange-ps/exchange/Resume-Queue.md rename to exchange/exchange-ps/ExchangePowerShell/Resume-Queue.md index 43bb312d87..7d18b6c74d 100644 --- a/exchange/exchange-ps/exchange/Resume-Queue.md +++ b/exchange/exchange-ps/ExchangePowerShell/Resume-Queue.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/resume-queue applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Resume-Queue -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/resume-queue +schema: 2.0.0 +title: Resume-Queue --- # Resume-Queue @@ -54,13 +55,15 @@ This example resumes processing of all queues where the NextHopDomain is Fourthc ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -78,7 +84,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -122,7 +132,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Retry-Queue.md b/exchange/exchange-ps/ExchangePowerShell/Retry-Queue.md similarity index 90% rename from exchange/exchange-ps/exchange/Retry-Queue.md rename to exchange/exchange-ps/ExchangePowerShell/Retry-Queue.md index c34b537241..42164baa7f 100644 --- a/exchange/exchange-ps/exchange/Retry-Queue.md +++ b/exchange/exchange-ps/ExchangePowerShell/Retry-Queue.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/retry-queue applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Retry-Queue -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/retry-queue +schema: 2.0.0 +title: Retry-Queue --- # Retry-Queue @@ -60,13 +61,15 @@ This example forces a connection attempt for all queues that meet the following ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -84,7 +90,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -103,7 +111,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -Resubmit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Resubmit parameter specifies whether the queue contents should be resubmitted to the categorizer before a connection is established. Valid input for this parameter is $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -144,7 +156,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md b/exchange/exchange-ps/ExchangePowerShell/Rotate-DkimSigningConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Rotate-DkimSigningConfig.md index d424e6898b..894b736a5b 100644 --- a/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Rotate-DkimSigningConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/rotate-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection -title: Rotate-DkimSigningConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/rotate-dkimsigningconfig +schema: 2.0.0 +title: Rotate-DkimSigningConfig --- # Rotate-DkimSigningConfig @@ -43,6 +44,9 @@ This example rotates the DKIM signing policy for the contoso.com domain. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the DKIM signing policy that you want to rotate. You can use any value that uniquely identifies the policy. For example: - Name: The domain name (for example, contoso.com). @@ -53,7 +57,6 @@ The Identity parameter specifies the DKIM signing policy that you want to rotate Type: DkimSigningConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -KeySize + +> Applicable: Exchange Online, Exchange Online Protection + The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are: - 1024 @@ -95,7 +103,6 @@ RSA keys are supported. Ed25519 keys aren't supported. Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md b/exchange/exchange-ps/ExchangePowerShell/Search-AdminAuditLog.md similarity index 87% rename from exchange/exchange-ps/exchange/Search-AdminAuditLog.md rename to exchange/exchange-ps/ExchangePowerShell/Search-AdminAuditLog.md index f42ad8e781..ead5224ff7 100644 --- a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Search-AdminAuditLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/search-adminauditlog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Search-AdminAuditLog -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/search-adminauditlog +schema: 2.0.0 +title: Search-AdminAuditLog --- # Search-AdminAuditLog @@ -94,6 +95,9 @@ This example returns entries in the administrator audit log of an Exchange Onlin ## PARAMETERS ### -Cmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Cmdlets parameter filters the results by the cmdlets that were used. You can specify multiple cmdlets separated by commas. In the results of this cmdlet, this property is named **CmdletName**. @@ -102,7 +106,6 @@ In the results of this cmdlet, this property is named **CmdletName**. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -112,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -120,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -145,7 +153,6 @@ In the results of this cmdlet, the date/time when the change was made (the cmdle Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -155,6 +162,9 @@ Accept wildcard characters: False ``` ### -ExternalAccess + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ExternalAccess parameter filters the results by changes that were made (cmdlets that were run) by users outside of your organization. Valid values are: - $true: Only return audit log entries where the change was made by an external user. In Exchange Online, use value to return audit log entries for changes that were made by Microsoft datacenter administrators. @@ -164,7 +174,6 @@ The ExternalAccess parameter filters the results by changes that were made (cmdl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -174,6 +183,9 @@ Accept wildcard characters: False ``` ### -IsSuccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The IsSuccess parameter filters the results by whether the changes were successful. Valid values are: - $true: Only return audit log entries where the change was successful (in other words, the cmdlet ran successfully). @@ -185,7 +197,6 @@ In the results of this cmdlet, this property is named **Succeeded**. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -195,6 +206,9 @@ Accept wildcard characters: False ``` ### -ObjectIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ObjectIds parameter filters the results by the object that was modified (the mailbox, public folder, Send connector, transport rule, accepted domain, etc. that the cmdlet operated on). A valid value depends on how the object is represented in the audit log. For example: - Name @@ -209,7 +223,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -219,6 +232,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Parameters parameter filters the results by the parameters that were used. You can only use this parameter with the Cmdlets parameter (you can't use it by itself). You can specify multiple parameters separated by commas. In the results of this cmdlet, this property is named **CmdletParameters** @@ -227,7 +243,6 @@ In the results of this cmdlet, this property is named **CmdletParameters** Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -237,6 +252,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. The default value is 1000. The maximum results to return is 250,000. @@ -245,7 +263,6 @@ The maximum results to return is 250,000. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -255,6 +272,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -270,7 +290,6 @@ In the results of this cmdlet, the date/time when the change was made (the cmdle Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -280,13 +299,15 @@ Accept wildcard characters: False ``` ### -StartIndex + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The StartIndex parameter specifies the position in the result set where the displayed results start. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -296,6 +317,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The UserIds parameter filters the results by the user who made the change (who ran the cmdlet). A typical value for this parameter is the user principal name (UPN; for example, helpdesk@contoso.com). But, updates that were made by system accounts without email addresses might use the Domain\\Username syntax (for example, NT AUTHORITY\SYSTEM (MSExchangeHMHost)). @@ -308,7 +332,6 @@ In the results of this cmdlet, this property is named **Caller** Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Search-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Search-Mailbox.md similarity index 89% rename from exchange/exchange-ps/exchange/Search-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Search-Mailbox.md index 942951ea8b..c2be455ddb 100644 --- a/exchange/exchange-ps/exchange/Search-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Search-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/search-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Search-Mailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/search-mailbox +schema: 2.0.0 +title: Search-Mailbox --- # Search-Mailbox @@ -16,7 +17,7 @@ This cmdlet is available only in on-premises Exchange. Use the Search-Mailbox cmdlet to search a mailbox and copy the results to a specified target mailbox, delete messages from the source mailbox, or both. -**Note**: In cloud-based environments, the Search-Mailbox cmdlet was deprecated in favor of [New-ComplianceSearch](https://learn.microsoft.com/powershell/module/exchange/new-compliancesearch) and related eDiscovery cmdlets. +**Note**: In cloud-based environments, the Search-Mailbox cmdlet was deprecated in favor of [New-ComplianceSearch](https://learn.microsoft.com/powershell/module/exchangepowershell/new-compliancesearch) and related eDiscovery cmdlets. By default, Search-Mailbox is available only in the Mailbox Search or Mailbox Import Export roles, and these roles aren't assigned to *any* role groups. To use this cmdlet, you need to add one or both of the roles to a role group (for example, the Organization Management role group). Only the Mailbox Import Export role gives you access to the DeleteContent parameter. For more information about adding roles to role groups, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -115,6 +116,9 @@ This example searches all mailboxes in your organization for messages that conta ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the mailbox to search. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -132,7 +136,6 @@ The Identity parameter specifies the identity of the mailbox to search. You can Type: MailboxOrMailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -142,6 +145,9 @@ Accept wildcard characters: False ``` ### -EstimateResultOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EstimateResultOnly switch returns only an estimate of the total number and size of messages. Messages aren't copied to the target mailbox. You don't need to specify a value with this switch. You can't use this switch with the TargetMailbox parameter. @@ -150,7 +156,6 @@ You can't use this switch with the TargetMailbox parameter. Type: SwitchParameter Parameter Sets: EstimateResult Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -160,13 +165,15 @@ Accept wildcard characters: False ``` ### -TargetFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetFolder parameter specifies a folder name in which search results are saved in the target mailbox. The folder is created in the target mailbox upon execution. ```yaml Type: String Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -176,6 +183,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetMailbox parameter specifies the destination mailbox where search results are copied. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -195,7 +205,6 @@ You must use this parameter with the TargetFolder parameter. You can't use this Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -205,6 +214,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -214,7 +226,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,6 +235,9 @@ Accept wildcard characters: False ``` ### -DeleteContent + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + **Note**: You need to be assigned the Mailbox Import Export management role to use this switch. By default, this role isn't assigned to any role group (including Organization Management). Typically, you assign a role to a built-in or custom role group. The DeleteContent switch specifies that the messages returned by the search be permanently deleted from the source mailbox. You don't need to specify a value with this switch. @@ -236,7 +250,6 @@ Before you use the DeleteContent switch to delete content, we recommend that you Type: SwitchParameter Parameter Sets: Mailbox, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,13 +259,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,6 +277,9 @@ Accept wildcard characters: False ``` ### -DoNotIncludeArchive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DoNotIncludeArchive switch specifies that the user's archive mailbox shouldn't be included in the search. You don't need to specify a value for this switch. By default, the archive mailbox is always searched. @@ -272,7 +290,6 @@ If auto-expanding archiving is enabled for an Exchange Online mailbox, only the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -282,6 +299,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you use the DeleteContent switch to permanently delete messages. @@ -290,7 +310,6 @@ Use this switch to hide the confirmation prompt when you use the DeleteContent s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,13 +319,15 @@ Accept wildcard characters: False ``` ### -IncludeUnsearchableItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeUnsearchableItems switch includes items that couldn't be indexed by Exchange Search in the search results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,6 +337,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogLevel parameter specifies the logging level for the search. It can have one of the following values: - Suppress: No logs are kept. @@ -330,7 +354,6 @@ When you included this parameter, an email message is created and sent to the ma Type: LoggingLevel Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,6 +363,9 @@ Accept wildcard characters: False ``` ### -LogOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogOnly switch performs a search, but only generates a log. Messages returned by the search aren't copied to the target mailbox. You don't need to specify a value with this switch. The logging level is specified by using the LogLevel parameter. @@ -348,7 +374,6 @@ The logging level is specified by using the LogLevel parameter. Type: SwitchParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -358,6 +383,9 @@ Accept wildcard characters: False ``` ### -SearchDumpster + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SearchDumpster switch specifies whether to include the Recoverable Items folder in the search. The Recoverable items folder stores items that were deleted from the Deleted Items folder or items that were hard-deleted until they're purged from the mailbox database. By default, the Recoverable Items folder is always included in the search. To exclude the Recoverable Items folder from the search, use this exact syntax: `-SearchDumpster:$false`. @@ -366,7 +394,6 @@ By default, the Recoverable Items folder is always included in the search. To ex Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -376,6 +403,9 @@ Accept wildcard characters: False ``` ### -SearchDumpsterOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SearchDumpsterOnly switch specifies that only the Recoverable Items folder of the specified mailbox is searched. You don't need to specify a value with this switch. The Recoverable items folder stores items that were deleted from the Deleted Items folder or items that were hard-deleted until they're purged from the mailbox database. @@ -386,7 +416,6 @@ You can also use this switch with the DeleteContent switch to delete messages fr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -396,6 +425,9 @@ Accept wildcard characters: False ``` ### -SearchQuery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). For more information about KQL in Exchange, see [Message properties and search operators for In-Place eDiscovery](https://learn.microsoft.com/exchange/security-and-compliance/in-place-ediscovery/message-properties-and-search-operators). If this parameter is empty, all messages are returned. @@ -406,7 +438,6 @@ If this parameter is empty, all messages are returned. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -416,13 +447,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md b/exchange/exchange-ps/ExchangePowerShell/Search-MailboxAuditLog.md similarity index 90% rename from exchange/exchange-ps/exchange/Search-MailboxAuditLog.md rename to exchange/exchange-ps/ExchangePowerShell/Search-MailboxAuditLog.md index f6ff4a429a..ec79d9383b 100644 --- a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Search-MailboxAuditLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/search-mailboxauditlog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Search-MailboxAuditLog -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/search-mailboxauditlog +schema: 2.0.0 +title: Search-MailboxAuditLog --- # Search-MailboxAuditLog @@ -89,6 +90,9 @@ This example retrieves mailbox audit log entries for Ken Kwok's mailbox for acti ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies a single mailbox to retrieve mailbox audit log entries from. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -106,7 +110,6 @@ The Identity parameter specifies a single mailbox to retrieve mailbox audit log Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -116,6 +119,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -124,7 +130,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,6 +139,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -142,7 +150,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,6 +159,9 @@ Accept wildcard characters: False ``` ### -ExternalAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalAccess parameter specifies whether to return only audit log entries for mailbox access by users that are outside of your organization. In Exchange Online, this parameter returns audit log entries for mailbox access by Microsoft datacenter administrators. Valid values are: $true: Audit log entries for mailbox access by external users or Microsoft datacenter administrators are returned. @@ -162,7 +172,6 @@ $false: Audit log entries for mailbox access by external users or Microsoft data Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -172,6 +181,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to include Microsoft 365 Groups in the search. You don't need to specify a value with this switch. @@ -180,7 +192,6 @@ The GroupMailbox switch is required to include Microsoft 365 Groups in the searc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -190,6 +201,9 @@ Accept wildcard characters: False ``` ### -HasAttachments + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The HasAttachments parameter filters the search by messages that have attachments. Valid values are: - $true: Only messages with attachments are included in the search. @@ -199,7 +213,6 @@ The HasAttachments parameter filters the search by messages that have attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,6 +222,9 @@ Accept wildcard characters: False ``` ### -IncludeInactiveMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IncludeInactiveMailbox Description }} @@ -217,7 +233,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -227,6 +242,9 @@ Accept wildcard characters: False ``` ### -LogonTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LogonTypes parameter specifies the type of logons. Valid values are: - Admin: Audit log entries for mailbox access by administrator logons are returned. @@ -237,7 +255,6 @@ The LogonTypes parameter specifies the type of logons. Valid values are: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,6 +264,9 @@ Accept wildcard characters: False ``` ### -Mailboxes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailboxes parameter specifies the mailboxes to retrieve mailbox audit log entries from. You can use this parameter to search audit logs for multiple mailboxes. You enter multiple mailboxes separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -257,7 +277,6 @@ You can't use this parameter with the ShowDetails switch. Type: MultiValuedProperty Parameter Sets: MultipleMailboxesSearch Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -267,6 +286,9 @@ Accept wildcard characters: False ``` ### -Operations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Operations parameter filters the search results by the mailbox actions that are logged by mailbox audit logging. Valid values are: - AddFolderPermissions (Exchange 2019 and Exchange Online only. Although this value is accepted, it's already included in the UpdateFolderPermissions action and isn't audited separately.) @@ -299,7 +321,6 @@ You can enter multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -309,13 +330,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of mailbox audit log entries to return. Valid values include an integer from 1 through 250000. By default, 1000 entries are returned. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -325,6 +348,9 @@ Accept wildcard characters: False ``` ### -ShowDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowDetails switch retrieves the details of each log entry from the mailbox. You don't need to specify a value with this switch. By default, all fields for each returned log entry are displayed in a list view. @@ -335,7 +361,6 @@ You can't use this switch with the Mailboxes parameter. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -345,6 +370,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -353,7 +381,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md b/exchange/exchange-ps/ExchangePowerShell/Search-MessageTrackingReport.md similarity index 85% rename from exchange/exchange-ps/exchange/Search-MessageTrackingReport.md rename to exchange/exchange-ps/ExchangePowerShell/Search-MessageTrackingReport.md index b56afd8580..d1f91cda9d 100644 --- a/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md +++ b/exchange/exchange-ps/ExchangePowerShell/Search-MessageTrackingReport.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/search-messagetrackingreport applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Search-MessageTrackingReport -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/search-messagetrackingreport +schema: 2.0.0 +title: Search-MessageTrackingReport --- # Search-MessageTrackingReport @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see [Get-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchange/get-messagetrackingreport). The message tracking report cmdlets are used by the delivery reports feature. +Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see [Get-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchangepowershell/get-messagetrackingreport). The message tracking report cmdlets are used by the delivery reports feature. In Exchange Online, delivery reports are replaced by message trace (the Get-MessageTraceV2 and Get-MessageTraceDetailV2 cmdlets). @@ -79,6 +80,9 @@ This example returns the message tracking reports that the Help desk can analyze ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter scopes the search to the specified mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -100,7 +104,6 @@ When you use this parameter with the Sender parameter, the specified mailbox is Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Sender parameter specifies the email address of the message sender for messages that are sent to the mailbox that's specified by the Identity parameter. You need to use this parameter with the Identity parameter. @@ -118,7 +124,6 @@ You need to use this parameter with the Identity parameter. Type: SmtpAddress Parameter Sets: SearchAsSender Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -BypassDelegateChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BypassDelegateChecking switch allows Help desk staff and administrators to track messages for any user. You don't need to specify a value with this switch. By default, users can only track messages that they send or receive from their own mailbox. @@ -136,7 +144,6 @@ By default, users can only track messages that they send or receive from their o Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,6 +153,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -155,7 +165,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,6 +174,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -173,7 +185,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,6 +194,9 @@ Accept wildcard characters: False ``` ### -DoNotResolve + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DoNotResolve switch specifies whether to prevent the resolution of email addresses to display names. You don't need to specify a value with this switch. Using this switch improves performance, but the lack of display names might make the results more difficult to interpret. @@ -191,7 +205,6 @@ Using this switch improves performance, but the lack of display names might make Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -201,13 +214,15 @@ Accept wildcard characters: False ``` ### -MessageEntryId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -217,13 +232,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -233,6 +250,9 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Recipients parameter filters the results by the email addresses of the specified recipients. You can specify multiple email addresses separated by commas. You can't use this parameter with the Sender parameter. @@ -241,7 +261,6 @@ You can't use this parameter with the Sender parameter. Type: SmtpAddress[] Parameter Sets: SearchAsRecipient Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -251,13 +270,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -267,13 +288,15 @@ Accept wildcard characters: False ``` ### -Subject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Subject parameter searches for messages with the specified Subject field value. If the value contains spaces, enclosed the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -283,6 +306,9 @@ Accept wildcard characters: False ``` ### -TraceLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TraceLevel parameter specifies the details to include in the results. Valid values are: - Low: Minimal additional data is returned, including servers that were accessed, timing, message tracking search result counts, and any error information. @@ -295,7 +321,6 @@ You only need to use this parameter for troubleshooting message tracking issues. Type: TraceLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -305,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md b/exchange/exchange-ps/ExchangePowerShell/Search-UnifiedAuditLog.md similarity index 94% rename from exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md rename to exchange/exchange-ps/ExchangePowerShell/Search-UnifiedAuditLog.md index 9043d4d2b9..c468fec3d7 100644 --- a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Search-UnifiedAuditLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/search-unifiedauditlog applicable: Exchange Online, Exchange Online Protection -title: Search-UnifiedAuditLog -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/search-unifiedauditlog +schema: 2.0.0 +title: Search-UnifiedAuditLog --- # Search-UnifiedAuditLog @@ -101,6 +102,9 @@ This example searches the unified audit log from May 1, 2023 to May 8, 2023 for ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Entries are stored in the unified audit log in Coordinated Universal Time (UTC). If you specify a date/time value without a time zone, the value is in UTC. To specify a date/time value for this parameter, use either of the following options: @@ -114,7 +118,6 @@ If you don't include a timestamp in the value for this parameter, the default ti Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Entries are stored in the unified audit log in Coordinated Universal Time (UTC). If you specify a date/time value without a time zone, the value is in UTC. To specify a date/time value for this parameter, use either of the following options: @@ -137,7 +143,6 @@ If you don't include a timestamp in the value for this parameter, the default ti Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -147,6 +152,9 @@ Accept wildcard characters: False ``` ### -Formatted + +> Applicable: Exchange Online, Exchange Online Protection + The Formatted switch causes attributes that are normally returned as integers (for example, RecordType and Operation) to be formatted as descriptive strings. You don't need to specify a value with this switch. In addition, this switch makes AuditData more readable. @@ -155,7 +163,6 @@ In addition, this switch makes AuditData more readable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -165,13 +172,15 @@ Accept wildcard characters: False ``` ### -FreeText + +> Applicable: Exchange Online, Exchange Online Protection + The FreeText parameter filters the log entries by the specified text string. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -HighCompleteness + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: This parameter is currently in Preview, isn't available in all organizations, and is subject to change. The HighCompleteness switch specifies completeness instead performance in the results. You don't need to specify a value with this switch. @@ -191,7 +203,6 @@ When you use this switch, the query returns more complete search results but mig Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -201,13 +212,15 @@ Accept wildcard characters: False ``` ### -IPAddresses + +> Applicable: Exchange Online, Exchange Online Protection + The IPAddresses parameter filters the log entries by the specified IP addresses. You specify multiple IP addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -217,13 +230,15 @@ Accept wildcard characters: False ``` ### -LongerRetentionEnabled + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill LongerRetentionEnabled Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +248,9 @@ Accept wildcard characters: False ``` ### -ObjectIds + +> Applicable: Exchange Online, Exchange Online Protection + The ObjectIds parameter filters the log entries by object ID. The object ID is the target object that was acted upon, and depends on the RecordType and Operations values of the event. For example, for SharePoint operations, the object ID is the URL path to a file, folder, or site. To search logs in a site, add a wildcard (\*) in front of the site URL (for example, `"https://contoso.sharepoint.com/sites/test/*"`). @@ -247,7 +265,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,6 +274,9 @@ Accept wildcard characters: False ``` ### -Operations + +> Applicable: Exchange Online, Exchange Online Protection + The Operations parameter filters the log entries by operation. The available values for this parameter depend on the RecordType value. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -265,7 +285,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,13 +294,15 @@ Accept wildcard characters: False ``` ### -RecordType + +> Applicable: Exchange Online, Exchange Online Protection + The RecordType parameter filters the log entries by record type. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). ```yaml Type: AuditRecordType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -291,13 +312,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online, Exchange Online Protection + The ResultSize parameter specifies the maximum number of results to return. The default value is 100, maximum is 5,000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,6 +330,9 @@ Accept wildcard characters: False ``` ### -SessionCommand + +> Applicable: Exchange Online, Exchange Online Protection + The SessionCommand parameter specifies how much information is returned and how it's organized. This parameter is required if you want to retrieve more than the default limit of 100 results. Valid values are: - ReturnLargeSet: This value causes the cmdlet to return unsorted data. By using paging, you can access a maximum of 50,000 results. This is the recommended value if an ordered result is not required and has been optimized for search latency. @@ -318,7 +344,6 @@ The SessionCommand parameter specifies how much information is returned and how Type: UnifiedAuditSessionCommand Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -328,6 +353,9 @@ Accept wildcard characters: False ``` ### -SessionId + +> Applicable: Exchange Online, Exchange Online Protection + 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. @@ -338,7 +366,6 @@ For a given session ID, if you use the SessionCommand value ReturnLargeSet, and Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -348,6 +375,9 @@ Accept wildcard characters: False ``` ### -SiteIds + +> Applicable: Exchange Online, Exchange Online Protection + The SiteIds parameter filters the log entries by the SharePoint SiteId (GUID). You can enter multiple values separated by commas: `Value1, Value2,...ValueN`. To obtain the SiteId for a SharePoint site, append `/_api/site/id` to the URL of the site collection you want to specify. For example, change the URL `https://contoso.sharepoint.com/sites/hr-project` to `https://contoso.sharepoint.com/sites/hr-project/_api/site/id`. An XML payload is returned and the SiteId for the site collection is displayed in the Edm.Guid property; for example: `14ab81b6-f23d-476a-8cac-ad5dbd2910f7`. @@ -356,7 +386,6 @@ To obtain the SiteId for a SharePoint site, append `/_api/site/id` to the URL of Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -366,6 +395,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Exchange Online, Exchange Online Protection + The UserIds parameter filters the log entries by the account (UserPrincipalName) of the user who performed the action. For example, laura@contoso.onmicrosoft.com. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -374,7 +406,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md b/exchange/exchange-ps/ExchangePowerShell/Send-TextMessagingVerificationCode.md similarity index 90% rename from exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md rename to exchange/exchange-ps/ExchangePowerShell/Send-TextMessagingVerificationCode.md index dd6524d3fd..b1af8ec2d7 100644 --- a/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md +++ b/exchange/exchange-ps/ExchangePowerShell/Send-TextMessagingVerificationCode.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/send-textmessagingverificationcode applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Send-TextMessagingVerificationCode -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/send-textmessagingverificationcode +schema: 2.0.0 +title: Send-TextMessagingVerificationCode --- # Send-TextMessagingVerificationCode @@ -61,6 +62,9 @@ This example sends the text messaging verification code to Tony Smith's mobile p ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox where you are trying to enable text messaging notifications. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -78,7 +82,6 @@ The Identity parameter specifies the mailbox where you are trying to enable text Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -115,7 +123,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ADServerSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-ADServerSettings.md similarity index 83% rename from exchange/exchange-ps/exchange/Set-ADServerSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ADServerSettings.md index fbc8c31fba..080dc688ce 100644 --- a/exchange/exchange-ps/exchange/Set-ADServerSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ADServerSettings.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-adserversettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ADServerSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/Set-ADServerSettings +schema: 2.0.0 +title: Set-ADServerSettings --- -# Set-AdServerSettings +# Set-ADServerSettings ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-AdServerSettings cmdlet to manage the Active Directory Domain Services (AD DS) environment in the current Exchange Management Shell session. The Set-AdServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. +Use the Set-ADServerSettings cmdlet to manage the Active Directory Domain Services (AD DS) environment in the current Exchange Management Shell session. The Set-ADServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -22,7 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ### Instance ``` -Set-AdServerSettings -RunspaceServerSettings +Set-ADServerSettings -RunspaceServerSettings [-Confirm] [-WhatIf] [] @@ -30,7 +31,7 @@ Set-AdServerSettings -RunspaceServerSettings ] +Set-ADServerSettings [-ConfigurationDomainController ] [-PreferredGlobalCatalog ] [-RecipientViewRoot ] [-SetPreferredDomainControllers ] @@ -42,7 +43,7 @@ Set-AdServerSettings [-ConfigurationDomainController ] ### SingleDC ``` -Set-AdServerSettings [[-PreferredServer] ] +Set-ADServerSettings [[-PreferredServer] ] [-RecipientViewRoot ] [-ViewEntireForest ] [-Confirm] @@ -57,14 +58,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Set-AdServerSettings -RecipientViewRoot "contoso.com/Marketing Users" +Set-ADServerSettings -RecipientViewRoot "contoso.com/Marketing Users" ``` This example sets the recipient scope to the Marketing Users OU in the contoso.com domain for the current session. ### Example 2 ```powershell -Set-AdServerSettings -ViewEntireForest $true -PreferredGlobalCatalog gc1.contoso.com +Set-ADServerSettings -ViewEntireForest $true -PreferredGlobalCatalog gc1.contoso.com ``` This example sets the scope of the current session to the entire forest and designates gc1.contoso.com as the preferred global catalog server. @@ -72,13 +73,15 @@ This example sets the scope of the current session to the entire forest and desi ## PARAMETERS ### -PreferredServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PreferredServer parameter specifies the FQDN of the domain controller to be used for this session. ```yaml Type: Fqdn Parameter Sets: SingleDC Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -RunspaceServerSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RunspaceServerSettings parameter specifies whether to pass an entire configuration object to the command to be processed. This parameter is useful in scripts where an entire object must be passed to the command. ```yaml Type: RunspaceServerSettingsPresentationObject Parameter Sets: Instance Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -ConfigurationDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConfigurationDomainController parameter specifies the fully qualified domain name (FQDN) of the configuration domain controller to be used for reading Exchange configuration information in this session. ```yaml Type: Fqdn Parameter Sets: FullParams Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -129,7 +139,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,13 +148,15 @@ Accept wildcard characters: False ``` ### -PreferredGlobalCatalog + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PreferredGlobalCatalog parameter specifies the FQDN of the global catalog server to be used for reading recipient information in this session. ```yaml Type: Fqdn Parameter Sets: FullParams Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -RecipientViewRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecipientViewRoot parameter specifies the organizational unit (OU) to include in the recipient scope for this session. When you specify a recipient scope with this parameter, only the recipients included in the scope are returned. To specify an OU, use the syntax `/`. ```yaml Type: String Parameter Sets: SingleDC, FullParams Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -SetPreferredDomainControllers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SetPreferredDomainControllers parameter specifies the list of domain controllers used to read information from Active Directory in this session. You must specify the FQDN of the domain controllers. Separate multiple domain controllers using commas. ```yaml Type: MultiValuedProperty Parameter Sets: FullParams Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -ViewEntireForest + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ViewEntireForest parameter specifies whether all the objects in the forest are viewed and managed in this session. Valid values are $true and $false. When you specify a value of $true, the value stored in the RecipientViewRoot parameter is removed and all of the recipients in the forest can be viewed and managed. @@ -195,7 +213,6 @@ When you specify a value of $true, the value stored in the RecipientViewRoot par Type: Boolean Parameter Sets: SingleDC, FullParams Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -205,13 +222,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ADSite.md b/exchange/exchange-ps/ExchangePowerShell/Set-ADSite.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-ADSite.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ADSite.md index b2769997e3..d3e770f585 100644 --- a/exchange/exchange-ps/exchange/Set-ADSite.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ADSite.md @@ -1,27 +1,28 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-adsite applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ADSite -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-adsite +schema: 2.0.0 +title: Set-ADSite --- -# Set-AdSite +# Set-ADSite ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-AdSite cmdlet to configure the Exchange settings of Active Directory sites. +Use the Set-ADSite cmdlet to configure the Exchange settings of Active Directory sites. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-AdSite [-Identity] +Set-ADSite [-Identity] [-Confirm] [-DomainController ] [-HubSiteEnabled ] @@ -38,7 +39,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Set-AdSite Default-First-Site-Name -HubSiteEnabled $true +Set-ADSite Default-First-Site-Name -HubSiteEnabled $true ``` This example configures the Active Directory site named Default-First-Site-Name as a hub site. @@ -46,13 +47,15 @@ This example configures the Active Directory site named Default-First-Site-Name ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the Active Directory site you want to modify. You can use any value that uniquely identifies the site. For example, you can use the name, GUID or distinguished name (DN) of the Active Directory site. ```yaml Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,13 +104,15 @@ Accept wildcard characters: False ``` ### -HubSiteEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The HubSiteEnabled parameter specifies whether this site acts as a hub site. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +122,9 @@ Accept wildcard characters: False ``` ### -InboundMailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InboundMailEnabled parameter enables or disables receiving incoming messages for all the Exchange located in the Active Directory site. Typically, this parameter is used after Active Directory site failover or maintenance. Valid input for this parameter is $true or $false. The default value is $true. If you set the value to $false, none of the Exchange servers in the Active Directory site will be able to receive incoming messages. @@ -121,7 +133,6 @@ Valid input for this parameter is $true or $false. The default value is $true. I Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +142,15 @@ Accept wildcard characters: False ``` ### -PartnerId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AdSiteLink.md b/exchange/exchange-ps/ExchangePowerShell/Set-ADSiteLink.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-AdSiteLink.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ADSiteLink.md index 0bdcffba25..01d0e16fc3 100644 --- a/exchange/exchange-ps/exchange/Set-AdSiteLink.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ADSiteLink.md @@ -1,27 +1,28 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-adsitelink applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AdSiteLink -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/Set-ADSitelink +schema: 2.0.0 +title: Set-ADSiteLink --- -# Set-AdSiteLink +# Set-ADSiteLink ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to an Active Directory IP site link. You can also use this cmdlet to configure the maximum message size that can pass across an Active Directory IP site link. +Use the Set-ADSiteLink cmdlet to assign an Exchange-specific cost to an Active Directory IP site link. You can also use this cmdlet to configure the maximum message size that can pass across an Active Directory IP site link. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-AdSiteLink [-Identity] +Set-ADSiteLink [-Identity] [-Confirm] [-DomainController ] [-ExchangeCost ] @@ -32,7 +33,7 @@ Set-AdSiteLink [-Identity] ``` ## DESCRIPTION -By default, Microsoft Exchange determines the least cost routing path by using the cost assigned to the Active Directory IP site link. You can use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to the Active Directory IP site link. The Exchange-specific cost is a separate attribute used instead of the Active Directory-assigned cost to determine the least cost routing path. +By default, Microsoft Exchange determines the least cost routing path by using the cost assigned to the Active Directory IP site link. You can use the Set-ADSiteLink cmdlet to assign an Exchange-specific cost to the Active Directory IP site link. The Exchange-specific cost is a separate attribute used instead of the Active Directory-assigned cost to determine the least cost routing path. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -40,7 +41,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Set-AdSiteLink DEFAULT_IP_SITE_LINK -ExchangeCost 25 -MaxMessageSize 10MB +Set-ADSiteLink DEFAULT_IP_SITE_LINK -ExchangeCost 25 -MaxMessageSize 10MB ``` This example assigns an Exchange-specific cost of 25 to the IP site link DEFAULT\_IP\_SITE\_LINK and configures a maximum message size limit of 10 MB on the IP site link. @@ -48,13 +49,15 @@ This example assigns an Exchange-specific cost of 25 to the IP site link DEFAULT ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name or GUID of the IP site link you want to modify. ```yaml Type: AdSiteLinkIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -91,7 +99,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -ExchangeCost + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExchangeCost parameter specifies an Exchange-specific cost for the IP site link. This cost is used instead of the Active Directory-assigned cost. To clear the value of the ExchangeCost parameter and revert to using the cost of the IP site link specified in Active Directory, set the value of the ExchangeCost parameter to $null. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,6 +126,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxMessageSize parameter specifies the maximum size of a message that can pass across the Active Directory IP site link. The default value is unlimited. When you enter a value, qualify the value with one of the following units: @@ -135,7 +147,6 @@ The valid input range for this parameter is from 64 KB through Int64. To remove Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,13 +156,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a unique name for the IP site link. The name that you assign overwrites the current identity of the IP site link. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ATPBuiltInProtectionRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ATPBuiltInProtectionRule.md index cb0c15498e..8a156797ad 100644 --- a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ATPBuiltInProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-atpbuiltinprotectionrule applicable: Exchange Online -title: Set-ATPBuiltInProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-atpbuiltinprotectionrule +schema: 2.0.0 +title: Set-ATPBuiltInProtectionRule --- # Set-ATPBuiltInProtectionRule @@ -65,6 +66,9 @@ This example remove all exceptions from the Built-in protection preset security ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -77,7 +81,6 @@ The name of the only rule is ATP Built-In Protection Rule. Type: DehydrateableRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -112,7 +120,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -153,7 +165,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -182,7 +196,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -192,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ATPProtectionPolicyRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ATPProtectionPolicyRule.md index a2820af421..ea44a4a727 100644 --- a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ATPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-atpprotectionpolicyrule applicable: Exchange Online -title: Set-ATPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-atpprotectionpolicyrule +schema: 2.0.0 +title: Set-ATPProtectionPolicyRule --- # Set-ATPProtectionPolicyRule @@ -63,6 +64,9 @@ This example removes all conditions and exceptions from the Standard preset secu ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -75,7 +79,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -110,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -151,7 +163,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -178,7 +192,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. We highly recommend that you use the default rule names for clarity and consistency. @@ -196,7 +212,6 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -206,6 +221,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. @@ -216,7 +234,6 @@ You must use the default value for the rule. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -226,13 +243,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -242,6 +261,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -257,7 +279,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -267,6 +288,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -284,7 +308,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -294,13 +317,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Set-AcceptedDomain.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-AcceptedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AcceptedDomain.md index cd7a31a975..d4947a9cab 100644 --- a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AcceptedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-accepteddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-AcceptedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-accepteddomain +schema: 2.0.0 +title: Set-AcceptedDomain --- # Set-AcceptedDomain @@ -55,13 +56,15 @@ This example makes the accepted domain Contoso the default accepted domain. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the accepted domain you want to modify. You can use any value that uniquely identifies the accepted domain object. For example, you can use the name, GUID or distinguished name (DN) of the accepted domain. ```yaml Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -AddressBookEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AddressBookEnabled parameter specifies whether to enable recipient filtering for this accepted domain. The default values are: @@ -83,7 +89,6 @@ The AddressBookEnabled parameter specifies whether to enable recipient filtering Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -CanHaveCloudCache + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill CanHaveCloudCache Description }} @@ -101,7 +109,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -120,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -140,7 +152,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -DomainType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DomainType parameter specifies the accepted domain type. Valid values are: - Authoritative: This is the default value. Your organization is completely responsible for delivering email to recipients in the domain, and for generating non-delivery reports (also known as an NDRs, delivery system notifications, DSNs, or bounce messages) for unresolved recipients. @@ -162,7 +176,6 @@ The DomainType parameter specifies the accepted domain type. Valid values are: Type: AcceptedDomainType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,6 +185,9 @@ Accept wildcard characters: False ``` ### -EnableNego2Authentication + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -180,7 +196,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MakeDefault parameter specifies whether the accepted domain is the default domain. Valid values are: $true or $false. @@ -205,7 +223,6 @@ If you don't use non-SMTP email addresses in your organization, you don't need t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,13 +232,15 @@ Accept wildcard characters: False ``` ### -MatchSubDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MatchSubDomains parameter enables mail to be sent by and received from users on any subdomain of this accepted domain. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -231,6 +250,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Name parameter specifies a unique name for the accepted domain object. The default value is the DomainName property value. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -239,7 +261,6 @@ The Name parameter specifies a unique name for the accepted domain object. The d Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -249,6 +270,9 @@ Accept wildcard characters: False ``` ### -OutboundOnly + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The OutboundOnly parameter specifies whether this accepted domain is an internal relay domain for the on-premises deployment for organizations that have coexistence with a cloud-based organization. @@ -259,7 +283,6 @@ The authoritative accepted domain for the on-premises deployment is configured a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -269,6 +292,9 @@ Accept wildcard characters: False ``` ### -PendingCompletion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -277,7 +303,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -287,6 +312,9 @@ Accept wildcard characters: False ``` ### -PendingRemoval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -295,7 +323,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -305,6 +332,9 @@ Accept wildcard characters: False ``` ### -SendingFromDomainDisabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The SendingFromDomainDisabled parameter specifies whether to allow email to be sent from addresses in the domain. Valid values are: @@ -318,7 +348,6 @@ A common scenario is addresses in a legacy domain that still need to receive ema Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -328,6 +357,9 @@ Accept wildcard characters: False ``` ### -SendingToDomainDisabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The SendingToDomainDisabled specifies whether to prevent delivery of messages sent to recipients in the domain. Valid values are: @@ -341,7 +373,6 @@ A common scenario is to prevent email delivery to recipients in your unused Mico Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -351,13 +382,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-AccessToCustomerDataRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AccessToCustomerDataRequest.md index a8ff53f2c3..0f0c11f6da 100644 --- a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AccessToCustomerDataRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-accesstocustomerdatarequest applicable: Exchange Online, Exchange Online Protection -title: Set-AccessToCustomerDataRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-accesstocustomerdatarequest +schema: 2.0.0 +title: Set-AccessToCustomerDataRequest --- # Set-AccessToCustomerDataRequest @@ -44,6 +45,9 @@ This example approves the customer lockbox request EXSR123456 with a comment. ## PARAMETERS ### -ApprovalDecision + +> Applicable: Exchange Online, Exchange Online Protection + The ApprovalDecision parameter specifies the approval decision for the customer lockbox request. Valid values are: - Approve @@ -54,7 +58,6 @@ The ApprovalDecision parameter specifies the approval decision for the customer Type: AccessToCustomerDataApproverDecision Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -RequestId + +> Applicable: Exchange Online, Exchange Online Protection + The RequestId parameter specifies the reference number of the customer lockbox request that you want to approve, deny, or cancel (for example, EXSR123456). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -ServiceName + +> Applicable: Exchange Online, Exchange Online Protection + The ServiceName parameter specifies the related service. Valid values are: - EOP @@ -107,7 +117,6 @@ The ServiceName parameter specifies the related service. Valid values are: Type: Microsoft.Exchange.Management.AccessToCustomerDataApproval.AccessToCustomerDataRequestServiceName Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAccessRule.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAccessRule.md index 3649c7062d..f09b1a8f8a 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncdeviceaccessrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ActiveSyncDeviceAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-activesyncdeviceaccessrule +schema: 2.0.0 +title: Set-ActiveSyncDeviceAccessRule --- # Set-ActiveSyncDeviceAccessRule @@ -53,13 +54,15 @@ This example changes the organization's device access rule so that all devices e ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the device access rule. ```yaml Type: ActiveSyncDeviceAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -AccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AccessLevel parameter specifies whether the devices are allowed, blocked or quarantined. ```yaml Type: DeviceAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -94,7 +102,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -112,7 +122,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAutoblockThreshold.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAutoblockThreshold.md index ba3b345abe..a6b7e0af1e 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAutoblockThreshold.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncDeviceAutoblockThreshold.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncdeviceautoblockthreshold applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ActiveSyncDeviceAutoblockThreshold -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-activesyncdeviceautoblockthreshold +schema: 2.0.0 +title: Set-ActiveSyncDeviceAutoblockThreshold --- # Set-ActiveSyncDeviceAutoblockThreshold @@ -56,13 +57,15 @@ This example sets the autoblock threshold rule RecentCommands with several setti ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the autoblock threshold rule. ```yaml Type: ActiveSyncDeviceAutoblockThresholdIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -AdminEmailInsert + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AdminEmailInsert parameter specifies the text to include in the email sent to the user when a mobile device triggers an autoblock threshold rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -BehaviorTypeIncidenceDuration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BehaviorTypeIncidenceDuration parameter specifies the interval (in minutes) within which the BehaviorType must occur to trigger the autoblock rule. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -BehaviorTypeIncidenceLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BehaviorTypeIncidenceLimit parameter specifies the number of occurrences of the behavior type needed to trigger blocking. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -129,7 +141,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,13 +150,15 @@ Accept wildcard characters: False ``` ### -DeviceBlockDuration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeviceBlockDuration parameter specifies the length of time (in minutes) that the mobile device is blocked. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +186,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncMailboxPolicy.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncMailboxPolicy.md index 1dae482742..c315385640 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncmailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ActiveSyncMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-activesyncmailboxpolicy +schema: 2.0.0 +title: Set-ActiveSyncMailboxPolicy --- # Set-ActiveSyncMailboxPolicy @@ -117,13 +118,15 @@ This example sets several policy settings for the Mobile Device mailbox policy D ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Mobile Device mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -133,6 +136,9 @@ Accept wildcard characters: False ``` ### -AllowApplePushNotifications + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowApplePushNotifications parameter specifies whether push notifications are allowed to Apple mobile devices. @@ -141,7 +147,6 @@ The AllowApplePushNotifications parameter specifies whether push notifications a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -151,13 +156,15 @@ Accept wildcard characters: False ``` ### -AllowBluetooth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile phone. The available options are Disable, HandsfreeOnly, and Allow. The default value is Allow. ```yaml Type: BluetoothType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,13 +174,15 @@ Accept wildcard characters: False ``` ### -AllowBrowser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowBrowser parameter indicates whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect non-Microsoft browsers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -183,13 +192,15 @@ Accept wildcard characters: False ``` ### -AllowCamera + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -199,13 +210,15 @@ Accept wildcard characters: False ``` ### -AllowConsumerEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowConsumerEmail parameter specifies whether the mobile phone user can configure a personal email account on the mobile phone. The default value is $true. This parameter doesn't control access to emails using non-Microsoft mobile phone email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -215,13 +228,15 @@ Accept wildcard characters: False ``` ### -AllowDesktopSync + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -231,13 +246,15 @@ Accept wildcard characters: False ``` ### -AllowExternalDeviceManagement + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the mobile phone. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,13 +264,15 @@ Accept wildcard characters: False ``` ### -AllowHTMLEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowHTMLEmail parameter specifies whether HTML email is enabled on the mobile phone. The default value is $true. If set to $false, all email is converted to plain text before synchronization occurs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -263,13 +282,15 @@ Accept wildcard characters: False ``` ### -AllowInternetSharing + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowInternetSharing parameter specifies whether the mobile phone can be used as a modem to connect a computer to the Internet. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -279,13 +300,15 @@ Accept wildcard characters: False ``` ### -AllowIrDA + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -295,13 +318,15 @@ Accept wildcard characters: False ``` ### -AllowMobileOTAUpdate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowMobileOTAUpdate parameter specifies whether the Exchange ActiveSync mailbox policy can be sent to the mobile phone over a cellular data connection. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -311,13 +336,15 @@ Accept wildcard characters: False ``` ### -AllowNonProvisionableDevices + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowNonProvisionableDevices parameter specifies whether all mobile phones can synchronize with the server running Exchange. When set to $true, the AllowNonProvisionableDevices parameter enables all mobile phones to synchronize with the Exchange server, regardless of whether the phone can enforce all the specific settings established in the Mobile Device mailbox policy. This also includes mobile phones managed by a separate device management system. When set to $false, this parameter blocks mobile phones that aren't provisioned from synchronizing with the Exchange server. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -327,13 +354,15 @@ Accept wildcard characters: False ``` ### -AllowPOPIMAPEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile phone. The default value is $true. This parameter doesn't control access by non-Microsoft email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -343,13 +372,15 @@ Accept wildcard characters: False ``` ### -AllowRemoteDesktop + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -359,13 +390,15 @@ Accept wildcard characters: False ``` ### -AllowSimpleDevicePassword + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSimpleDevicePassword parameter specifies whether a simple device password is allowed. A simple device password is a password that has a specific pattern, such as 1111 or 1234. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -375,13 +408,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMEEncryptionAlgorithmNegotiation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSMIMEEncryptionAlgorithmNegotiation parameter specifies whether the messaging application on the mobile phone can negotiate the encryption algorithm if a recipient's certificate doesn't support the specified encryption algorithm. ```yaml Type: SMIMEEncryptionAlgorithmNegotiationType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -391,13 +426,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMESoftCerts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -407,13 +444,15 @@ Accept wildcard characters: False ``` ### -AllowStorageCard + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowStorageCard parameter specifies whether the mobile phone can access information stored on a storage card. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -423,13 +462,15 @@ Accept wildcard characters: False ``` ### -AllowTextMessaging + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowTextMessaging parameter specifies whether text messaging is allowed from the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -439,13 +480,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedApplications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -455,13 +498,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedInstallationPackages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be executed on the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -471,13 +516,15 @@ Accept wildcard characters: False ``` ### -AllowWiFi + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowWiFi parameter specifies whether wireless Internet access is allowed on the mobile phone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -487,13 +534,15 @@ Accept wildcard characters: False ``` ### -AlphanumericDevicePasswordRequired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlphanumericDevicePasswordRequired parameter specifies whether the password for the mobile phone must be alphanumeric. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -503,13 +552,15 @@ Accept wildcard characters: False ``` ### -ApprovedApplicationList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApprovedApplicationList parameter specifies a list of approved applications for the mobile phone. ```yaml Type: ApprovedApplicationCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -519,13 +570,15 @@ Accept wildcard characters: False ``` ### -AttachmentsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AttachmentsEnabled parameter specifies whether attachments can be downloaded. When set to $false, the AttachmentsEnabled parameter blocks the user from downloading attachments. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -535,6 +588,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -544,7 +600,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -554,13 +609,15 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeviceEncryptionEnabled parameter specifies whether encryption is enabled. The DeviceEncryptionEnabled parameter, when set to $true, enables device encryption on the mobile phone. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -570,13 +627,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DevicePasswordEnabled parameter specifies whether a password is required. When set to $true, the DevicePasswordEnabled parameter requires that the user set a password for the mobile phone. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -586,13 +645,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordExpiration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DevicePasswordExpiration parameter specifies the length of time, in days, that a password can be used. After this length of time, a new password must be created. The format of the parameter is dd.hh.mm:ss, for example, 24.00:00 = 24 hours. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -602,13 +663,15 @@ Accept wildcard characters: False ``` ### -DevicePasswordHistory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DevicePasswordHistory parameter specifies the number of previously used passwords to store. When a user creates a password, the user can't reuse a stored password that was previously used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -618,13 +681,15 @@ Accept wildcard characters: False ``` ### -DevicePolicyRefreshInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DevicePolicyRefreshInterval parameter specifies how often the policy is sent from the server to the mobile phone. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -634,6 +699,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -642,7 +710,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -652,13 +719,15 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -668,13 +737,15 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault parameter specifies whether this policy is the default Mobile Device mailbox policy. The default value is $false. If another policy is currently set as the default, setting this parameter replaces the old default policy with this policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -684,13 +755,15 @@ Accept wildcard characters: False ``` ### -IsDefaultPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault parameter specifies whether this policy is the default Mobile Device mailbox policy. The default value is $false. If another policy is currently set as the default, setting this parameter replaces the old default policy with this policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -700,13 +773,15 @@ Accept wildcard characters: False ``` ### -MaxAttachmentSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile phone. The default value is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -716,6 +791,9 @@ Accept wildcard characters: False ``` ### -MaxCalendarAgeFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the device. The value is specified by entering one of the following values: - All @@ -729,7 +807,6 @@ The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days Type: CalendarAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -739,13 +816,15 @@ Accept wildcard characters: False ``` ### -MaxDevicePasswordFailedAttempts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxDevicePasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile phone. You can enter any number from 4 through 16. The default value is 8. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -755,6 +834,9 @@ Accept wildcard characters: False ``` ### -MaxEmailAgeFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the mobile phone. The value is specified by entering one of the following values. - All @@ -768,7 +850,6 @@ The MaxEmailAgeFilter parameter specifies the maximum number of days of email it Type: EmailAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -778,13 +859,15 @@ Accept wildcard characters: False ``` ### -MaxEmailBodyTruncationSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile phone. The value is specified in kilobytes (KB). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -794,13 +877,15 @@ Accept wildcard characters: False ``` ### -MaxEmailHTMLBodyTruncationSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are synchronized to the mobile phone. The value is specified in KB. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -810,13 +895,15 @@ Accept wildcard characters: False ``` ### -MaxInactivityTimeDeviceLock + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxInactivityTimeDeviceLock parameter specifies the length of time that the mobile phone can be inactive before the password is required to reactivate it. You can enter any interval between 30 seconds and 1 hour. The default value is 15 minutes. The format of the parameter is hh.mm:ss, for example, 15:00 = 15 minutes. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -826,13 +913,15 @@ Accept wildcard characters: False ``` ### -MinDevicePasswordComplexCharacters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MinDevicePasswordComplexCharacters parameter specifies the minimum number of complex characters required in a mobile phone password. A complex character isn't a letter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -842,13 +931,15 @@ Accept wildcard characters: False ``` ### -MinDevicePasswordLength + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MinDevicePasswordLength parameter specifies the minimum number of characters in the device password. You can enter any number from 1 through 16. The maximum length a password can be is 16 characters. The default value is 4. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -858,13 +949,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the friendly name of the Mobile Device mailbox policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -874,13 +967,15 @@ Accept wildcard characters: False ``` ### -PasswordRecoveryEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile phone is stored on an Exchange server. When set to $true, the PasswordRecoveryEnabled parameter enables you to store the recovery password for the mobile phone on an Exchange server. The default value is $false. The recovery password can be viewed from either Outlook on the web or the Exchange admin center. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -890,13 +985,15 @@ Accept wildcard characters: False ``` ### -RequireDeviceEncryption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -906,13 +1003,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptedSMIMEMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -922,13 +1021,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptionSMIMEAlgorithm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message. ```yaml Type: EncryptionSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -938,13 +1039,15 @@ Accept wildcard characters: False ``` ### -RequireManualSyncWhenRoaming + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireManualSyncWhenRoaming parameter specifies whether the mobile phone must synchronize manually while roaming. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -954,13 +1057,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEAlgorithm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message. ```yaml Type: SignedSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -970,13 +1075,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSignedSMIMEMessages parameter specifies whether the mobile phone must send signed S/MIME messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -986,13 +1093,15 @@ Accept wildcard characters: False ``` ### -RequireStorageCardEncryption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireStorageCardEncryption parameter specifies whether storage card encryption is enabled for the mailbox policy. Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1002,13 +1111,15 @@ Accept wildcard characters: False ``` ### -UnapprovedInROMApplicationList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UnapprovedInROMApplicationList parameter contains a list of applications that can't be run in ROM. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1018,13 +1129,15 @@ Accept wildcard characters: False ``` ### -UNCAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled. Access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1034,13 +1147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1050,13 +1165,15 @@ Accept wildcard characters: False ``` ### -WSSAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled. Access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncOrganizationSettings.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncOrganizationSettings.md index 78b5bcd932..3e8b02bfe3 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncOrganizationSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncorganizationsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ActiveSyncOrganizationSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-activesyncorganizationsettings +schema: 2.0.0 +title: Set-ActiveSyncOrganizationSettings --- # Set-ActiveSyncOrganizationSettings @@ -51,13 +52,15 @@ This example sets the default access level to quarantine and sets two administra ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the ActiveSync organization settings object that you want to modify. The default name of this object is Mobile Mailbox Settings. ```yaml Type: ActiveSyncOrganizationSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -AdminMailRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AdminMailRecipients parameter specifies the email addresses of the administrators for reporting purposes. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -77,7 +83,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -AllowAccessForUnSupportedPlatform + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -AllowRMSSupportForUnenlightenedApps + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The AllowRMSSupportForUnenlightenedApps parameter specifies whether to allow Rights Management Services (RMS) protected messages for ActiveSync clients that don't support RMS. Valid values are: @@ -114,7 +124,6 @@ The AllowRMSSupportForUnenlightenedApps parameter specifies whether to allow Rig Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -133,7 +145,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -DefaultAccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultAccessLevel parameter specifies the access level for new and existing device partnerships. Valid values are: - Allow (This is the default value) @@ -155,7 +169,6 @@ If you change this value from Allow to Block or Quarantine, all existing connect Type: DeviceAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,6 +178,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -173,7 +189,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,6 +198,9 @@ Accept wildcard characters: False ``` ### -EnableMobileMailboxPolicyWhenCAInplace + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill EnableMobileMailboxPolicyWhenCAInplace Description }} @@ -191,7 +209,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -201,6 +218,9 @@ Accept wildcard characters: False ``` ### -OtaNotificationMailInsert + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OtaNotificationMailInsert parameter specifies the text to include in an email message that's sent to users who need to update their older devices to use the new Exchange ActiveSync features in Microsoft Exchange. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -209,7 +229,6 @@ The maximum length is 256 characters. If the value contains spaces, enclose the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -TenantAdminPreference + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill TenantAdminPreference Description }} @@ -227,7 +249,6 @@ This parameter is available only in the cloud-based service. Type: TenantAdminPreference Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -237,6 +258,9 @@ Accept wildcard characters: False ``` ### -UserMailInsert + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UserMailInsert parameter specifies an informational footer that's added to the email message sent to users when their mobile device isn't synchronized because the device is quarantined. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -245,7 +269,6 @@ The maximum length is 256 characters. If the value contains spaces, enclose the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -255,13 +278,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncVirtualDirectory.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncVirtualDirectory.md index e46e295975..a23f8983c8 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ActiveSyncVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ActiveSyncVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-activesyncvirtualdirectory +schema: 2.0.0 +title: Set-ActiveSyncVirtualDirectory --- # Set-ActiveSyncVirtualDirectory @@ -82,6 +83,9 @@ This example configures the external URL on the default Exchange ActiveSync virt ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the ActiveSync virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -94,7 +98,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -104,13 +107,15 @@ Accept wildcard characters: False ``` ### -ActiveSyncServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveSyncServer parameter specifies the URL of the Mailbox server. This value is in the following format: https://servername/Microsoft-Server-ActiveSync. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -BadItemReportingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BadItemReportingEnabled parameter specifies whether items that can't be synchronized should be reported to the user. If set to $true, the user receives a notification when an item can't be synchronized to the mobile phone. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -BasicAuthEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: - $true: Basic authentication is enabled. This is the default value. @@ -145,7 +155,6 @@ The BasicAuthentication parameter specifies whether Basic authentication is enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +164,15 @@ Accept wildcard characters: False ``` ### -ClientCertAuth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ClientCertAuth parameter specifies the status of client certificate authentication. By default, client certificate authentication is disabled. The default setting is Ignore. ```yaml Type: ClientCertAuthTypes Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,13 +182,15 @@ Accept wildcard characters: False ``` ### -CompressionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CompressionEnabled parameter is a Boolean value that identifies the compression applied to the specified Exchange ActiveSync virtual directory. The default setting is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,6 +200,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -196,7 +212,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +239,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -234,7 +254,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -244,6 +263,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -253,7 +275,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,6 +284,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -275,7 +299,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -285,6 +308,9 @@ Accept wildcard characters: False ``` ### -ExternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalAuthenticationMethods parameter restricts the authentication methods that can be used to connect to the virtual directory from outside the firewall. Valid values are: - Adfs @@ -314,7 +340,6 @@ Although you can specify any of these values, whether or not the authentication Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,13 +349,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,13 +367,15 @@ Accept wildcard characters: False ``` ### -InstallIsapiFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InstallIsapiFilter parameter specifies whether the Internet Server API (ISAPI) filter is installed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +385,15 @@ Accept wildcard characters: False ``` ### -InternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalAuthenticationMethods parameter specifies the authentication methods supported by the server that contains the virtual directory when access is requested from inside the network firewall. If this parameter isn't set, all authentication methods can be used. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -372,13 +403,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -388,13 +421,15 @@ Accept wildcard characters: False ``` ### -MobileClientCertificateAuthorityURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MobileClientCertificateAuthorityURL parameter specifies the URL for the certification authority (CA) used by the mobile phone. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -404,13 +439,15 @@ Accept wildcard characters: False ``` ### -MobileClientCertificateProvisioningEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MobileClientCertificateProvisioningEnabled parameter specifies whether the Autodiscover service returns the Certificate Services server URL in the XML file. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -420,13 +457,15 @@ Accept wildcard characters: False ``` ### -MobileClientCertTemplateName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MobileClientCertTemplateName parameter specifies the template name for the client certificate. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -436,13 +475,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the Exchange ActiveSync virtual directory. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -452,13 +493,15 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsActionForUnknownServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoteDocumentsActionForUnknownServers parameter specifies the action that occurs when a Microsoft Windows SharePoint Services or Microsoft Windows file share request comes in via Exchange ActiveSync. When a request arrives, Exchange ActiveSync looks for the requested host name in the Allow and Block lists. If the host name isn't found in either list, the action specified in this parameter, either Block or Allow, is performed. ```yaml Type: RemoteDocumentsActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,13 +511,15 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsAllowedServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoteDocumentsAllowedServers parameter is a multivalued property that lists all the allowed servers for remote document access. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -484,13 +529,15 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsBlockedServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoteDocumentsBlockedServers parameter is a multivalued property that lists all the blocked servers for remote document access. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -500,13 +547,15 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsInternalDomainSuffixList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoteDocumentsInternalDomainSuffixList parameter is used in organizations that don't run Windows Internet Name Service (WINS) in their network. In these environments, you can specify one or more FQDNs that Exchange ActiveSync treats as internal when a request for remote file access is received. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -516,13 +565,15 @@ Accept wildcard characters: False ``` ### -SendWatsonReport + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendWatsonReport parameter specifies whether a Watson report is sent for errors and events. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -532,13 +583,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -548,13 +601,15 @@ Accept wildcard characters: False ``` ### -WindowsAuthEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsAuthEnabled parameter specifies whether Integrated Windows authentication is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AdaptiveScope.md b/exchange/exchange-ps/ExchangePowerShell/Set-AdaptiveScope.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-AdaptiveScope.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AdaptiveScope.md index 6560f5f4ab..e4178c71f3 100644 --- a/exchange/exchange-ps/exchange/Set-AdaptiveScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AdaptiveScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-adaptivescope applicable: Security & Compliance -title: Set-AdaptiveScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-adaptivescope +schema: 2.0.0 +title: Set-AdaptiveScope --- # Set-AdaptiveScope @@ -58,6 +59,9 @@ This example modifies the filter in exiting adaptive scope named Project X. The ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the adaptive scope that you want to modify. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the adaptive scope that you want to modify. You Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AdministrativeUnit + +> Applicable: Security & Compliance + {{ Fill AdministrativeUnit Description }} ```yaml Type: Guid -Parameter Sets: AdministrativeUnit +Parameter Sets: Default, AdaptiveScopeRawQuery, AdministrativeUnit Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -93,20 +98,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Guid -Parameter Sets: Default, AdaptiveScopeRawQuery -Aliases: -Applicable: Security & Compliance +### -FilterConditions -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Security & Compliance -### -FilterConditions The FilterConditions parameter specifies the conditions that are included in the dynamic boundary. Valid syntax and values depend of the value of the LocationType parameter: - User or Group: Active Directory attributes. For example, for the condition "('Country or region' equals 'US' or 'Canada') and 'Department' equals 'Finance'", use the following syntax: `@{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "Canada"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "Equals"; "Name" = "Department"}); "Conjunction" = "And"}` @@ -118,7 +113,6 @@ You can't use this parameter with the RawQuery parameter. Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -128,6 +122,9 @@ Accept wildcard characters: False ``` ### -RawQuery + +> Applicable: Security & Compliance + The RawQuery parameter switches the scope to advanced query mode. You use OPATH filter syntax for advanced query mode. You can't use this parameter with the FilterConditions parameter. @@ -136,7 +133,6 @@ You can't use this parameter with the FilterConditions parameter. Type: String Parameter Sets: AdaptiveScopeRawQuery Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -146,13 +142,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-AddressBookPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-AddressBookPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AddressBookPolicy.md index 6438ed69a2..ad5d4f2c0d 100644 --- a/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AddressBookPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-addressbookpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-AddressBookPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-addressbookpolicy +schema: 2.0.0 +title: Set-AddressBookPolicy --- # Set-AddressBookPolicy @@ -50,13 +51,15 @@ This example changes the OAB that the address book policy All Fabrikam ABP uses ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the address book policy that you want to modify. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -AddressLists + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AddressLists parameter specifies the address lists that will be used by mailbox users who are assigned this address book policy. This parameter accepts multiple values, which should be separated by a comma. ```yaml Type: AddressListIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -91,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -109,7 +119,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -GlobalAddressList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The GlobalAddressList parameter specifies the identity of the global address list (GAL) that will be used by mailbox users who are assigned this address book policy. You can specify only one GAL for each address book policy. ```yaml Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name that you want this address book policy to be called. Use this parameter to change the name of the address book policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -151,13 +164,15 @@ Accept wildcard characters: False ``` ### -OfflineAddressBook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OfflineAddressBook parameter specifies the identity of the offline address book (OAB) that will be used by mailbox users who are assigned this address book policy. You can specify only one OAB for each address book policy. ```yaml Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,9 +182,12 @@ Accept wildcard characters: False ``` ### -RoomList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RoomList parameter specifies an address list that used for location experiences for mailbox users who have this address book policy assigned to them. -- When using location experiences (for example, Room Finder or selecting a conference room when scheduling a meeting), users see only resources that match the [RecipientFilter](https://learn.microsoft.com/powershell/module/exchange/new-addresslist#-recipientfilter) results from the address list that's specified by this parameter. +- When using location experiences (for example, Room Finder or selecting a conference room when scheduling a meeting), users see only resources that match the [RecipientFilter](https://learn.microsoft.com/powershell/module/exchangepowershell/new-addresslist#-recipientfilter) results from the address list that's specified by this parameter. - When using experiences that aren't location specific (for example, the To or Cc fields of a calendar event), the address lists specified by the AddressLists parameter in this address book policy are applied. The address list specified by this parameter isn't used. A valid value for this parameter is one address list. You can use any value that uniquely identifies the address list. For example: @@ -185,7 +203,6 @@ A valid value for this parameter is one address list. You can use any value that Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -195,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/Set-AddressList.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AddressList.md index 686f5b3185..bee9b693b5 100644 --- a/exchange/exchange-ps/exchange/Set-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-AddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-addresslist +schema: 2.0.0 +title: Set-AddressList --- # Set-AddressList @@ -88,6 +89,9 @@ This example modifies the type of recipients and the department of the recipient ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the address list that you want to modify. You can use any value that uniquely identifies the address list. For example: - Name @@ -99,7 +103,6 @@ The Identity parameter specifies the address list that you want to modify. You c Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -121,7 +127,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -131,6 +136,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -143,7 +151,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -153,6 +160,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -165,7 +175,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -175,6 +184,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -187,7 +199,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,6 +208,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -209,7 +223,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +232,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -231,7 +247,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -241,6 +256,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -253,7 +271,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -263,6 +280,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -275,7 +295,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -285,6 +304,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -297,7 +319,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -307,6 +328,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -319,7 +343,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -329,6 +352,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -341,7 +367,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -351,6 +376,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -363,7 +391,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -373,6 +400,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -385,7 +415,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -395,6 +424,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -407,7 +439,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -417,6 +448,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -429,7 +463,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -439,6 +472,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -451,7 +487,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -461,6 +496,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -473,7 +511,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -483,6 +520,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -495,7 +535,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -505,6 +544,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -514,7 +556,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -524,13 +565,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -540,6 +583,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -548,7 +594,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -558,6 +603,9 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. @@ -566,7 +614,6 @@ The ForceUpgrade switch suppresses the confirmation message that appears if the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -576,6 +623,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -591,7 +641,6 @@ You can specify multiple values separated by commas. When you use multiple value Type: WellKnownRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -601,13 +650,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a unique name for the address list. The maximum length is 64 characters, and it can't include a carriage return or a backslash (\\). If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -617,6 +668,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -632,7 +686,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -642,6 +695,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -657,7 +713,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -667,13 +722,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md b/exchange/exchange-ps/ExchangePowerShell/Set-AddressRewriteEntry.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AddressRewriteEntry.md index 09836f6007..10e8fe26ff 100644 --- a/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AddressRewriteEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-addressrewriteentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AddressRewriteEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-addressrewriteentry +schema: 2.0.0 +title: Set-AddressRewriteEntry --- # Set-AddressRewriteEntry @@ -59,13 +60,15 @@ This example changes the existing address rewrite entry named "Address entry for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the address rewrite entry you want to modify. You can specify the name or GUID of the address rewrite entry. ```yaml Type: AddressRewriteEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -84,7 +90,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -102,7 +110,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -ExceptionList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExceptionList parameter specifies the domain names that should be excluded from address rewriting when the InternalAddress parameter contains a value that specifies multiple domain names. You can separate multiple domain names included with the ExceptionList parameter with commas. For more information about how to add values to or remove values from multivalued properties, see [Modifying multivalued properties](https://learn.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -ExternalAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalAddress parameter specifies the final email addresses that you want. If the InternalAddress parameter specifies a single email address (chris@contoso.com), the ExternalAddress parameter must also specify a single email address (support@contoso.com). If the InternalAddress parameter specifies a single domain (contoso.com) or a domain and all subdomains (\*.contoso.com), the ExternalAddress parameter must specify a single domain (fabrikam.com). You can't use the wildcard character (\*) with the ExternalAddress parameter. @@ -136,7 +148,6 @@ You can't use the wildcard character (\*) with the ExternalAddress parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -InternalAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalAddress parameter specifies the original email addresses that you want to change. You can use the following values: - Single email address: david@contoso.com @@ -156,7 +170,6 @@ The InternalAddress parameter specifies the original email addresses that you wa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a unique name for this address rewrite entry. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,6 +197,9 @@ Accept wildcard characters: False ``` ### -OutboundOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OutboundOnly parameter enables or disables outbound-only address rewriting. Valid input for this parameter is $true or $false. The value $true means address rewriting occurs in outbound mail only. The value $false means address rewriting occurs on outbound mail and also on inbound mail (rewritten email addresses are changed back to the original email addresses in inbound mail). The default value is $false. You must set this parameter to $true if the InternalAddress parameter contains the wildcard character to rewrite addresses in a domain and all subdomains (\*.contoso.com). @@ -192,7 +210,6 @@ Also, when you configure outbound-only address rewriting, you need to configure Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,13 +219,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-AdminAuditLogConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AdminAuditLogConfig.md index 6812c3cc6d..2039a6a6de 100644 --- a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AdminAuditLogConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-adminauditlogconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-AdminAuditLogConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-adminauditlogconfig +schema: 2.0.0 +title: Set-AdminAuditLogConfig --- # Set-AdminAuditLogConfig @@ -75,6 +76,9 @@ This example enables administrator audit logging only for specific parameters th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -83,7 +87,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AdminAuditLogAgeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AdminAuditLogAgeLimit parameter specifies how long each log entry should be kept before it's deleted. The default age limit is 90 days. @@ -109,7 +115,6 @@ Setting the age limit to 0 purges the audit log of all entries. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -AdminAuditLogCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AdminAuditLogCmdlets parameter specifies which cmdlets should be audited. You can specify one or more cmdlets, separated by commas. You can also use the wildcard character (\*) to match multiple cmdlets in one or more of the entries in the cmdlet list. To audit all cmdlets, specify only the wildcard character (\*). @@ -127,7 +135,6 @@ The AdminAuditLogCmdlets parameter specifies which cmdlets should be audited. Yo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -AdminAuditLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AdminAuditLogEnabled parameter specifies whether administrator audit logging is enabled. Valid values are: @@ -152,7 +162,6 @@ Changes to the administrator audit log configuration are always logged, regardle Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -AdminAuditLogExcludedCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AdminAuditLogExcludedCmdlets parameter specifies which cmdlets should be excluded from auditing. Use this parameter if you want to exclude specific cmdlets you don't want to audit even if they match a wildcard string specified in the AdminAuditLogCmdlets parameter. @@ -174,7 +186,6 @@ If you want to clear the list, specify a value of $null. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -AdminAuditLogParameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AdminAuditLogParameters parameter specifies which parameters should be audited on the cmdlets you specified using the AdminAuditLogCmdlets parameter. You can specify one or more parameters, separated by commas. You can also use the wildcard character (\*) to match multiple parameters in one or more of the entries in the parameters list. To audit all parameters, specify only the wildcard character (\*). @@ -192,7 +206,6 @@ The AdminAuditLogParameters parameter specifies which parameters should be audit Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +215,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -211,7 +227,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named Default value: None @@ -220,6 +235,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -228,7 +246,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,6 +255,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -246,7 +266,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named Default value: None @@ -255,6 +274,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LogLevel parameter specifies whether additional properties should be included in the log entries. Valid values are: @@ -266,7 +288,6 @@ The LogLevel parameter specifies whether additional properties should be include Type: AuditLogLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,6 +297,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Name parameter specifies the name of the AdminAuditLogConfig object. @@ -286,7 +310,6 @@ You don't need to specify this parameter when you configure administrator audit Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,6 +319,9 @@ Accept wildcard characters: False ``` ### -TestCmdletLoggingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The TestCmdletLoggingEnabled parameter specifies whether test cmdlets (cmdlet names that begin with the verb Test) results are included in admin audit logging. Valid values are: @@ -309,7 +335,6 @@ Test cmdlets can produce a large amount of information. As such, you should only Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -319,6 +344,9 @@ Accept wildcard characters: False ``` ### -UnifiedAuditLogIngestionEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The UnifiedAuditLogIngestionEnabled parameter specifies whether to enable or disable the recording of user and admin activities in the Microsoft 365 audit log. Valid values are: @@ -330,7 +358,6 @@ The UnifiedAuditLogIngestionEnabled parameter specifies whether to enable or dis Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named Default value: None @@ -339,13 +366,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named Default value: None diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishPolicy.md index a552fa50b5..f4a26fbb29 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-antiphishpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-AntiPhishPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-antiphishpolicy +schema: 2.0.0 +title: Set-AntiPhishPolicy --- # Set-AntiPhishPolicy @@ -90,6 +91,9 @@ In Microsoft Defender for Office 365, this example modifies the default antiphis ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -100,7 +104,6 @@ The Identity parameter specifies the antiphish policy that you want to modify. Y Type: AntiPhishPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -110,13 +113,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -AuthenticationFailAction + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The AuthenticationFailAction parameter specifies the action to take when the message fails composite authentication (a mixture of traditional SPF, DKIM, and DMARC email authentication checks and proprietary backend intelligence). Valid values are: @@ -137,7 +145,6 @@ The AuthenticationFailAction parameter specifies the action to take when the mes Type: SpoofAuthenticationFailAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -156,7 +166,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -DmarcQuarantineAction + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`. Valid values are: @@ -177,7 +189,6 @@ The DmarcQuarantineAction parameter specifies the action to take when a message Type: SpoofDmarcQuarantineAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,6 +198,9 @@ Accept wildcard characters: False ``` ### -DmarcRejectAction + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The DmarcRejectAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=reject`. Valid values are: @@ -200,7 +214,6 @@ This parameter is meaningful only when the HonorDmarcPolicy parameter is set to Type: SpoofDmarcRejectAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,6 +223,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. To enable or disable an existing anti-phishing policy (the combination of the antiphish rule and the associated antiphish policy), use the **Enable-AntiPhishRule** or **Disable-AntiPhishRule** cmdlets. @@ -222,7 +238,6 @@ In the output of the **Get-AntiPhishRule** cmdlet, whether the anti-phishing pol Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -232,6 +247,9 @@ Accept wildcard characters: False ``` ### -EnableFirstContactSafetyTips + +> Applicable: Exchange Online, Exchange Online Protection + The EnableFirstContactSafetyTips parameter specifies whether to enable or disable the safety tip that's shown when recipients first receive an email from a sender or do not often receive email from a sender. Valid values are: - $true: First contact safety tips are enabled. @@ -241,7 +259,6 @@ The EnableFirstContactSafetyTips parameter specifies whether to enable or disabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligence + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence, which is artificial intelligence (AI) that determines user email patterns with their frequent contacts. Mailbox intelligence helps distinguish between messages from legitimate and impersonated senders based on a recipient's previous communication history. Valid values are: @@ -262,7 +282,6 @@ The EnableMailboxIntelligence parameter specifies whether to enable or disable m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -272,6 +291,9 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligenceProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligenceProtection specifies whether to enable or disable taking action for impersonation detections from mailbox intelligence results. Valid values are: @@ -287,7 +309,6 @@ If you set this parameter to the value $false when the value of the EnableMailbo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -297,6 +318,9 @@ Accept wildcard characters: False ``` ### -EnableOrganizationDomainsProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Microsoft 365 organization. Valid values are: @@ -308,7 +332,6 @@ The EnableOrganizationDomainsProtection parameter specifies whether to enable do Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -318,6 +341,9 @@ Accept wildcard characters: False ``` ### -EnableSimilarDomainsSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for domain impersonation detections. Valid values are: @@ -329,7 +355,6 @@ The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the saf Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -339,6 +364,9 @@ Accept wildcard characters: False ``` ### -EnableSimilarUsersSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for user impersonation detections. Valid values are: @@ -350,7 +378,6 @@ The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -360,6 +387,9 @@ Accept wildcard characters: False ``` ### -EnableSpoofIntelligence + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableSpoofIntelligence parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: @@ -371,7 +401,6 @@ The EnableSpoofIntelligence parameter specifies whether to enable or disable ant Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -381,6 +410,9 @@ Accept wildcard characters: False ``` ### -EnableTargetedDomainsProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableTargetedDomainsProtection parameter specifies whether to enable domain impersonation protection for a list of specified domains. Valid values are: @@ -392,7 +424,6 @@ The EnableTargetedDomainsProtection parameter specifies whether to enable domain Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -402,6 +433,9 @@ Accept wildcard characters: False ``` ### -EnableTargetedUserProtection + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for a list of specified users. Valid values are: @@ -413,7 +447,6 @@ The EnableTargetedUserProtection parameter specifies whether to enable user impe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -423,6 +456,9 @@ Accept wildcard characters: False ``` ### -EnableUnauthenticatedSender + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableUnauthenticatedSender parameter enables or disables unauthenticated sender identification in Outlook. Valid values are: @@ -439,7 +475,6 @@ To prevent these identifiers from being added to messages from specific senders, Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -449,6 +484,9 @@ Accept wildcard characters: False ``` ### -EnableUnusualCharactersSafetyTips + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for unusual characters in domain and user impersonation detections. Valid values are: @@ -460,7 +498,6 @@ The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -470,6 +507,9 @@ Accept wildcard characters: False ``` ### -EnableViaTag + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The EnableViaTag parameter enables or disables adding the via tag to the From address in Outlook (chris@contso.com via fabrikam.com). Valid values are: @@ -486,7 +526,6 @@ To prevent the via tag from being added to messages from specific senders, you h Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -496,6 +535,9 @@ Accept wildcard characters: False ``` ### -ExcludedDomains + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. @@ -508,7 +550,6 @@ The maximum number of entries is approximately 1000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -518,6 +559,9 @@ Accept wildcard characters: False ``` ### -ExcludedSenders + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. @@ -528,7 +572,6 @@ The maximum number of entries is approximately 1000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -538,6 +581,9 @@ Accept wildcard characters: False ``` ### -HonorDmarcPolicy + +> Applicable: Exchange Online, Exchange Online Protection + This setting is part of spoof protection. The HonorDmarcPolicy enables or disables using the sender's DMARC policy to determine what to do to messages that fail DMARC checks. Valid values are: @@ -549,7 +595,6 @@ The HonorDmarcPolicy enables or disables using the sender's DMARC policy to dete Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -559,6 +604,9 @@ Accept wildcard characters: False ``` ### -ImpersonationProtectionState + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ImpersonationProtectionState parameter specifies the configuration of impersonation protection. Valid values are: @@ -571,7 +619,6 @@ The ImpersonationProtectionState parameter specifies the configuration of impers Type: ImpersonationProtectionState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -581,6 +628,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionAction parameter specifies what to do with messages that fail mailbox intelligence protection. Valid values are: @@ -598,7 +648,6 @@ This parameter is meaningful only if the EnableMailboxIntelligence and EnableMai Type: ImpersonationAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -608,6 +657,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionActionRecipients parameter specifies the recipients to add to detected messages when the MailboxIntelligenceProtectionAction parameter is set to the value Redirect or BccMessage. @@ -618,7 +670,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -628,6 +679,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by mailbox intelligence (the MailboxIntelligenceProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -646,7 +700,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -656,6 +709,9 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Online, Exchange Online Protection + The MakeDefault switch makes this antiphish policy the default antiphish policy. You don't need to specify a value with this switch. The default antiphish policy is applied to everyone (no corresponding antiphish rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). @@ -664,7 +720,6 @@ The default antiphish policy is applied to everyone (no corresponding antiphish Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -674,6 +729,9 @@ Accept wildcard characters: False ``` ### -PhishThresholdLevel + +> Applicable: Exchange Online + This setting is part of advanced settings and is available only in Microsoft Defender for Office 365. The PhishThresholdLevel parameter specifies the tolerance level that's used by machine learning in the handling of phishing messages. Valid values are: @@ -687,7 +745,6 @@ The PhishThresholdLevel parameter specifies the tolerance level that's used by m Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -697,13 +754,15 @@ Accept wildcard characters: False ``` ### -PolicyTag + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -713,6 +772,9 @@ Accept wildcard characters: False ``` ### -SpoofQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The SpoofQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by spoof intelligence (the AuthenticationFailAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -729,7 +791,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -739,6 +800,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. @@ -749,7 +813,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -759,6 +822,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: @@ -774,7 +840,6 @@ The TargetedDomainProtectionAction parameter specifies the action to take on det Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -784,6 +849,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by domain impersonation protection (the TargetedDomainProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -802,7 +870,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -812,6 +879,9 @@ Accept wildcard characters: False ``` ### -TargetedDomainsToProtect + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. @@ -822,7 +892,6 @@ You can specify multiple domains separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -832,6 +901,9 @@ Accept wildcard characters: False ``` ### -TargetedUserActionRecipients + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. @@ -842,7 +914,6 @@ A valid value for this parameter is an email address. You can specify multiple e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -852,6 +923,9 @@ Accept wildcard characters: False ``` ### -TargetedUserProtectionAction + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: @@ -867,7 +941,6 @@ The TargetedUserProtectionAction parameter specifies the action to take on detec Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -877,6 +950,9 @@ Accept wildcard characters: False ``` ### -TargetedUserQuarantineTag + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUserQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by user impersonation protection (the TargetedUserProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: @@ -895,7 +971,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -905,6 +980,9 @@ Accept wildcard characters: False ``` ### -TargetedUsersToProtect + +> Applicable: Exchange Online + This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. @@ -920,7 +998,6 @@ This parameter uses the syntax: "DisplayName;EmailAddress". Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -930,13 +1007,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-AntiPhishRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishRule.md index 9d41dff174..d3b9cfe74d 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AntiPhishRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-antiphishrule applicable: Exchange Online, Exchange Online Protection -title: Set-AntiPhishRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-antiphishrule +schema: 2.0.0 +title: Set-AntiPhishRule --- # Set-AntiPhishRule @@ -55,6 +56,9 @@ This example modifies the existing antiphish rule named Engineering Department P ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the antiphish rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the antiphish rule that you want to modify. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AntiPhishPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The AntiPhishPolicy parameter specifies the antiphish policy that's associated with the antiphish rule. You can use any value that uniquely identifies the policy. For example: - Name @@ -85,7 +91,6 @@ The AntiPhishPolicy parameter specifies the antiphish policy that's associated w Type: AntiPhishPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -120,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -161,7 +175,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -186,7 +202,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -196,13 +211,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the antiphish rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,6 +229,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -226,7 +246,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -236,13 +255,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -252,6 +273,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -267,7 +291,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -277,6 +300,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -294,7 +320,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -304,13 +329,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-App.md b/exchange/exchange-ps/ExchangePowerShell/Set-App.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-App.md rename to exchange/exchange-ps/ExchangePowerShell/Set-App.md index af5a021961..5c05af8d3d 100644 --- a/exchange/exchange-ps/exchange/Set-App.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-App.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-App -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-app +schema: 2.0.0 +title: Set-App --- # Set-App @@ -64,13 +65,15 @@ This example disables the organization app named FinanceTestApp across the organ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the AppID (GUID value) of the app that you want to modify. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. ```yaml Type: AppIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -89,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -DefaultStateForUser + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultStateForUser parameter specifies the default initial state of the organization app for the specified users. Valid values are: - Enabled: The organization app is enabled. @@ -111,7 +119,6 @@ You use this parameter with the OrganizationApp switch. Type: DefaultStateForUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -129,7 +139,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter specifies whether the app is available to users in the organization. Valid values are: - $true: The app is enabled for the specified users. This is the default value. @@ -150,7 +162,6 @@ This setting overrides the ProvidedTo, UserList, and DefaultStateForUser setting Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -OrganizationApp + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OrganizationApp switch specifies that the scope of the app is organizational (not bound to a specific user). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -176,13 +189,15 @@ Accept wildcard characters: False ``` ### -PrivateCatalog + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PrivateCatalog switch specifies that the app you want to modify is located in a private catalog. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -192,6 +207,9 @@ Accept wildcard characters: False ``` ### -ProvidedTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ProvidedTo parameter specifies the availability of the app in your organization. Valid value are: - Everyone: The app is provided to every user in the organization. This is the default value. Every user sees this app listed in the installed apps list in Outlook on the web Options. When an app in the installed apps list is enabled, users can use the features of this app in their email. All users are blocked from installing their own instances of this app, including but not limited to users with install apps permissions. @@ -203,7 +221,6 @@ You use this parameter with the OrganizationApp switch. Type: ClientExtensionProvidedTo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -213,6 +230,9 @@ Accept wildcard characters: False ``` ### -UserList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://learn.microsoft.com/office/dev/add-ins/publish/centralized-deployment). Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. For example: @@ -236,7 +256,6 @@ You use this parameter with the OrganizationApp switch. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,13 +265,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionCompliancePolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionCompliancePolicy.md index d7b88cea53..4830d65dc5 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancepolicy applicable: Security & Compliance -title: Set-AppRetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-appretentioncompliancepolicy +schema: 2.0.0 +title: Set-AppRetentionCompliancePolicy --- # Set-AppRetentionCompliancePolicy @@ -158,6 +159,9 @@ This example is similar to Example 2, except multiple deleted resources are spec ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -168,7 +172,6 @@ The Identity parameter specifies the app retention compliance policy that you wa Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -178,6 +181,9 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + The RetryDistribution switch specifies whether to redistribute the policy to all locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -188,7 +194,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistributionParameterSet Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -198,6 +203,9 @@ Accept wildcard characters: False ``` ### -AddAdaptiveScopeLocation + +> Applicable: Security & Compliance + The AddAdaptiveScopeLocation parameter specifies the adaptive scope location to add to the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -210,7 +218,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -220,6 +227,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -238,7 +248,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -248,6 +257,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocationException + +> Applicable: Security & Compliance + The AddExchangeLocationException parameter specifies the mailboxes to add to the list of excluded mailboxes when you're using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -266,7 +278,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -276,6 +287,9 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocation + +> Applicable: Security & Compliance + The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups when you aren't using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -291,7 +305,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -301,6 +314,9 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocationException + +> Applicable: Security & Compliance + The AddModernGroupLocationException parameter specifies the Microsoft 365 Groups to add to the list of excluded Microsoft 365 Groups when you're using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -316,7 +332,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -326,6 +341,9 @@ Accept wildcard characters: False ``` ### -Applications + +> Applicable: Security & Compliance + The Applications parameter specifies the applications to include in the policy. This parameter uses the following syntax: `"LocationType:App1,LocationType:App2,...LocationType:AppN`: @@ -356,7 +374,6 @@ This parameter uses the following syntax: `"LocationType:App1,LocationType:App2, Type: String[] Parameter Sets: Identity, AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -366,13 +383,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -382,6 +401,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -391,7 +413,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -401,6 +422,9 @@ Accept wildcard characters: False ``` ### -DeletedResources + +> Applicable: Security & Compliance + The DeletedResources parameter specifies the deleted mailbox or mail user to add as an exclusion to the respective location list. Use this parameter with the AddTeamsChatLocationException parameter for deleted mailboxes or mail users that need to be excluded from a Teams only retention policy. A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter. @@ -415,7 +439,6 @@ To prevent active mailboxes or mail users with the same SMTP address from being Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -425,6 +448,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter enables or disables the policy. Valid values are: - $true: The policy is enabled. This is the default value. @@ -434,7 +460,6 @@ The Enabled parameter enables or disables the policy. Valid values are: Type: Boolean Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -444,6 +469,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -452,7 +480,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation, InformationBarrierDefault Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -462,6 +489,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + **Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. @@ -472,7 +502,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -482,6 +511,9 @@ Accept wildcard characters: False ``` ### -RemoveAdaptiveScopeLocation + +> Applicable: Security & Compliance + The RemoveAdaptiveScopeLocation parameter specifies the adaptive scope location to remove from the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -494,7 +526,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -504,6 +535,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -522,7 +556,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -532,6 +565,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocationException + +> Applicable: Security & Compliance + The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -550,7 +586,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -560,6 +595,9 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocation + +> Applicable: Security & Compliance + The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups when you aren't using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -575,7 +613,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -585,6 +622,9 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocationException + +> Applicable: Security & Compliance + The RemoveModernGroupLocationException parameter specifies the Microsoft 365 Groups to remove from the list of excluded groups when you're using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -600,7 +640,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -610,6 +649,9 @@ Accept wildcard characters: False ``` ### -RestrictiveRetention + +> Applicable: Security & Compliance + The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: - $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. @@ -623,7 +665,6 @@ Therefore, before you lock a policy, it's critical that you understand your orga Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -633,13 +674,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionComplianceRule.md index 5c9bb418a3..94ac093cd4 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AppRetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancerule applicable: Security & Compliance -title: Set-AppRetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-appretentioncompliancerule +schema: 2.0.0 +title: Set-AppRetentionComplianceRule --- # Set-AppRetentionComplianceRule @@ -52,6 +53,9 @@ This example updates the length of the retention duration for a rule named 563 M ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the app retention compliance rule that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the app retention compliance rule that you want Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -117,7 +127,6 @@ Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -ContentDateFrom + +> Applicable: Security & Compliance + {{ Fill ContentDateFrom Description }} ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -ContentDateTo + +> Applicable: Security & Compliance + {{ Fill ContentDateTo Description }} ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -159,6 +172,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -167,7 +183,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -177,6 +192,9 @@ Accept wildcard characters: False ``` ### -ExcludedItemClasses + +> Applicable: Security & Compliance + The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter 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 @@ -196,7 +214,6 @@ You can specify multiple item class values by using the following syntax: `"Valu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -ExpirationDateOption + +> Applicable: Security & Compliance + The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: - CreationAgeInDays @@ -215,7 +235,6 @@ The ExpirationDateOption parameter specifies whether the expiration date is calc Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -225,6 +244,9 @@ Accept wildcard characters: False ``` ### -RetentionComplianceAction + +> Applicable: Security & Compliance + The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - Delete @@ -235,7 +257,6 @@ The RetentionComplianceAction parameter specifies the retention action for the r Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -245,6 +266,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - An integer: The hold duration in days. @@ -254,7 +278,6 @@ The RetentionDuration parameter specifies the hold duration for the retention ru Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -264,6 +287,9 @@ Accept wildcard characters: False ``` ### -RetentionDurationDisplayHint + +> Applicable: Security & Compliance + The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. - Days @@ -277,7 +303,6 @@ Type: HoldDurationHint Parameter Sets: (All) Aliases: Accepted values: Days, Months, Years -Applicable: Security & Compliance Required: False Position: Named @@ -287,13 +312,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-ApplicationAccessPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ApplicationAccessPolicy.md index dd98f50127..eef7ce2879 100644 --- a/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ApplicationAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection -title: Set-ApplicationAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-applicationaccesspolicy +schema: 2.0.0 +title: Set-ApplicationAccessPolicy --- # Set-ApplicationAccessPolicy @@ -45,13 +46,15 @@ This example modifies the description of the specified policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the application access policy that you want to modify. To find the Identity value for the policy, run the command Get-ApplicationAccessPolicy | Format-List Identity,Description,ScopeName,AccessRight,AppID. ```yaml Type: ApplicationAccessPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online, Exchange Online Protection + The Description parameter modifies the description of the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -77,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -86,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ArcConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-ArcConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-ArcConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ArcConfig.md index 5bf267a358..8b419a49ce 100644 --- a/exchange/exchange-ps/exchange/Set-ArcConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ArcConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-arcconfig applicable: Exchange Online, Exchange Online Protection -title: Set-ArcConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-arcconfig +schema: 2.0.0 +title: Set-ArcConfig --- # Set-ArcConfig @@ -97,6 +98,9 @@ If no other ARC sealers exist after removing this entry from the list, using the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the trusted ARC sealers list that you want to modify. Use one of the following values: - Default for your own organization. @@ -106,7 +110,6 @@ The Identity parameter specifies the trusted ARC sealers list that you want to m Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -116,6 +119,9 @@ Accept wildcard characters: False ``` ### -ArcTrustedSealers + +> Applicable: Exchange Online, Exchange Online Protection + The ArcTrustedSealers parameter specifies the domain name of the ARC sealers that you want to add. The domain name must match the domain that's shown in the `d` tag in the **ARC-Seal** and **ARC-Message-Signature** headers in affected email messages (for example, fabrikam.com). You can use Outlook to see these headers. @@ -130,7 +136,6 @@ To empty the list, use the value `" "` (a space enclosed in double quotation mar Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -140,6 +145,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -149,7 +157,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -159,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md b/exchange/exchange-ps/ExchangePowerShell/Set-AtpPolicyForO365.md similarity index 96% rename from exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AtpPolicyForO365.md index bcdc6c3dd1..5f93a93d5c 100644 --- a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AtpPolicyForO365.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-atppolicyforo365 applicable: Exchange Online -title: Set-AtpPolicyForO365 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-atppolicyforo365 +schema: 2.0.0 +title: Set-AtpPolicyForO365 --- # Set-AtpPolicyForO365 @@ -55,13 +56,15 @@ This example enables Safe Documents and Safe Attachments for SharePoint, OneDriv ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the policy that you want to modify. There's only one policy named Default. ```yaml Type: AtpPolicyForO365IdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -AllowSafeDocsOpen + +> Applicable: Exchange Online + The AllowSafeDocsOpen parameter specifies whether users can click through and bypass the Protected View container even when Safe Documents identifies a file as malicious. Valid values are: - $true: Users are allowed to exit the Protected View container even if the document has been identified as malicious. @@ -82,7 +88,6 @@ This parameter is meaningful only when the EnableSafeDocs parameter value is $tr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -101,7 +109,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -EnableATPForSPOTeamsODB + +> Applicable: Exchange Online + The EnableATPForSPOTeamsODB parameter enables or disables Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. Valid values are: - $true: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is enabled. SharePoint admins can use the DisallowInfectedFileDownload parameter on the [Set-SPOTenant](https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOTenant) cmdlet to control whether users are allowed to download files that are found to be malicious. @@ -120,7 +130,6 @@ The EnableATPForSPOTeamsODB parameter enables or disables Safe Attachments for S Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -EnableSafeDocs + +> Applicable: Exchange Online + The EnableSafeDocs parameter enables or disables Safe Documents in organizations with Microsoft 365 A5 or Microsoft 365 E5 Security licenses. Valid values are: - $true: Safe Documents is enabled and will upload user files to Microsoft Defender for Endpoint for scanning and verification. @@ -141,7 +153,6 @@ For more information about Safe Documents, see [Safe Documents in Microsoft 365 Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-AttachmentFilterListConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AttachmentFilterListConfig.md index 0bc5e542b8..1c317461b0 100644 --- a/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AttachmentFilterListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AttachmentFilterListConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-attachmentfilterlistconfig +schema: 2.0.0 +title: Set-AttachmentFilterListConfig --- # Set-AttachmentFilterListConfig @@ -49,6 +50,9 @@ This example modifies the action that the Attachment Filtering agent takes on an ## PARAMETERS ### -Action + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Action parameter specifies how the Attachment Filtering agent handles an attachment that matches an entry on the attachment filter list. Valid values are: - Reject: This value prevents both the email message and attachment from being delivered to the recipient and issues a non-delivery report (NDR) to the sender. This is the default value. @@ -59,7 +63,6 @@ The Action parameter specifies how the Attachment Filtering agent handles an att Type: FilterActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -AdminMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AdminMessage parameter specifies the content of a text file that replaces attachments removed by the Attachment Filtering agent. The AdminMessage parameter only appears when the Attachment Filtering agent is configured to remove an attachment that's been identified as bad. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -94,7 +102,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -112,7 +122,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -ExceptionConnectors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExceptionConnectors parameter specifies a list of connectors that should be excluded from attachment filtering. Attachment filters aren't applied to email messages received through these connectors. You must use the connector GUID to specify the ExceptionConnectors parameter value. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -RejectResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RejectResponse parameter specifies the message body that you want delivered in the NDR to senders whose messages contain an attachment that's blocked. The RejectResponse parameter is required only if you set the Action parameter to Reject. Don't exceed 240 characters in the parameter argument. When you pass an argument, you must enclose the RejectResponse parameter value in quotation marks (") if the phrase contains spaces, for example: "Message rejected". The default setting is Message rejected due to unacceptable attachments. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AuditConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-AuditConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-AuditConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AuditConfig.md index e2c5d20cfd..7c5c15ef4d 100644 --- a/exchange/exchange-ps/exchange/Set-AuditConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AuditConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-auditconfig applicable: Security & Compliance -title: Set-AuditConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-auditconfig +schema: 2.0.0 +title: Set-AuditConfig --- # Set-AuditConfig @@ -42,13 +43,15 @@ This example sets the auditing configuration for Exchange and SharePoint. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 1 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Security & Compliance + The Workload parameter specifies where auditing is allowed. Valid values are: - Exchange @@ -71,7 +77,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -97,13 +104,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AuthConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-AuthConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-AuthConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AuthConfig.md index a6ffa805ac..ab3ba426ba 100644 --- a/exchange/exchange-ps/exchange/Set-AuthConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AuthConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-authconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AuthConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-authconfig +schema: 2.0.0 +title: Set-AuthConfig --- # Set-AuthConfig @@ -90,13 +91,15 @@ This example immediately rolls over the certificate configured as the next certi ## PARAMETERS ### -CertificateThumbprint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CertificateThumbprint parameter specifies the thumbprint of the certificate to be used by Exchange for server-to-server authentication. ```yaml Type: String Parameter Sets: CurrentCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -ClearPreviousCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ClearPreviousCertificate switch clears the certificate that was saved as the previous certificate in the authorization configuration. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: PublishAuthCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -131,7 +139,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,13 +148,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -165,7 +177,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: CurrentCertificateParameter, PublishAuthCertificateParameter, NewCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,13 +186,15 @@ Accept wildcard characters: False ``` ### -NewCertificateEffectiveDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The NewCertificateEffectiveDate parameter specifies a date when the certificate configured as the next certificate should be used. ```yaml Type: DateTime Parameter Sets: NewCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +204,15 @@ Accept wildcard characters: False ``` ### -NewCertificateThumbprint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The NewCertificateThumbprint parameter specifies the thumbprint of the new certificate to be used as the next certificate in the authorization configuration. ```yaml Type: String Parameter Sets: NewCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +222,9 @@ Accept wildcard characters: False ``` ### -PublishCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PublishCertificate switch immediately rolls over the specified certificate as the current certificate. You don't need to specify a value with this switch. The certificate is immediately deployed to all Client Access servers. @@ -215,7 +233,6 @@ The certificate is immediately deployed to all Client Access servers. Type: SwitchParameter Parameter Sets: PublishAuthCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +242,15 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Realm parameter specifies a security realm for partner applications. If a service or user presents a token from a domain that's not an accepted domain in the Exchange organization, the token must contain the specified realm to gain access to resources. ```yaml Type: String Parameter Sets: AuthConfigSettings Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,13 +260,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter isn't available in this release. ```yaml Type: ServerIdParameter Parameter Sets: CurrentCertificateParameter, NewCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,6 +278,9 @@ Accept wildcard characters: False ``` ### -ServiceName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ServiceName parameter identifies Microsoft Exchange to other partner applications such as SharePoint 2013. Exchange Setup configures the ServiceName parameter with a specific constant value. You shouldn't change this parameter. Changing the ServiceName parameter can result in server-to-server authentication with partner applications not functioning. @@ -265,7 +289,6 @@ Exchange Setup configures the ServiceName parameter with a specific constant val Type: String Parameter Sets: AuthConfigSettings Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,6 +298,9 @@ Accept wildcard characters: False ``` ### -SkipImmediateCertificateDeployment + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipImmediateCertificateDeployment switch specifies that the certificate shouldn't be used immediately. You don't need to specify a value with this switch. We don't recommend using this switch in a production environment. @@ -283,7 +309,6 @@ We don't recommend using this switch in a production environment. Type: SwitchParameter Parameter Sets: CurrentCertificateParameter, NewCertificateParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +318,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AuthRedirect.md b/exchange/exchange-ps/ExchangePowerShell/Set-AuthRedirect.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-AuthRedirect.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AuthRedirect.md index e39dde30f7..8facbc23d1 100644 --- a/exchange/exchange-ps/exchange/Set-AuthRedirect.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AuthRedirect.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-authredirect applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AuthRedirect -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-authredirect +schema: 2.0.0 +title: Set-AuthRedirect --- # Set-AuthRedirect @@ -51,13 +52,15 @@ This example sets the TargetURL value for all existing OAuth redirection objects ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the existing OAuth redirection object that you want to modify. The object name uses the syntax `AuthRedirect-Bearer-GUID`. The easiest way to find the name of the OAuth redirection object is to run Get-AuthRedirect. ```yaml Type: AuthRedirectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -TargetUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetUrl parameter specifies the FQDN of the Exchange 2013 Client Access server that will process the Oauth request. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AuthServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-AuthServer.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-AuthServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AuthServer.md index 7caef4d3c2..9086e663d8 100644 --- a/exchange/exchange-ps/exchange/Set-AuthServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AuthServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-authserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AuthServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-authserver +schema: 2.0.0 +title: Set-AuthServer --- # Set-AuthServer @@ -94,6 +95,9 @@ This command disables the authorization server ACS. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the authorization server object that you want to modify. You can use any value that uniquely identifies the authorization server. For example: - Name @@ -104,7 +108,6 @@ The Identity parameter specifies the authorization server object that you want t Type: AuthServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -114,6 +117,9 @@ Accept wildcard characters: False ``` ### -ApplicationIdentifier + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available in the April 18, 2025 Hotfix update (HU) for Exchange 2019 CU15 and Exchange 2016 CU23. {{ Fill ApplicationIdentifier Description }} @@ -122,7 +128,6 @@ This parameter is available in the April 18, 2025 Hotfix update (HU) for Exchang Type: String Parameter Sets: AppSecret Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +137,15 @@ Accept wildcard characters: False ``` ### -AuthMetadataUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AuthMetadataUrl parameter specifies the URL of the authorization server. This can be the AuthMetadataUrl of your Exchange Online organization. ```yaml Type: String Parameter Sets: AuthMetadataUrl, NativeClientAuthServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -148,6 +155,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -157,7 +167,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,13 +176,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,6 +194,9 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in Exchange Server 2016 (CU18 or higher) and Exchange Server 2019 (CU7 or higher). The DomainName parameter specifies the tenant domain that's linked with the AuthServer object. This parameter uses the syntax: "tenantname.onmicrosoft.com". @@ -193,7 +207,6 @@ This parameter is used to link Tenant to the corresponding authserver object in Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,6 +216,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the authorization server is enabled. Only enabled authorization servers can issue and accept tokens. Disabling the authorization server prevents any partner applications configured to use the authorization server from getting a token. The Enabled parameter specifies whether the authorization server is enabled. Valid values are: @@ -214,7 +230,6 @@ The Enabled parameter specifies whether the authorization server is enabled. Val Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,6 +239,9 @@ Accept wildcard characters: False ``` ### -IsDefaultAuthorizationEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsDefaultAuthorizationEndpoint parameter specifies whether this server is the default authorization endpoint. Valid values are: $true: The authorization server's URL is advertised to calling partner applications and applications that need to get their OAuth access tokens from the authorization server. @@ -234,7 +252,6 @@ $false: The authorization server's URL is not advertised. The default value is $ Type: Boolean Parameter Sets: NativeClientAuthServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -244,13 +261,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a unique name for the authorization server object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,13 +279,15 @@ Accept wildcard characters: False ``` ### -RefreshAuthMetadata + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RefreshAuthMetadata switch specifies whether Exchange should refresh the auth metadata from the specified URL. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: RefreshAuthMetadata Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,6 +297,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. We don't recommend using this switch in a production environment. @@ -284,7 +308,6 @@ We don't recommend using this switch in a production environment. Type: SwitchParameter Parameter Sets: AuthMetadataUrl, NativeClientAuthServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -294,13 +317,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-AuthenticationPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AuthenticationPolicy.md index 5f9a01b922..b2e266edd3 100644 --- a/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AuthenticationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-authenticationpolicy applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-AuthenticationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-authenticationpolicy +schema: 2.0.0 +title: Set-AuthenticationPolicy --- # Set-AuthenticationPolicy @@ -87,6 +88,9 @@ In Exchange Online, this example blocks legacy Exchange tokens from being issued ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the authentication policy you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -97,7 +101,6 @@ The Identity parameter specifies the authentication policy you want to modify. Y Type: AuthPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthActiveSync + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthActiveSync switch specifies whether to allow Basic authentication with Exchange Active Sync. @@ -118,7 +124,6 @@ The AllowBasicAuthActiveSync switch specifies whether to allow Basic authenticat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthAutodiscover + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthAutodiscover switch specifies whether to allow Basic authentication with Autodiscover. @@ -139,7 +147,6 @@ The AllowBasicAuthAutodiscover switch specifies whether to allow Basic authentic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -149,6 +156,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthImap + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthImap switch specifies whether to allow Basic authentication with IMAP. @@ -160,7 +170,6 @@ The AllowBasicAuthImap switch specifies whether to allow Basic authentication wi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -170,6 +179,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthMapi + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthMapi switch specifies whether to allow Basic authentication with MAPI. @@ -181,7 +193,6 @@ The AllowBasicAuthMapi switch specifies whether to allow Basic authentication wi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthOfflineAddressBook + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthOfflineAddressBook switch specifies whether to allow Basic authentication with Offline Address Books. @@ -202,7 +216,6 @@ The AllowBasicAuthOfflineAddressBook switch specifies whether to allow Basic aut Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthOutlookService + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthOutlookService switch specifies whether to allow Basic authentication with the Outlook service. @@ -223,7 +239,6 @@ The AllowBasicAuthOutlookService switch specifies whether to allow Basic authent Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +248,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthPop + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthPop switch specifies whether to allow Basic authentication with POP. @@ -244,7 +262,6 @@ The AllowBasicAuthPop switch specifies whether to allow Basic authentication wit Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -254,6 +271,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthPowershell + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthPowerShell switch specifies whether to allow Basic authentication with PowerShell. @@ -265,7 +285,6 @@ The AllowBasicAuthPowerShell switch specifies whether to allow Basic authenticat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,6 +294,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthReportingWebServices + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthReporting Web Services switch specifies whether to allow Basic authentication with reporting web services. @@ -286,7 +308,6 @@ The AllowBasicAuthReporting Web Services switch specifies whether to allow Basic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -296,6 +317,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthRpc + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthRpc switch specifies whether to allow Basic authentication with RPC. @@ -307,7 +331,6 @@ The AllowBasicAuthRpc switch specifies whether to allow Basic authentication wit Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -317,6 +340,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthSmtp + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthSmtp switch specifies whether to allow Basic authentication with SMTP. @@ -328,7 +354,6 @@ The AllowBasicAuthSmtp switch specifies whether to allow Basic authentication wi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -338,6 +363,9 @@ Accept wildcard characters: False ``` ### -AllowBasicAuthWebServices + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowBasicAuthWebServices switch specifies whether to allow Basic authentication with Exchange Web Services (EWS). @@ -349,7 +377,6 @@ The AllowBasicAuthWebServices switch specifies whether to allow Basic authentica Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -359,6 +386,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyExchangeTokens + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowLegacyExchangeTokens switch specifies to allow legacy Exchange tokens to be issued to Outlook add-ins. You don't need to specify a value with this switch. @@ -377,7 +407,6 @@ The switch applies to the entire organization. The Identity parameter is require Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -387,6 +416,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthActiveSync + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthActiveSync switch specifies whether to allow only modern authentication with Exchange ActiveSync in Exchange 2019 CU2 or later hybrid environments. @@ -398,7 +430,6 @@ The BlockLegacyAuthActiveSync switch specifies whether to allow only modern auth Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -408,6 +439,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthAutodiscover + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthAutodiscover switch specifies whether to allow only modern authentication with Autodiscover in Exchange 2019 CU2 or later hybrid environments. @@ -419,7 +453,6 @@ The BlockLegacyAuthAutodiscover switch specifies whether to allow only modern au Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -429,6 +462,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthImap + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthImap switch specifies whether to allow only modern authentication with IMAP in Exchange 2019 CU2 or later hybrid environments. @@ -440,7 +476,6 @@ The BlockLegacyAuthImap switch specifies whether to allow only modern authentica Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -450,6 +485,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthMapi + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthMapi switch specifies whether to allow only modern authentication with MAPI in Exchange 2019 CU2 or later hybrid environments. @@ -461,7 +499,6 @@ The BlockLegacyAuthMapi switch specifies whether to allow only modern authentica Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -471,6 +508,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthOfflineAddressBook + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthOfflineAddressBook switch specifies whether to allow only modern authentication with Offline Address Books in Exchange 2019 CU2 or later hybrid environments. @@ -482,7 +522,6 @@ The BlockLegacyAuthOfflineAddressBook switch specifies whether to allow only mod Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -492,6 +531,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthPop + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthPop switch specifies whether to allow only modern authentication with POP in Exchange 2019 CU2 or later hybrid environments. @@ -503,7 +545,6 @@ The BlockLegacyAuthPop switch specifies whether to allow only modern authenticat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -513,6 +554,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthRpc + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthRpc switch specifies whether to allow only modern authentication with RPC in Exchange 2019 CU2 or later hybrid environments. @@ -524,7 +568,6 @@ The BlockLegacyAuthRpc switch specifies whether to allow only modern authenticat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -534,6 +577,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyAuthWebServices + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockLegacyAuthWebServices switch specifies whether to allow only modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU2 or later hybrid environments. @@ -545,7 +591,6 @@ The BlockLegacyAuthWebServices switch specifies whether to allow only modern aut Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -555,6 +600,9 @@ Accept wildcard characters: False ``` ### -BlockLegacyExchangeTokens + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The BlockLegacyExchangeTokens switch specifies to block legacy Exchange tokens being issued to Outlook add-ins. You don't need to specify a value with this switch. @@ -575,7 +623,6 @@ The switch applies to the entire organization. The Identity parameter is require Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -585,6 +632,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthActiveSync + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthActiveSync switch specifies whether to block modern authentication with Exchange ActiveSync in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -593,7 +643,6 @@ The BlockModernAuthActiveSync switch specifies whether to block modern authentic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -603,6 +652,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthAutodiscover + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthAutodiscover switch specifies whether to block modern authentication with Autodiscover in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -611,7 +663,6 @@ The BlockModernAuthAutodiscover switch specifies whether to block modern authent Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -621,6 +672,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthImap + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthImap switch specifies whether to block modern authentication with IMAP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -629,7 +683,6 @@ The BlockModernAuthImap switch specifies whether to block modern authentication Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -639,6 +692,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthMapi + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthMapi switch specifies whether to block modern authentication with MAPI in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -647,7 +703,6 @@ The BlockModernAuthMapi switch specifies whether to block modern authentication Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -657,6 +712,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthOfflineAddressBook + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthOfflineAddressBook switch specifies whether to block modern authentication with Offline Address Books in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -665,7 +723,6 @@ The BlockModernAuthOfflineAddressBook switch specifies whether to block modern a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -675,6 +732,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthPop + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthPop switch specifies whether to block modern authentication with POP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -683,7 +743,6 @@ The BlockModernAuthPop switch specifies whether to block modern authentication w Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -693,6 +752,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthRpc + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthRpc switch specifies whether to block modern authentication with RPC in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -701,7 +763,6 @@ The BlockModernAuthRpc switch specifies whether to block modern authentication w Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -711,6 +772,9 @@ Accept wildcard characters: False ``` ### -BlockModernAuthWebServices + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BlockModernAuthWebServices switch specifies whether to block modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. @@ -719,7 +783,6 @@ The BlockModernAuthWebServices switch specifies whether to block modern authenti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -729,6 +792,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -738,7 +804,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -748,6 +813,9 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill TenantId Description }} @@ -756,7 +824,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -766,13 +833,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelPolicy.md index 08f50e337c..7c95423e8b 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-autosensitivitylabelpolicy applicable: Security & Compliance -title: Set-AutoSensitivityLabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-autosensitivitylabelpolicy +schema: 2.0.0 +title: Set-AutoSensitivityLabelPolicy --- # Set-AutoSensitivityLabelPolicy @@ -103,6 +104,9 @@ This example adds the specified URLs to the SharePoint and OneDrive locations fo ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -113,7 +117,6 @@ The Identity parameter specifies the auto-labeling policy that you want to modif Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -123,6 +126,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter adds email messages to the policy if they're not already included. The valid value for this parameter is All. If the policy doesn't already include email messages (in the output of the Get-AutoSensitivityLabelPolicy cmdlet, the ExchangeLocation property value is blank), you can use this parameter in the following procedures: @@ -143,7 +149,6 @@ You can't specify inclusions and exclusions in the same policy. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -153,6 +158,9 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation + +> Applicable: Security & Compliance + The AddOneDriveLocation parameter specifies the OneDrive sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -161,7 +169,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddOneDriveLocationException parameter specifies the OneDrive sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -179,7 +189,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. SharePoint sites can't be added to the policy until they have been indexed. @@ -199,7 +211,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddSharePointLocationException parameter specifies the SharePoint sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -217,7 +231,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The ApplySensitivityLabel parameter selects which label to be used for the policy. This will override the previous label on the policy. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -243,6 +258,9 @@ Accept wildcard characters: False ``` ### -AutoEnableAfter + +> Applicable: Security & Compliance + The AutoEnableAfter parameter allows you to automatically turn on the policy after a set time period in simulation with no modifications to the policy. You need to explicitly set this parameter after each policy edit to keep or reset the automatic turn on timeline. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -255,7 +273,6 @@ You must use this parameter with the -StartSimulation parameter. Type: System.TimeSpan Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -265,13 +282,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -281,6 +300,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -290,7 +312,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -300,6 +321,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter enables or disables the policy. Valid values are: - $true: The policy is enabled. This is the default value. @@ -309,7 +333,6 @@ The Enabled parameter enables or disables the policy. Valid values are: Type: Boolean Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -319,6 +342,9 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedBy + +> Applicable: Security & Compliance + The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, one of the following statements must be true: @@ -334,7 +360,6 @@ You can't use this parameter with the OneDriveSharedBy parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -344,13 +369,15 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf + +> Applicable: Security & Compliance + {{ Fill ExceptIfOneDriveSharedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -360,13 +387,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -376,13 +405,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -392,6 +423,9 @@ Accept wildcard characters: False ``` ### -ExchangeSender + +> Applicable: Security & Compliance + The ExchangeSender parameter specifies the users whose email is included in the policy. You specify the users by email address. You can specify internal or external email addresses. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -407,7 +441,6 @@ You can't use this parameter with the ExchangeSenderException or ExchangeSenderM Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -417,6 +450,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderException + +> Applicable: Security & Compliance + The ExchangeSenderException parameter specifies the internal users whose email is excluded from the policy. You identify the users by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -432,7 +468,6 @@ You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf p Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -442,6 +477,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf + +> Applicable: Security & Compliance + The ExchangeSenderMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -459,7 +497,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -469,6 +506,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException + +> Applicable: Security & Compliance + The ExchangeSenderMemberOfException parameter specifies the distribution groups or mail-enabled security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -486,7 +526,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -496,6 +535,9 @@ Accept wildcard characters: False ``` ### -ExternalMailRightsManagementOwner + +> Applicable: Security & Compliance + The ExternalMailRightsManagementOwner parameter specifies the email address of a user mailbox that's used to encrypt incoming email messages from external senders using RMS. This parameter works only on Exchange locations, and the policy must apply a label that has an encryption action. @@ -506,7 +548,6 @@ To clear an existing email address, use the value $null. Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -516,6 +557,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -524,7 +568,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -534,13 +577,15 @@ Accept wildcard characters: False ``` ### -Locations + +> Applicable: Security & Compliance + {{ Fill Locations Description }} ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -550,6 +595,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Security & Compliance + The Mode parameter specifies the action and notification level of the auto-labeling policy. Valid values are: - Enable: The policy is enabled for actions and notifications. @@ -562,7 +610,6 @@ Type: PolicyMode Parameter Sets: (All) Aliases: Accepted values: Enable, TestWithNotifications, TestWithoutNotifications, Disable, PendingDeletion -Applicable: Security & Compliance Required: False Position: Named @@ -572,13 +619,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -588,13 +637,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -604,6 +655,9 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy + +> Applicable: Security & Compliance + The OneDriveSharedBy parameter specifies the users to include in the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, one of the following statements must be true: @@ -619,7 +673,6 @@ You can't use this parameter with the ExceptIfOneDriveSharedBy parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -629,13 +682,15 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf + +> Applicable: Security & Compliance + {{ Fill OneDriveSharedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -645,6 +700,9 @@ Accept wildcard characters: False ``` ### -OverwriteLabel + +> Applicable: Security & Compliance + The OverwriteLabel parameter specifies whether to overwrite a manual label. Valid values are: - $true: Overwrite the manual label. @@ -656,7 +714,6 @@ This parameter works only on Exchange locations. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -666,6 +723,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. @@ -674,7 +734,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -684,13 +743,15 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -700,6 +761,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and policies can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing policies. For example, if there are 5 existing policies: @@ -714,7 +778,6 @@ If you modify the priority value of a policy, the position of the policy in the Type: System.Int32 Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -724,6 +787,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter removes email messages from the policy if they're already included. The valid value for this parameter is All. If the policy already includes email messages (in the output of the Get-AutoSensitivityLabelPolicy cmdlet, the ExchangeLocation property value is All), you can use `-RemoveExchangeLocation All` to prevent the policy from applying to email messages. @@ -734,7 +800,6 @@ You can't use this parameter if email (the value Exchange) is used by any of the Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -744,6 +809,9 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation + +> Applicable: Security & Compliance + The RemoveOneDriveLocation parameter specifies the OneDrive sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -752,7 +820,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + This RemoveOneDriveLocationException parameter specifies the OneDrive sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -770,7 +840,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -788,7 +860,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The RemoveSharePointLocationException parameter specifies the SharePoint sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -806,7 +880,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The RetryDistribution switch redistributes the policy to all OneDrive and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -826,7 +902,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistributionParameterSet Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -836,13 +911,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -852,13 +929,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -868,6 +947,9 @@ Accept wildcard characters: False ``` ### -SpoAipIntegrationEnabled + +> Applicable: Security & Compliance + The SpoAipIntegrationEnabled parameter enables or disables built-in labeling for supported Office files in SharePoint and OneDrive. Valid values are: - $true: Users can apply your sensitivity labels in Office for the web. Users see the Sensitivity button on the ribbon so they can apply labels, and they see the name of any applied label on the status bar. @@ -877,7 +959,6 @@ The SpoAipIntegrationEnabled parameter enables or disables built-in labeling for Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -887,6 +968,9 @@ Accept wildcard characters: False ``` ### -StartSimulation + +> Applicable: Security & Compliance + Use the StartSimulation parameter to restart the simulation for updated results. Valid values are: - $true: Restart the simulation for updated results. **Any edits to an auto-labeling policy require restarting the simulation by using this value.** @@ -896,7 +980,6 @@ Use the StartSimulation parameter to restart the simulation for updated results. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -906,13 +989,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelRule.md index f477c1b30d..a41e2735f2 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AutoSensitivityLabelRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-autosensitivitylabelrule applicable: Security & Compliance -title: Set-AutoSensitivityLabelRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-autosensitivitylabelrule +schema: 2.0.0 +title: Set-AutoSensitivityLabelRule --- # Set-AutoSensitivityLabelRule @@ -98,6 +99,9 @@ This example changes the rule property "Comment" with the rule name "SocialSecur ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the auto-labeling policy rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -108,7 +112,6 @@ The Identity parameter specifies the auto-labeling policy rule that you want to Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -AccessScope + +> Applicable: Security & Compliance + The AccessScope parameter specifies a condition for the auto-labeling policy rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule is applied to content that's accessible inside the organization. @@ -129,7 +135,6 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Required: False Position: Named @@ -139,13 +144,15 @@ Accept wildcard characters: False ``` ### -ActivationDate + +> Applicable: Security & Compliance + {{ Fill ActivationDate Description }} ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -155,6 +162,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The AnyOfRecipientAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -169,7 +179,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -179,6 +188,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -189,7 +201,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -199,13 +210,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -215,6 +228,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -224,7 +240,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -234,6 +249,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"; minCount="1"; minConfidence="85"})`. @@ -246,7 +264,6 @@ To use groups: `@(@{operator="And"; groups=@(@{name="Default"; operator="Or"; se Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -256,13 +273,15 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ContentExtensionMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for words in file name extensions. You can specify multiple words separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -272,6 +291,9 @@ Accept wildcard characters: False ``` ### -ContentPropertyContainsWords + +> Applicable: Security & Compliance + The ContentPropertyContainsWords parameter specifies a condition for the auto-labeling policy rule that's based on a property match in content. The rule is applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -280,7 +302,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -290,13 +311,15 @@ Accept wildcard characters: False ``` ### -DefaultSpoDocLibraryHasLabel + +> Applicable: Security & Compliance + {{ Fill DefaultSpoDocLibraryHasLabel Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -306,6 +329,9 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the case hold rule is enabled or disabled. Valid values are: - $true: The rule is disabled. @@ -315,7 +341,6 @@ The Disabled parameter specifies whether the case hold rule is enabled or disabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -325,13 +350,15 @@ Accept wildcard characters: False ``` ### -DocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill DocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -341,6 +368,9 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected + +> Applicable: Security & Compliance + The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -350,7 +380,6 @@ The DocumentIsPasswordProtected parameter specifies a condition for the auto-lab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -360,6 +389,9 @@ Accept wildcard characters: False ``` ### -DocumentIsUnsupported + +> Applicable: Security & Compliance + The DocumentIsUnsupported parameter specifies a condition for the auto-labeling policy rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -369,7 +401,6 @@ The DocumentIsUnsupported parameter specifies a condition for the auto-labeling Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -379,6 +410,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesWords + +> Applicable: Security & Compliance + The DocumentNameMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for whole word matches in the name of message attachments. You can specify multiple words separated by commas. - Single word: `"no_reply"` @@ -390,7 +424,6 @@ The maximum individual word length is 128 characters. The maximum number of word Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -400,6 +433,9 @@ Accept wildcard characters: False ``` ### -DocumentSizeOver + +> Applicable: Security & Compliance + The DocumentSizeOver parameter specifies a condition for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -418,7 +454,6 @@ You can use this condition in auto-labeling policy rules that are scoped only to Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -428,6 +463,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAccessScope + +> Applicable: Security & Compliance + The ExceptIfAccessScopeAccessScope parameter specifies an exception for the auto-labeling policy rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule isn't applied to content that's accessible inside the organization. @@ -439,7 +477,6 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Required: False Position: Named @@ -449,6 +486,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. - Single word: `"no_reply"` @@ -463,7 +503,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -473,6 +512,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -483,7 +525,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -493,6 +534,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the auto-labeling policy rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -501,7 +545,6 @@ This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minC Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -511,13 +554,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words in file name extensions. You can specify multiple words separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -527,6 +572,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentPropertyContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentPropertyContainsWords parameter specifies an exception for the auto-labeling policy rule that's based on a property match in content. The rule is not applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -535,7 +583,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -545,13 +592,15 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill ExceptIfDocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -561,6 +610,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected + +> Applicable: Security & Compliance + The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -570,7 +622,6 @@ The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -580,6 +631,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsUnsupported + +> Applicable: Security & Compliance + The ExceptIfDocumentIsUnsupported parameter specifies an exception for the auto-labeling policy rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -589,7 +643,6 @@ The ExceptIfDocumentIsUnsupported parameter specifies an exception for the auto- Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -599,6 +652,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesWords + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -611,7 +667,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -621,6 +676,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentSizeOver + +> Applicable: Security & Compliance + The ExceptIfDocumentSizeOver parameter specifies an exception for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -639,7 +697,6 @@ You can use this exception in auto-labeling policy rules that are scoped only to Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -649,6 +706,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + The ExceptIfFrom parameter specifies an exception for the auto-labeling policy rule that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -662,7 +722,6 @@ The ExceptIfFrom parameter specifies an exception for the auto-labeling policy r Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -672,6 +731,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfFromAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -686,7 +748,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -696,6 +757,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -706,7 +770,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -716,6 +779,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Security & Compliance + The ExceptIfFromMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent by group members. You identify the group members by their email addresses. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -724,7 +790,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -734,6 +799,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -742,7 +810,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -752,6 +819,9 @@ Accept wildcard characters: False ``` ### -ExceptIfProcessingLimitExceeded + +> Applicable: Security & Compliance + The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule that looks for files where scanning couldn't complete. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -761,7 +831,6 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the aut Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -771,13 +840,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -787,6 +858,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + The ExceptIfSenderDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -795,7 +869,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -805,6 +878,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIPRanges + +> Applicable: Security & Compliance + The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -817,7 +893,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -827,6 +902,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + The ExceptIfSentTo parameter specifies an exception for the auto-labeling policy rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -844,7 +922,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -854,6 +931,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Security & Compliance + The ExceptIfSentToMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -862,7 +942,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -872,6 +951,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -882,7 +964,6 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -892,13 +973,15 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -908,13 +991,15 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -924,6 +1009,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Security & Compliance + The FromAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -938,7 +1026,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -948,6 +1035,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Security & Compliance + The FromAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -958,7 +1048,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -968,13 +1057,15 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -984,6 +1075,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -992,7 +1086,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1002,13 +1095,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1018,6 +1113,9 @@ Accept wildcard characters: False ``` ### -ProcessingLimitExceeded + +> Applicable: Security & Compliance + The ProcessingLimitExceeded parameter specifies a condition for the auto-labeling policy rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -1027,7 +1125,6 @@ The ProcessingLimitExceeded parameter specifies a condition for the auto-labelin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1037,13 +1134,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Security & Compliance + The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1053,6 +1152,9 @@ Accept wildcard characters: False ``` ### -ReportSeverityLevel + +> Applicable: Security & Compliance + The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: - None: You can't select this value if the rule has no actions configured. @@ -1065,7 +1167,6 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Required: False Position: Named @@ -1075,6 +1176,9 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Security & Compliance + The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - Ignore @@ -1086,7 +1190,6 @@ Type: PolicyRuleErrorAction Parameter Sets: (All) Aliases: Accepted values: Ignore, RetryThenBlock -Applicable: Security & Compliance Required: False Position: Named @@ -1096,6 +1199,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Security & Compliance + The SenderDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -1104,7 +1210,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1114,6 +1219,9 @@ Accept wildcard characters: False ``` ### -SenderIPRanges + +> Applicable: Security & Compliance + The SenderIpRanges parameter specifies a condition for the auto-sensitivity policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -1126,7 +1234,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1136,6 +1243,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + The SentTo parameter specifies a condition for the auto-sensitivity policy rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1153,7 +1263,6 @@ You can use this condition in auto-sensitivity policies that are scoped only to Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1163,6 +1272,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Security & Compliance + The SentToMemberOf parameter specifies a condition for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this condition in auto-labeling policies that are scoped only to Exchange. @@ -1171,7 +1283,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1181,13 +1292,15 @@ Accept wildcard characters: False ``` ### -SourceType + +> Applicable: Security & Compliance + {{ Fill SourceType Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1197,6 +1310,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Security & Compliance + The SubjectMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. @@ -1207,7 +1323,6 @@ You can use this condition in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1217,13 +1332,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -1233,6 +1350,9 @@ Accept wildcard characters: False ``` ### -Workload + +> Applicable: Security & Compliance + The Workload parameter specifies the workload. Valid values are: - Exchange @@ -1244,7 +1364,6 @@ Type: Workload Parameter Sets: (All) Aliases: Accepted values: Exchange, SharePoint, OneDriveForBusiness -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-AutodiscoverVirtualDirectory.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AutodiscoverVirtualDirectory.md index 21d6376337..d079983959 100644 --- a/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AutodiscoverVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-autodiscovervirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-AutodiscoverVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-autodiscovervirtualdirectory +schema: 2.0.0 +title: Set-AutodiscoverVirtualDirectory --- # Set-AutodiscoverVirtualDirectory @@ -67,6 +68,9 @@ This example sets Integrated Windows authentication for the Autodiscover virtual ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Autodiscover virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -79,7 +83,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: - $true: Basic authentication is enabled. This is the default value. @@ -98,7 +104,6 @@ The BasicAuthentication parameter specifies whether Basic authentication is enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -117,7 +125,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. @@ -136,7 +146,6 @@ The DigestAuthentication parameter specifies whether Digest authentication is en Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -174,7 +188,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +197,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -193,7 +209,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,6 +218,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -215,7 +233,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +242,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ExternalUrl parameter specifies the URL used to connect to the virtual directory from outside the network firewall. @@ -233,7 +253,6 @@ The ExternalUrl parameter specifies the URL used to connect to the virtual direc Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The InternalUrl parameter specifies the URL used to connect to the virtual directory from inside the network firewall. @@ -251,7 +273,6 @@ The InternalUrl parameter specifies the URL used to connect to the virtual direc Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -261,6 +282,9 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OAuthAuthentication parameter specifies whether OAuth authentication is enabled on the virtual directory. Valid values are: - $true: OAuth authentication is enabled. This is the default value. @@ -270,7 +294,6 @@ The OAuthAuthentication parameter specifies whether OAuth authentication is enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +303,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,6 +321,9 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: - $true: Integrated Windows authentication is enabled. This is the default value. @@ -305,7 +333,6 @@ The WindowsAuthentication parameter specifies whether Integrated Windows authent Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -315,6 +342,9 @@ Accept wildcard characters: False ``` ### -WSSecurityAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are: - $true: WS-Security authentication is enabled. This is the default value. @@ -324,7 +354,6 @@ The WSSecurityAuthentication parameter specifies whether WS-Security (Web Servic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-AvailabilityConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityConfig.md index 7fc266524e..2364adde75 100644 --- a/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-availabilityconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-AvailabilityConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-availabilityconfig +schema: 2.0.0 +title: Set-AvailabilityConfig --- # Set-AvailabilityConfig @@ -66,6 +67,9 @@ In Exchange Online, this example allows free/busy sharing only with the specifie ## PARAMETERS ### -AllowedTenantIds + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowedTenantIds parameter specifies the tenant ID values of Microsoft 365 organization that you want to share free/busy information with (for example, d6b0a40e-029b-43f2-9852-f3724f68ead9). You can specify multiple values separated by commas. A maximum of 25 values are allowed. @@ -78,7 +82,6 @@ To add or remove tenant IDs without affecting other existing values, use the fol Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -115,7 +123,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -OrgWideAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The OrgWideAccount parameter specifies who has permission to issue proxy Availability service requests on an organization-wide basis. You can specify the following types of users or groups (security principals) for this parameter: @@ -150,7 +160,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -PerUserAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PerUserAccount parameter specifies an account or security group that has permission to issue proxy Availability service requests on a per-user basis. @@ -181,7 +193,6 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +202,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md b/exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityReportOutage.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md rename to exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityReportOutage.md index 051ad1654f..7ff6054fec 100644 --- a/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-AvailabilityReportOutage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-availabilityreportoutage applicable: Exchange Server 2010 -title: Set-AvailabilityReportOutage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-availabilityreportoutage +schema: 2.0.0 +title: Set-AvailabilityReportOutage --- # Set-AvailabilityReportOutage @@ -59,13 +60,15 @@ This example overrides the specified outage with a new downtime value of 40 minu ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the outage to add to the outage reporting. ```yaml Type: AvailabilityReportOutageIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010 + The Comment parameter describes the outage that was inserted. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -ReportDate + +> Applicable: Exchange Server 2010 + The ReportDate parameter specifies the date to query for the outage report. ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -ResetToOriginal + +> Applicable: Exchange Server 2010 + The ResetToOriginal switch resets the previously selected outage value to the default value. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ResetToOriginal Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -123,6 +132,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -132,7 +144,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -DowntimeMinutes + +> Applicable: Exchange Server 2010 + The DowntimeMinutes parameter specifies the number of minutes of downtime to insert into the outage report. ```yaml Type: Double Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -158,6 +171,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -166,7 +182,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -176,13 +191,15 @@ Accept wildcard characters: False ``` ### -ReportingDatabase + +> Applicable: Exchange Server 2010 + The ReportingDatabase parameter specifies the name of the database on the reporting server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -192,13 +209,15 @@ Accept wildcard characters: False ``` ### -ReportingServer + +> Applicable: Exchange Server 2010 + The ReportingServer parameter specifies the name of the reporting database server to connect to. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -208,13 +227,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CASMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-CASMailbox.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-CASMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CASMailbox.md index 6ff7e5c704..9a16d536b4 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CASMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-casmailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-CASMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-casmailbox +schema: 2.0.0 +title: Set-CASMailbox --- # Set-CASMailbox @@ -108,6 +109,9 @@ This example sets the display name and disables Outlook Anywhere access for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to configure. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +129,6 @@ The Identity parameter specifies the mailbox that you want to configure. You can Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -135,6 +138,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncAllowedDeviceIDs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + TheActiveSyncAllowedDeviceIDs parameter specifies one or more Exchange ActiveSync device IDs that are allowed to synchronize with the mailbox. A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have Exchange ActiveSync partnerships with the mailbox. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -147,7 +153,6 @@ To clear the list of device IDs, use the value $null for this parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -157,6 +162,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncBlockedDeviceIDs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActiveSyncBlockedDeviceIDs parameter specifies one or more Exchange ActiveSync device IDs that aren't allowed to synchronize with the mailbox. A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have Exchange ActiveSync partnerships with the mailbox. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -169,7 +177,6 @@ To clear the list of device IDs, use the value $null for this parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -179,6 +186,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncDebugLogging + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActiveSyncDebugLogging parameter enables or disables Exchange ActiveSync debug logging for the mailbox. Valid values are: - $true: ActiveSync debug logging is enabled for 48 hours in Exchange Online, and 72 hours in Exchange Server. After the time period expires, the value reverts to $false. @@ -188,7 +198,6 @@ The ActiveSyncDebugLogging parameter enables or disables Exchange ActiveSync deb Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -198,6 +207,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActiveSyncEnabled parameter enables or disables access to the mailbox using Exchange ActiveSync. Valid values are: - $true: Access to the mailbox using ActiveSync is enabled. This is the default value. @@ -209,7 +221,6 @@ For more information, see [Enable or disable Exchange ActiveSync for a mailbox i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +230,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActiveSyncMailboxPolicy parameter specifies the Exchange ActiveSync mailbox policy for the mailbox. You can use any value that uniquely identifies the Exchange ActiveSync mailbox policy. For example: - Name @@ -231,7 +245,6 @@ The name of the default Exchange ActiveSync mailbox policy is Default. However, Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -241,6 +254,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncSuppressReadReceipt + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActiveSyncSuppressReadReceipt parameter controls the behavior of read receipts for Exchange ActiveSync clients that access the mailbox. Valid values are: - $true: Read receipts are not automatically returned when the user opens a message sent with a read receipt request. @@ -250,7 +266,6 @@ The ActiveSyncSuppressReadReceipt parameter controls the behavior of read receip Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -260,6 +275,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -269,7 +287,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -279,6 +296,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -287,7 +307,6 @@ The DisplayName parameter specifies the display name of the mailbox. The display Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,6 +316,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -305,7 +327,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -315,6 +336,9 @@ Accept wildcard characters: False ``` ### -ECPEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ECPEnabled parameter enables or disables access the Exchange admin center (EAC) or the Exchange Control Panel (ECP) for the specified user. Valid values are: @@ -326,7 +350,6 @@ The ECPEnabled parameter enables or disables access the Exchange admin center (E Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -336,6 +359,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). @@ -363,7 +389,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -373,6 +398,9 @@ Accept wildcard characters: False ``` ### -EwsAllowEntourage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsAllowEntourage parameter enables or disables access to the mailbox by Microsoft Entourage clients that use Exchange Web Services (for example, Entourage 2008 for Mac, Web Services Edition). - $true: Access to the mailbox using Microsoft Entourage is enabled. This is the default value. @@ -382,7 +410,6 @@ The EwsAllowEntourage parameter enables or disables access to the mailbox by Mic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -392,6 +419,9 @@ Accept wildcard characters: False ``` ### -EwsAllowList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsAllowList parameter specifies the Exchange Web Services applications (user agent strings) that are allowed to access the mailbox. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -404,7 +434,6 @@ This parameter is meaningful only when the EwsEnabled parameter is set to $true, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -414,6 +443,9 @@ Accept wildcard characters: False ``` ### -EwsAllowMacOutlook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsAllowMacOutlook parameter enables or disables access to the mailbox by Outlook for Mac clients that use Exchange Web Services (for example, Outlook for Mac 2011 or later). Valid values are: - $true: Outlook for Mac clients that use EWS are allowed to access the mailbox. This is the default value. @@ -425,7 +457,6 @@ In the cloud-based service, access for Outlook for Mac clients that use Microsof Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -435,6 +466,9 @@ Accept wildcard characters: False ``` ### -EwsAllowOutlook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsAllowOutlook parameter enables or disables access to the mailbox by Outlook clients that use Exchange Web Services. Outlook uses Exchange Web Services for free/busy, out-of-office settings, and calendar sharing. Valid values are: - $true: Access to the mailbox using EWS in Outlook clients is enabled. @@ -444,7 +478,6 @@ The EwsAllowOutlook parameter enables or disables access to the mailbox by Outlo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -454,6 +487,9 @@ Accept wildcard characters: False ``` ### -EwsApplicationAccessPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsApplicationAccessPolicy parameter controls access to the mailbox using Exchange Web Services applications. Valid values for this parameter are: @@ -467,7 +503,6 @@ This parameter doesn't affect access to the mailbox using Entourage, Outlook for Type: EwsApplicationAccessPolicy Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -477,6 +512,9 @@ Accept wildcard characters: False ``` ### -EwsBlockList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsBlockList parameter specifies the Exchange Web Services applications (user agent strings) that aren't allowed to access the mailbox using Exchange Web Services. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -489,7 +527,6 @@ This parameter is meaningful only when the EwsEnabled parameter is set to $true, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -499,6 +536,9 @@ Accept wildcard characters: False ``` ### -EwsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsEnabled parameter enables or disables access to the mailbox using Exchange Web Services clients. Valid values are: - $true: Access to the mailbox using EWS is enabled. This is the default value. @@ -510,7 +550,6 @@ The value of this parameter is meaningful only if the EwsEnabled parameter on th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -520,6 +559,9 @@ Accept wildcard characters: False ``` ### -HasActiveSyncDevicePartnership + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The HasActiveSyncDevicePartnership parameter specifies whether the mailbox has an Exchange ActiveSync device partnership established. Valid values are: @@ -531,7 +573,6 @@ The HasActiveSyncDevicePartnership parameter specifies whether the mailbox has a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -541,6 +582,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -554,7 +598,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -564,6 +607,9 @@ Accept wildcard characters: False ``` ### -ImapEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ImapEnabled parameter enables or disables access to the mailbox using IMAP4 clients. Valid values are: - $true: Access to the mailbox using IMAP4 is enabled. This is the default value. @@ -575,7 +621,6 @@ For more information, see [Enable or Disable POP3 or IMAP4 access for a user in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -585,6 +630,9 @@ Accept wildcard characters: False ``` ### -ImapEnableExactRFC822Size + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ImapEnableExactRFC822Size parameter specifies how message sizes are presented to IMAP4 clients that access the mailbox. Valid values are: @@ -598,7 +646,6 @@ We don't recommend changing this value unless you determine that the default set Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -608,6 +655,9 @@ Accept wildcard characters: False ``` ### -ImapForceICalForCalendarRetrievalOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ImapForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to IMAP4 clients that access the mailbox. Valid values are: - $true: All meeting requests are in the iCal format. @@ -619,7 +669,6 @@ To change the value of this parameter, you also need to set the value of the Ima Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -629,6 +678,9 @@ Accept wildcard characters: False ``` ### -ImapMessagesRetrievalMimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ImapMessagesRetrievalMimeFormat parameter specifies the message format for IMAP4 clients that access the mailbox. You can use an integer or a text value. Valid values are: - 0: TextOnly @@ -645,7 +697,6 @@ To change the value of this parameter, you also need to set the value of the Ima Type: MimeTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -655,6 +706,9 @@ Accept wildcard characters: False ``` ### -ImapSuppressReadReceipt + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ImapSuppressReadReceipt parameter controls the behavior of read receipts for IMAP4 clients that access the mailbox. Valid values are: - $true: The user receives a read receipt when the recipient opens the message. @@ -666,7 +720,6 @@ To change the value of this parameter, you also need to set the value of the Ima Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -676,6 +729,9 @@ Accept wildcard characters: False ``` ### -ImapUseProtocolDefaults + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ImapUseProtocolDefaults parameter specifies whether to use the IMAP4 protocol defaults for the mailbox. Valid values are: - $true: Use the protocol defaults for IMAP4 access to the mailbox. This is the default value. @@ -692,7 +748,6 @@ You need to set this parameter to $false when you use any of the following IMAP4 Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -702,6 +757,9 @@ Accept wildcard characters: False ``` ### -IsOptimizedForAccessibility + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The IsOptimizedForAccessibility parameter specifies whether the mailbox is configured to use the light version of Outlook on the web. Valid values are: @@ -713,7 +771,6 @@ The IsOptimizedForAccessibility parameter specifies whether the mailbox is confi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -723,6 +780,9 @@ Accept wildcard characters: False ``` ### -MacOutlookEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MacOutlookEnabled parameter enables or disables access to the mailbox using Outlook for Mac clients that use Microsoft Sync technology. Valid values are: @@ -736,7 +796,6 @@ Access for older Outlook for Mac clients that use Exchange Web Services is contr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -746,6 +805,9 @@ Accept wildcard characters: False ``` ### -MAPIBlockOutlookNonCachedMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MAPIBlockOutlookNonCachedMode parameter controls access to the mailbox using Outlook in online or offline mode. Valid values are: @@ -757,7 +819,6 @@ The MAPIBlockOutlookNonCachedMode parameter controls access to the mailbox using Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -767,6 +828,9 @@ Accept wildcard characters: False ``` ### -MAPIBlockOutlookExternalConnectivity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MAPIBlockOutlookExternalConnectivity parameter enables or disables external access to the mailbox in Outlook by removing the external URLs from the Autodiscover response. This setting affects Outlook Anywhere, MAPI over HTTP, and Exchange Web Services (EWS). Valid values are: @@ -780,7 +844,6 @@ The MAPIBlockOutlookExternalConnectivity parameter enables or disables external Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -790,6 +853,9 @@ Accept wildcard characters: False ``` ### -MAPIBlockOutlookRpcHttp + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MAPIBlockOutlookRpcHttp parameter enables or disables access to the mailbox in Outlook using Outlook Anywhere. Valid values are: @@ -801,7 +867,6 @@ The MAPIBlockOutlookRpcHttp parameter enables or disables access to the mailbox Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -811,6 +876,9 @@ Accept wildcard characters: False ``` ### -MAPIBlockOutlookVersions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MAPIBlockOutlookVersions parameter blocks access to the mailbox for specific versions of Outlook. @@ -823,7 +891,6 @@ The default value is blank. To reset this parameter, use the value $null. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -833,6 +900,9 @@ Accept wildcard characters: False ``` ### -MAPIEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MAPIEnabled parameter enables or disables access to the mailbox using MAPI clients (for example, Outlook). Valid values are: - $true: Access to the mailbox using MAPI clients is enabled. This is the default value. @@ -844,7 +914,6 @@ For more information, see[Enable or disable MAPI for a mailbox in Exchange Onlin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -854,6 +923,9 @@ Accept wildcard characters: False ``` ### -MapiHttpEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MapiHttpEnabled parameter enables or disables access to the mailbox in Outlook using MAPI over HTTP. Valid values are: @@ -866,7 +938,6 @@ The MapiHttpEnabled parameter enables or disables access to the mailbox in Outlo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -876,6 +947,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -884,7 +958,6 @@ The Name parameter specifies the unique name of the mailbox. The maximum length Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -894,6 +967,9 @@ Accept wildcard characters: False ``` ### -OneWinNativeOutlookEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OneWinNativeOutlookEnabled parameter enables or disables access to the mailbox using the new Outlook for Windows. @@ -906,7 +982,6 @@ Valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -916,6 +991,9 @@ Accept wildcard characters: False ``` ### -OutlookMobileEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookMobileEnabled parameter enables or disables access to the mailbox using Outlook for iOS and Android. Valid values are: @@ -927,7 +1005,6 @@ The OutlookMobileEnabled parameter enables or disables access to the mailbox usi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -937,6 +1014,9 @@ Accept wildcard characters: False ``` ### -OWAEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAEnabled parameter enables or disables access to the mailbox using Outlook on the web (formerly known as Outlook Web App or OWA) and the new Outlook for Windows. Valid values are: - $true: Access to the mailbox using Outlook on the web is enabled. This is the default value. @@ -948,7 +1028,6 @@ For more information, see [Enable or disable Outlook on the web for a mailbox in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -958,6 +1037,9 @@ Accept wildcard characters: False ``` ### -OWAforDevicesEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAforDevicesEnabled parameter enables or disables access to the mailbox using the older Outlook Web App (OWA) app on iOS and Android devices. Valid values are: - $true: Access to the mailbox using OWA for Devices is enabled. This is the default value. @@ -967,7 +1049,6 @@ The OWAforDevicesEnabled parameter enables or disables access to the mailbox usi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -977,6 +1058,9 @@ Accept wildcard characters: False ``` ### -OwaMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OwaMailboxPolicy parameter specifies the Outlook on the web mailbox policy for the mailbox. You can use any value that uniquely identifies the Outlook on the web mailbox policy. For example: - Name @@ -989,7 +1073,6 @@ The name of the default Outlook on the web mailbox policy is Default. Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -999,6 +1082,9 @@ Accept wildcard characters: False ``` ### -PopEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PopEnabled parameter enables or disables access to the mailbox using POP3 clients. Valid values are: - $true: Access to the mailbox using POP3 clients is enabled. This is the default value. @@ -1010,7 +1096,6 @@ For more information, see [Enable or Disable POP3 or IMAP4 access for a user in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1020,6 +1105,9 @@ Accept wildcard characters: False ``` ### -PopEnableExactRFC822Size + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PopEnableExactRFC822Size parameter specifies how message sizes are presented to POP3 clients that access the mailbox. Valid values are: @@ -1033,7 +1121,6 @@ We don't recommend changing this value unless you determine that the default set Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1043,6 +1130,9 @@ Accept wildcard characters: False ``` ### -PopForceICalForCalendarRetrievalOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PopForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to POP3 clients that access the mailbox. Valid values are: - $true: All meeting requests are in the iCal format. @@ -1054,7 +1144,6 @@ To change the value of this parameter, you also need to set the value of the Pop Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1064,6 +1153,9 @@ Accept wildcard characters: False ``` ### -PopMessagesRetrievalMimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PopMessagesRetrievalMimeFormat parameter specifies the message format for POP3 clients that access the mailbox. You can use an integer or a text value. Valid values are: - 0: TextOnly @@ -1080,7 +1172,6 @@ To change the value of this parameter, you also need to set the value of the Pop Type: MimeTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1090,6 +1181,9 @@ Accept wildcard characters: False ``` ### -PopSuppressReadReceipt + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PopSuppressReadReceipt parameter controls the behavior of read receipts for POP3 clients that access the mailbox. Valid values are: - $true: The user receives a read receipt when the recipient opens the message. @@ -1101,7 +1195,6 @@ To change the value of this parameter, you also need to set the value of the Pop Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1111,6 +1204,9 @@ Accept wildcard characters: False ``` ### -PopUseProtocolDefaults + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PopUseProtocolDefaults parameter specifies whether to use the POP3 protocol defaults for the mailbox. Valid values are: - $true: Use the protocol defaults for POP3 access to the mailbox. This is the default value. @@ -1127,7 +1223,6 @@ You need to set this parameter to $false when you use any of following parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1137,6 +1232,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. @@ -1145,7 +1243,6 @@ The PrimarySmtpAddress parameter specifies the primary return email address that Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1155,6 +1252,9 @@ Accept wildcard characters: False ``` ### -PublicFolderClientAccess + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: - $true: The user can access public folders in Outlook if the value of the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is $true (the default value is $false). @@ -1164,7 +1264,6 @@ The PublicFolderClientAccess parameter enables or disables access to public fold Type: Boolean Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1174,6 +1273,9 @@ Accept wildcard characters: False ``` ### -ResetAutoBlockedDevices + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ResetAutoBlockedDevices switch resets the status of blocked mobile devices that have exceeded the limits defined by the Set-ActiveSyncDeviceAutoblockThreshold cmdlet. You don't need to specify a value with this switch. @@ -1182,7 +1284,6 @@ The ResetAutoBlockedDevices switch resets the status of blocked mobile devices t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1192,6 +1293,9 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. @@ -1200,7 +1304,6 @@ The SamAccountName parameter (also known as the pre-Windows 2000 user account or Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1210,6 +1313,9 @@ Accept wildcard characters: False ``` ### -ShowGalAsDefaultView + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowGalAsDefaultView parameter specifies whether the global address list (GAL) is the default recipient picker for messages. Valid values are: - $true: Use the GAL as the primary address picker. This is the default value. @@ -1219,7 +1325,6 @@ The ShowGalAsDefaultView parameter specifies whether the global address list (GA Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1229,6 +1334,9 @@ Accept wildcard characters: False ``` ### -SmtpClientAuthenticationDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SmtpClientAuthenticationDisabled parameter specifies whether to disable authenticated SMTP (SMTP AUTH) for the mailbox. Examples of clients and services that require authenticated SMTP to send email messages include: @@ -1250,7 +1358,6 @@ To selectively enable authenticated SMTP for specific mailboxes only: disable au Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1260,6 +1367,9 @@ Accept wildcard characters: False ``` ### -UniversalOutlookEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The UniversalOutlookEnabled parameter enables or disables access to the mailbox using Windows 10 Mail and Calendar. Valid values are: @@ -1271,7 +1381,6 @@ The UniversalOutlookEnabled parameter enables or disables access to the mailbox Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1281,13 +1390,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md b/exchange/exchange-ps/ExchangePowerShell/Set-CASMailboxPlan.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-CASMailboxPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CASMailboxPlan.md index 5901e16225..d755e6ec94 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CASMailboxPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-casmailboxplan applicable: Exchange Online, Exchange Online Protection -title: Set-CASMailboxPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-casmailboxplan +schema: 2.0.0 +title: Set-CASMailboxPlan --- # Set-CASMailboxPlan @@ -52,6 +53,9 @@ This example disables Exchange ActiveSync and POP3 access to mailboxes in the CA ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the CAS mailbox plan that you want to modify. You can use any value that uniquely identifies the CAS mailbox plan. For example: - Name @@ -64,7 +68,6 @@ The display name and name of the CAS mailbox plan is the same as the correspondi Type: MailboxPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ActiveSyncEnabled parameter enables or disables access to the mailbox by using Exchange Active Sync (EAS). Valid values are: - $true: ActiveSync access to the mailbox is enabled. This is the default value. @@ -83,7 +89,6 @@ The ActiveSyncEnabled parameter enables or disables access to the mailbox by usi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -102,7 +110,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -ECPEnabled + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill ECPEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -EwsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill EwsEnabled Description }} ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +155,9 @@ Accept wildcard characters: False ``` ### -ImapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ImapEnabled parameter enables or disables access to the mailbox by using IMAP4 clients. Valid values are: - $true: IMAP4 access to the mailbox is enabled. This is default value for all CAS mailbox plans except ExchangeOnlineDeskless. @@ -153,7 +167,6 @@ The ImapEnabled parameter enables or disables access to the mailbox by using IMA Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -MAPIEnabled + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill MAPIEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -OWAEnabled + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill OWAEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -195,6 +212,9 @@ Accept wildcard characters: False ``` ### -OwaMailboxPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The OwaMailboxPolicy parameter specifies the Outlook on the web (formerly known as Outlook Web App) mailbox policy for the mailbox. You can use any value that uniquely identifies the policy. For example: - Name @@ -209,7 +229,6 @@ You can use the Get-OwaMailboxPolicy cmdlet to view the available Outlook on the Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -PopEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The PopEnabled parameter enables or disables access to the mailbox by using POP3 clients. Valid values are: - $true: POP3 access to the mailbox is enabled. This is the default value. @@ -228,7 +250,6 @@ The PopEnabled parameter enables or disables access to the mailbox by using POP3 Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -238,13 +259,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CalendarNotification.md b/exchange/exchange-ps/ExchangePowerShell/Set-CalendarNotification.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-CalendarNotification.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CalendarNotification.md index 29fe0d712f..21a621c826 100644 --- a/exchange/exchange-ps/exchange/Set-CalendarNotification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CalendarNotification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-calendarnotification applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-CalendarNotification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-calendarnotification +schema: 2.0.0 +title: Set-CalendarNotification --- # Set-CalendarNotification @@ -59,6 +60,9 @@ This example configures the calendar in Tony's mailbox to send the following tex ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -76,7 +80,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -CalendarUpdateNotification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarUpdateNotification parameter specifies whether calendar update text message notifications are sent to the user's mobile device. Valid values are: - $true: Calendar update text message notifications are enabled. @@ -95,7 +101,6 @@ The CalendarUpdateNotification parameter specifies whether calendar update text Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -CalendarUpdateSendDuringWorkHour + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarUpdateSendDuringWorkHour parameter specifies whether calendar update text notifications are sent to the user's mobile device during working hours only. Valid values are: - $true: Calendar update text message notifications are sent during working hours only. @@ -114,7 +122,6 @@ The CalendarUpdateSendDuringWorkHour parameter specifies whether calendar update Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -133,7 +143,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -DailyAgendaNotification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DailyAgendaNotification parameter specifies whether daily agenda text message notifications are sent to the user's mobile device. Valid values are: - $true: Daily agenda text message notifications are sent. @@ -152,7 +164,6 @@ The DailyAgendaNotification parameter specifies whether daily agenda text messag Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -DailyAgendaNotificationSendTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DailyAgendaNotificationSendTime parameter specifies the time to send daily agenda text message notifications to the user's mobile device. To specify a value, enter it as a time span: hh:mm:ss where hh = hours, mm = minutes and ss = seconds. @@ -172,7 +186,6 @@ The default value is 08:00:00. Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,13 +195,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,13 +213,15 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -214,6 +231,9 @@ Accept wildcard characters: False ``` ### -MeetingReminderNotification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MeetingReminderNotification parameter specifies whether meeting reminder text message notifications are sent to the user's mobile device. Valid values are: - $true: Meeting reminder text message notifications are sent. @@ -223,7 +243,6 @@ The MeetingReminderNotification parameter specifies whether meeting reminder tex Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,6 +252,9 @@ Accept wildcard characters: False ``` ### -MeetingReminderSendDuringWorkHour + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MeetingReminderSendDuringWorkHour parameter specifies whether meeting reminder text message notifications are sent to the user's mobile device during working hours only. Valid values are: - $true: Meeting update notifications are sent during working hours only. @@ -242,7 +264,6 @@ The MeetingReminderSendDuringWorkHour parameter specifies whether meeting remind Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,13 +273,15 @@ Accept wildcard characters: False ``` ### -NextDays + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The NextDays parameter specifies how many days should be sent in the daily agenda text message notification to the user's mobile device. A valid value is an integer between 1 and 7. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -268,13 +291,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md b/exchange/exchange-ps/ExchangePowerShell/Set-CalendarProcessing.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-CalendarProcessing.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CalendarProcessing.md index edc2b0bc9a..6897e1410a 100644 --- a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CalendarProcessing.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-calendarprocessing applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-CalendarProcessing -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-calendarprocessing +schema: 2.0.0 +title: Set-CalendarProcessing --- # Set-CalendarProcessing @@ -156,6 +157,9 @@ This example rejects meeting requests from any user who isn't a member of the Ex ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the resource mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -173,7 +177,6 @@ The Identity parameter specifies the resource mailbox that you want to modify. Y Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -183,6 +186,9 @@ Accept wildcard characters: False ``` ### -AddAdditionalResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AddAdditionalResponse parameter specifies whether additional information (the value of the AdditionalResponse parameter) is added to meeting request responses. Valid values are: - $true: Text from the AdditionalResponse parameter is added to meeting request responses. @@ -194,7 +200,6 @@ This parameter is used only on resource mailboxes where the AutomateProcessing p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -204,13 +209,15 @@ Accept wildcard characters: False ``` ### -AdditionalResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AdditionalResponse parameter specifies the additional information to be included in responses to meeting requests when the value of the AddAdditionalResponse parameter is $true. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -220,6 +227,9 @@ Accept wildcard characters: False ``` ### -AddNewRequestsTentatively + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AddNewRequestsTentatively parameter specifies whether new meeting requests are added to the calendar as tentative. Valid values are: - $true: New calendar items are added to the calendar as tentative. This is the default value. @@ -229,7 +239,6 @@ The AddNewRequestsTentatively parameter specifies whether new meeting requests a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -239,6 +248,9 @@ Accept wildcard characters: False ``` ### -AddOrganizerToSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AddOrganizerToSubject parameter specifies whether the meeting organizer's name is used as the subject of the meeting request. Valid values are: - $true: The meeting organizer's name replaces any existing Subject value for the meeting request. This is the default value. @@ -252,7 +264,6 @@ This parameter is used only on resource mailboxes where the AutomateProcessing p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,6 +273,9 @@ Accept wildcard characters: False ``` ### -AllBookInPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllBookInPolicy parameter specifies whether to automatically approve in-policy requests from all users to the resource mailbox. Valid values are: - $true: In-policy requests from all users are automatically approved. This is the default value. @@ -271,7 +285,6 @@ The AllBookInPolicy parameter specifies whether to automatically approve in-poli Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -281,6 +294,9 @@ Accept wildcard characters: False ``` ### -AllowConflicts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowConflicts parameter specifies whether to allow conflicting meeting requests. Valid values are: - $true: Conflicts are allowed. A recurring meeting series is accepted regardless of whether any occurrences conflict with existing bookings. The values of the ConflictPercentageAllowed or MaximumConflictInstances parameters are ignored. @@ -294,7 +310,6 @@ The AllowConflicts parameter specifies whether to allow conflicting meeting requ Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -304,6 +319,9 @@ Accept wildcard characters: False ``` ### -AllowRecurringMeetings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowRecurringMeetings parameter specifies whether to allow recurring meetings in meeting requests. Valid values are: - $true: Recurring meetings are allowed. This is the default value. @@ -313,7 +331,6 @@ The AllowRecurringMeetings parameter specifies whether to allow recurring meetin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -323,6 +340,9 @@ Accept wildcard characters: False ``` ### -AllRequestInPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllRequestInPolicy parameter specifies whether to allow all users to submit in-policy requests to the resource mailbox. Valid values are: - $true: All users are allowed to submit in-policy requests to the resource mailbox. These requests require approval by a resource mailbox delegate if the AllBookInPolicy parameter is set to $false (the default value of AllBookInPolicy is $true). @@ -332,7 +352,6 @@ The AllRequestInPolicy parameter specifies whether to allow all users to submit Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -342,6 +361,9 @@ Accept wildcard characters: False ``` ### -AllRequestOutOfPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllRequestOutOfPolicy parameter specifies whether to allow all users to submit out-of-policy requests to the resource mailbox. Valid values are: - $true: All users are allowed to submit out-of-policy requests to the resource mailbox. Out-of-policy requests require approval by a resource mailbox delegate. @@ -351,7 +373,6 @@ The AllRequestOutOfPolicy parameter specifies whether to allow all users to subm Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -361,6 +382,9 @@ Accept wildcard characters: False ``` ### -AutomateProcessing + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AutomateProcessing parameter enables or disables calendar processing on the mailbox. Valid values are: - None: Calendar processing is disabled on the mailbox. Both the resource booking attendant and the Calendar Attendant are disabled on the mailbox. @@ -377,7 +401,6 @@ The default value for user mailboxes is AutoUpdate, but you can't change the val Type: CalendarProcessingFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -387,6 +410,9 @@ Accept wildcard characters: False ``` ### -BookingType + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingType parameter specifies how reservations work on the resource mailbox. Valid values are: @@ -398,7 +424,6 @@ The BookingType parameter specifies how reservations work on the resource mailbo Type: Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -408,13 +433,15 @@ Accept wildcard characters: False ``` ### -BookingWindowInDays + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BookingWindowInDays parameter specifies the maximum number of days in advance that the resource can be reserved. A valid value is an integer from 0 through 1080. The default value is 180 days. The value 0 means today. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -424,6 +451,9 @@ Accept wildcard characters: False ``` ### -BookInPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BookInPolicy parameter specifies users or groups who are allowed to submit in-policy meeting requests to the resource mailbox that are automatically approved. You can use any value that uniquely identifies the user or group. For example: - Name @@ -445,7 +475,6 @@ To add users or groups without affecting the other entries, see Example 7. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -455,6 +484,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -464,7 +496,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -474,6 +505,9 @@ Accept wildcard characters: False ``` ### -ConflictPercentageAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConflictPercentageAllowed parameter specifies the maximum percentage of meeting conflicts for new recurring meeting requests. A valid value is an integer from 0 through 100. The default value is 0. If a new recurring meeting request conflicts with existing reservations for the resource more than the percentage specified by this parameter, the recurring meeting request is automatically declined. When the value is 0, no conflicts are permitted for new recurring meeting requests. @@ -482,7 +516,6 @@ If a new recurring meeting request conflicts with existing reservations for the Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -492,6 +525,9 @@ Accept wildcard characters: False ``` ### -DeleteAttachments + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeleteAttachments parameter specifies whether to remove attachments from all incoming messages. Valid values are: - $true: Remove any attachments in incoming messages. This is the default value. @@ -503,7 +539,6 @@ This parameter is used only on resource mailboxes where the AutomateProcessing p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -513,6 +548,9 @@ Accept wildcard characters: False ``` ### -DeleteComments + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeleteComments parameter specifies whether to remove or keep any text in the message body of incoming meeting requests. Valid values are: - $true: Remove any text in the message body of incoming meeting requests. This is the default value. @@ -524,7 +562,6 @@ This parameter is used only on resource mailboxes where the AutomateProcessing p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -534,6 +571,9 @@ Accept wildcard characters: False ``` ### -DeleteNonCalendarItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeleteNonCalendarItems parameter specifies whether to remove or keep all non-calendar-related messages that are received by the resource mailbox. Valid values are: - $true: Non-calendar messages are deleted. This is the default value. @@ -543,7 +583,6 @@ The DeleteNonCalendarItems parameter specifies whether to remove or keep all non Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -553,6 +592,9 @@ Accept wildcard characters: False ``` ### -DeleteSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeleteSubject parameter specifies whether to remove or keep the subject of incoming meeting requests. Valid values are: - $true: Remove the Subject value of incoming meeting requests. This is the default value. @@ -564,7 +606,6 @@ This parameter is used only on resource mailboxes where the AutomateProcessing p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -574,6 +615,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -582,7 +626,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -592,6 +635,9 @@ Accept wildcard characters: False ``` ### -EnableAutoRelease + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill EnableAutoRelease Description }} @@ -600,7 +646,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -610,6 +655,9 @@ Accept wildcard characters: False ``` ### -EnableResponseDetails + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EnableResponseDetails parameter specifies whether to include the reasons for accepting or declining a meeting in the response email message. Valid values are: - $true: The reasons for accepting or declining a meeting are included in the response message. This is the default value. @@ -619,7 +667,6 @@ The EnableResponseDetails parameter specifies whether to include the reasons for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -629,6 +676,9 @@ Accept wildcard characters: False ``` ### -EnforceCapacity + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EnforceCapacity parameter specifies whether to restrict the number of attendees to the capacity of the workspace. For example, if capacity is set to 10, then only 10 people can book the workspace. Valid values are: @@ -640,7 +690,6 @@ The EnforceCapacity parameter specifies whether to restrict the number of attend Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -650,6 +699,9 @@ Accept wildcard characters: False ``` ### -EnforceSchedulingHorizon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EnforceSchedulingHorizon parameter controls the behavior of recurring meetings that extend beyond the date specified by the BookingWindowInDays parameter. Valid values are: - $true: A recurring meeting request is automatically declined if the meetings start on or before the date specified by the BookingWindowInDays parameter, and the meetings extend beyond the specified date. This is the default value. @@ -659,7 +711,6 @@ The EnforceSchedulingHorizon parameter controls the behavior of recurring meetin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -669,6 +720,9 @@ Accept wildcard characters: False ``` ### -ForwardRequestsToDelegates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForwardRequestsToDelegates parameter specifies whether to forward incoming meeting requests to the delegates that are configured for the resource mailbox. Valid values are: - $true: Forward incoming meeting requests to the delegates. This is the default value. @@ -678,7 +732,6 @@ The ForwardRequestsToDelegates parameter specifies whether to forward incoming m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -688,6 +741,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -699,7 +755,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -709,6 +764,9 @@ Accept wildcard characters: False ``` ### -MaximumConflictInstances + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaximumConflictInstances parameter specifies the maximum number of conflicts for new recurring meeting requests when the AllowRecurringMeetings parameter is set to $true. A valid value is an integer from 0 through INT32 (2147483647). The default value is 0. If a new recurring meeting request conflicts with existing reservations for the resource more than the number of times specified by the MaximumConflictInstances parameter value, the recurring meeting request is automatically declined. When the value is 0, no conflicts are permitted for new recurring meeting requests. @@ -717,7 +775,6 @@ If a new recurring meeting request conflicts with existing reservations for the Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -727,6 +784,9 @@ Accept wildcard characters: False ``` ### -MaximumDurationInMinutes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaximumDurationInMinutes parameter specifies the maximum duration in minutes for meeting requests. A valid value is an integer from 0 through INT32 (2147483647). The default value is 1440 (24 hours). When the value is set to 0, the maximum duration of a meeting is unlimited. For recurring meetings, the value of this parameter applies to the length of an individual meeting instance. @@ -735,7 +795,6 @@ When the value is set to 0, the maximum duration of a meeting is unlimited. For Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -745,6 +804,9 @@ Accept wildcard characters: False ``` ### -MinimumDurationInMinutes + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MinimumDurationInMinutes parameter specifies the minimum duration in minutes for meeting requests in workspace mailboxes. A valid value is an integer from 0 through INT32 (2147483647). The default value is 0, which means there is no minimum duration. @@ -757,7 +819,6 @@ This parameter only works on workspace mailboxes. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -767,6 +828,9 @@ Accept wildcard characters: False ``` ### -OrganizerInfo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OrganizerInfo parameter specifies whether the resource mailbox sends organizer information when a meeting request is declined because of conflicts. Valid values are: - $true: Organizer information is sent when a meeting request is declined because of conflicts. This is the default value. @@ -776,7 +840,6 @@ The OrganizerInfo parameter specifies whether the resource mailbox sends organiz Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -786,6 +849,9 @@ Accept wildcard characters: False ``` ### -PostReservationMaxClaimTimeInMinutes + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill PostReservationMaxClaimTimeInMinutes Description }} @@ -794,7 +860,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -804,6 +869,9 @@ Accept wildcard characters: False ``` ### -ProcessExternalMeetingMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ProcessExternalMeetingMessages parameter specifies whether to process meeting requests that originate outside the Exchange organization. Valid values are: - $true: Meeting requests from external senders are processed. @@ -813,7 +881,6 @@ The ProcessExternalMeetingMessages parameter specifies whether to process meetin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -823,6 +890,9 @@ Accept wildcard characters: False ``` ### -RemoveCanceledMeetings + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The RemoveCanceledMeetings parameter specifies whether to automatically delete meetings that were cancelled by the organizer from the resource mailbox's calendar. Valid values are: @@ -834,7 +904,6 @@ The RemoveCanceledMeetings parameter specifies whether to automatically delete m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -844,6 +913,9 @@ Accept wildcard characters: False ``` ### -RemoveForwardedMeetingNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoveForwardedMeetingNotifications parameter specifies whether forwarded meeting notifications are moved to the Deleted Items folder after they're processed by the Calendar Attendant. Valid values are: - $true: Processed forwarded meeting notifications are deleted (moved to the Deleted Items folder). @@ -853,7 +925,6 @@ The RemoveForwardedMeetingNotifications parameter specifies whether forwarded me Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -863,6 +934,9 @@ Accept wildcard characters: False ``` ### -RemoveOldMeetingMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoveOldMeetingMessages parameter specifies whether the Calendar Attendant removes old and redundant updates and responses. Valid values are: - $true: Outdated and redundant meeting messages are deleted. This is the default value. @@ -872,7 +946,6 @@ The RemoveOldMeetingMessages parameter specifies whether the Calendar Attendant Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -882,6 +955,9 @@ Accept wildcard characters: False ``` ### -RemovePrivateProperty + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemovePrivateProperty parameter specifies whether to clear the private flag for incoming meetings that were sent by the organizer in the original requests. Valid values are: - $true: The private flag for incoming meeting requests is cleared (the meeting is no longer private). This is the default value. @@ -891,7 +967,6 @@ The RemovePrivateProperty parameter specifies whether to clear the private flag Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -901,6 +976,9 @@ Accept wildcard characters: False ``` ### -RequestInPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestInPolicy parameter specifies users who are allowed to submit in-policy meeting requests to the resource mailbox that require approval by a resource mailbox delegate. You can use any value that uniquely identifies the user. For example: - Name @@ -916,7 +994,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -926,6 +1003,9 @@ Accept wildcard characters: False ``` ### -RequestOutOfPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestOutOfPolicy parameter specifies users who are allowed to submit out-of-policy requests that require approval by a resource mailbox delegate. You can use any value that uniquely identifies the user. For example: - Name @@ -941,7 +1021,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -951,6 +1030,9 @@ Accept wildcard characters: False ``` ### -ResourceDelegates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResourceDelegates parameter specifies users can approve or reject requests that are sent to the resource mailbox. You can use any value that uniquely identifies the user. For example: - Name @@ -966,7 +1048,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -976,6 +1057,9 @@ Accept wildcard characters: False ``` ### -ScheduleOnlyDuringWorkHours + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ScheduleOnlyDuringWorkHours parameter specifies whether to allow meetings to be scheduled outside of the working hours that are defined for the resource mailbox. Valid values are: - $true: Meeting requests that are outside of working hours are automatically rejected. @@ -987,7 +1071,6 @@ You configure the working hours of the resource mailbox by using the WorkDays, W Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -997,6 +1080,9 @@ Accept wildcard characters: False ``` ### -TentativePendingApproval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TentativePendingApproval parameter specifies whether to mark pending requests as tentative on the calendar. Valid values are: - $true: Meeting requests that are awaiting approval from a delegate appear in the calendar as tentative. This is the default value. @@ -1006,7 +1092,6 @@ The TentativePendingApproval parameter specifies whether to mark pending request Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1016,13 +1101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldPolicy.md index db1f2c2ede..68741273ad 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-caseholdpolicy applicable: Security & Compliance -title: Set-CaseHoldPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-caseholdpolicy +schema: 2.0.0 +title: Set-CaseHoldPolicy --- # Set-CaseHoldPolicy @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Set-CaseHoldPolicy cmdlet to modify existing case hold policies in the Microsoft Purview compliance portal. -**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. If you need to update a policy multiple times, make all changes in a single call of the cmdlet. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy). +**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. If you need to update a policy multiple times, make all changes in a single call of the cmdlet. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/get-caseholdpolicy). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -70,6 +71,9 @@ This example makes the following changes to the existing case hold policy named ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -80,7 +84,6 @@ The Identity parameter specifies the case hold policy that you want to modify. Y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -100,7 +106,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes. Valid values are: - A mailbox @@ -127,7 +135,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -137,13 +144,15 @@ Accept wildcard characters: False ``` ### -AddPublicFolderLocation + +> Applicable: Security & Compliance + The AddPublicFolderLocation parameter specifies that you want to add all public folders to the case hold policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation + +> Applicable: Security & Compliance + The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -163,7 +175,6 @@ SharePoint sites can't be added to the policy until they have been indexed. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -173,13 +184,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -189,6 +202,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -198,7 +214,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -208,6 +223,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -217,7 +235,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -227,6 +244,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -235,7 +255,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -245,6 +264,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter specifies the existing mailboxes to remove from the policy. Valid values are: - A mailbox @@ -262,7 +284,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -272,13 +293,15 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation + +> Applicable: Security & Compliance + The RemovePublicFolderLocation parameter specifies that you want to remove all public folders from the case hold policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -288,6 +311,9 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation + +> Applicable: Security & Compliance + The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -296,7 +322,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -306,13 +331,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-CaseHoldRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldRule.md index 3935336a80..c34bc26621 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CaseHoldRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-caseholdrule applicable: Security & Compliance -title: Set-CaseHoldRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-caseholdrule +schema: 2.0.0 +title: Set-CaseHoldRule --- # Set-CaseHoldRule @@ -45,6 +46,9 @@ This example disables the enabled case hold rule named "Internal Company Rule". ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the case hold rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the case hold rule that you want to modify. You Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -90,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -108,7 +118,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the case hold rule is enabled or disabled. Valid values are: - $true: The rule is disabled. @@ -127,7 +139,6 @@ The Disabled parameter specifies whether the case hold rule is enabled or disabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -137,13 +148,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md b/exchange/exchange-ps/ExchangePowerShell/Set-ClassificationRuleCollection.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ClassificationRuleCollection.md index 1848e06aee..2502056704 100644 --- a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ClassificationRuleCollection.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-classificationrulecollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ClassificationRuleCollection -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-classificationrulecollection +schema: 2.0.0 +title: Set-ClassificationRuleCollection --- # Set-ClassificationRuleCollection @@ -45,6 +46,9 @@ This example imports the classification rule collection file C:\\My Documents\\E ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FileData parameter specifies the classification rule collection file you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -53,7 +57,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessArray.md b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessArray.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-ClientAccessArray.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessArray.md index caa657f795..00eda61ee3 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessArray.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessArray.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessarray applicable: Exchange Server 2010 -title: Set-ClientAccessArray -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-clientaccessarray +schema: 2.0.0 +title: Set-ClientAccessArray --- # Set-ClientAccessArray @@ -60,6 +61,9 @@ This example associates the existing Client Access array named ContosoArray with ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Client Access array that you want to modify. You can use these values: - Name (if the value doesn't contain spaces) @@ -72,7 +76,6 @@ The Identity parameter specifies the Client Access array that you want to modify Type: ClientAccessArrayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -91,7 +97,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010 + The Fqdn parameter specifies the fully qualified domain name of the Client Access array (for example, casarray01.contoso.com). This is the value that RPC over TCP clients use to connect to the Client Access servers in the array. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the descriptive name of the Client Access array. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). If the value contains spaces, you can't use the Name value to identify the Client Access array for the Get-ClientAccessArray, Remove-ClientAccessArray, or Set-ClientAccessArray cmdlets. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Exchange Server 2010 + The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: - Name @@ -161,7 +175,6 @@ To see a list of available sites, use the Get-ADSite cmdlet. Type: AdSiteIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-ClientAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessRule.md index 9a82144d26..19c664d7a8 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-ClientAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-clientaccessrule +schema: 2.0.0 +title: Set-ClientAccessRule --- # Set-ClientAccessRule @@ -86,6 +87,9 @@ This example adds the IP address range 172.17.17.27/16 to the existing client ac ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the client access rule that you want to modify. You can use any value that uniquely identifies the client access rule. For example: - Name @@ -96,7 +100,6 @@ The Identity parameter specifies the client access rule that you want to modify. Type: ClientAccessRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. ```yaml Type: ClientAccessRulesAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -AnyOfAuthenticationTypes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The AnyOfAuthenticationTypes parameter specifies a condition for the client access rule that's based on the client's authentication type. @@ -144,7 +152,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -154,6 +161,9 @@ Accept wildcard characters: False ``` ### -AnyOfClientIPAddressesOrRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AnyOfClientIPAddressesOrRanges parameter specifies a condition for the client access rule that's based on the client's IPv4 or IPv6 address. Valid values are: - Single IP address: For example, 192.168.1.1 or 2001:DB8::2AA:FF:C0A8:640A. @@ -170,7 +180,6 @@ For more information about IPv6 addresses and syntax, see this Exchange 2013 top Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -180,6 +189,9 @@ Accept wildcard characters: False ``` ### -AnyOfProtocols + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AnyOfProtocols parameter specifies a condition for the client access rule that's based on the client's protocol. Valid values for this parameter are: @@ -207,7 +219,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -217,13 +228,15 @@ Accept wildcard characters: False ``` ### -AnyOfSourceTcpPortNumbers + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -233,6 +246,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -242,7 +258,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -252,6 +267,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -260,7 +278,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,13 +287,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the client access rule is enabled or disabled. Valid values for this parameter are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -286,6 +305,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfAuthenticationTypes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptAnyOfAuthenticationTypes parameter specifies an exception for the client access rule that's based on the client's authentication type. @@ -308,7 +330,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -318,6 +339,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfClientIPAddressesOrRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExceptAnyOfClientIPAddressesOrRanges parameter specifies an exception for the client access rule that's based on the client's IPv4 or IPv6 address. Valid values are: - Single IP address: For example, 192.168.1.1 or 2001:DB8::2AA:FF:C0A8:640A. @@ -334,7 +358,6 @@ For more information about IPv6 addresses and syntax, see this Exchange 2013 top Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -344,6 +367,9 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfProtocols + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptAnyOfProtocols parameter specifies an exception for the client access rule that's based on the client's protocol. @@ -371,7 +397,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -381,13 +406,15 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfSourceTcpPortNumbers + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -397,13 +424,15 @@ Accept wildcard characters: False ``` ### -ExceptUserIsMemberOf + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -413,6 +442,9 @@ Accept wildcard characters: False ``` ### -ExceptUsernameMatchesAnyOfPatterns + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. @@ -425,7 +457,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -435,13 +466,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the client access rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -451,13 +484,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the client access rule. A lower integer value indicates a higher priority, and a higher priority rule is evaluated before a lower priority rule. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -467,6 +502,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Scope parameter specifies the scope of the client access rule. Valid values are: - Users: The rule only applies to end-user connections. @@ -476,7 +514,6 @@ The Scope parameter specifies the scope of the client access rule. Valid values Type: ClientAccessRulesScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -486,13 +523,15 @@ Accept wildcard characters: False ``` ### -UserIsMemberOf + +> Applicable: Exchange Server 2013 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -502,6 +541,9 @@ Accept wildcard characters: False ``` ### -UsernameMatchesAnyOfPatterns + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. @@ -514,7 +556,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -524,6 +565,9 @@ Accept wildcard characters: False ``` ### -UserRecipientFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPATH filter syntax to identify the user based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties. @@ -563,7 +607,6 @@ For detailed information about OPATH filter syntax in Exchange, see [Additional Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -573,13 +616,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessServer.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-ClientAccessServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessServer.md index 343bf8d337..485c03031d 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ClientAccessServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-clientaccessserver +schema: 2.0.0 +title: Set-ClientAccessServer --- # Set-ClientAccessServer @@ -73,6 +74,9 @@ This example configures the internal Autodiscover URL for the Active Directory s ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -84,7 +88,6 @@ The Identity parameter specifies the server that you want to modify. You can use Type: ClientAccessServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AlternateServiceAccountCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AlternateServiceAccountCredential parameter specifies an alternative service account username and password that's typically used for Kerberos authentication in Exchange Server 2010 coexistence environments. You can specify multiple values separated by commas. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -102,7 +108,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential[] Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,13 +117,15 @@ Accept wildcard characters: False ``` ### -Array + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ClientAccessArrayIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -AutoDiscoverServiceInternalUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDiscoverServiceInternalUri parameter specifies the internal URL of the Autodiscover service. ```yaml Type: Uri Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverSiteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDiscoverSiteScope parameter specifies the Active Directory site that the Autodiscover service is authoritative for. Clients that connect to the Autodiscover service by using the internal URL need to exist in the specified site. To see the available Active Directory sites, use the Get-ADSite cmdlet. @@ -154,7 +166,6 @@ To specify multiple values, use the following syntax: `Value1,Value2,...ValueN`. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -CleanUpInvalidAlternateServiceAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CleanUpInvalidAlternateServiceAccountCredentials switch specifies whether to remove a previously configured alternate service account that's no longer valid. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -189,7 +205,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,6 +232,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogEnabled parameter specifies whether logging is enabled for Information Rights Management (IRM). Valid values are $true or $false. The default value is $true. @@ -223,7 +243,6 @@ The IrmLogEnabled parameter specifies whether logging is enabled for Information Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -233,6 +252,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxAge parameter specifies the max age for IRM logs. Logs older than the specified value are deleted. @@ -245,7 +267,6 @@ For example, to specify a 15-hour interval, enter 15:00:00. The default value is Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -255,6 +276,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxDirectorySize parameter specifies the maximum directory size for IRM logs. When the maximum directory size is reached, the server deletes the old log files first. @@ -275,7 +299,6 @@ Unqualified values are typically treated as bytes, but small values may be round Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -285,6 +308,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxFileSize parameter specifies the maximum size of the IRM log. This value can't be larger than the IrmLogMaxDirectorySize parameter value. @@ -306,7 +332,6 @@ The value of this parameter must be less than or equal to the value of the Recei Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -316,6 +341,9 @@ Accept wildcard characters: False ``` ### -IrmLogPath + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogPath parameter specifies the location of the IRM log files. The default location is %ExchangeInstallPath%Logging\\IRMLogs. @@ -324,7 +352,6 @@ The IrmLogPath parameter specifies the location of the IRM log files. The defaul Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -334,6 +361,9 @@ Accept wildcard characters: False ``` ### -IsOutOfService + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -342,7 +372,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -352,13 +381,15 @@ Accept wildcard characters: False ``` ### -RemoveAlternateServiceAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoveAlternateServiceAccountCredentials switch specifies whether to remove a previously distributed alternate service account. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -368,13 +399,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessService.md b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessService.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-ClientAccessService.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessService.md index bff2cc0183..513a753cb2 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ClientAccessService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessservice applicable: Exchange Server 2016, Exchange Server 2019 -title: Set-ClientAccessService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-clientaccessservice +schema: 2.0.0 +title: Set-ClientAccessService --- # Set-ClientAccessService @@ -59,6 +60,9 @@ This example configures the internal Autodiscover URL for the Active Directory s ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the server that you want to modify. You can use Type: ClientAccessServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AlternateServiceAccountCredential + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The AlternateServiceAccountCredential parameter specifies an alternative service account that's typically used for Kerberos authentication in Exchange Server 2010 coexistence environments. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -88,7 +94,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential[] Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -Array + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ClientAccessArrayIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -AutoDiscoverServiceInternalUri + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The AutoDiscoverServiceInternalUri parameter specifies the internal URL of the Autodiscover service. ```yaml Type: Uri Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverSiteScope + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The AutoDiscoverSiteScope parameter specifies the Active Directory site that the Autodiscover service is authoritative for. Clients that connect to the Autodiscover service by using the internal URL need to exist in the specified site. To see the available Active Directory sites, use the Get-ADSite cmdlet. @@ -140,7 +152,6 @@ To specify multiple values, use the following syntax: `Value1,Value2,...ValueN`. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -CleanUpInvalidAlternateServiceAccountCredentials + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The CleanUpInvalidAlternateServiceAccountCredentials switch specifies whether to remove a previously configured alternate service account that's no longer valid. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -175,7 +191,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,13 +200,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,13 +218,15 @@ Accept wildcard characters: False ``` ### -RemoveAlternateServiceAccountCredentials + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RemoveAlternateServiceAccountCredentials switch specifies whether to remove a previously distributed alternate service account. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: AlternateServiceAccount Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,13 +236,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Clutter.md b/exchange/exchange-ps/ExchangePowerShell/Set-Clutter.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-Clutter.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Clutter.md index 980d6d409c..0744a0ad2e 100644 --- a/exchange/exchange-ps/exchange/Set-Clutter.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Clutter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-clutter applicable: Exchange Online, Exchange Online Protection -title: Set-Clutter -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-clutter +schema: 2.0.0 +title: Set-Clutter --- # Set-Clutter @@ -42,6 +43,9 @@ This example disables Clutter for the user Alexander Martinez. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: Exchange Online, Exchange Online Protection + The Enable parameter specifies whether to enable or disable Clutter for the mailbox. Valid values are: - $true: Clutter is enabled for the mailbox. This is the default value. @@ -78,7 +84,6 @@ The Enable parameter specifies whether to enable or disable Clutter for the mail Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill UseCustomRouting Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md b/exchange/exchange-ps/ExchangePowerShell/Set-CmdletExtensionAgent.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Set-CmdletExtensionAgent.md index 1f29b9f3c9..681865354f 100644 --- a/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-CmdletExtensionAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-cmdletextensionagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-CmdletExtensionAgent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-cmdletextensionagent +schema: 2.0.0 +title: Set-CmdletExtensionAgent --- # Set-CmdletExtensionAgent @@ -49,6 +50,9 @@ This example changes the priority of the fictitious "Validation Agent" cmdlet ex ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the cmdlet extension agent that you want to modify. You can use any value that uniquely identifies the agent. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the cmdlet extension agent that you want to mod Type: CmdletExtensionAgentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name of the cmdlet extension agent. The maximum length of the agent name is 64 characters. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the priority of the cmdlet extension agent. Higher priority agents are applied before lower priority agents. A valid value is an integer from 0 to 255. Lower integer values indicate higher priority. ```yaml Type: Byte Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ComplianceCase.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceCase.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-ComplianceCase.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceCase.md index 2975872e51..def617a424 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceCase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceCase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancecase applicable: Security & Compliance -title: Set-ComplianceCase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-compliancecase +schema: 2.0.0 +title: Set-ComplianceCase --- # Set-ComplianceCase @@ -49,6 +50,9 @@ This example adds a description and case Id to the existing eDiscovery case name ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the compliance case that you want to modify. You can use any value that uniquely identifies the case. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the compliance case that you want to modify. Yo Type: ComplianceCaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -CaseType + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: ComplianceCaseType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -Close + +> Applicable: Security & Compliance + The Close switch specifies that you want to close the compliance case. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -109,7 +119,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +128,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the compliance case. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -151,13 +164,15 @@ Accept wildcard characters: False ``` ### -ExternalId + +> Applicable: Security & Compliance + The ExternalId parameter specifies an optional ID or external case number that you can associate with the compliance case. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -167,13 +182,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies the unique name of the compliance case. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -183,13 +200,15 @@ Accept wildcard characters: False ``` ### -Reopen + +> Applicable: Security & Compliance + The Reopen switch specifies that you want to re-open a closed compliance case. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -199,13 +218,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceRetentionEventType.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceRetentionEventType.md index 095fd20c7a..a8987cc8b3 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceRetentionEventType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-complianceretentioneventtype applicable: Security & Compliance -title: Set-ComplianceRetentionEventType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-complianceretentioneventtype +schema: 2.0.0 +title: Set-ComplianceRetentionEventType --- # Set-ComplianceRetentionEventType @@ -43,6 +44,9 @@ This example add a comment to the retention event type named Fabrikam Project ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention event type that you want to modify. You can use any value that uniquely identifies the retention event type. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the retention event type that you want to modif Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearch.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearch.md index 2f6e6859f5..3919717169 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancesearch applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Set-ComplianceSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-compliancesearch +schema: 2.0.0 +title: Set-ComplianceSearch --- # Set-ComplianceSearch @@ -86,6 +87,9 @@ You might have to change the language setting if you're using non-English keywor ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Identity parameter specifies the compliance search that you want to modify. You can use any value that uniquely identifies the compliance search. For example: @@ -99,7 +103,6 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Microsoft 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. @@ -120,7 +126,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocationExclusion + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to add to the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -143,7 +151,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -153,6 +160,9 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. @@ -163,7 +173,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -173,6 +182,9 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationExclusion + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -181,7 +193,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -AllowNotFoundExchangeLocationsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The AllowNotFoundExchangeLocationsEnabled parameter specifies whether to include mailboxes other than regular user mailboxes in the compliance search. Valid values are: - $true: The search doesn't try to validate the existence of the mailbox before proceeding. This value is required if you want to search mailboxes that don't resolve as regular mailboxes. @@ -207,7 +221,6 @@ The mailbox types that are affected by the value of this parameter include: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -217,6 +230,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -226,7 +242,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -236,6 +251,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -244,7 +262,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -254,13 +271,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Description parameter specifies a description for the compliance search. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -270,6 +289,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocation + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The ExchangeLocation parameter specifies the mailboxes to include. Valid values are: - A regular user mailbox. Including other types of mailboxes (for example, inactive mailboxes or Microsoft 365 guest users) is controlled by the AllowNotFoundExchangeLocationsEnabled parameter. @@ -284,7 +306,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -294,6 +315,9 @@ Accept wildcard characters: False ``` ### -ExchangeLocationExclusion + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -307,7 +331,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -317,6 +340,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -325,7 +351,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -335,6 +360,9 @@ Accept wildcard characters: False ``` ### -HoldNames + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The HoldNames parameter specifies that the content locations that have been placed on hold in the eDiscovery case will be searched. You use the value All for this parameter. You can use this parameter only for compliance searches that are associated with an eDiscovery case. @@ -347,7 +375,6 @@ Also, if a content location was placed on a query-based case hold, only items th Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -357,13 +384,15 @@ Accept wildcard characters: False ``` ### -IncludeOrgContent + +> Applicable: Security & Compliance + {{ Fill IncludeOrgContent Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -373,6 +402,9 @@ Accept wildcard characters: False ``` ### -IncludeUserAppContent + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The IncludeUserAppContent parameter specifies that you want to search the cloud-based storage location for users who don't have a regular Microsoft 365 user account in your organization. These types of users include users without an Exchange Online license who use Office applications, Microsoft 365 guest users, and on-premises users whose identity is synchronized with your Microsoft 365 organization. Valid values are: @@ -384,7 +416,6 @@ The IncludeUserAppContent parameter specifies that you want to search the cloud- Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -394,6 +425,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Language parameter specifies the language for the compliance search. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -402,7 +436,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -412,13 +445,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -428,6 +463,9 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The PublicFolderLocation parameter specifies that you want to include all public folders in the search. You use the value All for this parameter. @@ -436,7 +474,6 @@ The PublicFolderLocation parameter specifies that you want to include all public Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -446,6 +483,9 @@ Accept wildcard characters: False ``` ### -RefinerNames + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -454,7 +494,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -464,6 +503,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -475,7 +517,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -485,6 +526,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocationExclusion + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -498,7 +542,6 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -508,6 +551,9 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -516,7 +562,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -526,6 +571,9 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. @@ -536,7 +584,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -546,6 +593,9 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationExclusion + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -554,7 +604,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -564,6 +613,9 @@ Accept wildcard characters: False ``` ### -SharePointLocation + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. @@ -574,7 +626,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -584,6 +635,9 @@ Accept wildcard characters: False ``` ### -SharePointLocationExclusion + +> Applicable: Security & Compliance + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -592,7 +646,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -602,6 +655,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -610,7 +666,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearchAction.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearchAction.md index a490fa06ca..a70ca0736f 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSearchAction.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancesearchaction applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Set-ComplianceSearchAction -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-compliancesearchaction +schema: 2.0.0 +title: Set-ComplianceSearchAction --- # Set-ComplianceSearchAction @@ -49,6 +50,9 @@ This example changes the export key on the export compliance search action named ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Identity parameter specifies the compliance search action that you want to modify. You can use any value that uniquely identifies the compliance search action. For example: - Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"` (for example, `"Case 1234_Preview`). @@ -58,7 +62,6 @@ The Identity parameter specifies the compliance search action that you want to m Type: ComplianceSearchActionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -ChangeExportKey + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The ChangeExportKey switch creates a new export key for the compliance search action. You don't need to specify a value with this switch. This switch is meaningful only on export compliance search actions. @@ -76,7 +82,6 @@ This switch is meaningful only on export compliance search actions. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSecurityFilter.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSecurityFilter.md index 5301f61588..1717b76660 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceSecurityFilter.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancesecurityfilter applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Set-ComplianceSecurityFilter -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-compliancesecurityfilter +schema: 2.0.0 +title: Set-ComplianceSecurityFilter --- # Set-ComplianceSecurityFilter @@ -62,13 +63,15 @@ This example removes user annb@contoso.com to the compliance security filter nam ## PARAMETERS ### -FilterName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The FilterName parameter specifies the name of the compliance security filter that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Action parameter specifies that type of search action that the filter is applied to. A valid value for this parameter is All, which means the filter is applied to all search actions. - Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. @@ -90,7 +96,6 @@ The Action parameter specifies that type of search action that the filter is app Type: ComplianceSecurityFilterActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -109,7 +117,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Description parameter specifies a description for the compliance security filter. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -Filters + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Filters parameter specifies the search criteria for the compliance security filter. You can create three different types of filters: - Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is `Mailbox_`, where `` is a mailbox property value. For example,`"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"` allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). @@ -147,7 +159,6 @@ You can specify multiple filters of the same type. For example, `"Mailbox_Custom Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -Region + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Region parameter specifies the satellite location for multi-geo tenants to conduct eDiscovery searches in. Valid values are: - APC: Asia-Pacific @@ -176,7 +190,6 @@ If you don't use this parameter in a multi-geo tenant, eDiscovery searches are p Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -186,6 +199,9 @@ Accept wildcard characters: False ``` ### -Users + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Users parameter specifies the user who gets this filter applied to their searches. Valid values are: - One or more users: Identify users by their alias or email address. You can specify multiple values separated by commas. @@ -200,7 +216,6 @@ The values you specify will overwrite any existing entries. See the Examples sec Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -210,13 +225,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ComplianceTag.md b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceTag.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-ComplianceTag.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ComplianceTag.md index ef1e0e1fd7..49c0584557 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ComplianceTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancetag applicable: Security & Compliance -title: Set-ComplianceTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-compliancetag +schema: 2.0.0 +title: Set-ComplianceTag --- # Set-ComplianceTag @@ -67,6 +68,9 @@ This example modifies the existing label named HR Content by modifying the reten ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the label that you want to modify. You can use any value that uniquely identifies the tag. For example: - Name @@ -77,7 +81,6 @@ The Identity parameter specifies the label that you want to modify. You can use Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -AutoApprovalPeriod + +> Applicable: Security & Compliance + {{ Fill AutoApprovalPeriod Description }} ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -ComplianceTagForNextStage + +> Applicable: Security & Compliance + {{ Fill ComplianceTagForNextStage Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -144,7 +156,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -EventType + +> Applicable: Security & Compliance + The EventType specifies the retention rule that's associated with the label. You can use any value that uniquely identifies the rule. For example: - Name @@ -166,7 +180,6 @@ You can use the Get-RetentionComplianceRule cmdlet to view the available retenti Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -176,6 +189,9 @@ Accept wildcard characters: False ``` ### -FilePlanProperty + +> Applicable: Security & Compliance + The FilePlanProperty parameter specifies the file plan properties to include in the label. To view the file plan property names that you need to use in this parameter, run the following commands: - `Get-FilePlanPropertyAuthority | Format-List Name` @@ -209,7 +225,6 @@ You use the second variable as the value for this parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -FlowId + +> Applicable: Security & Compliance + **Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. The FlowId parameter specifies the Power Automate flow to run at the end of the retention period. A valid value for this parameter is the GUID value of the flow. @@ -232,7 +250,6 @@ You can find the GUID value of the flow by using either of the following methods Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -242,6 +259,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -250,7 +270,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -260,6 +279,9 @@ Accept wildcard characters: False ``` ### -MultiStageReviewProperty + +> Applicable: Security & Compliance + The MultiStageReviewProperty parameter specifies the multi-stage review properties to include in the label. This parameter uses the following syntax: `'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'` @@ -274,7 +296,6 @@ This syntax is a JSON object that defines each review stage id, review stage nam Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -284,13 +305,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Security & Compliance + The Notes parameter specifies an optional note. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is a user note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -300,13 +323,15 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + {{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: PriorityCleanup Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -316,6 +341,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - A positive integer. @@ -325,7 +353,6 @@ The RetentionDuration parameter specifies the number of days to retain the conte Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -335,13 +362,15 @@ Accept wildcard characters: False ``` ### -ReviewerEmail + +> Applicable: Security & Compliance + The ReviewerEmail parameter specifies the email address of a reviewer for Delete and KeepAndDelete retention actions. You can specify multiple email addresses separated by commas. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -351,13 +380,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Contact.md b/exchange/exchange-ps/ExchangePowerShell/Set-Contact.md similarity index 78% rename from exchange/exchange-ps/exchange/Set-Contact.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Contact.md index a173246fe3..29b5f373c7 100644 --- a/exchange/exchange-ps/exchange/Set-Contact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Contact.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-contact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-Contact -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-contact +schema: 2.0.0 +title: Set-Contact --- # Set-Contact @@ -85,6 +86,9 @@ Change the Company parameter value to Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the contact that you want to modify. You can use any value that uniquely identifies the contact. For example: - Name @@ -96,7 +100,6 @@ The Identity parameter specifies the contact that you want to modify. You can us Type: ContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -AllowUMCallsFromNonUsers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AllowUMCallsFromNonUsers parameter specifies whether to exclude the contact from Unified Messaging directory searches. @@ -114,7 +120,6 @@ The AllowUMCallsFromNonUsers parameter specifies whether to exclude the contact Type: AllowUMCallsFromNonUsersFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,13 +129,15 @@ Accept wildcard characters: False ``` ### -AssistantName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AssistantName parameter specifies the name of the contact's assistant. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -140,13 +147,15 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The City parameter specifies the contact's city. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -Company + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Company parameter specifies the contact's company. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,6 +183,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -181,7 +195,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -191,6 +204,9 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CountryOrRegion parameter specifies the contact's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name). A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). @@ -201,7 +217,6 @@ The friendly name is returned in the CountryOrRegion property value by the Get-C Type: CountryInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -211,6 +226,9 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: @@ -222,7 +240,6 @@ The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-fre Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -232,13 +249,15 @@ Accept wildcard characters: False ``` ### -Department + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Department parameter specifies the contact's department. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,6 +267,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the contact. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only if the contact is mail-enabled. @@ -256,7 +278,6 @@ This parameter is meaningful only if the contact is mail-enabled. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -266,6 +287,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -274,7 +298,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,13 +307,15 @@ Accept wildcard characters: False ``` ### -Fax + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Fax parameter specifies the contact's fax number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,13 +325,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -316,6 +343,9 @@ Accept wildcard characters: False ``` ### -GeoCoordinates + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The GeoCoordinates parameter specifies the contact's location in latitude, longitude and (optionally) altitude coordinates. A valid value for this parameter uses one of the following formats: - Latitude and longitude: For example, "47.644125;-122.122411" @@ -327,7 +357,6 @@ The GeoCoordinates parameter specifies the contact's location in latitude, longi Type: GeoCoordinates Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -337,13 +366,15 @@ Accept wildcard characters: False ``` ### -HomePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The HomePhone parameter specifies the contact's home telephone number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -353,6 +384,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -366,7 +400,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -376,13 +409,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -392,13 +427,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -408,13 +445,15 @@ Accept wildcard characters: False ``` ### -Manager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Manager parameter specifies the contact's manager. ```yaml Type: UserContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -424,13 +463,15 @@ Accept wildcard characters: False ``` ### -MobilePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MobilePhone parameter specifies the contact's primary mobile phone number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -440,13 +481,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -456,13 +499,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -472,13 +517,15 @@ Accept wildcard characters: False ``` ### -Office + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Office parameter specifies the user's physical office name or number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -488,13 +535,15 @@ Accept wildcard characters: False ``` ### -OtherFax + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OtherFax parameter specifies the contact's alternative fax number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -504,13 +553,15 @@ Accept wildcard characters: False ``` ### -OtherHomePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OtherHomePhone parameter specifies the contact's alternative home telephone number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -520,13 +571,15 @@ Accept wildcard characters: False ``` ### -OtherTelephone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OtherTelephone parameter specifies the contact's alternative office telephone number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -536,13 +589,15 @@ Accept wildcard characters: False ``` ### -Pager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Pager parameter specifies the contact's pager number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -552,13 +607,15 @@ Accept wildcard characters: False ``` ### -Phone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Phone parameter specifies the contact's office telephone number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -568,13 +625,15 @@ Accept wildcard characters: False ``` ### -PhoneticDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -584,13 +643,15 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PostalCode parameter specifies the contact's postal code. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -600,13 +661,15 @@ Accept wildcard characters: False ``` ### -PostOfficeBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PostOfficeBox parameter specifies the contact's post office box number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -616,13 +679,15 @@ Accept wildcard characters: False ``` ### -SeniorityIndex + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + 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. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -632,6 +697,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -646,7 +714,6 @@ This parameter is meaningful only if the contact is mail-enabled. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -656,13 +723,15 @@ Accept wildcard characters: False ``` ### -StateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The StateOrProvince parameter specifies the contact's state or province. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -672,13 +741,15 @@ Accept wildcard characters: False ``` ### -StreetAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The StreetAddress parameter specifies the contact's physical address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -688,13 +759,15 @@ Accept wildcard characters: False ``` ### -TelephoneAssistant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TelephoneAssistant parameter specifies the telephone number of the contact's assistant. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -704,13 +777,15 @@ Accept wildcard characters: False ``` ### -Title + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Title parameter specifies the contact's title. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -720,6 +795,9 @@ Accept wildcard characters: False ``` ### -UMCallingLineIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMCallingLineIds parameter specifies telephone numbers or extensions that can be mapped to a Unified Messaging (UM)-enabled user. You can specify more than one telephone number for each user, separated by a comma. Values for this parameter must be less than 128 characters in length and may include an optional plus sign (+) that precedes the numbers. Each UM-enabled user must have a unique UMCallingLineIds parameter value. @@ -728,7 +806,6 @@ The UMCallingLineIds parameter specifies telephone numbers or extensions that ca Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -738,6 +815,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -758,7 +838,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -768,13 +847,15 @@ Accept wildcard characters: False ``` ### -WebPage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WebPage parameter specifies the contact's web page. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -784,13 +865,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -800,6 +883,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -811,7 +897,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-ContentFilterConfig.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-ContentFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ContentFilterConfig.md index 80deb1646f..43970e90cf 100644 --- a/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ContentFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-contentfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ContentFilterConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-contentfilterconfig +schema: 2.0.0 +title: Set-ContentFilterConfig --- # Set-ContentFilterConfig @@ -70,6 +71,9 @@ It defines two users for whom the Content Filter won't process messages. ## PARAMETERS ### -BypassedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassedRecipients parameter specifies the SMTP addresses of recipients who skip processing by the Content Filter agent. You can specify multiple recipients separated by commas (for example, `"recipient1@contoso.com","recipient2@contoso.com"`). The maximum number of recipient entries is 100. @@ -78,7 +82,6 @@ You can specify multiple recipients separated by commas (for example, `"recipien Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -BypassedSenderDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassedSenderDomains parameter specifies the sender email address domains of senders who skip processing by the Content Filter agent. You can specify multiple sender domains separated by commas (`"contoso.com","fabrikam.com"`). Use a wildcard character (\*) to specify a domain and all subdomains (for example: `*.contoso.com`). The maximum number of domain entries is 100. @@ -96,7 +102,6 @@ You can specify multiple sender domains separated by commas (`"contoso.com","fab Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -BypassedSenders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassedSenders parameter specifies the SMTP addresses of senders who skip processing by the Content Filter agent. You can specify multiple senders separated by commas (for example, `"sender1@contoso.com","sender2@contoso.com"`). The maximum number of recipient entries is 100. @@ -114,7 +122,6 @@ You can specify multiple senders separated by commas (for example, `"sender1@con Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -133,7 +143,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -151,7 +163,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter enables or disables the Content Filter agent on the computer on which you're running the command. Valid values are: - $true: The Content Filter agent is enabled. This is the default value. @@ -170,7 +184,6 @@ The Enabled parameter enables or disables the Content Filter agent on the comput Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalMailEnabled parameter specifies whether all messages from unauthenticated connections from sources external to your Exchange organization are processed by the Content Filter agent. Valid values are: - $true: Messages from unauthenticated connections are processed by the Content Filter agent. This is the default value. @@ -189,7 +205,6 @@ The ExternalMailEnabled parameter specifies whether all messages from unauthenti Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,6 +214,9 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalMailEnabled parameter specifies whether all messages from authenticated connections and from authoritative domains in your enterprise are processed by the Content Filter agent. Valid values are: - $true: Messages from authenticated connections are processed by the Content Filter agent. @@ -208,7 +226,6 @@ The InternalMailEnabled parameter specifies whether all messages from authentica Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -218,6 +235,9 @@ Accept wildcard characters: False ``` ### -OutlookEmailPostmarkValidationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OutlookEmailPostmarkValidationEnabled parameter specifies whether Outlook Email Postmark validation is enabled. - For outbound messages, the Content Filter agent applies a computational postmark header to help destination email systems distinguish legitimate email from spam. @@ -232,7 +252,6 @@ Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -242,13 +261,15 @@ Accept wildcard characters: False ``` ### -QuarantineMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QuarantineMailbox parameter specifies an SMTP address to be used as a spam quarantine mailbox. A spam quarantine mailbox is required when you set the SCLQuarantineEnabled parameter to $true. All messages that meet or exceed the value set in the SCLQuarantineThreshold parameter are sent to the SMTP address that you set in this parameter. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -258,13 +279,15 @@ Accept wildcard characters: False ``` ### -RejectionResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RejectionResponse parameter specifies the message body that you want delivered in the non-delivery report (NDR) to senders whose messages meet or exceed the SCLRejectThreshold value. The RejectionResponse parameter is required if you set the SCLRejectEnabled parameter to $true. The RejectionResponse parameter takes a string. Don't exceed 240 characters in the argument. When you pass an argument, you must enclose the RejectionResponse parameter in quotation marks (") if the phrase contains spaces, for example: "Message rejected". The default setting is Message rejected due to content restrictions. ```yaml Type: AsciiString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -274,6 +297,9 @@ Accept wildcard characters: False ``` ### -SCLDeleteEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SCLDeleteEnabled parameter specifies whether all messages that meet or exceed the value set in the SCLDeleteThreshold parameter are deleted. Valid values are: - $true: Messages that meet or exceed the value set in the SCLDeleteThreshold parameter are deleted. @@ -283,7 +309,6 @@ The SCLDeleteEnabled parameter specifies whether all messages that meet or excee Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +318,15 @@ Accept wildcard characters: False ``` ### -SCLDeleteThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SCLDeleteThreshold parameter specifies an integer value from 1 through 9. This value represents the SCL rating that a particular message must meet or exceed for the Content Filter agent to delete the message and not send an NDR. To enable this functionality, you must set the SCLDeleteEnabled parameter to $true. The default setting is 9. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,6 +336,9 @@ Accept wildcard characters: False ``` ### -SCLQuarantineEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SCLQuarantineEnabled parameter specifies whether all messages that meet or exceed the value set in the SCLQuarantineThreshold parameter are sent to the spam quarantine mailbox specified in the QuarantineMailbox parameter. Valid values are: - $true: Messages that meet or exceed the value set in the SCLQuarantineThreshold parameter are sent to the spam quarantine mailbox specified in the QuarantineMailbox parameter. @@ -318,7 +348,6 @@ The SCLQuarantineEnabled parameter specifies whether all messages that meet or e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -328,13 +357,15 @@ Accept wildcard characters: False ``` ### -SCLQuarantineThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SCLQuarantineThreshold parameter specifies an integer value from 1 through 9. This value represents the SCL rating that a particular message must meet or exceed for the Content Filter agent to quarantine the message. To enable quarantine functionality, you must set the SCLQuarantineEnabled parameter to $true, and provide a valid SMTP address in the QuarantineMailbox parameter. The default setting is 9. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -344,6 +375,9 @@ Accept wildcard characters: False ``` ### -SCLRejectEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SCLRejectEnabled parameter specifies whether all messages that meet or exceed the value set in the SCLRejectThreshold parameter are rejected in an NDR to the sender. Valid values are: - $true: Messages that meet or exceed the value set in the SCLRejectThreshold parameter are rejected in an NDR is to the sender. @@ -353,7 +387,6 @@ The SCLRejectEnabled parameter specifies whether all messages that meet or excee Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -363,13 +396,15 @@ Accept wildcard characters: False ``` ### -SCLRejectThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SCLRejectThreshold parameter specifies an integer value from 1 through 9. This value represents the SCL rating that a particular message must meet or exceed for the Content Filter agent to reject the message and send an NDR to the sender. To enable the delete functionality, you must set the SCLDeleteEnabled parameter to $true. Also, you can revise the default NDR message by editing the RejectionResponse parameter. The default setting is 7. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -379,13 +414,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DataClassification.md b/exchange/exchange-ps/ExchangePowerShell/Set-DataClassification.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-DataClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DataClassification.md index a31254e845..adc832cfbe 100644 --- a/exchange/exchange-ps/exchange/Set-DataClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DataClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dataclassification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-DataClassification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dataclassification +schema: 2.0.0 +title: Set-DataClassification --- # Set-DataClassification @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [Set-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. +In Exchange Online, this cmdlet has been replaced by the [Set-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the Set-DataClassification cmdlet to modify data classification rules that use document fingerprints. @@ -93,6 +94,9 @@ The first three commands return the list of document fingerprints in the data cl ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the data classification rule that you want to modify. You can use any value that uniquely identifies the data classification rule. For example: - Name @@ -103,7 +107,6 @@ The Identity parameter specifies the data classification rule that you want to m Type: DataClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -122,7 +128,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -132,13 +137,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Description parameter specifies a description for the data classification rule. You use the Description parameter with the Locale and Name parameters to specify descriptions for the data classification rule in different languages. The localized values of Description appear in the AllLocalizedDescriptions property of the data classification rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -148,13 +155,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,13 +173,15 @@ Accept wildcard characters: False ``` ### -Fingerprints -The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the data classification rule. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing data classification rule, see the Examples section. + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the data classification rule. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-fingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing data classification rule, see the Examples section. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,6 +191,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault switch is used with the Locale parameter to specify the default language for the data classification rule. You don't need to specify a value with this switch. The default Locale value is stored in the DefaultCulture property. @@ -190,7 +204,6 @@ When you change the default Locale value, the Name value of the data classificat Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -200,6 +213,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Locale parameter adds or removes languages that are associated with the data classification rule. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -210,7 +226,6 @@ Typically, you use the Locale parameter with the Name and Description parameters Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -220,6 +235,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a name for the data classification rule. The value must be less than 256 characters. You use the Name parameter with the Locale and Description parameters to specify names for the data classification rule in different languages. The localized values of Name appear in the AllLocalizedNames property of the data classification rule. @@ -230,7 +248,6 @@ The value of the Name parameter is used in the Policy Tip that's presented to us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -240,13 +257,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DataEncryptionPolicy.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DataEncryptionPolicy.md index 729b74f9f7..12b4c81f90 100644 --- a/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DataEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dataencryptionpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-DataEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dataencryptionpolicy +schema: 2.0.0 +title: Set-DataEncryptionPolicy --- # Set-DataEncryptionPolicy @@ -82,6 +83,9 @@ This example updates the data encryption policy named Europe Mailboxes after one ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the data encryption policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -92,7 +96,6 @@ The Identity parameter specifies the data encryption policy that you want to mod Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -102,15 +105,17 @@ Accept wildcard characters: False ``` ### -PermanentDataPurgeContact + +> Applicable: Exchange Online, Exchange Online Protection + The PermanentDataPurgeContact parameter specifies a contact for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks. You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeReason parameters. ```yaml Type: String -Parameter Sets: TenantAdminPurgeKeyRequest +Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -119,20 +124,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: DCAdminPurgeKeyRequest -Aliases: -Applicable: Exchange Online, Exchange Online Protection +### -PermanentDataPurgeReason -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online, Exchange Online Protection -### -PermanentDataPurgeReason The PermanentDataPurgeReason parameter specifies a descriptive reason for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks. You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeContact parameters. @@ -141,7 +136,6 @@ You need to use this parameter with the PermanentDataPurgeRequested and Permanen Type: String Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -151,6 +145,9 @@ Accept wildcard characters: False ``` ### -PermanentDataPurgeRequested + +> Applicable: Exchange Online, Exchange Online Protection + The PermanentDataPurgeRequested switch specifies whether to initiate the deletion of all data that's encrypted by the data encryption policy. You don't need to specify a value with this switch. You need to use this switch with the PermanentDataPurgeReason and PermanentDataPurgeContact parameters. @@ -161,7 +158,6 @@ After you use this switch, you can't assign the data encryption policy to other Type: SwitchParameter Parameter Sets: TenantAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -171,13 +167,15 @@ Accept wildcard characters: False ``` ### -Refresh + +> Applicable: Exchange Online + Use the Refresh switch to update the data encryption policy in Exchange Online after you rotate any of the associated keys in the Azure Key Vault. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: RefreshKey Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -187,6 +185,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -198,7 +199,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,13 +208,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online + The Description parameter specifies an optional description for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -224,13 +226,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -240,6 +244,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter enables or disable the data encryption policy. Valid values are: - $true: The policy is enabled. @@ -249,7 +256,6 @@ The Enabled parameter enables or disable the data encryption policy. Valid value Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -259,6 +265,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to delete all data that's encrypted by the data encryption policy (the PermanentDataPurgeRequested switch), but the associated Azure Key Vault has also been deleted. @@ -267,7 +276,6 @@ Use this switch to delete all data that's encrypted by the data encryption polic Type: SwitchParameter Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -277,13 +285,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -293,13 +303,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroup.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroup.md index d5e6a1b952..9d95637c81 100644 --- a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-DatabaseAvailabilityGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-databaseavailabilitygroup +schema: 2.0.0 +title: Set-DatabaseAvailabilityGroup --- # Set-DatabaseAvailabilityGroup @@ -133,13 +134,15 @@ This example configures the DAG DAG1 for AutoReseed using custom mount point pat ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the DAG that you want to modify. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -149,13 +152,15 @@ Accept wildcard characters: False ``` ### -ActivityState + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ActivityStateOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,13 +170,15 @@ Accept wildcard characters: False ``` ### -AllowCrossSiteRpcClientAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +188,15 @@ Accept wildcard characters: False ``` ### -AlternateWitnessDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AlternateWitnessDirectory parameter specifies the name of an alternate directory that's used to store file share witness data. The specified directory must not be in use by any other DAGs or used for any other purpose. This parameter is used only as part of a datacenter switchover process. If the DAG is extended across multiple datacenters in a site resilience configuration, we recommend preconfiguring the alternate witness server and directory. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,13 +206,15 @@ Accept wildcard characters: False ``` ### -AlternateWitnessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AlternateWitnessServer parameter specifies the name of an alternate server that's used to store file share witness data. The specified server must not be a member of the DAG that's configured to use it. This parameter is used only as part of a datacenter switchover process. If the DAG is extended across multiple datacenters in a site resilience configuration, we recommend preconfiguring the alternate witness server and directory. ```yaml Type: FileShareWitnessServerName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -213,13 +224,15 @@ Accept wildcard characters: False ``` ### -AutoDagAllServersInstalled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -229,13 +242,15 @@ Accept wildcard characters: False ``` ### -AutoDagAutoRedistributeEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The AutoDagAutoRedistributeEnabled parameter specifies whether automatic DAG redistribution is enabled or disabled during AutoReseed. The default value is $true (enabled). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,13 +260,15 @@ Accept wildcard characters: False ``` ### -AutoDagAutoReseedEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDagAutoReseedEnabled is used to enable or disable Autoreseed. The default value is $true (enabled). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,13 +278,15 @@ Accept wildcard characters: False ``` ### -AutoDagBitlockerEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDagBitlockerEnabled parameter ensures that Disk Reclaimer handles spare disks correctly and encrypts them with BitLocker. If Bitlocker is used to encrypt database disks, set the value of this parameter to $true on all Mailbox servers in the DAG after they are all running Exchange 2013 CU13 or later, or Exchange 2016 CU2 or later. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,13 +296,15 @@ Accept wildcard characters: False ``` ### -AutoDagDatabaseCopiesPerDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +314,15 @@ Accept wildcard characters: False ``` ### -AutoDagDatabaseCopiesPerVolume + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDagDatabaseCopiesPerVolume parameter is used to specify the configured number of database copies per volume. This parameter is used only with AutoReseed. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,13 +332,15 @@ Accept wildcard characters: False ``` ### -AutoDagDatabasesRootFolderPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDagDatabasesRootFolderPath parameter specifies the directory containing the database mount points when using AutoReseed. This parameter is required when using AutoReseed. AutoReseed uses a default path of C:\\ExchangeDatabases. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,13 +350,15 @@ Accept wildcard characters: False ``` ### -AutoDagDiskReclaimerEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDagDiskReclaimerEnabled is used to enable or disable the volume formatting functions used by Autoreseed. The default value is $true (enabled). If you set this to $false, you will need to manually format the volume before the database(s) can be reseeded. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -341,13 +368,15 @@ Accept wildcard characters: False ``` ### -AutoDagTotalNumberOfDatabases + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,13 +386,15 @@ Accept wildcard characters: False ``` ### -AutoDagTotalNumberOfServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -373,13 +404,15 @@ Accept wildcard characters: False ``` ### -AutoDagVolumesRootFolderPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDagVolumesRootFolderPath parameter specifies the volume containing the mount points for all disks, including spare disks, when using the AutoReseed feature of the DAG. This parameter is required when using AutoReseed. AutoReseed uses a default path of C:\\ExchangeVolumes. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -389,6 +422,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -398,7 +434,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -408,13 +443,15 @@ Accept wildcard characters: False ``` ### -DagConfiguration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: DatabaseAvailabilityGroupConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -424,13 +461,15 @@ Accept wildcard characters: False ``` ### -DatabaseAvailabilityGroupIpAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DatabaseAvailabilityGroupIpAddresses parameter specifies one or more static IP addresses to the DAG when a Mailbox server is added to a DAG. If you omit the DatabaseAvailabilityGroupIpAddresses parameter when creating a DAG, the system attempts to lease one or more IP addresses from a Dynamic Host Configuration Protocol (DHCP) server in your organization to assign to the DAG. You must specify this parameter each time an additional IP address is added to the DAG, such as in the case of multi-subnet DAGs. You must also specify all IP addresses previously assigned to the DAG each time the DatabaseAvailabilityGroupIpAddresses parameter is used. Setting the DatabaseAvailabilityGroupIpAddresses parameter to a value of 0.0.0.0 automatically configures the DAG to use DHCP. ```yaml Type: IPAddress[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -440,6 +479,9 @@ Accept wildcard characters: False ``` ### -DatacenterActivationMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DatacenterActivationMode parameter specifies the datacenter activation mode for the DAG. Valid values are: - Off: Datacenter activation mode is disabled. @@ -449,7 +491,6 @@ The DatacenterActivationMode parameter specifies the datacenter activation mode Type: DatacenterActivationModeOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -459,6 +500,9 @@ Accept wildcard characters: False ``` ### -DiscoverNetworks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoverNetworks switch specifies whether to force a rediscovery of the network and network interfaces. You don't need to specify a value with this switch. By default, internal network heartbeats are sent between DAG members on the same subnet. If there's no response to the heartbeats, network discovery is performed automatically by the system. If you add or remove networks or change DAG network subnets, you can force rediscovery of all DAG networks by using the DiscoverNetworks switch. @@ -467,7 +511,6 @@ By default, internal network heartbeats are sent between DAG members on the same Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -477,13 +520,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -493,6 +538,9 @@ Accept wildcard characters: False ``` ### -FileSystem + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The FileSystem parameter specifies the file system that's used for the DAG. Valid values are: - NTFS @@ -502,7 +550,6 @@ The FileSystem parameter specifies the file system that's used for the DAG. Vali Type: FileSystemMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -512,13 +559,15 @@ Accept wildcard characters: False ``` ### -ManualDagNetworkConfiguration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ManualDagNetworkConfiguration parameter specifies whether DAG networks should be automatically configured. If this parameter is set to $false, DAG networks are automatically configured. If this parameter is set to $true, you must manually configure DAG networks. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -528,13 +577,15 @@ Accept wildcard characters: False ``` ### -MetaCacheDatabaseVolumesPerServer + +> Applicable: Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -544,6 +595,9 @@ Accept wildcard characters: False ``` ### -NetworkCompression + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The NetworkCompression parameter specifies the network compression option for the DAG. Valid values are: - Disabled: Network compression is disabled on all networks. @@ -555,7 +609,6 @@ The NetworkCompression parameter specifies the network compression option for th Type: NetworkOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -565,6 +618,9 @@ Accept wildcard characters: False ``` ### -NetworkEncryption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The NetworkEncryption parameter specifies the network encryption option for the DAG. Valid values are: - Disabled: Network encryption is disabled on all networks. @@ -576,7 +632,6 @@ The NetworkEncryption parameter specifies the network encryption option for the Type: NetworkOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -586,6 +641,9 @@ Accept wildcard characters: False ``` ### -PreferenceMoveFrequency + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The PreferenceMoveFrequency parameter specifies how frequently the Microsoft Exchange Replication service inspects and automatically rebalances the database copies. If the most preferred database copy (ActivationPreference value of 1) isn't the active copy, the most preferred database copy is activated by performing a lossless switchover. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -598,7 +656,6 @@ The default value is 01:00:00 (1 hour). To disable this feature, specify the val Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -608,13 +665,15 @@ Accept wildcard characters: False ``` ### -ReplayLagManagerEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReplayLagManagerEnabled parameter specifies whether to disable the automatic playdown of log files for a lagged database copy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -624,13 +683,15 @@ Accept wildcard characters: False ``` ### -ReplicationPort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReplicationPort parameter specifies a Transmission Control Protocol (TCP) port for replication (log shipping and seeding) activity. If this parameter isn't specified, the default port for replication is TCP 64327. ```yaml Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -640,13 +701,15 @@ Accept wildcard characters: False ``` ### -SkipDagValidation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when configuring the DAG. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -656,13 +719,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -672,13 +737,15 @@ Accept wildcard characters: False ``` ### -WitnessDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WitnessDirectory parameter specifies the name of the directory on the server that's used to store file share witness data. The specified directory must not be in use by any other DAGs. ```yaml Type: NonRootLocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -688,13 +755,15 @@ Accept wildcard characters: False ``` ### -WitnessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WitnessServer parameter specifies the name of a server that will act as a witness for the DAG. The server specified can't be a member of the DAG. ```yaml Type: FileShareWitnessServerName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroupNetwork.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroupNetwork.md index 1cf2e33f62..12e8a3b755 100644 --- a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DatabaseAvailabilityGroupNetwork.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-databaseavailabilitygroupnetwork applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-DatabaseAvailabilityGroupNetwork -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-databaseavailabilitygroupnetwork +schema: 2.0.0 +title: Set-DatabaseAvailabilityGroupNetwork --- # Set-DatabaseAvailabilityGroupNetwork @@ -57,13 +58,15 @@ This example disables the DAG network DAGNetwork02 in the DAG DAG2 for replicati ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the DAG network being configured. ```yaml Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Description parameter specifies an optional description for the DAG network. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,13 +133,15 @@ Accept wildcard characters: False ``` ### -IgnoreNetwork + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreNetwork parameter indicates that the specified network should be ignored and not used by the DAG. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter provides a name for the DAG network. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +169,15 @@ Accept wildcard characters: False ``` ### -ReplicationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReplicationEnabled parameter specifies whether the network can be used for replication activity. If this parameter isn't specified, the default behavior is to enable the network for replication. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +187,15 @@ Accept wildcard characters: False ``` ### -Subnets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Subnets parameter specifies one or more subnets that are associated with the DAG network. ```yaml Type: DatabaseAvailabilityGroupSubnetId[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantBriefingConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantBriefingConfig.md index 82ecf059aa..02455e250f 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantBriefingConfig.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig applicable: Exchange Online -title: Set-DefaultTenantBriefingConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-defaulttenantbriefingconfig +schema: 2.0.0 +title: Set-DefaultTenantBriefingConfig --- # Set-DefaultTenantBriefingConfig @@ -53,6 +53,9 @@ This example sets the default Briefing email configuration for the organization ## PARAMETERS ### -IsEnabledByDefault + +> Applicable: Exchange Online + The IsEnabledByDefault parameter specifies the default Briefing email configuration for the organization. Valid values are: - Opt-in: By default, all users in the organization are subscribed to receive the Briefing email. @@ -69,7 +72,6 @@ This setting does not affect users who've already updated their user settings to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -79,13 +81,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantMyAnalyticsFeatureConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 9c1ba06bb4..4bbfbdba3d 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig applicable: Exchange Online -title: Set-DefaultTenantMyAnalyticsFeatureConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-defaulttenantmyanalyticsfeatureconfig +schema: 2.0.0 +title: Set-DefaultTenantMyAnalyticsFeatureConfig --- # Set-DefaultTenantMyAnalyticsFeatureConfig @@ -70,6 +70,9 @@ This example sets the meeting effectiveness survey sampling rate to 20%. ## PARAMETERS ### -Feature + +> Applicable: Exchange Online + The Feature parameter specifies the Viva Insights feature to enable or disable. Valid values are: - Add-in @@ -85,7 +88,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: Dashboard, Add-in, Digest-email, Meeting-effectiveness-survey, Scheduled-send, All -Applicable: Exchange Online Required: False Position: Named @@ -95,6 +97,9 @@ Accept wildcard characters: False ``` ### -IsEnabled + +> Applicable: Exchange Online + The IsEnabled parameter enables or disables the Viva Insights feature specified by the Feature parameter. Valid values are: - $true: The feature is enabled. @@ -104,7 +109,6 @@ The IsEnabled parameter enables or disables the Viva Insights feature specified Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -114,13 +118,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,6 +136,9 @@ Accept wildcard characters: False ``` ### -SamplingRate + +> Applicable: Exchange Online + This parameter is available only in version 3.2.0 or later. The SamplingRate parameter specifies the meeting effectiveness survey sampling rate. The percentage value is expressed a a decimal (for example, 0.1 indicates 10%). A valid value is from 0.1 to 0.7. @@ -138,7 +147,6 @@ The SamplingRate parameter specifies the meeting effectiveness survey sampling r Type: Double Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeliveryAgentConnector.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeliveryAgentConnector.md index e1280caf99..3c06a255d6 100644 --- a/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeliveryAgentConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-deliveryagentconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-DeliveryAgentConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-deliveryagentconnector +schema: 2.0.0 +title: Set-DeliveryAgentConnector --- # Set-DeliveryAgentConnector @@ -73,13 +74,15 @@ This example uses the temporary variable $ConnectorConfig to add the address spa ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the GUID or name of the delivery agent connector. ```yaml Type: DeliveryAgentConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AddressSpaces parameter specifies the domain names that the delivery agent connector is responsible for. The complete syntax for entering an address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. Enclose each address space in quotation marks ("). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -130,7 +140,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -DeliveryProtocol + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -164,7 +178,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the delivery agent connector is enabled. The default value is $true. @@ -182,7 +198,6 @@ The default value is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,6 +207,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -200,7 +218,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +227,9 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. If the value of this parameter is $false, the connector can be used by all Mailbox servers in your organization. If the value of this parameter is $true, the connector can only be used by Mailbox servers in the same Active Directory site. The default value is $false. @@ -218,7 +238,6 @@ The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +247,9 @@ Accept wildcard characters: False ``` ### -MaxConcurrentConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConcurrentConnections parameter specifies the maximum number of concurrent connections this connector accepts from a specific IP address. The default value is 5. @@ -236,7 +258,6 @@ The default value is 5. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,6 +267,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxMessageSize parameter specifies the maximum size of a message that's allowed to pass through this connector. When you enter a value, qualify the value with one of the following units: - B (bytes) @@ -261,7 +285,6 @@ The default value is unlimited. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -271,6 +294,9 @@ Accept wildcard characters: False ``` ### -MaxMessagesPerConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxMessagesPerConnection parameter specifies the maximum number of messages this connector accepts per connection. The connector terminates the connection after this limit is reached and the sending server has to initiate a new connection to send more messages. The default value is 20. @@ -279,7 +305,6 @@ The default value is 20. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,13 +314,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -305,6 +332,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceTransportServers parameter specifies the list of Mailbox servers that host this connector. You can specify more than one server by separating their names with commas. By default, only the local server on which the command is executed is added to this parameter. @@ -313,7 +343,6 @@ By default, only the local server on which the command is executed is added to t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -323,13 +352,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DetailsTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Set-DetailsTemplate.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-DetailsTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DetailsTemplate.md index dfeb2f1c61..248527df63 100644 --- a/exchange/exchange-ps/exchange/Set-DetailsTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DetailsTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-detailstemplate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-DetailsTemplate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-detailstemplate +schema: 2.0.0 +title: Set-DetailsTemplate --- # Set-DetailsTemplate @@ -44,6 +45,9 @@ This example sets attributes for the User details template for the U.S. English ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the details template using a GUID or specifies a template type and language separated by a slash. The following is an example of the user template type and U.S. English language: en-us\\User. Details template types include: - User @@ -57,7 +61,6 @@ The Identity parameter specifies the details template using a GUID or specifies Type: DetailsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -Pages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessPolicy.md index 0bbba58e9e..5e4ae5fe94 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconditionalaccesspolicy applicable: Security & Compliance -title: Set-DeviceConditionalAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-deviceconditionalaccesspolicy +schema: 2.0.0 +title: Set-DeviceConditionalAccessPolicy --- # Set-DeviceConditionalAccessPolicy @@ -64,6 +65,9 @@ This example disables the existing mobile device conditional access policy named ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device conditional access policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the mobile device conditional access policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -125,7 +135,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -144,7 +156,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -162,7 +176,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessRule.md index f9e793ed4e..2bf094221a 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConditionalAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconditionalaccessrule applicable: Security & Compliance -title: Set-DeviceConditionalAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-deviceconditionalaccessrule +schema: 2.0.0 +title: Set-DeviceConditionalAccessRule --- # Set-DeviceConditionalAccessRule @@ -100,13 +101,15 @@ This example modifies the specified mobile device conditional access rule to blo ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device conditional access rule that you want to modify. The name of the rule uses the syntax `{}`. For example, `Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}`. You can find the name value by running the command: Get-DeviceConfigurationRule | Format-List Name. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -116,6 +119,9 @@ Accept wildcard characters: False ``` ### -TargetGroups + +> Applicable: Security & Compliance + The TargetGroups parameter specifies the security groups that this rule applies to. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. You can specify multiple groups separated by commas. @@ -124,7 +130,6 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -134,6 +139,9 @@ Accept wildcard characters: False ``` ### -AccountName + +> Applicable: Security & Compliance + The AccountName parameter specifies the account name. Valid values for this parameter are: - A text value. @@ -143,7 +151,6 @@ The AccountName parameter specifies the account name. Valid values for this para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -153,6 +160,9 @@ Accept wildcard characters: False ``` ### -AccountUserName + +> Applicable: Security & Compliance + The AccountUserName parameter specifies the account user name. Valid values for this parameter are: - A text value. @@ -162,7 +172,6 @@ The AccountUserName parameter specifies the account user name. Valid values for Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,6 +181,9 @@ Accept wildcard characters: False ``` ### -AllowAppStore + +> Applicable: Security & Compliance + The AllowAppStore parameter specifies whether to allow access to the app store on devices. Valid values for this parameter are: - $true: Access to the app store is allowed. @@ -187,7 +199,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -197,6 +208,9 @@ Accept wildcard characters: False ``` ### -AllowAssistantWhileLocked + +> Applicable: Security & Compliance + The AllowAssistantWhileLocked parameter specifies whether to allow the use of the voice assistant while devices are locked. Valid values for this parameter are: - $true: The voice assistant can be used while devices are locked. @@ -209,7 +223,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -219,6 +232,9 @@ Accept wildcard characters: False ``` ### -AllowConvenienceLogon + +> Applicable: Security & Compliance + The AllowConvenienceLogon parameter specifies whether to allow convenience logons on devices. Valid values for this parameter are: - $true: Convenience logons are allowed. @@ -231,7 +247,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -241,6 +256,9 @@ Accept wildcard characters: False ``` ### -AllowDiagnosticSubmission + +> Applicable: Security & Compliance + The AllowDiagnosticSubmission parameter specifies whether to allow diagnostic submissions from devices. Valid values for this parameter are: - $true: Diagnostic submissions are allowed. @@ -257,7 +275,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -267,6 +284,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudBackup + +> Applicable: Security & Compliance + The AllowiCloudBackup parameter specifies whether to allow Apple iCloud Backup from devices. Valid values for this parameter are: - $true: iCloud Backup is allowed. @@ -282,7 +302,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -292,6 +311,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudDocSync + +> Applicable: Security & Compliance + The AllowiCloudDocSync parameter specifies whether to allow Apple iCloud Documents & Data sync on devices. Valid values for this parameter are: - $true: iCloud Documents & Data sync is allowed. @@ -307,7 +329,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -317,6 +338,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudPhotoSync + +> Applicable: Security & Compliance + The AllowiCloudPhotoSync parameter specifies whether to allow Apple iCloud Photos sync on devices. Valid values for this parameter are: - $true: iCloud Photos sync is allowed. @@ -332,7 +356,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -342,6 +365,9 @@ Accept wildcard characters: False ``` ### -AllowJailbroken + +> Applicable: Security & Compliance + The AllowJailbroken parameter specifies whether to allow access to your organization by jailbroken or rooted devices. - $true: Jailbroken devices are allowed. @@ -357,7 +383,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -367,6 +392,9 @@ Accept wildcard characters: False ``` ### -AllowPassbookWhileLocked + +> Applicable: Security & Compliance + The AllowPassbookWhileLocked parameter specifies whether to allow the use of Apple Passbook while devices are locked. Valid values for this parameter are: - $true: Passbook is available while devices are locked. @@ -379,7 +407,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -389,6 +416,9 @@ Accept wildcard characters: False ``` ### -AllowScreenshot + +> Applicable: Security & Compliance + The AllowScreenshot parameter specifies whether to allow screenshots on devices. Valid values for this parameter are: - $true: Screenshots are allowed. @@ -404,7 +434,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -414,6 +443,9 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Security & Compliance + The AllowSimplePassword parameter specifies whether to allow simple or non-complex passwords on devices. Valid values for this parameter are: - $true: Simple passwords are allowed. @@ -430,7 +462,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -440,6 +471,9 @@ Accept wildcard characters: False ``` ### -AllowVideoConferencing + +> Applicable: Security & Compliance + The AllowVideoConferencing parameter specifies whether to allow video conferencing on devices. Valid values for this parameter are: - $true: Video conferencing is allowed. @@ -452,7 +486,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -462,6 +495,9 @@ Accept wildcard characters: False ``` ### -AllowVoiceAssistant + +> Applicable: Security & Compliance + The AllowVoiceAssistant parameter specifies whether to allow using the voice assistant on devices. Valid values for this parameter are: - $true: The voice assistant is allowed. @@ -474,7 +510,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -484,6 +519,9 @@ Accept wildcard characters: False ``` ### -AllowVoiceDialing + +> Applicable: Security & Compliance + The AllowVoiceDialing parameter specifies whether to allow voice-activated telephone dialing. Valid values for this parameter are: - $true: Voice dialing is allowed. @@ -496,7 +534,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -506,6 +543,9 @@ Accept wildcard characters: False ``` ### -AntiVirusSignatureStatus + +> Applicable: Security & Compliance + The AntiVirusSignatureStatus parameter specifies the antivirus signature status. Valid values for this parameter are: - An integer. @@ -517,7 +557,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -527,6 +566,9 @@ Accept wildcard characters: False ``` ### -AntiVirusStatus + +> Applicable: Security & Compliance + The AntiVirusStatus parameter specifies antivirus status. Valid values for this parameter are: - An integer. @@ -538,7 +580,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -548,6 +589,9 @@ Accept wildcard characters: False ``` ### -AppsRating + +> Applicable: Security & Compliance + The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - AllowAll @@ -563,7 +607,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -573,6 +616,9 @@ Accept wildcard characters: False ``` ### -AutoUpdateStatus + +> Applicable: Security & Compliance + The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - AutomaticCheckForUpdates @@ -588,7 +634,6 @@ This setting is available only on Windows 8.1 RT devices. Type: CAAutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -598,6 +643,9 @@ Accept wildcard characters: False ``` ### -BluetoothEnabled + +> Applicable: Security & Compliance + The BluetoothEnabled parameter specifies whether to enable or disable Bluetooth on devices. Valid values for this parameter are: - $true: Bluetooth is enabled. @@ -610,7 +658,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -620,6 +667,9 @@ Accept wildcard characters: False ``` ### -CameraEnabled + +> Applicable: Security & Compliance + The CameraEnabled parameter specifies whether to enable or disable cameras on devices. Valid values for this parameter are: - $true: Cameras are enabled. @@ -636,7 +686,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -646,6 +695,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -655,7 +707,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -665,13 +716,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -681,6 +734,9 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Security & Compliance + The EmailAddress parameter specifies the email address. Valid values are: - An email address: For example, julia@contoso.com. @@ -690,7 +746,6 @@ The EmailAddress parameter specifies the email address. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -700,6 +755,9 @@ Accept wildcard characters: False ``` ### -EnableRemovableStorage + +> Applicable: Security & Compliance + The EnableRemovableStorage parameter specifies whether removable storage can be used by devices. Valid values for this parameter are: - $true: Removable storage can be used. @@ -712,7 +770,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -722,6 +779,9 @@ Accept wildcard characters: False ``` ### -ExchangeActiveSyncHost + +> Applicable: Security & Compliance + The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Valid values for this parameter are: - A text value. @@ -731,7 +791,6 @@ The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Val Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -741,6 +800,9 @@ Accept wildcard characters: False ``` ### -FirewallStatus + +> Applicable: Security & Compliance + The FirewallStatus parameter specifies the acceptable firewall status values on devices. Valid values for this parameter are: - Required @@ -752,7 +814,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -762,6 +823,9 @@ Accept wildcard characters: False ``` ### -ForceAppStorePassword + +> Applicable: Security & Compliance + The ForceAppStorePassword parameter specifies whether to require a password to use the app store on devices. Valid values for this parameter are: - $true: App store passwords are required. @@ -774,7 +838,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -784,6 +847,9 @@ Accept wildcard characters: False ``` ### -ForceEncryptedBackup + +> Applicable: Security & Compliance + The ForceEncryptedBackup parameter specifies whether to force encrypted backups for devices. Valid values for this parameter are: - $true: Encrypted backups are required. @@ -799,7 +865,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -809,6 +874,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordAttemptsBeforeWipe + +> Applicable: Security & Compliance + The MaxPasswordAttemptsBeforeWipe parameter specifies the number of incorrect password attempts that cause devices to be automatically wiped. Valid values for this parameter are: - An integer. @@ -825,7 +893,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -835,6 +902,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordGracePeriod + +> Applicable: Security & Compliance + The MaxPasswordGracePeriod parameter specifies the length of time users are allowed to reset expired passwords on devices. This setting is available only on Apple iOS 6+ devices. @@ -845,7 +915,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -855,6 +924,9 @@ Accept wildcard characters: False ``` ### -MoviesRating + +> Applicable: Security & Compliance + The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: @@ -945,7 +1017,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -955,6 +1026,9 @@ Accept wildcard characters: False ``` ### -PasswordComplexity + +> Applicable: Security & Compliance + The PasswordComplexity parameter specifies the password complexity. Valid values for this parameter are: - An integer. @@ -964,7 +1038,6 @@ The PasswordComplexity parameter specifies the password complexity. Valid values Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -974,6 +1047,9 @@ Accept wildcard characters: False ``` ### -PasswordExpirationDays + +> Applicable: Security & Compliance + The PasswordExpirationDays parameter specifies the number of days that the same password can be used on devices before users are required to change their passwords . Valid values for this parameter are: - An integer. @@ -990,7 +1066,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1000,6 +1075,9 @@ Accept wildcard characters: False ``` ### -PasswordHistoryCount + +> Applicable: Security & Compliance + The PasswordHistoryCount parameter specifies the minimum number of unique new passwords that are required on devices before an old password can be reused. Valid values for this parameter are: - An integer. @@ -1016,7 +1094,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1026,6 +1103,9 @@ Accept wildcard characters: False ``` ### -PasswordMinComplexChars + +> Applicable: Security & Compliance + The PasswordMinComplexChars parameter specifies the minimum number of complex characters that are required for device passwords. A complex character isn't a letter. Valid values for this parameter are: - An integer. @@ -1035,7 +1115,6 @@ The PasswordMinComplexChars parameter specifies the minimum number of complex ch Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1045,6 +1124,9 @@ Accept wildcard characters: False ``` ### -PasswordMinimumLength + +> Applicable: Security & Compliance + The PasswordMinimumLength parameter specifies the minimum number of characters that are required for device passwords. Valid values for this parameter are: - An integer. @@ -1061,7 +1143,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1071,6 +1152,9 @@ Accept wildcard characters: False ``` ### -PasswordQuality + +> Applicable: Security & Compliance + The PasswordQuality parameter specifies the minimum password quality rating that's required for device passwords. Password quality is a numeric scale that indicates the security and complexity of the password. A higher quality value indicates a more secure password. Valid values for this parameter are: @@ -1084,7 +1168,6 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1094,6 +1177,9 @@ Accept wildcard characters: False ``` ### -PasswordRequired + +> Applicable: Security & Compliance + The PasswordRequired parameter specifies whether a password is required to access devices. Valid values for this parameter are: - $true: Device passwords are required. @@ -1110,7 +1196,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1120,6 +1205,9 @@ Accept wildcard characters: False ``` ### -PasswordTimeout + +> Applicable: Security & Compliance + The PasswordTimeout parameter specifies the length of time that devices can be inactive before a password is required to reactivate them. This setting is available on the following types of devices: @@ -1135,7 +1223,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1145,6 +1232,9 @@ Accept wildcard characters: False ``` ### -PhoneMemoryEncrypted + +> Applicable: Security & Compliance + The PhoneMemoryEncrypted parameter specifies whether to encrypt the memory on devices. Valid values for this parameter are: - $true: Memory is encrypted. @@ -1160,7 +1250,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1170,6 +1259,9 @@ Accept wildcard characters: False ``` ### -RegionRatings + +> Applicable: Security & Compliance + The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: @@ -1191,7 +1283,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1201,6 +1292,9 @@ Accept wildcard characters: False ``` ### -RequireEmailProfile + +> Applicable: Security & Compliance + The RequireEmailProfile parameter specifies whether an email profile is required on devices. Valid values for this parameter are: - $true: An email profile is required. This value is required for selective wipe on iOS devices. @@ -1211,7 +1305,6 @@ The RequireEmailProfile parameter specifies whether an email profile is required Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1221,6 +1314,9 @@ Accept wildcard characters: False ``` ### -SmartScreenEnabled + +> Applicable: Security & Compliance + The SmartScreenEnabled parameter specifies whether to requireWindows SmartScreen on devices. Valid values for this parameter are: - $true: SmartScreen is enabled. @@ -1233,7 +1329,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1243,6 +1338,9 @@ Accept wildcard characters: False ``` ### -SystemSecurityTLS + +> Applicable: Security & Compliance + The SystemSecurityTLS parameter specifies whether TLS encryption is used on devices. Valid values for this parameter are: - $true: TLS encryption is used. @@ -1255,7 +1353,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1265,6 +1362,9 @@ Accept wildcard characters: False ``` ### -TVShowsRating + +> Applicable: Security & Compliance + The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: @@ -1344,7 +1444,6 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1354,6 +1453,9 @@ Accept wildcard characters: False ``` ### -UserAccountControlStatus + +> Applicable: Security & Compliance + The UserAccountControlStatus parameter specifies how User Account Control messages are presented on devices. Valid values for this parameter are: - $null (blank): The setting isn't configured. This is the default value. @@ -1368,7 +1470,6 @@ This setting is available only on Windows 8.1 RT devices. Type: CAUserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1378,13 +1479,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -1394,6 +1497,9 @@ Accept wildcard characters: False ``` ### -WLANEnabled + +> Applicable: Security & Compliance + The WLANEnabled parameter specifies whether Wi-Fi is enabled devices. Valid values for this parameter are: - $true: Wi-Fi is enabled. @@ -1406,7 +1512,6 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1416,6 +1521,9 @@ Accept wildcard characters: False ``` ### -WorkFoldersSyncUrl + +> Applicable: Security & Compliance + The WorkFoldersSyncUrl parameter specifies the URL that's used to synchronize company data on devices. Valid input for this parameter a URL. For example, `https://workfolders.contoso.com`. @@ -1426,7 +1534,6 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationPolicy.md index ed19ba795f..4f8b285283 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconfigurationpolicy applicable: Security & Compliance -title: Set-DeviceConfigurationPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-deviceconfigurationpolicy +schema: 2.0.0 +title: Set-DeviceConfigurationPolicy --- # Set-DeviceConfigurationPolicy @@ -64,6 +65,9 @@ This example disables the mobile device configuration policy named Engineering G ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device configuration policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the mobile device configuration policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -125,7 +135,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -144,7 +156,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -162,7 +176,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationRule.md index 3ea511f71e..5495fd17ec 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceConfigurationRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconfigurationrule applicable: Security & Compliance -title: Set-DeviceConfigurationRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-deviceconfigurationrule +schema: 2.0.0 +title: Set-DeviceConfigurationRule --- # Set-DeviceConfigurationRule @@ -99,13 +100,15 @@ This example modifies the specified mobile device configuration rule to block sc ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the mobile device configuration rule that you want to modify. The name of the rule uses the syntax ` Applicable: Security & Compliance + The TargetGroups parameter specifies the security groups that this rule applies to. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. You can specify multiple groups separated by commas. @@ -123,7 +129,6 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -133,6 +138,9 @@ Accept wildcard characters: False ``` ### -AccountName + +> Applicable: Security & Compliance + The AccountName parameter specifies the account name. Valid values for this parameter are: - A text value. @@ -142,7 +150,6 @@ The AccountName parameter specifies the account name. Valid values for this para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -152,6 +159,9 @@ Accept wildcard characters: False ``` ### -AccountUserName + +> Applicable: Security & Compliance + The AccountUserName parameter specifies the account user name. Valid values for this parameter are: - A text value. @@ -161,7 +171,6 @@ The AccountUserName parameter specifies the account user name. Valid values for Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -171,6 +180,9 @@ Accept wildcard characters: False ``` ### -AllowAppStore + +> Applicable: Security & Compliance + The AllowAppStore parameter specifies whether to allow access to the app store on devices. Valid values for this parameter are: - $true: Access to the app store is allowed. @@ -186,7 +198,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -196,6 +207,9 @@ Accept wildcard characters: False ``` ### -AllowAssistantWhileLocked + +> Applicable: Security & Compliance + The AllowAssistantWhileLocked parameter specifies whether to allow the use of the voice assistant while devices are locked. Valid values for this parameter are: - $true: The voice assistant can be used while devices are locked. @@ -208,7 +222,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -218,6 +231,9 @@ Accept wildcard characters: False ``` ### -AllowConvenienceLogon + +> Applicable: Security & Compliance + The AllowConvenienceLogon parameter specifies whether to allow convenience logons on devices. Valid values for this parameter are: - $true: Convenience logons are allowed. @@ -230,7 +246,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -240,6 +255,9 @@ Accept wildcard characters: False ``` ### -AllowDiagnosticSubmission + +> Applicable: Security & Compliance + The AllowDiagnosticSubmission parameter specifies whether to allow diagnostic submissions from devices. Valid values for this parameter are: - $true: Diagnostic submissions are allowed. @@ -256,7 +274,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -266,6 +283,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudBackup + +> Applicable: Security & Compliance + The AllowiCloudBackup parameter specifies whether to allow Apple iCloud Backup from devices. Valid values for this parameter are: - $true: iCloud Backup is allowed. @@ -281,7 +301,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -291,6 +310,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudDocSync + +> Applicable: Security & Compliance + The AllowiCloudDocSync parameter specifies whether to allow Apple iCloud Documents & Data sync on devices. Valid values for this parameter are: - $true: iCloud Documents & Data sync is allowed. @@ -306,7 +328,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -316,6 +337,9 @@ Accept wildcard characters: False ``` ### -AllowiCloudPhotoSync + +> Applicable: Security & Compliance + The AllowiCloudPhotoSync parameter specifies whether to allow Apple iCloud Photos sync on devices. Valid values for this parameter are: - $true: iCloud Photos sync is allowed. @@ -331,7 +355,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -341,6 +364,9 @@ Accept wildcard characters: False ``` ### -AllowPassbookWhileLocked + +> Applicable: Security & Compliance + The AllowPassbookWhileLocked parameter specifies whether to allow the use of Apple Passbook while devices are locked. Valid values for this parameter are: - $true: Passbook is available while devices are locked. @@ -353,7 +379,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -363,6 +388,9 @@ Accept wildcard characters: False ``` ### -AllowScreenshot + +> Applicable: Security & Compliance + The AllowScreenshot parameter specifies whether to allow screenshots on devices. Valid values for this parameter are: - $true: Screenshots are allowed. @@ -378,7 +406,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -388,6 +415,9 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Security & Compliance + The AllowSimplePassword parameter specifies whether to allow simple or non-complex passwords on devices. Valid values for this parameter are: - $true: Simple passwords are allowed. @@ -404,7 +434,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -414,6 +443,9 @@ Accept wildcard characters: False ``` ### -AllowVideoConferencing + +> Applicable: Security & Compliance + The AllowVideoConferencing parameter specifies whether to allow video conferencing on devices. Valid values for this parameter are: - $true: Video conferencing is allowed. @@ -426,7 +458,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -436,6 +467,9 @@ Accept wildcard characters: False ``` ### -AllowVoiceAssistant + +> Applicable: Security & Compliance + The AllowVoiceAssistant parameter specifies whether to allow using the voice assistant on devices. Valid values for this parameter are: - $true: The voice assistant is allowed. @@ -448,7 +482,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -458,6 +491,9 @@ Accept wildcard characters: False ``` ### -AllowVoiceDialing + +> Applicable: Security & Compliance + The AllowVoiceDialing parameter specifies whether to allow voice-activated telephone dialing. Valid values for this parameter are: - $true: Voice dialing is allowed. @@ -470,7 +506,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -480,6 +515,9 @@ Accept wildcard characters: False ``` ### -AntiVirusSignatureStatus + +> Applicable: Security & Compliance + The AntiVirusSignatureStatus parameter specifies the antivirus signature status. Valid values for this parameter are: - An integer. @@ -491,7 +529,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -501,6 +538,9 @@ Accept wildcard characters: False ``` ### -AntiVirusStatus + +> Applicable: Security & Compliance + The AntiVirusStatus parameter specifies the antivirus status. Valid values for this parameter are: - An integer. @@ -512,7 +552,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -522,6 +561,9 @@ Accept wildcard characters: False ``` ### -AppsRating + +> Applicable: Security & Compliance + The AppsRating parameter species the maximum or most restrictive rating of apps that are allowed on devices. Valid values for this parameter are: - AllowAll @@ -537,7 +579,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -547,6 +588,9 @@ Accept wildcard characters: False ``` ### -AutoUpdateStatus + +> Applicable: Security & Compliance + The AutoUpdateStatus parameter specifies the update settings for devices. Valid values for this parameter are: - AutomaticCheckForUpdates @@ -562,7 +606,6 @@ This setting is available only on Windows 8.1 RT devices. Type: AutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -572,6 +615,9 @@ Accept wildcard characters: False ``` ### -BluetoothEnabled + +> Applicable: Security & Compliance + The BluetoothEnabled parameter specifies whether to enable or disable Bluetooth on devices. Valid values for this parameter are: - $true: Bluetooth is enabled. @@ -584,7 +630,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -594,6 +639,9 @@ Accept wildcard characters: False ``` ### -CameraEnabled + +> Applicable: Security & Compliance + The CameraEnabled parameter specifies whether to enable or disable cameras on devices. Valid values for this parameter are: - $true: Cameras are enabled. @@ -610,7 +658,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -620,6 +667,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -629,7 +679,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -639,13 +688,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -655,6 +706,9 @@ Accept wildcard characters: False ``` ### -EmailAddress + +> Applicable: Security & Compliance + The EmailAddress parameter specifies the email address. Valid values are: - An email address: For example, julia@contoso.com. @@ -664,7 +718,6 @@ The EmailAddress parameter specifies the email address. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -674,6 +727,9 @@ Accept wildcard characters: False ``` ### -EnableRemovableStorage + +> Applicable: Security & Compliance + The EnableRemovableStorage parameter specifies whether removable storage can be used by devices. Valid values for this parameter are: - $true: Removable storage can be used. @@ -686,7 +742,6 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -696,6 +751,9 @@ Accept wildcard characters: False ``` ### -ExchangeActiveSyncHost + +> Applicable: Security & Compliance + The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Valid values for this parameter are: - A text value. @@ -705,7 +763,6 @@ The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Val Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -715,6 +772,9 @@ Accept wildcard characters: False ``` ### -FirewallStatus + +> Applicable: Security & Compliance + The FirewallStatus parameter specifies the acceptable firewall status values on devices. Valid values for this parameter are: - Required @@ -726,7 +786,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -736,6 +795,9 @@ Accept wildcard characters: False ``` ### -ForceAppStorePassword + +> Applicable: Security & Compliance + The ForceAppStorePassword parameter specifies whether to require a password to use the app store on devices. Valid values for this parameter are: - $true: App store passwords are required. @@ -748,7 +810,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -758,6 +819,9 @@ Accept wildcard characters: False ``` ### -ForceEncryptedBackup + +> Applicable: Security & Compliance + The ForceEncryptedBackup parameter specifies whether to force encrypted backups for devices. Valid values for this parameter are: - $true: Encrypted backups are required. @@ -773,7 +837,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -783,6 +846,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordAttemptsBeforeWipe + +> Applicable: Security & Compliance + The MaxPasswordAttemptsBeforeWipe parameter specifies the number of incorrect password attempts that cause devices to be automatically wiped. Valid values for this parameter are: - An integer. @@ -799,7 +865,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -809,6 +874,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordGracePeriod + +> Applicable: Security & Compliance + The MaxPasswordGracePeriod parameter specifies the length of time users are allowed to reset expired passwords on devices. This setting is available only on Apple iOS 6+ devices. @@ -819,7 +887,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -829,6 +896,9 @@ Accept wildcard characters: False ``` ### -MoviesRating + +> Applicable: Security & Compliance + The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: @@ -919,7 +989,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -929,6 +998,9 @@ Accept wildcard characters: False ``` ### -PasswordComplexity + +> Applicable: Security & Compliance + The PasswordComplexity parameter specifies the password complexity. Valid values for this parameter are: - An integer. @@ -938,7 +1010,6 @@ The PasswordComplexity parameter specifies the password complexity. Valid values Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -948,6 +1019,9 @@ Accept wildcard characters: False ``` ### -PasswordExpirationDays + +> Applicable: Security & Compliance + The PasswordExpirationDays parameter specifies the number of days that the same password can be used on devices before users are required to change their passwords . Valid values for this parameter are: - An integer. @@ -964,7 +1038,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -974,6 +1047,9 @@ Accept wildcard characters: False ``` ### -PasswordHistoryCount + +> Applicable: Security & Compliance + The PasswordHistoryCount parameter specifies the minimum number of unique new passwords that are required on devices before an old password can be reused. Valid values for this parameter are: - An integer. @@ -990,7 +1066,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1000,6 +1075,9 @@ Accept wildcard characters: False ``` ### -PasswordMinComplexChars + +> Applicable: Security & Compliance + The PasswordMinComplexChars parameter specifies the minimum number of complex characters that are required for device passwords. A complex character isn't a letter. Valid values for this parameter are: - An integer. @@ -1009,7 +1087,6 @@ The PasswordMinComplexChars parameter specifies the minimum number of complex ch Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1019,6 +1096,9 @@ Accept wildcard characters: False ``` ### -PasswordMinimumLength + +> Applicable: Security & Compliance + The PasswordMinimumLength parameter specifies the minimum number of characters that are required for device passwords. Valid values for this parameter are: - An integer. @@ -1035,7 +1115,6 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1045,6 +1124,9 @@ Accept wildcard characters: False ``` ### -PasswordQuality + +> Applicable: Security & Compliance + The PasswordQuality parameter specifies the minimum password quality rating that's required for device passwords. Password quality is a numeric scale that indicates the security and complexity of the password. A higher quality value indicates a more secure password. Valid values for this parameter are: @@ -1058,7 +1140,6 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1068,6 +1149,9 @@ Accept wildcard characters: False ``` ### -PasswordRequired + +> Applicable: Security & Compliance + The PasswordRequired parameter specifies whether a password is required to access devices. Valid values for this parameter are: - $true: Device passwords are required. @@ -1084,7 +1168,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1094,6 +1177,9 @@ Accept wildcard characters: False ``` ### -PasswordTimeout + +> Applicable: Security & Compliance + The PasswordTimeout parameter specifies the length of time that devices can be inactive before a password is required to reactivate them. This setting is available on the following types of devices: @@ -1109,7 +1195,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1119,6 +1204,9 @@ Accept wildcard characters: False ``` ### -PhoneMemoryEncrypted + +> Applicable: Security & Compliance + The PhoneMemoryEncrypted parameter specifies whether to encrypt the memory on devices. Valid values for this parameter are: - $true: Memory is encrypted. @@ -1134,7 +1222,6 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1144,6 +1231,9 @@ Accept wildcard characters: False ``` ### -RegionRatings + +> Applicable: Security & Compliance + The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: @@ -1165,7 +1255,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1175,6 +1264,9 @@ Accept wildcard characters: False ``` ### -RequireEmailProfile + +> Applicable: Security & Compliance + The RequireEmailProfile parameter specifies whether an email profile is required on devices. Valid values for this parameter are: - $true: An email profile is required. This value is required for selective wipe on iOS devices. @@ -1185,7 +1277,6 @@ The RequireEmailProfile parameter specifies whether an email profile is required Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1195,6 +1286,9 @@ Accept wildcard characters: False ``` ### -SmartScreenEnabled + +> Applicable: Security & Compliance + The SmartScreenEnabled parameter specifies whether to requireWindows SmartScreen on devices. Valid values for this parameter are: - $true: SmartScreen is enabled. @@ -1207,7 +1301,6 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1217,6 +1310,9 @@ Accept wildcard characters: False ``` ### -SystemSecurityTLS + +> Applicable: Security & Compliance + The SystemSecurityTLS parameter specifies whether TLS encryption is used on devices. Valid values for this parameter are: - $true: TLS encryption is used. @@ -1229,7 +1325,6 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1239,6 +1334,9 @@ Accept wildcard characters: False ``` ### -TVShowsRating + +> Applicable: Security & Compliance + The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: @@ -1318,7 +1416,6 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1328,6 +1425,9 @@ Accept wildcard characters: False ``` ### -UserAccountControlStatus + +> Applicable: Security & Compliance + The UserAccountControlStatus parameter specifies how User Account Control messages are presented on devices. Valid values for this parameter are: - $null (blank): The setting isn't configured. This is the default value. @@ -1342,7 +1442,6 @@ This setting is available only on Windows 8.1 RT devices. Type: UserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1352,13 +1451,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -1368,6 +1469,9 @@ Accept wildcard characters: False ``` ### -WLANEnabled + +> Applicable: Security & Compliance + The WLANEnabled parameter specifies whether Wi-Fi is enabled devices. Valid values for this parameter are: - $true: Wi-Fi is enabled. @@ -1380,7 +1484,6 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1390,6 +1493,9 @@ Accept wildcard characters: False ``` ### -WorkFoldersSyncUrl + +> Applicable: Security & Compliance + The WorkFoldersSyncUrl parameter specifies the URL that's used to synchronize company data on devices. Valid input for this parameter a URL. For example, `https://workfolders.contoso.com`. @@ -1400,7 +1506,6 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantPolicy.md index 4642570323..c5e82785ad 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-devicetenantpolicy applicable: Security & Compliance -title: Set-DeviceTenantPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-devicetenantpolicy +schema: 2.0.0 +title: Set-DeviceTenantPolicy --- # Set-DeviceTenantPolicy @@ -64,13 +65,15 @@ This example disables your organization's mobile device tenant policy. ## PARAMETERS ### -RetryDistribution + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -105,7 +113,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -124,7 +134,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -142,7 +154,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the mobile device tenant policy that you want to modify, but there's only one in your organization. The name of the policy is a GUID value. For example, a6958701-c82c-4064-ac11-64e40e7f4032. You can find this value by running the command: Get-DeviceTenantPolicy | Format-List Name. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-DeviceTenantRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantRule.md index e931196275..d878367c08 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DeviceTenantRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-devicetenantrule applicable: Security & Compliance -title: Set-DeviceTenantRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-devicetenantrule +schema: 2.0.0 +title: Set-DeviceTenantRule --- # Set-DeviceTenantRule @@ -55,13 +56,15 @@ This example modifies your organization's mobile device tenant rule by replacing ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the mobile device tenant rule that you want to modify, but there's only one in your organization. The name of the rule is a GUID. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. You can find the name value by running the command Get-DeviceTenantRule | Format-List Name. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -ApplyPolicyTo + +> Applicable: Security & Compliance + The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: - ExchangeOnline @@ -81,7 +87,6 @@ The ApplyPolicyTo parameter specifies where to apply the policy in your organiza Type: PolicyResourceScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -BlockUnsupportedDevices + +> Applicable: Security & Compliance + The BlockUnsupportedDevices parameter specifies whether to block access to your organization by unsupported devices. Valid values for this parameter are: - $true: Unsupported devices are blocked. @@ -100,7 +108,6 @@ The BlockUnsupportedDevices parameter specifies whether to block access to your Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -119,7 +129,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -145,6 +156,9 @@ Accept wildcard characters: False ``` ### -ExclusionList + +> Applicable: Security & Compliance + The ExclusionList parameter specifies the security groups to exclude from this policy. Members of the specified security groups who have non-compliant devices are not affected by block access actions. This parameter uses the GUID value of the group. To find this GUID value, run the command Get-Group | Format-Table Name,GUID. @@ -155,7 +169,6 @@ To enter multiple values and overwrite any existing entries, use the following s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Set-DistributionGroup.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DistributionGroup.md index 918556255a..0eafe6e2d8 100644 --- a/exchange/exchange-ps/exchange/Set-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-DistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-distributiongroup +schema: 2.0.0 +title: Set-DistributionGroup --- # Set-DistributionGroup @@ -126,6 +127,9 @@ This example changes the name of an existing distribution group from Ed\_DirectR ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name @@ -139,7 +143,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -149,6 +152,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -172,7 +178,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -182,6 +187,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -205,7 +213,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +222,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -240,7 +250,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -250,6 +259,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -274,7 +286,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -284,6 +295,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -303,7 +317,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,6 +326,9 @@ Accept wildcard characters: False ``` ### -BccBlocked + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The BccBlocked parameter specifies whether members of the group don't receive messages if the group is used in the Bcc line. Valid values are: @@ -324,7 +340,6 @@ The BccBlocked parameter specifies whether members of the group don't receive me Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -334,6 +349,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -355,7 +373,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -365,6 +382,9 @@ Accept wildcard characters: False ``` ### -BypassNestedModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ByPassNestedModerationEnabled parameter specifies how to handle message approval when a moderated group contains other moderated groups as members. Valid values are: - $true: After a moderator approves a message sent to the group, the message is automatically approved for all other moderated groups that are members of the group. @@ -374,7 +394,6 @@ The ByPassNestedModerationEnabled parameter specifies how to handle message appr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -384,6 +403,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -395,7 +417,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -405,6 +426,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -414,7 +438,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -424,6 +447,9 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: @@ -435,7 +461,6 @@ The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-fre Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -445,13 +470,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -461,13 +488,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -477,13 +506,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -493,13 +524,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -509,13 +542,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -525,13 +560,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -541,13 +578,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -557,13 +596,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -573,13 +614,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -589,13 +632,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -605,13 +650,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -621,13 +668,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -637,13 +686,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -653,13 +704,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -669,13 +722,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -685,6 +740,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Description parameter specifies an optional description for the distribution group. If the value contains spaces, enclose the value in quotation marks. @@ -693,7 +751,6 @@ The Description parameter specifies an optional description for the distribution Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -703,6 +760,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). If a group naming policy is enforced in your organization, users need to follow the naming constraints as specified by the DistributionGroupNameBlockedWordList parameter on the Set-OrganizationConfig cmdlet. To bypass this requirement, use the IgnoreNamingPolicy switch. @@ -711,7 +771,6 @@ If a group naming policy is enforced in your organization, users need to follow Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -721,6 +780,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -729,7 +791,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -739,6 +800,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -766,7 +830,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -776,6 +839,9 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: @@ -787,7 +853,6 @@ The EmailAddressPolicyEnabled parameter specifies whether to apply email address Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -797,6 +862,9 @@ Accept wildcard characters: False ``` ### -ExpansionServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ExpansionServer parameter specifies the Exchange server that's used to expand the distribution group. The default value is blank ($null), which means expansion happens on the closest available Exchange server. If you specify an expansion server, and that server is unavailable, any messages that are sent to the distribution group can't be delivered. @@ -812,7 +880,6 @@ When you specify an expansion server, use the ExchangeLegacyDN. You can find thi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -822,6 +889,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -834,7 +904,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -844,6 +913,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -856,7 +928,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -866,6 +937,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -878,7 +952,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -888,6 +961,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -900,7 +976,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -910,6 +985,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -922,7 +1000,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -932,13 +1009,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -948,6 +1027,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this group. Although messages send on behalf of the group clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the group, not the sender. The sender you specify for this parameter must a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the sender. For example: @@ -973,7 +1055,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -983,6 +1064,9 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. @@ -992,7 +1076,6 @@ The HiddenFromAddressListsEnabled parameter specifies whether this recipient is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1002,6 +1085,9 @@ Accept wildcard characters: False ``` ### -HiddenGroupMembershipEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the distribution group from users who aren't members of the group. You don't need to specify a value with this switch. @@ -1014,7 +1100,6 @@ You can use this setting to help comply with regulations that require you to hid Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1024,6 +1109,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -1037,7 +1125,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1047,6 +1134,9 @@ Accept wildcard characters: False ``` ### -IgnoreNamingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The IgnoreNamingPolicy switch specifies whether to prevent this group from being affected by your organization's group naming policy. You don't need to specify a value with this switch. The group naming policy is defined by the DistributionGroupNamingPolicy and DistributionGroupNameBlockedWordList parameters on the Set-OrganizationConfig cmdlet. @@ -1055,7 +1145,6 @@ The group naming policy is defined by the DistributionGroupNamingPolicy and Dist Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1065,6 +1154,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -1076,7 +1168,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1086,6 +1177,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -1100,7 +1194,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1110,6 +1203,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies an owner for the group. A group must have at least one owner. If you don't use this parameter to specify the owner when you create the group, the user account that created the group is the owner. The group owner is able to: - Modify the properties of the group @@ -1148,7 +1244,6 @@ Owners that you specify with this parameter are not added as group members. You Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1158,6 +1253,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxReceiveSize parameter specifies the maximum size of an email message that can be sent to this group. Messages that exceed the maximum size are rejected by the group. @@ -1179,7 +1277,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1189,6 +1286,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxSendSize parameter specifies the maximum size of an email message that can be sent by this group. @@ -1210,7 +1310,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1220,6 +1319,9 @@ Accept wildcard characters: False ``` ### -MemberDepartRestriction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MemberDepartRestriction parameter specifies the restrictions that you put on requests to leave the group. Valid values are: - Open: Members can leave the group without approval from one of the group owners. This is the default value for universal distribution groups. You can't use this value on universal security groups. @@ -1229,7 +1331,6 @@ The MemberDepartRestriction parameter specifies the restrictions that you put on Type: MemberUpdateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1239,6 +1340,9 @@ Accept wildcard characters: False ``` ### -MemberJoinRestriction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MemberJoinRestriction parameter specifies the restrictions that you put on requests to join the group. Valid values are: - Open: Users can add themselves to the group without approval from a group owner. You can't use this value on universal security groups. @@ -1249,7 +1353,6 @@ The MemberJoinRestriction parameter specifies the restrictions that you put on r Type: MemberUpdateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1259,6 +1362,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1280,7 +1386,6 @@ For distribution groups, if you set the ModerationEnabled parameter to the value Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1290,6 +1395,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -1301,7 +1409,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1311,13 +1418,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the group. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1327,6 +1436,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the group are no longer automatically updated by email address policies. @@ -1337,7 +1449,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1347,6 +1458,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1370,7 +1484,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1380,6 +1493,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1403,7 +1519,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1413,6 +1528,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1438,7 +1556,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1448,6 +1565,9 @@ Accept wildcard characters: False ``` ### -ReportToManagerEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ReportToManagerEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the owner (first one listed if more than one) of the group (defined by the ManagedBy property). Valid values are: - $true: Delivery status notifications are sent to the owner (first one listed if more than one) of the group. @@ -1459,7 +1579,6 @@ The ReportToManagerEnabled and ReportToOriginatorEnabled parameters affect the r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1469,6 +1588,9 @@ Accept wildcard characters: False ``` ### -ReportToOriginatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ReportToOriginatorEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to senders who send messages to this group. Valid values are: - $true: Delivery status notifications are sent to the message senders. This is the default value. @@ -1480,7 +1602,6 @@ The ReportToManagerEnabled and ReportToOriginatorEnabled parameters affect the r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1490,6 +1611,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1499,7 +1623,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1509,6 +1632,9 @@ Accept wildcard characters: False ``` ### -ResetMigrationToUnifiedGroup + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResetMigrationToUnifiedGroup switch specifies whether you want to reset the flag that indicates the migration of the distribution group to a Microsoft 365 Group is in progress. You don't need to specify a value with this switch. @@ -1517,7 +1643,6 @@ The ResetMigrationToUnifiedGroup switch specifies whether you want to reset the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1527,6 +1652,9 @@ Accept wildcard characters: False ``` ### -RoomList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RoomList switch specifies that all members of this distribution group are room mailboxes. You don't need to specify a value with this switch. You can create a distribution group for an office building in your organization and add all rooms in that building to the distribution group. Room list distribution groups are used to generate a list of building locations for meeting requests in Outlook 2010 or later. Room lists allow a user to select a building and get availability information for all rooms in that building, without having to add each room individually. @@ -1535,7 +1663,6 @@ You can create a distribution group for an office building in your organization Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1545,6 +1672,9 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). @@ -1553,7 +1683,6 @@ The SamAccountName parameter (also known as the pre-Windows 2000 user account or Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1563,6 +1692,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -1575,7 +1707,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1585,6 +1716,9 @@ Accept wildcard characters: False ``` ### -SendOofMessageToOriginatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SendOofMessageToOriginatorEnabled parameter specifies how to handle out of office (OOF) messages for members of the group. Valid values are: - $true: When messages are sent to the group, OOF messages for any of the group members are sent to the message sender. @@ -1594,7 +1728,6 @@ The SendOofMessageToOriginatorEnabled parameter specifies how to handle out of o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1604,6 +1737,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -1616,7 +1752,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1626,6 +1761,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -1646,7 +1784,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1656,6 +1793,9 @@ Accept wildcard characters: False ``` ### -UpdateMemberCount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill UpdateMemberCount Description }} @@ -1664,7 +1804,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1674,13 +1813,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1690,6 +1831,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -1701,7 +1845,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-DkimSigningConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-DkimSigningConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DkimSigningConfig.md index f2b0ed064b..e05a1d19ae 100644 --- a/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DkimSigningConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection -title: Set-DkimSigningConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dkimsigningconfig +schema: 2.0.0 +title: Set-DkimSigningConfig --- # Set-DkimSigningConfig @@ -47,6 +48,9 @@ This example disables the DKIM signing policy for the contoso.com domain. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the DKIM signing policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name: The domain name (for example, contoso.com). @@ -57,7 +61,6 @@ The Identity parameter specifies the DKIM signing policy that you want to modify Type: DkimSigningConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -BodyCanonicalization + +> Applicable: Exchange Online, Exchange Online Protection + The BodyCanonicalization parameter specifies the canonicalization algorithm that's used to create and verify the message body part of the DKIM signature. This value effectively controls the sensitivity of DKIM to changes to the message body in transit. Valid values are: - Relaxed: Changes in whitespace and changes in empty lines at the end of the message body are tolerated. This is the default value. @@ -92,7 +100,6 @@ The BodyCanonicalization parameter specifies the canonicalization algorithm that Type: CanonicalizationType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -111,7 +121,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -130,7 +142,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -140,6 +151,9 @@ Accept wildcard characters: False ``` ### -HeaderCanonicalization + +> Applicable: Exchange Online, Exchange Online Protection + The HeaderCanonicalization parameter specifies the canonicalization algorithm that's used to create and verify the message header part of the DKIM signature. This value effectively controls the sensitivity of DKIM to changes to the message headers in transit. Valid values are: - Relaxed: Common modifications to the message header are tolerated (for example, header field line rewrapping, changes in unnecessary whitespace or empty lines, and changes in case for header fields). This is the default value. @@ -149,7 +163,6 @@ The HeaderCanonicalization parameter specifies the canonicalization algorithm th Type: CanonicalizationType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -159,6 +172,9 @@ Accept wildcard characters: False ``` ### -PublishTxtRecords + +> Applicable: Exchange Online, Exchange Online Protection + The PublishTxtRecords switch publishes the required data for the selected domain so the correct DKIM records can be created in DNS. You don't need to specify a value with this switch. If you're using a third party DNS service, you still need to create the CNAME records that point to the DKIM records that have been created for you. @@ -167,7 +183,6 @@ If you're using a third party DNS service, you still need to create the CNAME re Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -177,13 +192,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpCompliancePolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpCompliancePolicy.md index af75bf6d9d..1970809d33 100644 --- a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpcompliancepolicy applicable: Security & Compliance -title: Set-DlpCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpcompliancepolicy +schema: 2.0.0 +title: Set-DlpCompliancePolicy --- # Set-DlpCompliancePolicy @@ -124,6 +125,9 @@ This example adds the specified workspace IDs to the Power BI location for the D ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -135,7 +139,6 @@ The Identity parameter specifies the DLP policy that you want to modify. You can Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -145,6 +148,9 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + The RetryDistribution switch redistributes the policy to all Exchange, OneDrive, and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported if you used this switch. @@ -155,7 +161,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -165,6 +170,9 @@ Accept wildcard characters: False ``` ### -AddEndpointDlpLocation + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The AddEndpointDLPLocation parameter specifies the user accounts to add to the list of included accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. @@ -177,7 +185,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -187,6 +194,9 @@ Accept wildcard characters: False ``` ### -AddEndpointDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The AddEndpointDlpLocationException parameter specifies the user accounts to add to the list of excluded accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. @@ -199,7 +209,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -209,6 +218,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter adds email messages to the DLP policy if they're not already included. The valid value for this parameter is All. If the policy doesn't already include email messages (in the output of the Get-DlpCompliancePolicy cmdlet, the ExchangeLocation property value is blank), you can use this parameter in the following procedures: @@ -223,7 +235,6 @@ If the policy doesn't already include email messages (in the output of the Get-D Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -233,6 +244,9 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation + +> Applicable: Security & Compliance + The AddOneDriveLocation parameter adds OneDrive sites to the DLP policy if they're not already included. The valid value for this parameter is All. If the policy doesn't already include OneDrive sites (in the output of the Get-DlpCompliancePolicy cmdlet, the OneDriveLocation property value is blank), you can use this parameter in the following procedures: @@ -255,7 +269,6 @@ You can't specify inclusions and exclusions in the same policy. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -265,13 +278,15 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocationException + +> Applicable: Security & Compliance + Don't use this parameter. See the AddOneDriveLocation parameter for an explanation. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -281,6 +296,9 @@ Accept wildcard characters: False ``` ### -AddOnPremisesScannerDlpLocation + +> Applicable: Security & Compliance + The AddOnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to add to the list of included repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -291,7 +309,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -301,6 +318,9 @@ Accept wildcard characters: False ``` ### -AddOnPremisesScannerDlpLocationException + +> Applicable: Security & Compliance + The AddOnPremisesScannerDlpLocationExclusion parameter specifies the on-premises file shares and SharePoint document libraries and folders to add to the list of excluded repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -311,7 +331,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -321,6 +340,9 @@ Accept wildcard characters: False ``` ### -AddPowerBIDlpLocation + +> Applicable: Security & Compliance + The AddPowerBIDlpLocation parameter specifies the Power BI workspace IDs to add to the list of included workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. You can find the workspace ID using one of the following procedures: @@ -335,7 +357,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddPowerBIDlpLocationException parameter specifies the Power BI workspace IDs to add to the list of excluded workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. You can find the workspace ID using one of the following procedures: @@ -359,7 +383,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites if you used the value All for the SharePointLocation parameter. You identify the site by its URL value. You can't add SharePoint sites to the policy until they have been indexed. @@ -379,7 +405,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddSharePointLocationException parameter specifies the SharePoint sites to add to the list of excluded sites if you used the value All for the SharePointLocation parameter. You identify the site by its URL value. You can't add SharePoint sites to the policy until they have been indexed. @@ -399,7 +427,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddTeamsLocation parameter specifies the accounts, distribution groups, or mail-enabled security groups to add to the list of included Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -417,7 +447,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The AddTeamsLocationException parameter specifies the accounts, distribution groups, or mail-enabled security groups to add to the list of excluded Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -435,7 +467,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The AddThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to add to the list of included apps if you used the value All for the ThirdPartyAppDlpLocation parameter. @@ -457,7 +491,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -467,6 +500,9 @@ Accept wildcard characters: False ``` ### -AddThirdPartyAppDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The AddThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps to add to the list of excluded apps if you used the value All for the ThirdPartyAppDlpLocation parameter. @@ -479,7 +515,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -489,13 +524,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -505,6 +542,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -514,7 +554,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -524,13 +563,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill EndpointDlpAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -540,13 +581,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill EndpointDlpAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -556,13 +599,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpExtendedLocations + +> Applicable: Security & Compliance + {{ Fill EndpointDlpExtendedLocations Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -572,6 +617,9 @@ Accept wildcard characters: False ``` ### -EnforcementPlanes + +> Applicable: Security & Compliance + The EnforcementPlanes parameter defines the layer where policy actions are run. This parameter uses the following syntax: `-EnforcementPlanes @("")`. @@ -585,7 +633,6 @@ Currently, supported values are: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -595,6 +642,9 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedBy + +> Applicable: Security & Compliance + The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, one of the following statements must be true: @@ -610,7 +660,6 @@ You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMember Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -620,6 +669,9 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf + +> Applicable: Security & Compliance + The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to exclude from the DLP policy (the OneDrive sites of group members are excluded from the policy). You identify the groups by email address. To use this parameter, one of the following statements must be true: @@ -637,7 +689,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -647,13 +698,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -663,13 +716,15 @@ Accept wildcard characters: False ``` ### -ExchangeAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill ExchangeAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -679,6 +734,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf + +> Applicable: Security & Compliance + The ExchangeSenderMemberOf parameter specifies the distribution groups or security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -696,7 +754,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -706,6 +763,9 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException + +> Applicable: Security & Compliance + The ExchangeSenderMemberOfException parameter specifies the distribution groups or security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -723,7 +783,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -733,6 +792,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -741,7 +803,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -751,13 +812,15 @@ Accept wildcard characters: False ``` ### -IsFromSmartInsights + +> Applicable: Security & Compliance + {{ Fill IsFromSmartInsights Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -767,6 +830,9 @@ Accept wildcard characters: False ``` ### -Locations + +> Applicable: Security & Compliance + The Locations parameter specifies to whom, what, and where the DLP policy applies. This parameter uses the following properties: - Workload: What the DLP policy applies to. Use the value `Applications`. @@ -794,7 +860,6 @@ After you create the `$loc` variable as shown in the previous examples, use the Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -804,6 +869,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Security & Compliance + The Mode parameter specifies the action and notification level of the DLP policy. Valid values are: - Enable: The policy is enabled for actions and notifications. This is the default value. @@ -815,7 +883,6 @@ The Mode parameter specifies the action and notification level of the DLP policy Type: PolicyMode Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -825,13 +892,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -841,13 +910,15 @@ Accept wildcard characters: False ``` ### -OneDriveAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill OneDriveAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -857,6 +928,9 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy + +> Applicable: Security & Compliance + The OneDriveSharedBy parameter specifies the users to include in the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). To use this parameter, one of the following statements must be true: @@ -872,7 +946,6 @@ You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDri Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -882,6 +955,9 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf + +> Applicable: Security & Compliance + The OneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the DLP policy (the OneDrive sites of group members are included in the policy). You identify the groups by email address. To use this parameter, one of the following statements must be true: @@ -899,7 +975,6 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -909,6 +984,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. @@ -917,7 +995,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -927,6 +1004,9 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + The PolicyTemplateInfo specifies the built-in or custom DLP policy templates to use in the DLP policy. For more information about DLP policy templates, see [What the DLP policy templates include](https://learn.microsoft.com/purview/what-the-dlp-policy-templates-include). @@ -935,7 +1015,6 @@ For more information about DLP policy templates, see [What the DLP policy templa Type: PswsHashtable Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -945,6 +1024,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and policies can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing policies. For example, if there are 5 existing policies: @@ -959,7 +1041,6 @@ If you modify the priority value of a policy, the position of the policy in the Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -969,6 +1050,9 @@ Accept wildcard characters: False ``` ### -RemoveEndpointDlpLocation + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The RemoveEndpointDlpLocation parameter specifies the user accounts to remove from the list of included accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You specify the account by name or email address. @@ -981,7 +1065,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -991,6 +1074,9 @@ Accept wildcard characters: False ``` ### -RemoveEndpointDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The RemoveEndpointDlpLocation parameter specifies the user accounts to remove from the list of excluded accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You specify the account by name or email address. @@ -1003,7 +1089,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1013,6 +1098,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter removes email messages from the DLP policy if they're already included. The valid value for this parameter is All. If the policy already includes email messages (in the output of the Get-DlpCompliancePolicy cmdlet, the ExchangeLocation property value is All), you can use `-RemoveExchangeLocation All` to prevent the policy from applying to email messages. @@ -1021,7 +1109,6 @@ If the policy already includes email messages (in the output of the Get-DlpCompl Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1031,6 +1118,9 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation + +> Applicable: Security & Compliance + The RemoveOneDriveLocation parameter removes OneDrive sites from the DLP policy if they're already included. The valid value for this parameter is All. If the policy already includes OneDrive sites (in the output of the Get-DlpCompliancePolicy cmdlet, the OneDriveLocation property value is All), you can use `-RemoveOneDriveLocation All` to prevent the policy from applying to OneDrive sites. @@ -1041,7 +1131,6 @@ If the policy already includes OneDrive sites (in the output of the Get-DlpCompl Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1051,13 +1140,15 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocationException + +> Applicable: Security & Compliance + Don't use this parameter. See the RemoveOneDriveLocation parameter for an explanation. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1067,6 +1158,9 @@ Accept wildcard characters: False ``` ### -RemoveOnPremisesScannerDlpLocation + +> Applicable: Security & Compliance + The RemoveOnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to remove from the list of included repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1077,7 +1171,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1087,6 +1180,9 @@ Accept wildcard characters: False ``` ### -RemoveOnPremisesScannerDlpLocationException + +> Applicable: Security & Compliance + The RemoveOnPremisesScannerDlpLocationException parameter specifies the on-premises file shares and SharePoint document libraries and folders to remove from the list of excluded repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1097,7 +1193,6 @@ For more information about the DLP on-premises scanner, see [Learn about the dat Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1107,6 +1202,9 @@ Accept wildcard characters: False ``` ### -RemovePowerBIDlpLocation + +> Applicable: Security & Compliance + The RemovePowerBIDlpLocation parameter specifies the Power BI workspace IDs to remove from the list of included workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. You can find the workspace ID using one of the following procedures: @@ -1121,7 +1219,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The RemovePowerBIDlpLocationException parameter specifies the Power BI workspace IDs to remove the list of excluded workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. You can find the workspace ID using one of the following procedures: @@ -1145,7 +1245,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites if you used the value All for the SharePointLocation parameter. You specify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1163,7 +1265,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The RemoveSharePointLocationException parameter specifies the SharePoint sites to remove from the list of excluded sites if you used the value All for the SharePointLocation parameter. You specify the site by its URL value. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1181,7 +1285,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The RemoveTeamsLocation parameter specifies the accounts, distribution groups, or mail-enabled security groups to remove from the list of included Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You specify the entries by the email address or name of the account, distribution group, or mail-enabled security group. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1199,7 +1305,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + The RemoveTeamsLocationException parameter specifies the accounts, distribution groups, or mail-enabled security groups to remove from the list of excluded Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1217,7 +1325,6 @@ To enter multiple values, use the following syntax: `,,... Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The RemoveThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to remove from the list of included apps if you used the value All for the ThirdPartyAppDlpLocation parameter. @@ -1239,7 +1349,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1249,6 +1358,9 @@ Accept wildcard characters: False ``` ### -RemoveThirdPartyAppDlpLocationException + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The RemoveThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps tp remove from the list of excluded apps if you used the value All for the ThirdPartyAppDlpLocation parameter. @@ -1261,7 +1373,6 @@ For more information about DLP for non-Microsoft cloud apps, see [Use data loss Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1271,13 +1382,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1287,13 +1400,15 @@ Accept wildcard characters: False ``` ### -SharePointAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill SharePointAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1303,13 +1418,15 @@ Accept wildcard characters: False ``` ### -StartSimulation + +> Applicable: Security & Compliance + {{ Fill StartSimulation Description }} ```yaml Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1319,13 +1436,15 @@ Accept wildcard characters: False ``` ### -TeamsAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill TeamsAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1335,13 +1454,15 @@ Accept wildcard characters: False ``` ### -TeamsAdaptiveScopesException + +> Applicable: Security & Compliance + {{ Fill TeamsAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1351,13 +1472,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-DlpComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpComplianceRule.md index 4a833c4d4b..1843b0a257 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpcompliancerule applicable: Security & Compliance -title: Set-DlpComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpcompliancerule +schema: 2.0.0 +title: Set-DlpComplianceRule --- # Set-DlpComplianceRule @@ -259,6 +260,9 @@ This example uses the AdvancedRule parameter to read the following complex condi ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the DLP rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -270,7 +274,6 @@ The Identity parameter specifies the DLP rule that you want to modify. You can u Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -280,6 +283,9 @@ Accept wildcard characters: False ``` ### -AccessScope + +> Applicable: Security & Compliance + The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule is applied to content that's accessible or delivered to a recipient inside the organization. @@ -290,7 +296,6 @@ The AccessScope parameter specifies a condition for the DLP rule that's based on Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -300,13 +305,15 @@ Accept wildcard characters: False ``` ### -ActivationDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -316,6 +323,9 @@ Accept wildcard characters: False ``` ### -AddRecipients + +> Applicable: Security & Compliance + The AddRecipients parameter specifies an action for the DLP rule that adds the specified recipients to email messages. This parameter uses the following syntax: - `@{ = "emailaddress"}`. For example, `@{AddToRecipients = "laura@contoso.com"}` or `@{BlindCopyTo = "julia@contoso.com"}`. @@ -327,7 +337,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -337,6 +346,9 @@ Accept wildcard characters: False ``` ### -AdvancedRule + +> Applicable: Security & Compliance + The AdvancedRule parameter uses complex rule syntax that supports multiple AND, OR, and NOT operators and nested groups. This parameter uses JSON syntax that's similar to the traditional advanced syntax, but is read from a file that contains additional operators and combinations that aren't traditionally supported. @@ -347,7 +359,6 @@ For syntax details, see Example 2. Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -357,13 +368,15 @@ Accept wildcard characters: False ``` ### -AlertProperties + +> Applicable: Security & Compliance + {{ Fill AlertProperties Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -373,6 +386,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The AnyOfRecipientAddressContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -387,7 +403,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -397,6 +412,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -407,7 +425,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -417,6 +434,9 @@ Accept wildcard characters: False ``` ### -ApplyBrandingTemplate + +> Applicable: Security & Compliance + The ApplyBrandingTemplate parameter specifies an action for the DLP rule that applies a custom branding template for messages encrypted by Microsoft Purview Message Encryption. You identify the custom branding template by name. If the name contains spaces, enclose the name in quotation marks ("). Use the EnforcePortalAccess parameter to control whether external users are required to use the encrypted message portal to view encrypted messages. @@ -425,7 +445,6 @@ Use the EnforcePortalAccess parameter to control whether external users are requ Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -435,6 +454,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimer + +> Applicable: Security & Compliance + The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = ; FallbackAction = }`. - Text: Specifies the disclaimer text to add. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. @@ -447,7 +469,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -457,13 +478,15 @@ Accept wildcard characters: False ``` ### -AttachmentIsNotLabeled + +> Applicable: Security & Compliance + {{ Fill AttachmentIsNotLabeled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -473,6 +496,9 @@ Accept wildcard characters: False ``` ### -BlockAccess + +> Applicable: Security & Compliance + The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: - $true: Blocks further access to the source item that matched the rule. The owner, author, and site owner can still access the item. @@ -482,7 +508,6 @@ The BlockAccess parameter specifies an action for the DLP rule that blocks acces Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -492,6 +517,9 @@ Accept wildcard characters: False ``` ### -BlockAccessScope + +> Applicable: Security & Compliance + The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - All: Blocks access to everyone except the owner and the last modifier. @@ -502,7 +530,6 @@ The BlockAccessScope parameter specifies the scope of the block access action. V Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -512,13 +539,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -528,6 +557,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -539,7 +571,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -549,6 +580,9 @@ Accept wildcard characters: False ``` ### -ContentCharacterSetContainsWords + +> Applicable: Security & Compliance + The ContentCharacterSetContainsWords parameter specifies a condition for the rule that looks for character set names in messages. You can specify multiple values separated by commas. Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874`. @@ -557,7 +591,6 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -567,6 +600,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information types, the parameter can also be applied to files that contain sensitivity labels. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for a sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. @@ -577,7 +613,6 @@ Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -587,13 +622,15 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -603,13 +640,15 @@ Accept wildcard characters: False ``` ### -ContentFileTypeMatches + +> Applicable: Security & Compliance + {{ Fill ContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -619,13 +658,15 @@ Accept wildcard characters: False ``` ### -ContentIsNotLabeled + +> Applicable: Security & Compliance + {{ Fill ContentIsNotLabeled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -635,13 +676,15 @@ Accept wildcard characters: False ``` ### -ContentIsShared + +> Applicable: Security & Compliance + {{ Fill ContentIsShared Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -651,6 +694,9 @@ Accept wildcard characters: False ``` ### -ContentPropertyContainsWords + +> Applicable: Security & Compliance + The ContentPropertyContainsWords parameter specifies a condition for the DLP rule that's based on a property match in content. The rule is applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -659,7 +705,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -669,6 +714,9 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: - $true: The rule is disabled. @@ -678,7 +726,6 @@ The Disabled parameter specifies whether the DLP rule is disabled. Valid values Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -688,6 +735,9 @@ Accept wildcard characters: False ``` ### -DocumentContainsWords + +> Applicable: Security & Compliance + The DocumentContainsWords parameter specifies a condition for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -698,7 +748,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -708,13 +757,15 @@ Accept wildcard characters: False ``` ### -DocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill DocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -724,13 +775,15 @@ Accept wildcard characters: False ``` ### -DocumentCreatedByMemberOf + +> Applicable: Security & Compliance + {{ Fill DocumentCreatedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -740,6 +793,9 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected + +> Applicable: Security & Compliance + The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -749,7 +805,6 @@ The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -759,6 +814,9 @@ Accept wildcard characters: False ``` ### -DocumentIsUnsupported + +> Applicable: Security & Compliance + The DocumentIsUnsupported parameter specifies a condition for the DLP rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -768,7 +826,6 @@ The DocumentIsUnsupported parameter specifies a condition for the DLP rule that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -778,6 +835,9 @@ Accept wildcard characters: False ``` ### -DocumentMatchesPatterns + +> Applicable: Security & Compliance + The DocumentMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -788,7 +848,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -798,6 +857,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesPatterns + +> Applicable: Security & Compliance + The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -806,7 +868,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -816,6 +877,9 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesWords + +> Applicable: Security & Compliance + The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -828,7 +892,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -838,6 +901,9 @@ Accept wildcard characters: False ``` ### -DocumentSizeOver + +> Applicable: Security & Compliance + The DocumentSizeOver parameter specifies a condition for the DLP rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -856,7 +922,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -866,6 +931,9 @@ Accept wildcard characters: False ``` ### -DomainCountOver + +> Applicable: Security & Compliance + The DomainCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipient domains is greater than the specified value. You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. @@ -874,7 +942,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. In Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named Default value: None @@ -883,6 +950,9 @@ Accept wildcard characters: False ``` ### -EncryptRMSTemplate + +> Applicable: Security & Compliance + The EncryptRMSTemplate parameter specifies an action for the DLP rule that applies rights management service (RMS) templates to files. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. @@ -891,7 +961,6 @@ Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -901,13 +970,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpBrowserRestrictions + +> Applicable: Security & Compliance + {{ Fill EndpointDlpBrowserRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -917,6 +988,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpRestrictions + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. The EndpointDlpRestrictions parameter specifies the restricted endpoints for Endpoint DLP. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. @@ -945,7 +1019,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -955,6 +1028,9 @@ Accept wildcard characters: False ``` ### -EnforcePortalAccess + +> Applicable: Security & Compliance + The EnforcePortalAccess parameter specifies whether external recipients are required to view encrypted mail using the encrypted message portal when the ApplyBrandingTemplate action is also specified. Valid values are: - $true: External recipients are required to use the encrypted message portal to view encrypted messages. @@ -964,7 +1040,6 @@ The EnforcePortalAccess parameter specifies whether external recipients are requ Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -974,6 +1049,9 @@ Accept wildcard characters: False ``` ### -EvaluateRulePerComponent + +> Applicable: Security & Compliance + The EvaluateRulePerComponent parameter specifies whether a match for conditions and exceptions in the rule is contained within the same message component. Valid values are: - $true: A DLP rule match for conditions and exceptions must be in the same message component (for example, in the message body or in a single attachment). @@ -992,7 +1070,6 @@ This parameter works with the following conditions or exceptions only: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1002,6 +1079,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAccessScope + +> Applicable: Security & Compliance + The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: - InOrganization: The rule isn't applied to content that's accessible or delivered to a recipient inside the organization. @@ -1012,7 +1092,6 @@ The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1022,6 +1101,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. - Single word: `"no_reply"` @@ -1036,7 +1118,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1046,6 +1127,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1056,7 +1140,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1066,6 +1149,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentCharacterSetContainsWords parameter specifies an exception for the rule that looks for character set names in messages. To specify multiple words, this parameter uses the syntax: `Word1,word2,...wordN`. Don't use leading or trailing spaces. @@ -1076,7 +1162,6 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1086,6 +1171,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information types, the parameter can also be applied to files that contain sensitivity labels. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for a sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. @@ -1096,7 +1184,6 @@ Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1106,13 +1193,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords + +> Applicable: Security & Compliance + The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1122,13 +1211,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentFileTypeMatches + +> Applicable: Security & Compliance + {{ Fill ExceptIfContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1138,13 +1229,15 @@ Accept wildcard characters: False ``` ### -ExceptIfContentIsShared + +> Applicable: Security & Compliance + {{ Fill ExceptIfContentIsShared Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1154,6 +1247,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentPropertyContainsWords + +> Applicable: Security & Compliance + The ExceptIfContentPropertyContainsWords parameter specifies an exception for the DLP rule that's based on a property match in content. The rule is not applied to content that contains the specified property. This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. @@ -1162,7 +1258,6 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1172,6 +1267,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentContainsWords + +> Applicable: Security & Compliance + The ExceptIfDocumentContainsWords parameter specifies an exception for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1182,7 +1280,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1192,13 +1289,15 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedBy + +> Applicable: Security & Compliance + {{ Fill ExceptIfDocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1208,13 +1307,15 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedByMemberOf + +> Applicable: Security & Compliance + {{ Fill ExceptIfDocumentCreatedByMemberOf Description }} ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1224,6 +1325,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected + +> Applicable: Security & Compliance + The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. @@ -1233,7 +1337,6 @@ The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1243,6 +1346,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsUnsupported + +> Applicable: Security & Compliance + The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: - $true: Look for unsupported files that can't be scanned. @@ -1252,7 +1358,6 @@ The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1262,6 +1367,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfDocumentMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -1272,7 +1380,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1282,6 +1389,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1290,7 +1400,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1300,6 +1409,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentNameMatchesWords + +> Applicable: Security & Compliance + The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1312,7 +1424,6 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1322,6 +1433,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentSizeOver + +> Applicable: Security & Compliance + The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. When you enter a value, qualify the value with one of the following units: @@ -1340,7 +1454,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1350,6 +1463,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + The ExceptIfFrom parameter specifies an exception for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1358,7 +1474,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1368,6 +1483,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Security & Compliance + The ExceptIfFromAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1382,7 +1500,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1392,6 +1509,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1402,7 +1522,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1412,6 +1531,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Security & Compliance + The FromMemberOf parameter specifies an exception for the DLP rule that looks for messages sent by group members. You identify the group by its email address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -1420,7 +1542,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1430,6 +1551,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope + +> Applicable: Security & Compliance + The ExceptIfFromScope parameter specifies an exception for the rule that looks for the location of message senders. Valid values are: - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. @@ -1441,7 +1565,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1451,6 +1574,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride + +> Applicable: Security & Compliance + The ExceptIfHasSenderOverride parameter specifies an exception for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: - $true: Look for messages where the sender took action to override a DLP policy. @@ -1462,7 +1588,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1472,6 +1597,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Security & Compliance + The HeaderContainsWords parameter specifies an exception for the DLP rule that looks for words in a header field. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1482,7 +1610,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1492,6 +1619,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1500,7 +1630,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1510,6 +1639,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver + +> Applicable: Security & Compliance + The ExceptIfMessageSizeOver parameter specifies an exception for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. When you enter a value, qualify the value with one of the following units: @@ -1528,7 +1660,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1538,6 +1669,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Security & Compliance + The ExceptIfMessageTypeMatches parameter specifies an exception for the rule that looks for messages of the specified type. Valid values are: - ApprovalRequest: Moderation request messages sent to moderators. @@ -1555,7 +1689,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1565,6 +1698,9 @@ Accept wildcard characters: False ``` ### -ExceptIfProcessingLimitExceeded + +> Applicable: Security & Compliance + The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP rule that looks for files where scanning couldn't complete. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -1574,7 +1710,6 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1584,6 +1719,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords + +> Applicable: Security & Compliance + The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: - City @@ -1624,7 +1762,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1634,6 +1771,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -1674,7 +1814,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1684,13 +1823,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1700,6 +1841,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords + +> Applicable: Security & Compliance + The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: - City @@ -1740,7 +1884,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1750,6 +1893,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -1790,7 +1936,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1800,6 +1945,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + The ExceptIfSenderDomainIs parameter specifies an exception for the DLP rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1808,7 +1956,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1818,6 +1965,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIPRanges + +> Applicable: Security & Compliance + The ExceptIfSenderIpRanges parameter specifies an exception for the DLP rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -1830,7 +1980,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1840,6 +1989,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + The ExceptIfSentTo parameter specifies an exception for the DLP rule that looks for recipients in messages. You identify the recipients by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1848,7 +2000,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1858,6 +2009,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Security & Compliance + The ExceptIfSentToMemberOf parameter specifies an exception for the DLP rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1866,7 +2020,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1876,6 +2029,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Security & Compliance + The ExceptIfSubjectContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in the Subject field of messages. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -1890,7 +2046,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1900,6 +2055,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -1910,7 +2068,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1920,6 +2077,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Security & Compliance + The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the rule that looks for words in the Subject field or body of messages. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1930,7 +2090,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1940,6 +2099,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns + +> Applicable: Security & Compliance + The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1948,7 +2110,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1958,6 +2119,9 @@ Accept wildcard characters: False ``` ### -ExceptIfUnscannableDocumentExtensionIs + +> Applicable: Security & Compliance + The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -1966,7 +2130,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1976,6 +2139,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Security & Compliance + The ExceptIfWithImportance parameter specifies an exception for the rule that looks for messages with the specified importance level. Valid values are: - Low @@ -1988,7 +2154,6 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1998,13 +2163,15 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2014,6 +2181,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + The From parameter specifies a condition for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2022,7 +2192,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2032,6 +2201,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Security & Compliance + The FromAddressContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -2046,7 +2218,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2056,6 +2227,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Security & Compliance + The FromAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -2066,7 +2240,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2076,6 +2249,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Security & Compliance + The FromMemberOf parameter specifies a condition for the DLP rule that looks for messages sent by group members. You identify the group by its email address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -2084,7 +2260,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2094,6 +2269,9 @@ Accept wildcard characters: False ``` ### -FromScope + +> Applicable: Security & Compliance + The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. @@ -2105,7 +2283,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2115,6 +2292,9 @@ Accept wildcard characters: False ``` ### -GenerateAlert + +> Applicable: Security & Compliance + The GenerateAlert parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2128,7 +2308,6 @@ The email message that's generated by this action contains a link to detailed in Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2138,6 +2317,9 @@ Accept wildcard characters: False ``` ### -GenerateIncidentReport + +> Applicable: Security & Compliance + The GenerateIncidentReport parameter specifies an action for the DLP rule that sends an incident report to the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2149,7 +2331,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2159,6 +2340,9 @@ Accept wildcard characters: False ``` ### -HasSenderOverride + +> Applicable: Security & Compliance + The SenderOverride parameter specifies a condition for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: - $true: Look for messages where the sender took action to override a DLP policy. @@ -2170,7 +2354,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2180,6 +2363,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Security & Compliance + The HeaderContainsWords parameter specifies a condition for the DLP rule that looks for words in a header field. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -2190,7 +2376,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2200,6 +2385,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Security & Compliance + The HeaderMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2208,7 +2396,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2218,6 +2405,9 @@ Accept wildcard characters: False ``` ### -IncidentReportContent + +> Applicable: Security & Compliance + The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: - All @@ -2246,7 +2436,6 @@ Therefore, any additional values that you use with the value "Default" are ignor Type: ReportContentOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2256,13 +2445,15 @@ Accept wildcard characters: False ``` ### -MessageIsNotLabeled + +> Applicable: Security & Compliance + {{ Fill MessageIsNotLabeled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2272,6 +2463,9 @@ Accept wildcard characters: False ``` ### -MessageSizeOver + +> Applicable: Security & Compliance + The MessageSizeOver parameter specifies a condition for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. When you enter a value, qualify the value with one of the following units: @@ -2290,7 +2484,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2300,6 +2493,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Security & Compliance + The MessageTypeMatches parameter specifies a condition for the rule that looks for messages of the specified type. Valid values are: - ApprovalRequest: Moderation request messages sent to moderators. @@ -2317,7 +2513,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2327,13 +2522,15 @@ Accept wildcard characters: False ``` ### -MipRestrictAccess + +> Applicable: Security & Compliance + {{ Fill MipRestrictAccess Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2343,6 +2540,9 @@ Accept wildcard characters: False ``` ### -Moderate + +> Applicable: Security & Compliance + The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = "emailaddress1,emailaddress2,...emailaddressN"}`. You can use this action in DLP policies that are scoped only to Exchange. @@ -2351,7 +2551,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2361,6 +2560,9 @@ Accept wildcard characters: False ``` ### -ModifySubject + +> Applicable: Security & Compliance + The ModifySubject parameter uses regular expressions to find text patterns in the subject of the email message, and then modifies the subject with the text that you specify. This parameter uses the syntax: `@{Patterns="RegEx1","RegEx2",..."RegEx10}"; SubjectText="Replacement Text"; ReplaceStrategy="Value"}`. The `ReplaceStrategy=` property uses one of the following values: @@ -2375,7 +2577,6 @@ The maximum individual regular expression length is 128 characters. The maximum Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2385,6 +2586,9 @@ Accept wildcard characters: False ``` ### -NonBifurcatingAccessScope + +> Applicable: Security & Compliance + The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule that looks for recipients in the specified access scope. The rule is applied to all copies of the message. Valid values are: - HasInternal: At least one recipient is inside the organization. @@ -2397,7 +2601,6 @@ You can use this condition in DLP policies that are scoped only to Exchange Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2407,6 +2610,9 @@ Accept wildcard characters: False ``` ### -NotifyAllowOverride + +> Applicable: Security & Compliance + The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - FalsePositive: Allows overrides in the case of false positives. @@ -2420,7 +2626,6 @@ You can specify multiple values separated by commas. The values WithoutJustifica Type: OverrideOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2430,13 +2635,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomSenderDisplayName + +> Applicable: Security & Compliance + {{ Fill NotifyEmailCustomSenderDisplayName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2446,13 +2653,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomSubject + +> Applicable: Security & Compliance + The NotifyEmailCustomSubject parameter specifies the custom text in the subject line of email notification message that's sent to recipients when the conditions of the rule are met. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2462,6 +2671,9 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomText + +> Applicable: Security & Compliance + The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. This parameter has a 5000 character limit, and supports plain text, HTML tags and the following tokens (variables): @@ -2475,7 +2687,6 @@ This parameter has a 5000 character limit, and supports plain text, HTML tags an Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2485,13 +2696,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailExchangeIncludeAttachment + +> Applicable: Security & Compliance + {{ Fill NotifyEmailExchangeIncludeAttachment Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2501,13 +2714,15 @@ Accept wildcard characters: False ``` ### -NotifyEmailOnedriveRemediationActions + +> Applicable: Security & Compliance + {{ Fill NotifyEmailOnedriveRemediationActions Description }} ```yaml Type: NotifyEmailRemediationActions Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2517,6 +2732,9 @@ Accept wildcard characters: False ``` ### -NotifyEndpointUser + +> Applicable: Security & Compliance + **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. {{ Fill NotifyEndpointUser Description }} @@ -2527,7 +2745,6 @@ For more information about Endpoint DLP, see [Learn about Endpoint data loss pre Type: PswsHashtable Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2537,13 +2754,15 @@ Accept wildcard characters: False ``` ### -NotifyOverrideRequirements + +> Applicable: Security & Compliance + {{ Fill NotifyOverrideRequirements Description }} ```yaml Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2553,13 +2772,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomDialog + +> Applicable: Security & Compliance + {{ Fill NotifyPolicyTipCustomDialog Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2569,13 +2790,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomText + +> Applicable: Security & Compliance + The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2585,6 +2808,9 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomTextTranslations + +> Applicable: Security & Compliance + The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax `CultureCode:Text`. Valid culture codes are supported values from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -2595,7 +2821,6 @@ To enter multiple values and overwrite any existing entries, use the following s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2605,6 +2830,9 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipDisplayOption + +> Applicable: Security & Compliance + The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: - Tip: Displays policy tip at the top of the mail. This is the default value. @@ -2614,7 +2842,6 @@ The NotifyPolicyTipDialogOption parameter specifies a display option for the pol Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2624,13 +2851,15 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipUrl + +> Applicable: Security & Compliance + The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. ```yaml Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2640,6 +2869,9 @@ Accept wildcard characters: False ``` ### -NotifyUser + +> Applicable: Security & Compliance + The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: - An email address. @@ -2653,7 +2885,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2663,6 +2894,9 @@ Accept wildcard characters: False ``` ### -NotifyUserType + +> Applicable: Security & Compliance + The NotifyUserType parameter specifies the type of notification that's used for the rule. Valid values are: - NotSet @@ -2674,7 +2908,6 @@ The NotifyUserType parameter specifies the type of notification that's used for Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.NotifyUserType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2684,13 +2917,15 @@ Accept wildcard characters: False ``` ### -OnPremisesScannerDlpRestrictions + +> Applicable: Security & Compliance + {{ Fill OnPremisesScannerDlpRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2700,6 +2935,9 @@ Accept wildcard characters: False ``` ### -PrependSubject + +> Applicable: Security & Compliance + The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you specify. If the text contains spaces, enclose the value in quotation marks ("). Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. @@ -2710,7 +2948,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2720,6 +2957,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: @@ -2734,7 +2974,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2744,6 +2983,9 @@ Accept wildcard characters: False ``` ### -ProcessingLimitExceeded + +> Applicable: Security & Compliance + The ProcessingLimitExceeded parameter specifies a condition for the DLP rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: - $true: Look for files where scanning couldn't complete. @@ -2753,7 +2995,6 @@ The ProcessingLimitExceeded parameter specifies a condition for the DLP rule tha Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2763,6 +3004,9 @@ Accept wildcard characters: False ``` ### -Quarantine + +> Applicable: Security & Compliance + This parameter specifies an action or part of an action for the rule. The Quarantine parameter specifies an action that quarantines messages. Valid values are: @@ -2774,7 +3018,6 @@ The Quarantine parameter specifies an action that quarantines messages. Valid va Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2784,6 +3027,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeContainsWords + +> Applicable: Security & Compliance + The RecipientADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: - City @@ -2824,7 +3070,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2834,6 +3079,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The RecipientADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -2874,7 +3122,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2884,6 +3131,9 @@ Accept wildcard characters: False ``` ### -RecipientCountOver + +> Applicable: Security & Compliance + The RecipientCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipients is greater than the specified value. Groups are counted as one recipient. You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. @@ -2892,7 +3142,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. In Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named Default value: None @@ -2901,13 +3150,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Security & Compliance + The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2917,6 +3168,9 @@ Accept wildcard characters: False ``` ### -RedirectMessageTo + +> Applicable: Security & Compliance + The RedirectMessageTo parameter specifies an action for the DLP rule that redirects the message to the specified email address. You can specify multiple values separated by commas. You can use this action in DLP policies that are scoped only to Exchange. @@ -2925,7 +3179,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2935,6 +3188,9 @@ Accept wildcard characters: False ``` ### -RemoveHeader + +> Applicable: Security & Compliance + The RemoveHeader parameter specifies an action for the DLP rule that removes a header field from the message header. This parameter uses the syntax `HeaderName` or `"HeaderName:HeaderValue"`.You can specify multiple header names or header name and value pairs separated by commas: `HeaderName1,"HeaderName2:HeaderValue2",HeaderName3,..."HeaderNameN:HeaderValueN"`. The maximum header name length is 64 characters, and header names can't contain spaces or colons ( : ). The maximum header value length is 128 characters. @@ -2945,7 +3201,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2955,6 +3210,9 @@ Accept wildcard characters: False ``` ### -RemoveRMSTemplate + +> Applicable: Security & Compliance + The RemoveRMSTemplate parameter specifies an action for the DLP rule that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: - $true: The message and attachments are decrypted. @@ -2966,7 +3224,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2976,6 +3233,9 @@ Accept wildcard characters: False ``` ### -ReportSeverityLevel + +> Applicable: Security & Compliance + The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: - None: You can't select this value if the rule has no actions configured. @@ -2987,7 +3247,6 @@ The ReportSeverityLevel parameter specifies the severity level of the incident r Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -2997,13 +3256,15 @@ Accept wildcard characters: False ``` ### -RestrictAccess + +> Applicable: Security & Compliance + {{ Fill RestrictAccess Description }} ```yaml Type: System.Collections.Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3013,13 +3274,15 @@ Accept wildcard characters: False ``` ### -RestrictBrowserAccess + +> Applicable: Security & Compliance + {{ Fill RestrictBrowserAccess Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3029,6 +3292,9 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Security & Compliance + The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - Ignore: Ignore the failure of the rule and thereby any actions in that rule and move to the next rule. @@ -3039,7 +3305,6 @@ The RuleErrorAction parameter specifies what to do if an error is encountered du Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3049,6 +3314,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeContainsWords + +> Applicable: Security & Compliance + The SenderADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: - City @@ -3089,7 +3357,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3099,6 +3366,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeMatchesPatterns + +> Applicable: Security & Compliance + The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: - City @@ -3139,7 +3409,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3149,6 +3418,9 @@ Accept wildcard characters: False ``` ### -SenderAddressLocation + +> Applicable: Security & Compliance + The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: - Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. @@ -3167,7 +3439,6 @@ Note that message envelope searching is available only for the following conditi Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicySenderAddressLocation Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3177,6 +3448,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Security & Compliance + The SenderDomainIs parameter specifies a condition for the DLP rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3185,7 +3459,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3195,6 +3468,9 @@ Accept wildcard characters: False ``` ### -SenderIPRanges + +> Applicable: Security & Compliance + The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -3207,7 +3483,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3217,6 +3492,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + The SentTo parameter specifies a condition for the DLP rule that looks for recipients in messages. You identify the recipients by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3225,7 +3503,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3235,6 +3512,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Security & Compliance + The SentToMemberOf parameter specifies a condition for the DLP rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3243,7 +3523,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3253,6 +3532,9 @@ Accept wildcard characters: False ``` ### -SetHeader + +> Applicable: Security & Compliance + The SetHeader parameter specifies an action for the DLP rule that adds or modifies a header field and value in the message header. This parameter uses the syntax `"HeaderName:HeaderValue"`. You can specify multiple header name and value pairs separated by commas: `"HeaderName1:HeaderValue1",HeaderName2:HeaderValue2",..."HeaderNameN:HeaderValueN"`. The maximum header name length is 64 characters, and header names can't contains spaces or colons ( : ). The maximum header value length is 128 characters. @@ -3263,7 +3545,6 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3273,6 +3554,9 @@ Accept wildcard characters: False ``` ### -SharedByIRMUserRisk + +> Applicable: Security & Compliance + The SharedByIRMUserRisk parameter specifies the risk category of the user performing the violating action. Valid values are: - FCB9FA93-6269-4ACF-A756-832E79B36A2A (Elevated Risk Level) @@ -3285,7 +3569,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: All Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3295,6 +3578,9 @@ Accept wildcard characters: False ``` ### -StopPolicyProcessing + +> Applicable: Security & Compliance + The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: - $true: Stop processing more rules. @@ -3304,7 +3590,6 @@ The StopPolicyProcessing parameter specifies an action that stops processing mor Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3314,6 +3599,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Security & Compliance + The SubjectContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in the Subject field of messages. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` @@ -3328,7 +3616,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3338,6 +3625,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Security & Compliance + The SubjectMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. @@ -3348,7 +3638,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3358,6 +3647,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Security & Compliance + The SubjectOrBodyContainsWords parameter specifies a condition for the rule that looks for words in the Subject field or body of messages. To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -3368,7 +3660,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3378,6 +3669,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyMatchesPatterns + +> Applicable: Security & Compliance + The SubjectOrBodyMatchesPatterns parameter specifies a condition for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. You can use this condition in DLP policies that are scoped only to Exchange. @@ -3386,7 +3680,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3396,13 +3689,15 @@ Accept wildcard characters: False ``` ### -ThirdPartyAppDlpRestrictions + +> Applicable: Security & Compliance + {{ Fill ThirdPartyAppDlpRestrictions Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3412,13 +3707,15 @@ Accept wildcard characters: False ``` ### -TriggerPowerAutomateFlow + +> Applicable: Security & Compliance + {{ Fill TriggerPowerAutomateFlow Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3428,6 +3725,9 @@ Accept wildcard characters: False ``` ### -UnscannableDocumentExtensionIs + +> Applicable: Security & Compliance + The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -3436,7 +3736,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -3446,13 +3745,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -3462,6 +3763,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Security & Compliance + The WithImportance parameter specifies a condition for the rule that looks for messages with the specified importance level. Valid values are: - Low @@ -3474,7 +3778,6 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpEdmSchema.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-DlpEdmSchema.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpEdmSchema.md index be8d02a43c..29d9c6a526 100644 --- a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpEdmSchema.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpedmschema applicable: Security & Compliance -title: Set-DlpEdmSchema -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpedmschema +schema: 2.0.0 +title: Set-DlpEdmSchema --- # Set-DlpEdmSchema @@ -44,6 +45,9 @@ This example modifies a DLP EDM schema using the edm.xml file in the C:\\My Docu ## PARAMETERS ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the DLP EDM schema that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -52,7 +56,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpKeywordDictionary.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpKeywordDictionary.md index aa9f4a5616..252eb72c74 100644 --- a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpKeywordDictionary.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpkeyworddictionary applicable: Security & Compliance -title: Set-DlpKeywordDictionary -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpkeyworddictionary +schema: 2.0.0 +title: Set-DlpKeywordDictionary --- # Set-DlpKeywordDictionary @@ -107,13 +108,15 @@ After you use Notepad to modify the terms and save the file, the last four comma ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the name of the DLP keyword dictionary that you want to modify. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: SensitiveInformationTypeIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -123,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -132,7 +138,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -142,13 +147,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies descriptive text for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -158,13 +165,15 @@ Accept wildcard characters: False ``` ### -DoNotPersistKeywords + +> Applicable: Security & Compliance + {{ Fill DoNotPersistKeywords Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -174,6 +183,9 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF-16. For more information, see the examples in this topic. The maximum file size is up to 1 MB of terms after compression. The organization limit for all dictionaries is also 1 MB after compression. @@ -182,7 +194,6 @@ The maximum file size is up to 1 MB of terms after compression. The organization Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -192,13 +203,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a unique name for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -208,13 +221,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DlpPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpPolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-DlpPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpPolicy.md index 74002da4a2..5a996fc620 100644 --- a/exchange/exchange-ps/exchange/Set-DlpPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlppolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-DlpPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlppolicy +schema: 2.0.0 +title: Set-DlpPolicy --- # Set-DlpPolicy @@ -49,6 +50,9 @@ This example disables the DLP policy named Employee Numbers. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the DLP policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the DLP policy that you want to modify. You can Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Description parameter specifies an optional description for the DLP policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,6 +129,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mode parameter specifies the action and notification level of the DLP policy. Valid values for this parameter are: - Audit: When a message matches the conditions specified by the DLP policy, the actions specified by the policy aren't enforced and no notification emails are sent. @@ -132,7 +144,6 @@ If the State parameter is set to Disabled, the value of the Mode parameter is ir Type: RuleMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a unique name for the DLP policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -158,13 +171,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The State parameter enables or disables the DLP policy. Valid input for this parameter is Enabled or Disabled. ```yaml Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationType.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationType.md index e6a09ab1b6..73e210f497 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationType.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype applicable: Security & Compliance -title: Set-DlpSensitiveInformationType -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpsensitiveinformationtype +schema: 2.0.0 +title: Set-DlpSensitiveInformationType --- # Set-DlpSensitiveInformationType @@ -93,6 +94,9 @@ The first three commands return the list of document fingerprints in the sensiti ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitive information type rule that you want to modify. You can use any value that uniquely identifies the sensitive information type rule. For example: - Name @@ -103,7 +107,6 @@ The Identity parameter specifies the sensitive information type rule that you wa Type: SensitiveInformationTypeIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -124,7 +130,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -134,13 +139,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the sensitive information type rule. You use the Description parameter with the Locale and Name parameters to specify descriptions for the sensitive information type rule in different languages. The localized values of Description appear in the AllLocalizedDescriptions property of the sensitive information type rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -150,13 +157,15 @@ Accept wildcard characters: False ``` ### -FileData + +> Applicable: Security & Compliance + {{ Fill FileData Description }} ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -166,13 +175,15 @@ Accept wildcard characters: False ``` ### -Fingerprints -The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the sensitive information type rule. For instructions on how to import documents to use as templates for fingerprints, see [New-DlpFingerprint](https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing sensitive information type rule, see the Examples section. + +> Applicable: Security & Compliance + +The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the sensitive information type rule. For instructions on how to import documents to use as templates for fingerprints, see [New-DlpFingerprint](https://learn.microsoft.com/powershell/module/exchangepowershell/new-dlpfingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing sensitive information type rule, see the Examples section. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -182,13 +193,15 @@ Accept wildcard characters: False ``` ### -IsExact + +> Applicable: Security & Compliance + {{ Fill IsExact Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Security & Compliance + The Locale parameter adds or removes languages that are associated with the sensitive information type rule. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -208,7 +224,6 @@ Typically, you use the Locale parameter with the Name and Description parameters Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -218,6 +233,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Security & Compliance + The Name parameter specifies a name for the sensitive information type rule. The value must be less than 256 characters. You use the Name parameter with the Locale and Description parameters to specify names for the sensitive information type rule in different languages. The localized values of Name appear in the AllLocalizedNames property of the sensitive information type rule. @@ -228,7 +246,6 @@ The value of the Name parameter is used in the Policy Tip that's presented to us Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -238,13 +255,15 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: Security & Compliance + {{ Fill Threshold Description }} ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -254,13 +273,15 @@ Accept wildcard characters: False ``` ### -ThresholdConfig + +> Applicable: Security & Compliance + {{ Fill ThresholdConfig Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -270,13 +291,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationTypeRulePackage.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationTypeRulePackage.md index 944203816e..83ed95ed5b 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DlpSensitiveInformationTypeRulePackage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtyperulepackage applicable: Security & Compliance -title: Set-DlpSensitiveInformationTypeRulePackage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dlpsensitiveinformationtyperulepackage +schema: 2.0.0 +title: Set-DlpSensitiveInformationTypeRulePackage --- # Set-DlpSensitiveInformationTypeRulePackage @@ -44,6 +45,9 @@ This example imports the sensitive information type rule package C:\\My Document ## PARAMETERS ### -FileData + +> Applicable: Security & Compliance + The FileData parameter specifies the sensitive information type rule package that you want to import. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -52,7 +56,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Set-DynamicDistributionGroup.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Set-DynamicDistributionGroup.md index 4b26f36939..65cda8e11c 100644 --- a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-DynamicDistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-dynamicdistributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-DynamicDistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-dynamicdistributiongroup +schema: 2.0.0 +title: Set-DynamicDistributionGroup --- # Set-DynamicDistributionGroup @@ -151,6 +152,9 @@ This example applies the following changes to the existing dynamic distribution ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the dynamic distribution group that you want to modify. You can use any value that uniquely identifies the dynamic distribution group. For example: - Name @@ -164,7 +168,6 @@ The Identity parameter specifies the dynamic distribution group that you want to Type: DynamicGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -174,6 +177,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -197,7 +203,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -207,6 +212,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -230,7 +238,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -240,6 +247,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -265,7 +275,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,6 +284,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -299,7 +311,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -309,6 +320,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -328,7 +342,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -338,6 +351,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -359,7 +375,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -369,6 +384,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -381,7 +399,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -391,6 +408,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -403,7 +423,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -413,6 +432,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -425,7 +447,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -435,6 +456,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -447,7 +471,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -457,6 +480,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -469,7 +495,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -479,6 +504,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -491,7 +519,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -501,6 +528,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -513,7 +543,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -523,6 +552,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -535,7 +567,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -545,6 +576,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -557,7 +591,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -567,6 +600,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -579,7 +615,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -589,6 +624,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -601,7 +639,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -611,6 +648,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -623,7 +663,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -633,6 +672,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -645,7 +687,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -655,6 +696,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -667,7 +711,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -677,6 +720,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -689,7 +735,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -699,6 +744,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -711,7 +759,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -721,6 +768,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -733,7 +783,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -743,6 +792,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -755,7 +807,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -765,6 +816,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -774,7 +828,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -784,6 +837,9 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: @@ -795,7 +851,6 @@ The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-fre Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -805,13 +860,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -821,13 +878,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -837,13 +896,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -853,13 +914,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -869,13 +932,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -885,13 +950,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -901,13 +968,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -917,13 +986,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -933,13 +1004,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -949,13 +1022,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -965,13 +1040,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -981,13 +1058,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -997,13 +1076,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1013,13 +1094,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1029,13 +1112,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1045,6 +1130,9 @@ Accept wildcard characters: False ``` ### -DirectMembershipOnly + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1053,7 +1141,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1063,13 +1150,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the dynamic distribution group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1079,6 +1168,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -1087,7 +1179,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1097,6 +1188,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -1124,7 +1218,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1134,6 +1227,9 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: @@ -1145,7 +1241,6 @@ The EmailAddressPolicyEnabled parameter specifies whether to apply email address Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1155,6 +1250,9 @@ Accept wildcard characters: False ``` ### -ExpansionServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ExpansionServer parameter specifies the Exchange server that's used to expand the distribution group. The default value is blank ($null), which means expansion happens on the closest available Exchange server. If you specify an expansion server, and that server is unavailable, any messages that are sent to the distribution group can't be delivered. @@ -1170,7 +1268,6 @@ When you specify an expansion server, use the ExchangeLegacyDN. You can find thi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1180,6 +1277,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -1192,7 +1292,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1202,6 +1301,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -1214,7 +1316,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1224,6 +1325,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -1236,7 +1340,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1246,6 +1349,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -1258,7 +1364,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1268,6 +1373,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -1280,7 +1388,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1290,6 +1397,9 @@ Accept wildcard characters: False ``` ### -ForceMembershipRefresh + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill ForceMembershipRefresh Description }} @@ -1298,7 +1408,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1308,13 +1417,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1324,6 +1435,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this dynamic distribution group. Although messages send on behalf of the group clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the group, not the sender. The sender you specify for this parameter must a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the sender. For example: @@ -1349,7 +1463,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1359,6 +1472,9 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. @@ -1368,7 +1484,6 @@ The HiddenFromAddressListsEnabled parameter specifies whether this recipient is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1378,6 +1493,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -1391,7 +1509,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1401,6 +1518,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -1416,7 +1536,6 @@ You can specify multiple values separated by commas. When you use multiple value Type: WellKnownRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1426,6 +1545,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -1437,7 +1559,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1447,6 +1568,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -1461,7 +1585,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1471,6 +1594,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies an owner for the group. A dynamic group can only have one owner. The group owner is able to: - Modify the properties of the group @@ -1494,7 +1620,6 @@ The owner you specify for this parameter must be a mailbox, mail user or mail-en Type: GeneralRecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1504,6 +1629,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxReceiveSize parameter specifies the maximum allowed email message size that can be sent to this group. @@ -1525,7 +1653,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1535,6 +1662,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxSendSize parameter specifies the maximum allowed email message size that can be sent from this group. @@ -1556,7 +1686,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1566,6 +1695,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1585,7 +1717,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1595,6 +1726,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -1606,7 +1740,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1616,13 +1749,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the dynamic distribution group. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1632,13 +1767,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1648,13 +1785,15 @@ Accept wildcard characters: False ``` ### -PhoneticDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1664,6 +1803,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the group are no longer automatically updated by email address policies. @@ -1674,7 +1816,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1684,6 +1825,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -1699,7 +1843,6 @@ Note that the RecipientContainer property can't be blank. The group is always li Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1709,6 +1852,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -1724,7 +1870,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1734,6 +1879,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1757,7 +1905,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1767,6 +1914,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1790,7 +1940,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1800,6 +1949,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1825,7 +1977,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1835,6 +1986,9 @@ Accept wildcard characters: False ``` ### -ReportToManagerEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ReportToManagerEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the owners of the group (defined by the ManagedBy property). Valid values are: - $true: Delivery status notifications are sent to the owners of the group. @@ -1846,7 +2000,6 @@ The ReportToManagerEnabled and ReportToOriginatorEnabled parameters affect the r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1856,6 +2009,9 @@ Accept wildcard characters: False ``` ### -ReportToOriginatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ReportToOriginatorEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to senders who send messages to this group. Valid values are: - $true: Delivery status notifications are sent to the message senders. This is the default value. @@ -1867,7 +2023,6 @@ The ReportToManagerEnabled and ReportToOriginatorEnabled parameters affect the r Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1877,6 +2032,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1886,7 +2044,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1896,6 +2053,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -1908,7 +2068,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1918,6 +2077,9 @@ Accept wildcard characters: False ``` ### -SendOofMessageToOriginatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SendOofMessageToOriginatorEnabled parameter specifies how to handle out of office (OOF) messages for members of the group. Valid values are: - $true: When messages are sent to the group, OOF messages for any of the group members are sent to the message sender. This is the default value. @@ -1927,7 +2089,6 @@ The SendOofMessageToOriginatorEnabled parameter specifies how to handle out of o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1937,6 +2098,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -1949,7 +2113,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1959,6 +2122,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -1979,7 +2145,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1989,6 +2154,9 @@ Accept wildcard characters: False ``` ### -UpdateMemberCount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill UpdateMemberCount Description }} @@ -1997,7 +2165,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2007,13 +2174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2023,6 +2192,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -2034,7 +2206,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-EOPProtectionPolicyRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EOPProtectionPolicyRule.md index 0f0aa7ab42..09ecc30047 100644 --- a/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EOPProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection -title: Set-EOPProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-eopprotectionpolicyrule +schema: 2.0.0 +title: Set-EOPProtectionPolicyRule --- # Set-EOPProtectionPolicyRule @@ -63,6 +64,9 @@ This example removes all conditions and exceptions from the Standard preset secu ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: - Name @@ -75,7 +79,6 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -110,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -151,7 +163,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: - Name @@ -178,7 +192,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. We highly recommend that you use the default rule names for clarity and consistency. @@ -196,7 +212,6 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -206,6 +221,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. @@ -216,7 +234,6 @@ You must use the default value for the rule. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,13 +243,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -242,6 +261,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -257,7 +279,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -267,6 +288,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -284,7 +308,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -294,13 +317,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-EcpVirtualDirectory.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EcpVirtualDirectory.md index df1c651b18..5626991ff1 100644 --- a/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EcpVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ecpvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-EcpVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ecpvirtualdirectory +schema: 2.0.0 +title: Set-EcpVirtualDirectory --- # Set-EcpVirtualDirectory @@ -67,6 +68,9 @@ This example turns off the Internet access to the EAC on server named Server01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the ECP virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -81,7 +85,6 @@ To manage the first ECP virtual directory created in an Exchange organization, y Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -AdfsAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AdfsAuthentication parameter specifies that the ECP virtual directory allows users to authenticate through Active Directory Federation Services (AD FS) authentication. This parameter accepts $true or $false. The default value is $false. The ADFS authentication settings for Set-OwaVirtualDirectory and Set-EcpVirtualDirectory are related. You need to set the AdfsAuthentication parameter on Set-EcpVirtualDirectory to $true before you can set the AdfsAuthentication parameter on Set-OwaVirtualDirectory to $true. Likewise, you need to set the AdfsAuthentication parameter on Set-OwaVirtualDirectory to $false before you can set the AdfsAuthentication parameter on Set-EcpVirtualDirectory to $false. @@ -99,7 +105,6 @@ The ADFS authentication settings for Set-OwaVirtualDirectory and Set-EcpVirtualD Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -AdminEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AdminEnabled parameter specifies that the EAC isn't able to be accessed through the Internet. For more information, see [Turn off access to the Exchange admin center](https://learn.microsoft.com/Exchange/architecture/client-access/disable-exchange-admin-center-access). This parameter accepts $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: - $true: Basic authentication is enabled. This is the default value. @@ -136,7 +146,6 @@ This parameter can be used with the FormsAuthentication parameter or with the Di Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -155,7 +167,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,6 +176,9 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. @@ -174,7 +188,6 @@ The DigestAuthentication parameter specifies whether Digest authentication is en Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,13 +197,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -212,7 +230,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +239,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -231,7 +251,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +260,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -253,7 +275,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,13 +284,15 @@ Accept wildcard characters: False ``` ### -ExternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalAuthenticationMethods parameter specifies the authentication methods supported on the Exchange server from outside the firewall. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -279,6 +302,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used. You need to set this parameter to allow the Autodiscover service to return the URL for the ECP virtual directory. @@ -287,7 +313,6 @@ This setting is also important when Secure Sockets Layer (SSL) is used. You need Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,6 +322,9 @@ Accept wildcard characters: False ``` ### -FormsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FormsAuthentication parameter specifies whether forms-based authentication is enabled on the ECP virtual directory. Valid values are: - $true: Forms authentication is enabled. The BasicAuthentication parameter is set to $true, and the DigestAuthentication and WindowsAuthentication parameters are set to $false. @@ -306,7 +334,6 @@ The FormsAuthentication parameter specifies whether forms-based authentication i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,13 +343,15 @@ Accept wildcard characters: False ``` ### -GzipLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GzipLevel parameter sets Gzip configuration information for the ECP virtual directory. ```yaml Type: GzipLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,6 +361,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is also important when SSL is used. You need to set this parameter to allow the Autodiscover service to return the URL for the ECP virtual directory. @@ -340,7 +372,6 @@ This setting is also important when SSL is used. You need to set this parameter Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -350,13 +381,15 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2019 + {{ Fill OAuthAuthentication Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -366,13 +399,15 @@ Accept wildcard characters: False ``` ### -OwaOptionsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaOptionsEnabled parameter specifies that Outlook on the web Options is enabled for end users. If this parameter is set to $false, users aren't able to access Outlook on the web Options. You may want to disable access if your organization uses non-Microsoft provider tools. This parameter accepts $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -382,13 +417,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -398,6 +435,9 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: - $true: Integrated Windows authentication is enabled. This is the default value. @@ -407,7 +447,6 @@ The WindowsAuthentication parameter specifies whether Integrated Windows authent Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-EdgeSyncServiceConfig.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EdgeSyncServiceConfig.md index e63e09bc66..3ee57372e0 100644 --- a/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EdgeSyncServiceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-edgesyncserviceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-EdgeSyncServiceConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-edgesyncserviceconfig +schema: 2.0.0 +title: Set-EdgeSyncServiceConfig --- # Set-EdgeSyncServiceConfig @@ -65,13 +66,15 @@ The log files are kept for 3 days. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the Microsoft Exchange EdgeSync service you want to configure. ```yaml Type: EdgeSyncServiceConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -ConfigurationSyncInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConfigurationSyncInterval parameter specifies how frequently the Microsoft Exchange EdgeSync service synchronizes configuration data. The default value is 3 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -89,7 +95,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -108,7 +116,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -CookieValidDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CookieValidDuration parameter specifies how long a cookie record is valid. The default value is 21 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -126,7 +136,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -FailoverDCInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FailoverDCInterval parameter specifies how long EdgeSync waits before failing over to another domain controller if it can't read configuration data from Active Directory. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -160,7 +174,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,6 +183,9 @@ Accept wildcard characters: False ``` ### -LockDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LockDuration parameter specifies how long an instance of the Microsoft Exchange EdgeSync service can maintain an exclusive lock on the synchronization rights. While an EdgeSync service maintains an exclusive lock on synchronization rights, no other EdgeSync service can take over synchronization. The default value is 6 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -178,7 +194,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +203,9 @@ Accept wildcard characters: False ``` ### -LockRenewalDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LockRenewalDuration parameter specifies how long before the expiry of an exclusive lock an EdgeSync service can renew the lock. The default value is 4 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -196,7 +214,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +223,15 @@ Accept wildcard characters: False ``` ### -LogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogEnabled parameter specifies enables or disables the EdgeSyncLog. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +241,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogLevel parameter specifies the EdgeSync logging level. Valid values are: - None (This is the default value) @@ -233,7 +255,6 @@ The LogLevel parameter specifies the EdgeSync logging level. Valid values are: Type: EdgeSyncLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,6 +264,9 @@ Accept wildcard characters: False ``` ### -LogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogMaxAge parameter specifies the maximum duration in days to keep the EdgeSyncLog files. Log files older than the specified value can be overwritten. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -251,7 +275,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,6 +284,9 @@ Accept wildcard characters: False ``` ### -LogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogMaxDirectorySize specifies the maximum amount of disk space the EdgeSyncLog directory can use. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -279,7 +305,6 @@ The value of the LogMaxFileSize parameter must be less than or equal to the valu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,6 +314,9 @@ Accept wildcard characters: False ``` ### -LogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogMaxFileSize parameter specifies the maximum log file size for the EdgeSyncLog files. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -307,7 +335,6 @@ The value of the LogMaxFileSize parameter must be less than or equal to the valu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,13 +344,15 @@ Accept wildcard characters: False ``` ### -LogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogPath parameter specifies the disk location to store the EdgeSyncLog files. The default value is TransportRoles\\Logs\\EdgeSync\\. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -333,13 +362,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a unique name for the EdgeSync service configuration. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -349,6 +380,9 @@ Accept wildcard characters: False ``` ### -OptionDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OptionDuration parameter specifies how long an instance of the Microsoft Exchange EdgeSync service can maintain an optional lock on the synchronization rights. While an EdgeSync service maintains an optional lock on synchronization rights, another EdgeSync service can take over synchronization after the optional lock has expired if it's initiated using the Start-EdgeSynchronization command. The default value is 30 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -357,7 +391,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -367,6 +400,9 @@ Accept wildcard characters: False ``` ### -RecipientSyncInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecipientSyncInterval parameter specifies how frequently the Microsoft Exchange EdgeSync service synchronizes recipient data from the global catalog. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -375,7 +411,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -385,13 +420,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-EmailAddressPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EmailAddressPolicy.md index 3d157d6042..1124b51735 100644 --- a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EmailAddressPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-emailaddresspolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-EmailAddressPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-emailaddresspolicy +schema: 2.0.0 +title: Set-EmailAddressPolicy --- # Set-EmailAddressPolicy @@ -96,6 +97,9 @@ In Exchange Online, this example modifies the existing email address policy name ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the email address policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -106,7 +110,6 @@ The Identity parameter specifies the email address policy that you want to modif Type: EmailAddressPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -116,6 +119,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. @@ -130,7 +136,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,6 +145,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. @@ -154,7 +162,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -164,6 +171,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. @@ -178,7 +188,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +197,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. @@ -202,7 +214,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +223,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. @@ -226,7 +240,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +249,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. @@ -250,7 +266,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,6 +275,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. @@ -274,7 +292,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,6 +301,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. @@ -298,7 +318,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -308,6 +327,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. @@ -322,7 +344,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,6 +353,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. @@ -346,7 +370,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,6 +379,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. @@ -370,7 +396,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -380,6 +405,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. @@ -394,7 +422,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -404,6 +431,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. @@ -418,7 +448,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -428,6 +457,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. @@ -442,7 +474,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -452,6 +483,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. @@ -466,7 +500,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -476,6 +509,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. @@ -490,7 +526,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -500,6 +535,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. @@ -514,7 +552,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -524,6 +561,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. @@ -538,7 +578,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -548,6 +587,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -557,7 +599,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -567,6 +608,9 @@ Accept wildcard characters: False ``` ### -DisabledEmailAddressTemplates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DisabledEmailAddressTemplates parameter specifies the proxy email addresses templates that are included in an email address policy, but aren't used to configure the email addresses of recipients. @@ -584,7 +628,6 @@ Typically, this property is only populated by values after a migration from a pr Type: ProxyAddressTemplateCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -594,6 +637,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -602,7 +648,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -612,6 +657,9 @@ Accept wildcard characters: False ``` ### -EnabledEmailAddressTemplates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EnabledEmailAddressTemplates parameter specifies the rules in the email address policy that are used to generate email addresses for recipients. Valid syntax for this parameter is `Type:AddressFormat`: @@ -631,7 +679,6 @@ In Exchange Online PowerShell, if you use this parameter with the IncludeUnified Type: ProxyAddressTemplateCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -641,6 +688,9 @@ Accept wildcard characters: False ``` ### -EnabledPrimarySMTPAddressTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EnabledPrimarySMTPAddressTemplate parameter specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. @@ -653,7 +703,6 @@ In Exchange Online PowerShell, if you use this parameter with the IncludeUnified Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -663,13 +712,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -679,6 +730,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: @@ -696,7 +750,6 @@ You can specify multiple values separated by commas. When you use multiple value Type: WellKnownRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -706,13 +759,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name for the email address policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -722,6 +777,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Priority parameter specifies the order that the email address policies are evaluated. By default, every time that you add a new email address policy, the policy is assigned a priority of N+1, where N is the number of email address policies that you've created. If you set this parameter to a value that's the same as another email address policy, the priority of the policy that you added first is incremented by 1. @@ -732,7 +790,6 @@ If you set this parameter to a value that's the same as another email address po Type: EmailAddressPolicyPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -742,6 +799,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -757,7 +817,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -767,6 +826,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. @@ -783,7 +845,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -793,13 +854,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-EmailTenantSettings.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-EmailTenantSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EmailTenantSettings.md index 795f69bb1f..bffda0e62d 100644 --- a/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EmailTenantSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-emailtenantsettings applicable: Exchange Online -title: Set-EmailTenantSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-emailtenantsettings +schema: 2.0.0 +title: Set-EmailTenantSettings --- # Set-EmailTenantSettings @@ -45,13 +46,15 @@ This example enables priority account protection in the organization. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the settings object that you want to modify. The only settings object in the organization is named Default. ```yaml Type: EmailTenantSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: 0 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -80,13 +85,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -96,6 +103,9 @@ Accept wildcard characters: False ``` ### -EnablePriorityAccountProtection + +> Applicable: Exchange Online + The EnablePriorityAccountProtection parameter enables or disable priority account protection in the organization. Valid values are: - $true: Priority account protection is enabled. @@ -105,7 +115,6 @@ The EnablePriorityAccountProtection parameter enables or disable priority accoun Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -IgnoreDehydratedFlag + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -131,13 +142,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EventLogLevel.md b/exchange/exchange-ps/ExchangePowerShell/Set-EventLogLevel.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-EventLogLevel.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EventLogLevel.md index 4b819c2bb3..9c20bb18f4 100644 --- a/exchange/exchange-ps/exchange/Set-EventLogLevel.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EventLogLevel.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-eventloglevel applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-EventLogLevel -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-eventloglevel +schema: 2.0.0 +title: Set-EventLogLevel --- # Set-EventLogLevel @@ -39,18 +40,20 @@ Set-EventLogLevel -Identity "Exchange01\MSExchangeTransport\SmtpReceive" -Level This example sets the event log level to High for the MSExchangeTransport\\SmtpReceive event logging category on the Exchange server Exchange01. -**Note**: Run the Get-EventLogLevel cmdlet to retrieve a list of the event categories on your server. For more information, see [Get-EventLogLevel](https://learn.microsoft.com/powershell/module/exchange/get-eventloglevel). +**Note**: Run the Get-EventLogLevel cmdlet to retrieve a list of the event categories on your server. For more information, see [Get-EventLogLevel](https://learn.microsoft.com/powershell/module/exchangepowershell/get-eventloglevel). ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the event logging category for which you want to set the event logging level. ```yaml Type: ECIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Level parameter specifies the log level for the specific event logging category. The valid values are: - Lowest @@ -72,7 +78,6 @@ The Level parameter specifies the log level for the specific event logging categ Type: ECIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -91,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-EventsFromEmailConfiguration.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-EventsFromEmailConfiguration.md index 77225894de..706bc92788 100644 --- a/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-EventsFromEmailConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-eventsfromemailconfiguration applicable: Exchange Online -title: Set-EventsFromEmailConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-eventsfromemailconfiguration +schema: 2.0.0 +title: Set-EventsFromEmailConfiguration --- # Set-EventsFromEmailConfiguration @@ -71,13 +72,15 @@ This example resets Events from Email settings for the user. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox that you want to modify. You identify the mailbox by email address. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -CreateEventsFromEmailAsPrivate + +> Applicable: Exchange Online + The CreateEventsFromEmailAsPrivate parameter specifies whether to create the events discovered from messages as normal or private events. Valid values are: - $true: The events are crated as private events. This is the default value. @@ -96,7 +102,6 @@ The CreateEventsFromEmailAsPrivate parameter specifies whether to create the eve Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -EventReservationProcessingLevel + +> Applicable: Exchange Online + This parameter has been deprecated and is no longer used. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -122,6 +129,9 @@ Accept wildcard characters: False ``` ### -FlightReservationProcessingLevel + +> Applicable: Exchange Online + The FlightReservationProcessingLevel parameter specifies whether flight reservations are automatically discovered from messages, and whether these reservations are automatically added to the user's calendar. Valid values are: - Disabled: Do not discover flight reservations from messages. @@ -134,7 +144,6 @@ Note that these values are case sensitive. Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -FoodEstablishmentReservationProcessingLevel + +> Applicable: Exchange Online + This parameter has been deprecated and is no longer used. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -160,13 +171,15 @@ Accept wildcard characters: False ``` ### -InvoiceProcessingLevel + +> Applicable: Exchange Online + This parameter has been deprecated and is no longer used. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -176,6 +189,9 @@ Accept wildcard characters: False ``` ### -LodgingReservationProcessingLevel + +> Applicable: Exchange Online + The LodgingReservationProcessingLevel parameter specifies whether lodging reservations are automatically discovered from messages, and whether these reservations are automatically added to the user's calendar. Valid values are: - Disabled: Do not discover lodging reservations from messages. @@ -186,7 +202,6 @@ The LodgingReservationProcessingLevel parameter specifies whether lodging reserv Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -196,6 +211,9 @@ Accept wildcard characters: False ``` ### -ParcelDeliveryProcessingLevel + +> Applicable: Exchange Online + The ParcelDeliveryProcessingLevel parameter specifies whether parcel deliveries are automatically discovered from messages, and whether these reservations are automatically added to the user's calendar. Valid values are: - Disabled: Do not discover parcel deliveries from messages. @@ -206,7 +224,6 @@ The ParcelDeliveryProcessingLevel parameter specifies whether parcel deliveries Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,6 +233,9 @@ Accept wildcard characters: False ``` ### -RentalCarReservationProcessingLevel + +> Applicable: Exchange Online + The RentalCarReservationProcessingLevel parameter specifies whether rental car reservations are automatically discovered from messages, and whether these reservations are automatically added to the user's calendar. Valid values are: - Disabled: Do not discover rental car reservations from messages. @@ -226,7 +246,6 @@ The RentalCarReservationProcessingLevel parameter specifies whether rental car r Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -236,13 +255,15 @@ Accept wildcard characters: False ``` ### -ResetSettings + +> Applicable: Exchange Online + The ResetSettings switch specifies whether to return all of the reservation discovery settings to their default values. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ResetSettings Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -252,13 +273,15 @@ Accept wildcard characters: False ``` ### -ServiceReservationProcessingLevel + +> Applicable: Exchange Online + This parameter has been deprecated and is no longer used. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeAssistanceConfig.md similarity index 81% rename from exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExchangeAssistanceConfig.md index 69e2cfccc7..01ea6df375 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeAssistanceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangeassistanceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ExchangeAssistanceConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-exchangeassistanceconfig +schema: 2.0.0 +title: Set-ExchangeAssistanceConfig --- # Set-ExchangeAssistanceConfig @@ -60,13 +61,15 @@ This example changes the Help location for the Exchange admin center. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -CommunityLinkDisplayEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -CommunityURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -117,7 +127,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -ControlPanelFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -ControlPanelFeedbackURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,13 +172,15 @@ Accept wildcard characters: False ``` ### -ControlPanelHelpURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ControlPanelHelpURL parameter specifies the URL where help for the Exchange admin center (EAC) is hosted. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,6 +190,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -183,7 +201,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +210,9 @@ Accept wildcard characters: False ``` ### -ExchangeHelpAppOnline + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExchangeHelpAppOnline specifies whether your organization uses the public help that's hosted by Microsoft. Valid values are: - $true: Your organization uses the help that's hosted by Microsoft. This is the default value. @@ -202,7 +222,6 @@ The ExchangeHelpAppOnline specifies whether your organization uses the public he Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,13 +231,15 @@ Accept wildcard characters: False ``` ### -ManagementConsoleFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,13 +249,15 @@ Accept wildcard characters: False ``` ### -ManagementConsoleFeedbackURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -244,13 +267,15 @@ Accept wildcard characters: False ``` ### -ManagementConsoleHelpURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ManagementConsoleHelpURL parameter specifies the URL where help for the Exchange Management Console (EMC) is hosted. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,13 +285,15 @@ Accept wildcard characters: False ``` ### -OWAFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,13 +303,15 @@ Accept wildcard characters: False ``` ### -OWAFeedbackURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -292,13 +321,15 @@ Accept wildcard characters: False ``` ### -OWAHelpURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OWAHelpURL parameter specifies the URL for where help for the standard version of Outlook on the web is hosted. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -308,13 +339,15 @@ Accept wildcard characters: False ``` ### -OWALightFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,13 +357,15 @@ Accept wildcard characters: False ``` ### -OWALightFeedbackURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,13 +375,15 @@ Accept wildcard characters: False ``` ### -OWALightHelpURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OWALightHelpURL parameter specifies the URL for where help for the light version of Outlook on the web is hosted. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +393,15 @@ Accept wildcard characters: False ``` ### -PrivacyLinkDisplayEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -372,13 +411,15 @@ Accept wildcard characters: False ``` ### -PrivacyStatementURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -388,13 +429,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExchangeFeature.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeFeature.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-ExchangeFeature.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExchangeFeature.md index f023153538..a899325723 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeFeature.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeFeature.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangefeature applicable: Exchange Server 2019 -title: Set-ExchangeFeature -schema: 2.0.0 author: lusassl-msft +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: lusassl ms.reviewer: srvar +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-exchangefeature +schema: 2.0.0 +title: Set-ExchangeFeature --- # Set-ExchangeFeature @@ -61,6 +63,9 @@ This example blocks the features F1.1.1, F1.2.1, and F2.1.1 on the computer name ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019 + The Identity parameter specifies the Exchange server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -72,7 +77,6 @@ The Identity parameter specifies the Exchange server that you want to modify. Yo Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: True Position: 0 @@ -82,13 +86,15 @@ Accept wildcard characters: False ``` ### -Approve + +> Applicable: Exchange Server 2019 + The Approve switch approves the feature specified by the FeatureID parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -98,13 +104,15 @@ Accept wildcard characters: False ``` ### -Block + +> Applicable: Exchange Server 2019 + The Block switch blocks the feature specified by the FeatureID parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -123,7 +134,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019 Required: False Position: Named @@ -133,13 +143,15 @@ Accept wildcard characters: False ``` ### -FeatureID + +> Applicable: Exchange Server 2019 + The FeatureID parameter specifies the feature you want to control. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -149,13 +161,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExchangeServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeServer.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-ExchangeServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExchangeServer.md index b010016da0..1dc0ff53dd 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangeserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ExchangeServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-exchangeserver +schema: 2.0.0 +title: Set-ExchangeServer --- # Set-ExchangeServer @@ -74,6 +75,9 @@ This example removes an Exchange server from the Customer Experience Improvement ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Exchange server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -85,7 +89,6 @@ The Identity parameter specifies the Exchange server that you want to modify. Yo Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -104,7 +110,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -CustomerFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CustomerFeedbackEnabled parameter specifies whether the Exchange server is enrolled in the Microsoft Customer Experience Improvement Program (CEIP). The CEIP collects anonymous information about how you use Exchange and problems that you might encounter. If you decide not to participate in the CEIP, the servers are opted-out automatically. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -DataCollectionEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The DataCollectionEnabled parameter specifies whether the EM Service will collect and send diagnostic data to Microsoft using OCS. Valid values are: - $true: The EM Service collects and sends diagnostic data to Microsoft using OCS. @@ -139,7 +149,6 @@ The DataCollectionEnabled parameter specifies whether the EM Service will collec Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -157,7 +169,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -ErrorReportingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ErrorReportingEnabled parameter specifies whether error reporting is enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,6 +196,9 @@ Accept wildcard characters: False ``` ### -InternetWebProxy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternetWebProxy parameter specifies the web proxy server that the Exchange server uses to reach the internet. A valid value for this parameter is the URL of the web proxy server. In Exchange 2016 or later, to configure a list of servers that bypass the web proxy server and connect to the internet directly, use the InternetWebProxyBypassList parameter. @@ -191,7 +207,6 @@ In Exchange 2016 or later, to configure a list of servers that bypass the web pr Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,6 +216,9 @@ Accept wildcard characters: False ``` ### -InternetWebProxyBypassList + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The InternetWebProxyBypassList parameter specifies a list of servers that bypass the web proxy server specified by the InternetWebProxy parameter. You identify the servers by their FQDN (for example, server01.contoso.com). To enter multiple values and overwrite any existing FQDN entries, use the following syntax: @("host1.contoso.com","host2.contoso.com","host3.contoso.com"). @@ -211,7 +229,6 @@ The maximum number of servers you can enter with this parameter is 100. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -221,13 +238,15 @@ Accept wildcard characters: False ``` ### -MitigationsApplied + +> Applicable: Exchange Server 2016, Exchange Server 2019 + Do not use this parameter. The EM service uses this parameter to store and track mitigation status. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,6 +256,9 @@ Accept wildcard characters: False ``` ### -MitigationsBlocked + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The MitigationsBlocked parameter specifies a list of mitigations that are blocked. The Mitigation IDs present in this list are not applied by EM service in its hourly run. To enter multiple values and overwrite any existing Mitigation entries, use the following syntax: `@("Entry1","Entry2",..."EntryN")`. @@ -245,7 +267,6 @@ To enter multiple values and overwrite any existing Mitigation entries, use the Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +276,9 @@ Accept wildcard characters: False ``` ### -MitigationsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The MitigationsEnabled parameter specifies whether the Exchange Emergency Mitigation service (EM service) automatically applies mitigations on the Exchange server. Valid values are: - $true: The EM Service automatically applies mitigations on the Exchange server. @@ -266,7 +290,6 @@ For more information, see [Exchange Emergency Mitigation (EM) service](https://l Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,13 +299,15 @@ Accept wildcard characters: False ``` ### -MonitoringGroup + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringGroup parameter specifies how to add your Exchange servers to monitoring groups. You can add your servers to an existing group or create a monitoring group based on location or deployment, or to partition monitoring responsibility among your servers. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -292,13 +317,15 @@ Accept wildcard characters: False ``` ### -ProductKey + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProductKey parameter specifies the server product key. ```yaml Type: ProductKey Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -308,13 +335,15 @@ Accept wildcard characters: False ``` ### -RingLevel + +> Applicable: Exchange Server 2019 + The RingLevel parameter specifies the server ring level that's used by the Feature Flighting feature. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -324,13 +353,15 @@ Accept wildcard characters: False ``` ### -StaticConfigDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The StaticConfigDomainController parameter specifies whether to configure a domain controller to be used by the server via Directory Service Access (DSAccess). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,13 +371,15 @@ Accept wildcard characters: False ``` ### -StaticDomainControllers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The StaticDomainControllers parameter specifies whether to configure a list of domain controllers to be used by the server via DSAccess. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +389,15 @@ Accept wildcard characters: False ``` ### -StaticExcludedDomainControllers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The StaticExcludedDomainControllers parameter specifies whether to exclude a list of domain controllers from being used by the server. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -372,13 +407,15 @@ Accept wildcard characters: False ``` ### -StaticGlobalCatalogs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The StaticGlobalCatalogs parameter specifies whether to configure a list of global catalogs to be used by the server via DSAccess. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -388,13 +425,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeSettings.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-ExchangeSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExchangeSettings.md index 436392e2c0..84fe110fd6 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExchangeSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangesettings applicable: Exchange Server 2016, Exchange Server 2019 -title: Set-ExchangeSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-exchangesettings +schema: 2.0.0 +title: Set-ExchangeSettings --- # Set-ExchangeSettings @@ -207,6 +208,9 @@ This example allows users to see the results of Unified Audit Logging. This exam ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the existing Exchange settings object that contains the Exchange settings that you want to configure. The value of this parameter is the value of the Name parameter on the New-ExchangeSetting cmdlet when the Exchange settings object was created. @@ -215,7 +219,6 @@ The value of this parameter is the value of the Name parameter on the New-Exchan Type: ExchangeSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -225,13 +228,15 @@ Accept wildcard characters: False ``` ### -ClearHistory + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ClearHistory switch specifies that you want to clear the entries in the modification history for the Exchange setting object. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ClearHistory Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -241,6 +246,9 @@ Accept wildcard characters: False ``` ### -ConfigName + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ConfigName parameter specifies the available Exchange setting that you want to add, remove, or update in the Exchange settings object. Valid values for this parameter are determined by the configuration schema that was specified by the Name parameter on the New-ExchangeSettings cmdlet. For add and update operations, you also need to use the ConfigValue parameter to specify the actual value for the setting. You can't use the ConfigName parameter with the ConfigPairs parameter. @@ -249,7 +257,6 @@ For add and update operations, you also need to use the ConfigValue parameter to Type: String Parameter Sets: UpdateSetting, RemoveSetting Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -259,15 +266,17 @@ Accept wildcard characters: False ``` ### -ConfigPairs + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ConfigName parameter specifies the available Exchange setting that you want to add, remove, or update in the Exchange settings object. Valid values for this parameter are determined by the configuration schema that was specified by the Name parameter on the New-ExchangeSettings cmdlet. The syntax for a value is `=`. You can separate multiple values separated by commas. You can't use the ConfigPairs parameter with the ConfigName or ConfigValue parameters. ```yaml Type: String[] -Parameter Sets: RemoveMultipleSettings, UpdateMultipleSettings +Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric, RemoveMultipleSettings, UpdateMultipleSettings Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -276,20 +285,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String[] -Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -ConfigValue -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019 -### -ConfigValue The ConfigValue parameter specifies the value for the Exchange setting that you specified with the ConfigName parameter. The values are determined by the type of setting (a number, a timespan, $true or $false, etc.). You can't use the ConfigValue parameter with the ConfigPairs parameter. @@ -298,7 +297,6 @@ You can't use the ConfigValue parameter with the ConfigPairs parameter. Type: String Parameter Sets: UpdateSetting Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -308,6 +306,9 @@ Accept wildcard characters: False ``` ### -CreateSettingsGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The CreateSettingsGroup switch specifies that you're creating an Exchange settings group, which is a group of related Exchange settings. You don't need to specify a value with this switch. Depending on how you want to configure the settings group, you use either the GroupName parameter or the SettingsGroup parameter to specify the name of the Exchange settings group. Choose carefully, because you can't rename an existing settings group. @@ -316,7 +317,6 @@ Depending on how you want to configure the settings group, you use either the Gr Type: SwitchParameter Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupAdvanced, CreateSettingsGroupGeneric Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -326,6 +326,9 @@ Accept wildcard characters: False ``` ### -ExpirationDate + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ExpirationDate parameter specifies the end date/time of the Exchange settings that are defined by the specified Exchange settings group. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -334,9 +337,8 @@ You can only use the ExpirationDate parameter with the CreateSettingsGroup or Up ```yaml Type: DateTime -Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric +Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric, UpdateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -345,20 +347,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: DateTime -Parameter Sets: UpdateSettingsGroup -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +### -GuidMatch -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2016, Exchange Server 2019 -### -GuidMatch The GuidMatch parameter specifies the scope of an Exchange settings group based on the GUID of the object (for example, the GUID of the mailbox database). This parameter is available for use with all Scope parameter values other than Forest. You use the GuidMatch parameter only when you create Exchange settings groups by using the CreateSettingsGroup switch with the GroupName parameter. @@ -369,7 +361,6 @@ You can't use this parameter with the GenericScopeName, GenericScopeValue, MaxVe Type: Guid Parameter Sets: CreateSettingsGroupGuid Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -379,13 +370,15 @@ Accept wildcard characters: False ``` ### -Reason + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Reason parameter specifies a description for why the Exchange setting or settings group was created or modified. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -395,6 +388,9 @@ Accept wildcard characters: False ``` ### -RemoveSetting + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RemoveSetting switch specifies that you're removing an existing Exchange setting from an Exchange settings object. You don't need to specify a value with this switch. You use the ConfigPairs parameter or the ConfigName parameter to specify the setting that you want to remove. @@ -403,7 +399,6 @@ You use the ConfigPairs parameter or the ConfigName parameter to specify the set Type: SwitchParameter Parameter Sets: RemoveSetting, RemoveMultipleSettings Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -413,6 +408,9 @@ Accept wildcard characters: False ``` ### -RemoveSettingsGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RemoveSettingsGroup switch specifies that you're removing an Exchange settings group. You don't need to specify a value with this switch. You use the GroupName parameter to specify the Exchange settings group that you want to remove. @@ -421,7 +419,6 @@ You use the GroupName parameter to specify the Exchange settings group that you Type: SwitchParameter Parameter Sets: RemoveSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -431,6 +428,9 @@ Accept wildcard characters: False ``` ### -SettingsGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The SettingsGroup parameter specifies an existing Exchange settings group that's used to create a new settings group, or modify an existing settings group. You can't use the SettingsGroup parameter with the GroupName parameter. @@ -439,7 +439,6 @@ You can't use the SettingsGroup parameter with the GroupName parameter. Type: String Parameter Sets: CreateSettingsGroupAdvanced, UpdateSettingsGroupAdvanced Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -449,6 +448,9 @@ Accept wildcard characters: False ``` ### -UpdateSetting + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The UpdateSetting switch specifies that you're updating an Exchange setting in an existing Exchange settings object. You don't need to specify a value with this switch. You use the ConfigPairs parameter or the ConfigName and ConfigValue parameters to configure the Exchange setting. @@ -457,7 +459,6 @@ You use the ConfigPairs parameter or the ConfigName and ConfigValue parameters t Type: SwitchParameter Parameter Sets: UpdateSetting, UpdateMultipleSettings Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -467,6 +468,9 @@ Accept wildcard characters: False ``` ### -UpdateSettingsGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The UpdateSettingsGroup switch specifies that you're modifying an Exchange settings group. You don't need to specify a value with this switch. Depending on how you want to configure the settings group, you use either the GroupName parameter or the SettingsGroup parameter to specify the Exchange settings group that you want to modify. @@ -475,7 +479,6 @@ Depending on how you want to configure the settings group, you use either the Gr Type: SwitchParameter Parameter Sets: UpdateSettingsGroup, UpdateSettingsGroupAdvanced Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -485,6 +488,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -496,7 +502,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -506,6 +511,9 @@ Accept wildcard characters: False ``` ### -Disable + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Disable switch specifies that the Exchange settings group is disabled. You don't need to specify a value with this switch. You can only use this switch with the CreateSettingsGroup switch. @@ -516,7 +524,6 @@ To use this switch to enable an Exchange settings group, use this exact syntax ` Type: SwitchParameter Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -526,6 +533,9 @@ Accept wildcard characters: False ``` ### -DisableGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The DisableGroup parameter specifies the name of the enabled Exchange settings group that you want to disable. If the value contains spaces, enclose the value in quotation marks ("). You can use the DisableGroup and EnableGroup parameters together in the same command to enable and disable different Exchange settings groups at the same time. @@ -534,7 +544,6 @@ You can use the DisableGroup and EnableGroup parameters together in the same com Type: String Parameter Sets: EnableSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -544,13 +553,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -560,6 +571,9 @@ Accept wildcard characters: False ``` ### -EnableGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The EnableGroup parameter specifies the name of the disabled Exchange settings group that you want to enable. If the value contains spaces, enclose the value in quotation marks ("). You can use the DisableGroup and EnableGroup parameters together in the same command to enable and disable different Exchange settings groups at the same time. @@ -568,7 +582,6 @@ You can use the DisableGroup and EnableGroup parameters together in the same com Type: String Parameter Sets: EnableSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -578,6 +591,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -586,7 +602,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -596,13 +611,15 @@ Accept wildcard characters: False ``` ### -GenericScopeName + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The GenericScopeName parameter specifies the name of the scope. The available values are determined by the schema of the Exchange setting object. ```yaml Type: String Parameter Sets: CreateSettingsGroupGeneric Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -612,13 +629,15 @@ Accept wildcard characters: False ``` ### -GenericScopeValue + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The GenericScopeValue parameter specifies the value of the scope specified by the GenericScopeName parameter. The available values are determined by the schema of the Exchange setting object. ```yaml Type: String Parameter Sets: CreateSettingsGroupGeneric Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -628,6 +647,9 @@ Accept wildcard characters: False ``` ### -GroupName + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The GroupName parameter specifies the name of the Exchange settings group in group operations. For example: - Create Exchange settings groups and simultaneously configure the group scope and priority. @@ -641,7 +663,6 @@ If the value contains spaces, enclose the value in quotation marks ("). Type: String Parameter Sets: UpdateSetting, RemoveSetting, CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric, UpdateSettingsGroup, RemoveMultipleSettings, RemoveSettingsGroup, UpdateMultipleSettings Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -651,6 +672,9 @@ Accept wildcard characters: False ``` ### -MaxVersion + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The MaxVersion parameter specifies the scope of an Exchange settings group based on the version of the object (for example, the version of Exchange that's installed on the server). This parameter is available for use with all Scope parameter values other than Forest. You use the MaxVersion parameter together with the MinVersion parameter only when you create Exchange settings groups by using the CreateSettingsGroup switch with the GroupName parameter. @@ -661,7 +685,6 @@ You can't use this parameter with the GuidMatch, GenericScopeName, or GenericSco Type: String Parameter Sets: CreateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -671,6 +694,9 @@ Accept wildcard characters: False ``` ### -MinVersion + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The MinVersion parameter specifies the scope of an Exchange settings group based on the version of the object (for example, the version of Exchange that's installed on the server). This parameter is available for use with all Scope parameter values other than Forest. You use the MinVersion parameter together with the MaxVersion parameter only when you create Exchange settings groups by using the CreateSettingsGroup switch with the GroupName parameter. @@ -681,7 +707,6 @@ You can't use this parameter with GuidMatch, GenericScopeName, or GenericScopeVa Type: String Parameter Sets: CreateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -691,6 +716,9 @@ Accept wildcard characters: False ``` ### -NameMatch + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The NameMatch parameter specifies the scope of an Exchange settings group based on the name of the object (for example, the process name). This parameter is available for use with all Scope parameter values other than Forest. You use the NameMatch parameter only when you create Exchange settings groups by using the CreateSettingsGroup switch with the GroupName parameter. @@ -701,7 +729,6 @@ You can't use this parameter with the GuidMatch, GenericScopeName, or GenericSco Type: String Parameter Sets: CreateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -711,13 +738,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the priority of an Exchange settings group. The priority value for every group must be unique. A lower priority value indicates a higher priority. ```yaml Type: Int32 Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric, UpdateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -727,6 +756,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Scope parameter specifies the scope of the Exchange settings object. Valid values are: - Dag @@ -742,7 +774,6 @@ The Scope parameter specifies the scope of the Exchange settings object. Valid v Type: ExchangeSettingsScope Parameter Sets: CreateSettingsGroup, CreateSettingsGroupGuid, CreateSettingsGroupGeneric Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -752,6 +783,9 @@ Accept wildcard characters: False ``` ### -ScopeFilter + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ScopeFilter parameter uses OPATH filter syntax to specify the scope of an Exchange settings group based. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"ServerRole -like 'Mailbox*'"`). - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -771,7 +805,6 @@ You use this parameter only when you update Exchange settings groups by using th Type: String Parameter Sets: CreateSettingsGroup, UpdateSettingsGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -781,13 +814,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExoPhishSimOverrideRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExoPhishSimOverrideRule.md index 65ae3af9cb..0ff54a190c 100644 --- a/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExoPhishSimOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-exophishsimoverriderule applicable: Exchange Online -title: Set-ExoPhishSimOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-exophishsimoverriderule +schema: 2.0.0 +title: Set-ExoPhishSimOverrideRule --- # Set-ExoPhishSimOverrideRule @@ -57,6 +58,9 @@ This example modifies the specified phishing simulation override rule with the s ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -70,7 +74,6 @@ Use the Get-ExoPhishSimOverrideRule cmdlet to find the values. The name of the r Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AddDomains + +> Applicable: Exchange Online + The AddDomains parameter specifies an existing entry to add to the list of email domains that are used by the non-Microsoft phishing simulation. You can specify multiple values separated by commas. A maximum of 20 entries are allowed in the list. @@ -88,7 +94,6 @@ You can specify multiple values separated by commas. A maximum of 20 entries are Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -AddSenderIpRanges + +> Applicable: Exchange Online + The AddSenderIpRanges parameter specifies an existing entry to add to the list of source IP addresses that are used by the non-Microsoft phishing simulation. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -112,7 +120,6 @@ A maximum of 10 entries are allowed in the list. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -147,7 +159,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -157,13 +168,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -173,6 +186,9 @@ Accept wildcard characters: False ``` ### -RemoveDomains + +> Applicable: Exchange Online + The RemoveDomains parameter specifies an existing entry to remove from the list of email domains that are used by the non-Microsoft phishing simulation. You can specify multiple values separated by commas. @@ -181,7 +197,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -191,6 +206,9 @@ Accept wildcard characters: False ``` ### -RemoveSenderIpRanges + +> Applicable: Exchange Online + The RemoveSenderIpRanges parameter specifies an existing entry to remove from the list of source IP addresses that are used by the non-Microsoft phishing simulation. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -203,7 +221,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -213,13 +230,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExoSecOpsOverrideRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExoSecOpsOverrideRule.md index 29ef4908ae..c289ce7162 100644 --- a/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExoSecOpsOverrideRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-exosecopsoverriderule applicable: Exchange Online -title: set-ExoSecOpsOverrideRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/get-exosecopsoverriderule +schema: 2.0.0 +title: set-ExoSecOpsOverrideRule --- # Set-ExoSecOpsOverrideRule @@ -53,6 +54,9 @@ This example adds a comment to the specified SecOps mailbox override rule. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -66,7 +70,6 @@ Use the Get-ExoSecOpsMailboxRule cmdlet to find these values. The name of the ru Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -101,7 +109,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -111,13 +118,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md b/exchange/exchange-ps/ExchangePowerShell/Set-ExternalInOutlook.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-ExternalInOutlook.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ExternalInOutlook.md index 83221e105b..618f01f80b 100644 --- a/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ExternalInOutlook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-externalinoutlook applicable: Exchange Online, Exchange Online Protection -title: Set-ExternalInOutlook -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-externalinoutlook +schema: 2.0.0 +title: Set-ExternalInOutlook --- # Set-ExternalInOutlook @@ -58,6 +59,9 @@ This example adds and removes the specified email addresses from the exception l ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID of the external sender identification object that you want to modify. This parameter is optional and typically isn't needed, because the organization's GUID resolves automatically when you use this cmdlet. @@ -68,7 +72,6 @@ If you specify an invalid Identity value, the cmdlet still runs and changes the Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -AllowList + +> Applicable: Exchange Online + The AllowList parameter specifies exceptions to external sender identification in supported versions of Outlook. Messages received from the specified senders or senders in the specified domains don't receive native External sender identification. The allow list uses the `5322.From` address (also known as the **From** address or P2 sender). Valid values are an individual domain (contoso.com), a domain and all subdomains (*.contoso.com) or email addresses (admin@contoso.com). @@ -94,7 +100,6 @@ The maximum number of entries is 50, and the total size of all entries can't exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter enables or disables external sender identification in supported versions of Outlook. Valid values are: - $true: External sender identification in Outlook is enabled. An External icon is added in the area of the subject line of messages from external senders. To exempt specific senders or sender domains from this identification, use the AllowList parameter. @@ -115,7 +123,6 @@ After an admin enables this setting, it can take between 24 and 48 hours for use Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -135,4 +142,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-OrganizationConfig](https://learn.microsoft.com/powershell/module/exchange/set-organizationconfig) +[Set-OrganizationConfig](https://learn.microsoft.com/powershell/module/exchangepowershell/set-organizationconfig) diff --git a/exchange/exchange-ps/exchange/Set-FeatureConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-FeatureConfiguration.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-FeatureConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FeatureConfiguration.md index 775dd3b86a..70bc6decf7 100644 --- a/exchange/exchange-ps/exchange/Set-FeatureConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FeatureConfiguration.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-featureconfiguration applicable: Security & Compliance -title: Set-FeatureConfiguration +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-featureconfiguration schema: 2.0.0 +title: Set-FeatureConfiguration --- # Set-FeatureConfiguration @@ -62,6 +64,9 @@ This example updates a collection policy named "Microsoft Copilot collection pol ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the feature configuration that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -72,7 +77,6 @@ The Identity parameter specifies the feature configuration that you want to modi Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -82,13 +86,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -107,7 +116,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -117,13 +125,15 @@ Accept wildcard characters: False ``` ### -Locations + +> Applicable: Security & Compliance + The locations parameter specifies where the feature configuration applies. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -133,6 +143,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Security & Compliance + The Mode parameter specifies feature configuration mode. Valid values are: - Enable: The feature configuration is enabled. @@ -142,7 +155,6 @@ The Mode parameter specifies feature configuration mode. Valid values are: Type: PolicyMode Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -152,13 +164,15 @@ Accept wildcard characters: False ``` ### -ScenarioConfig + +> Applicable: Security & Compliance + The ScenarioConfig parameter specifies additional information about the feature configuration. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -168,13 +182,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md b/exchange/exchange-ps/ExchangePowerShell/Set-FederatedOrganizationIdentifier.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FederatedOrganizationIdentifier.md index 92e99bb1fe..c18d4a1ee1 100644 --- a/exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FederatedOrganizationIdentifier.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-federatedorganizationidentifier applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-FederatedOrganizationIdentifier -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-federatedorganizationidentifier +schema: 2.0.0 +title: Set-FederatedOrganizationIdentifier --- # Set-FederatedOrganizationIdentifier @@ -68,13 +69,15 @@ This example enables the organization identifier. This enables federation for th ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the federated organization identifier. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -AccountNamespace + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AccountNamespace parameter specifies the federated domain to be used to establish the organization identifier with the Microsoft Federation Gateway. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -109,7 +117,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -DefaultDomain + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DefaultDomain parameter specifies the federated domain used for delegation tokens issued by the Microsoft Federation Gateway for user accounts in the Exchange organization. If the DefaultDomain parameter isn't set, the primary SMTP domain for each user account is used in delegation tokens issued by the Microsoft Federation Gateway. Only a single domain or subdomain for the Exchange organization should be configured, and it applies to all delegation tokens issued for the Exchange organization, for example, contoso.com. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -DelegationFederationTrust + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DelegationFederationTrust parameter specifies the identity of the federation trust to be used by the organization identifier. ```yaml Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -159,7 +173,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the organization identifier is enabled. Valid values include $true or $false. Setting the parameter to $false disables federation. @@ -177,7 +193,6 @@ Setting the parameter to $false disables federation. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,13 +202,15 @@ Accept wildcard characters: False ``` ### -OrganizationContact + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationContact parameter specifies the SMTP address of the federation contact. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,13 +220,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FederationTrust.md b/exchange/exchange-ps/ExchangePowerShell/Set-FederationTrust.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-FederationTrust.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FederationTrust.md index 5a6e6a3d8a..932434bdf2 100644 --- a/exchange/exchange-ps/exchange/Set-FederationTrust.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FederationTrust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-federationtrust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-FederationTrust -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-federationtrust +schema: 2.0.0 +title: Set-FederationTrust --- # Set-FederationTrust @@ -88,6 +89,9 @@ Before you configure a federation trust to use the next certificate as the curre ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the federation trust being modified. **Note**: For Exchange Online organizations, use the value "Microsoft Entra authentication". @@ -96,7 +100,6 @@ The Identity parameter specifies the name of the federation trust being modified Type: FederationTrustIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -ApplicationUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ApplicationUri parameter specifies the primary domain used for the federation organization identifier. ```yaml Type: String Parameter Sets: ApplicationUri Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -PublishFederationCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PublishFederationCertificate switch specifies the next certificate as the current certificate for the federation trust and publishes it to the Microsoft Federation Gateway. You don't need to specify a value with this switch. The certificate is used to encrypt tokens with the Microsoft Federation Gateway. @@ -132,7 +140,6 @@ Before setting the next certificate to be used as the current certificate, ensur Type: SwitchParameter Parameter Sets: PublishFederationCertificate Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -151,7 +161,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,13 +170,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +188,15 @@ Accept wildcard characters: False ``` ### -MetadataUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MetadataUrl parameter specifies the URL where WS-FederationMetadata is published by the Microsoft Federation Gateway. ```yaml Type: Uri Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,13 +206,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a name for the federation trust. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -RefreshMetadata + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RefreshMetadata switch specifies that the metadata document and certificate is retrieved again from the Microsoft Federation Gateway. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +242,15 @@ Accept wildcard characters: False ``` ### -Thumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Thumbprint parameter specifies the thumbprint of the X.509 certificate to be configured as the next certificate for the federation trust. After the certificate is deployed on all Exchange servers in the organization, you can use the PublishFederationCertificate switch to configure the trust to use this certificate. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,13 +260,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyAuthority.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyAuthority.md index 2c6319179c..2f500c9bff 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyAuthority.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertyauthority applicable: Security & Compliance -title: Set-FilePlanPropertyAuthority +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertyauthority schema: 2.0.0 +title: Set-FilePlanPropertyAuthority --- # Set-FilePlanPropertyAuthority @@ -39,6 +41,9 @@ This example modifies the display name for the custom file plan property authori ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property authority that you want to modify. You can use any value that uniquely identifies the authority. For example: - Name @@ -49,7 +54,6 @@ The Identity parameter specifies the custom file plan property authority that yo Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -59,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -68,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -78,13 +84,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property authority. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCategory.md index c997f07927..7643afcc0f 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertycategory applicable: Security & Compliance -title: Set-FilePlanPropertyCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertycategory schema: 2.0.0 +title: Set-FilePlanPropertyCategory --- # Set-FilePlanPropertyCategory @@ -37,6 +39,9 @@ This example modifies the display name for the custom file plan property categor ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property category that you want to modify. You can use any value that uniquely identifies the category. For example: - Name @@ -47,7 +52,6 @@ The Identity parameter specifies the custom file plan property category that you Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -57,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -66,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -76,13 +82,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property category. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -92,13 +100,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCitation.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCitation.md index 78ebda0733..fe10f51f45 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyCitation.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertycitation applicable: Security & Compliance -title: Set-FilePlanPropertyCitation +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertycitation schema: 2.0.0 +title: Set-FilePlanPropertyCitation --- # Set-FilePlanPropertyCitation @@ -42,6 +44,9 @@ This example modifies the citation URL for the custom file plan property citatio ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property citation that you want to modify. You can use any value that uniquely identifies the citation. For example: - Name @@ -52,7 +57,6 @@ The Identity parameter specifies the custom file plan property citation that you Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -62,13 +66,15 @@ Accept wildcard characters: False ``` ### -CitationJurisdiction + +> Applicable: Security & Compliance + The CitationJurisdiction parameter specifies the jurisdiction for the file plan property citation. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -78,13 +84,15 @@ Accept wildcard characters: False ``` ### -CitationUrl + +> Applicable: Security & Compliance + The CitationJurisdiction parameter specifies the URL for the file plan property citation. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -94,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -103,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -113,13 +123,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property citation. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -129,13 +141,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyDepartment.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyDepartment.md index 40d312c5a8..aa1f144242 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyDepartment.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertydepartment applicable: Security & Compliance -title: Set-FilePlanPropertyDepartment +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertydepartment schema: 2.0.0 +title: Set-FilePlanPropertyDepartment --- # Set-FilePlanPropertyDepartment @@ -44,6 +46,9 @@ This example modifies the display name for the custom file plan property departm ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property department that you want to modify. You can use any value that uniquely identifies the department. For example: - Name @@ -54,7 +59,6 @@ The Identity parameter specifies the custom file plan property department that y Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -64,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -73,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -83,13 +89,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property department. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -99,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyReferenceId.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyReferenceId.md index 0be4986969..9f9b2aa030 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertyReferenceId.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertyreferenceid applicable: Security & Compliance -title: Set-FilePlanPropertyReferenceId +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertyreferenceid schema: 2.0.0 +title: Set-FilePlanPropertyReferenceId --- # Set-FilePlanPropertyReferenceId @@ -40,6 +42,9 @@ This example modifies the display name for the custom file plan property referen ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property reference ID that you want to modify. You can use any value that uniquely identifies the reference ID. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property reference ID that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property reference ID. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertySubCategory.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertySubCategory.md index 384fa72ff4..d5177695be 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FilePlanPropertySubCategory.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertysubcategory applicable: Security & Compliance -title: Set-FilePlanPropertySubCategory +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-fileplanpropertysubcategory schema: 2.0.0 +title: Set-FilePlanPropertySubCategory --- # Set-FilePlanPropertySubCategory @@ -40,6 +42,9 @@ This example modifies the display name for the custom file plan property subcate ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the custom file plan property subcategory that you want to modify. You can use any value that uniquely identifies the subcategory. For example: - Name @@ -50,7 +55,6 @@ The Identity parameter specifies the custom file plan property subcategory that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -60,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -69,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -79,13 +85,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name of the file plan property subcategory. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FocusedInbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-FocusedInbox.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-FocusedInbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FocusedInbox.md index daebaa21e2..584d428bc6 100644 --- a/exchange/exchange-ps/exchange/Set-FocusedInbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FocusedInbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-focusedinbox applicable: Exchange Online, Exchange Online Protection -title: Set-FocusedInbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-focusedinbox +schema: 2.0.0 +title: Set-FocusedInbox --- # Set-FocusedInbox @@ -44,6 +45,9 @@ This example disables Focused Inbox for the mailbox of laura@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -FocusedInboxOn + +> Applicable: Exchange Online, Exchange Online Protection + The FocusedInboxOn parameter enables or disables Focused Inbox for the mailbox. Valid values are: - $true: Focused Inbox is enabled. This is the default value. @@ -80,7 +86,6 @@ The FocusedInboxOn parameter enables or disables Focused Inbox for the mailbox. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill UseCustomRouting Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ForeignConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-ForeignConnector.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-ForeignConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ForeignConnector.md index 5ee2d43be4..0ff39d0e21 100644 --- a/exchange/exchange-ps/exchange/Set-ForeignConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ForeignConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-foreignconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ForeignConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-foreignconnector +schema: 2.0.0 +title: Set-ForeignConnector --- # Set-ForeignConnector @@ -56,6 +57,9 @@ This example configures a 10 MB message size limit on the existing Foreign conne ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Foreign connector that you want to modify. The Identity parameter can take any of the following values for the Foreign connector object: - GUID @@ -66,7 +70,6 @@ The Identity parameter specifies the Foreign connector that you want to modify. Type: ForeignConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. - AddressSpaceType: The address space type may be SMTP, X400, or any other text string. If you omit the address space type, an SMTP address space type is assumed. @@ -97,7 +103,6 @@ To add or remove one or more address space values without affecting any existing Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -132,7 +142,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -150,7 +162,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -DropDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DropDirectory parameter specifies the name of the Drop directory used by this Foreign connector. All outbound messages sent to address spaces defined by this Foreign connector are put in the specified Drop directory. The location of the Drop directory for each Foreign connector is controlled by the following two items: - RootDropDirectoryPath parameter in the Set-TransportService cmdlet: This option is used for all Foreign connectors that exist on the Mailbox server. The value of the RootDropDirectoryPath parameter may be a local path or a Universal Naming Convention (UNC) path to a remote server. @@ -181,7 +195,6 @@ The Drop directory must have the following permissions assigned to it: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,6 +204,9 @@ Accept wildcard characters: False ``` ### -DropDirectoryQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DropDirectoryQuota parameter specifies the maximum size of all message files in the Drop directory. When the specified value is reached, no new message files can be copied into the Drop directory until the existing messages are delivered and deleted. When you enter a value, qualify the value with one of the following units: @@ -209,7 +225,6 @@ The valid input range for this parameter is from 1 through 2147483647 bytes. If Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,13 +234,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether to enable the Foreign connector. The valid values are $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -235,6 +252,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -243,7 +263,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,13 +272,15 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. When the value of this parameter is $false, the connector can be used by all Mailbox servers in the Exchange organization. When the value of this parameter is $true, the connector can be used only by Mailbox servers in the same Active Directory site. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -269,6 +290,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxMessageSize parameter specifies the maximum size of a message that can pass through this Foreign connector. When you enter a value, qualify the value with one of the following units: @@ -287,7 +311,6 @@ If you enter a value of unlimited, no message size limit is imposed on this Fore Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -297,13 +320,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a descriptive name for the Foreign connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,13 +338,15 @@ Accept wildcard characters: False ``` ### -RelayDsnRequired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RelayDsnRequired parameter specifies whether a Relay delivery status notification (DSN) is required by the Foreign connector when messages are written to the Drop directory. The valid input values for this parameter are $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -329,6 +356,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceTransportServers parameter specifies the names of the Mailbox servers that use this Foreign connector. Having a single Foreign connector homed on multiple Mailbox servers running the Transport service provides fault tolerance and high availability if one of the servers fails. The default value of this parameter is the name of the Mailbox server on which this Foreign connector was first installed. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -339,7 +369,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -349,13 +378,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-FrontendTransportService.md b/exchange/exchange-ps/ExchangePowerShell/Set-FrontendTransportService.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-FrontendTransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Set-FrontendTransportService.md index 1332c4a436..ae846c4f1f 100644 --- a/exchange/exchange-ps/exchange/Set-FrontendTransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-FrontendTransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-frontendtransportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-FrontendTransportService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-frontendtransportservice +schema: 2.0.0 +title: Set-FrontendTransportService --- # Set-FrontendTransportService @@ -92,13 +93,15 @@ This example sets the ReceiveProtocolLogPath parameter to C:\\SMTP Protocol Logs ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server that you want to modify. ```yaml Type: FrontendTransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -108,13 +111,15 @@ Accept wildcard characters: False ``` ### -AgentLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogMaxAge parameter specifies the maximum age for the agent log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -134,7 +142,6 @@ Setting the value of the AgentLogMaxAge parameter to 00:00:00 prevents the autom Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogMaxDirectorySize parameter specifies the maximum size of all agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -162,7 +172,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +181,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogMaxFileSize parameter specifies the maximum size of each agent log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -190,7 +202,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,13 +211,15 @@ Accept wildcard characters: False ``` ### -AgentLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogPath parameter specifies the default agent log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\AgentLog. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the AgentLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -216,6 +229,9 @@ Accept wildcard characters: False ``` ### -AntispamAgentsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AntispamAgentsEnabled parameter specifies whether anti-spam agents are installed on the server specified with the Identity parameter. The default value is $false for the Front End Transport service. You set this parameter by using a script. You shouldn't modify this parameter manually. @@ -224,7 +240,6 @@ You set this parameter by using a script. You shouldn't modify this parameter ma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -234,6 +249,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -243,7 +261,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,13 +270,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -269,6 +288,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxAge parameter specifies the maximum age for the connectivity log file. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -279,7 +301,6 @@ For example, to specify 25 days for this parameter, use 25.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,6 +310,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all connectivity logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 1000 MB. When you enter a value, qualify the value with one of the following units: @@ -307,7 +331,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,6 +340,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxFileSize parameter specifies the maximum size of each connectivity log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -335,7 +361,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -345,13 +370,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\Connectivity. Setting the value of this parameter to $null disables connectivity logging. However, setting this parameter to $null when the value of the ConnectivityLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -361,13 +388,15 @@ Accept wildcard characters: False ``` ### -DnsLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -377,6 +406,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogMaxAge parameter specifies the maximum age for the DNS log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -387,7 +419,6 @@ Setting the value of the DnsLogMaxAge parameter to 00:00:00 prevents the automat Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -397,6 +428,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogMaxDirectorySize parameter specifies the maximum size of all DNS logs in the DNS log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 100 MB. When you enter a value, qualify the value with one of the following units: @@ -415,7 +449,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -425,6 +458,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogMaxFileSize parameter specifies the maximum size of each DNS log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -443,7 +479,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -453,13 +488,15 @@ Accept wildcard characters: False ``` ### -DnsLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogPath parameter specifies the DNS log directory location. The default value is blank ($null), which indicates no location is configured. If you enable DNS logging, you need to specify a local file path for the DNS log files by using this parameter. If the path contains spaces, enclose the entire path value in quotation marks ("). ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -469,13 +506,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -485,13 +524,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSAdapterEnabled parameter specifies one or more Domain Name System (DNS) servers that Exchange uses for external DNS lookups. When the ExternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations outside the Exchange organization are performed by using the DNS settings of the external network adapter specified by the value of the ExternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for external Exchange DNS lookups only, you must specify the DNS servers by using the ExternalDNSServers parameter, and you must also set the value of the ExternalDNSAdapterEnabled parameter to $false. The default value of the ExternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -501,6 +542,9 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of destinations that exist outside the Exchange organization. The concept of an external network adapter and an internal network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and external DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for external DNS lookups. The default value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the value of the ExternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the ExternalDNSServers parameter is used. @@ -509,7 +553,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -519,13 +562,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSProtocolOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSProtocolOption parameter specifies which protocol to use when querying external DNS servers. The valid options for this parameter are Any, UseTcpOnly, and UseUdpOnly. The default value is Any. ```yaml Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -535,6 +580,9 @@ Accept wildcard characters: False ``` ### -ExternalDNSServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. You must separate IP addresses by using commas. The default value is an empty list ({}). If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the ExternalDNSServers parameter and its list of DNS servers isn't used. @@ -543,7 +591,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the Ext Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -553,13 +600,15 @@ Accept wildcard characters: False ``` ### -ExternalIPAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalIPAddress parameter specifies the IP address used in the Received message header field for every message that travels through the Front End Transport service. The IP address in the Received header field is used for hop count and routing loop detection. The IP address specified by the ExternalIPAddress parameter overrides the external network adapter's actual IP address. Typically, you would want to set the value of the ExternalIPAddress parameter to match the value of your domain's public MX record. The default value of the ExternalIPAddress parameter is blank. This means the actual IP address of the external network adapter is used in the Received header field. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -569,13 +618,15 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSAdapterEnabled parameter specifies one or more DNS servers that Exchange uses for internal DNS lookups. When the InternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations inside the Exchange organization are performed by using the DNS settings of the internal network adapter specified by the value of the InternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for internal Exchange DNS lookups only, you must specify the DNS servers by using the InternalDNSServers parameter, and you must also set the value of the InternalDNSAdapterEnabled parameter to $false. The default value of the InternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -585,6 +636,9 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of servers that exist inside the Exchange organization. The concept of an internal network adapter and an external network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and internal DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for internal DNS lookups. The default value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the InternalDNSAdapterEnabled parameter is set to $false, the value of the InternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the InternalDNSServers parameter is used. @@ -593,7 +647,6 @@ If the value of the InternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -603,6 +656,9 @@ Accept wildcard characters: False ``` ### -InternalDNSProtocolOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSProtocolOption parameter specifies which protocol to use when you query internal DNS servers. Valid options for this parameter are Any, UseTcpOnly, or UseUdpOnly. The default value is Any. @@ -611,7 +667,6 @@ The default value is Any. Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -621,6 +676,9 @@ Accept wildcard characters: False ``` ### -InternalDNSServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSServers parameter specifies the list of DNS servers that should be used when resolving a domain name. DNS servers are specified by IP address and are separated by commas. The default value is any empty list ({}). If the InternalDNSAdapterGuid parameter is set, and the value of the InternalDNSAdapterEnabled parameter is set to $true, the InternalDNSServers parameter and its list of DNS servers isn't used. @@ -629,7 +687,6 @@ If the InternalDNSAdapterGuid parameter is set, and the value of the InternalDNS Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -639,6 +696,9 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorProtocolLoggingLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging on the implicit and invisible intra-organization Send connector In the Front End Transport service. Valid values are: - None: Protocol logging is disabled for the intra-organization Send connector in the Front End Transport service. @@ -648,7 +708,6 @@ The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP pro Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -658,13 +717,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionRatePerMinute + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConnectionRatePerMinute parameter specifies the maximum rate that connections are allowed to be opened with the transport service. If many connections are attempted with the transport service at the same time, the MaxConnectionRatePerMinute parameter limits the rate that the connections are opened so that the server's resources aren't overwhelmed. The default value is 1200 connections per minute. The valid input range for this parameter is from 1 through 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -674,6 +735,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Receive connectors in the Transport service on the server. Log files that are older than the specified value are automaticallydeleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -686,7 +750,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -696,6 +759,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Receive connectors in the Front End Transport service on the server. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -718,7 +784,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -728,6 +793,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all Receive connectors in the Front End Transport service on the server. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -750,7 +818,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -760,6 +827,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogPath parameter specifies the location of the protocol log directory for all Receive connectors in the Front End Transport service on the server. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\ProtocolLog\\SmtpReceive. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for any Receive connector in the Front End Transport service. To disable protocol logging for Receive connectors, use the value None for the ProtocolLoggingLevel parameter on the Set-ReceiveConnector cmdlet for each Receive connector in the Front End Transport service. @@ -768,7 +838,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -778,6 +847,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxAge + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogMaxAge parameter specifies the maximum routing table log age. Log files older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -788,7 +860,6 @@ For example, to specify 5 days for this parameter, use 5.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -798,6 +869,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxDirectorySize + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the routing table log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -816,7 +890,6 @@ The valid input range for this parameter is from 1 through 9223372036854775807 b Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -826,13 +899,15 @@ Accept wildcard characters: False ``` ### -RoutingTableLogPath + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\Routing. Setting this parameter to $null disables routing table logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -842,6 +917,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Send connectors in the Front End Transport service that have this server configured as a source server. Log files that are older than the specified value are deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -854,7 +932,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -864,6 +941,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Send connectors in the Front End Transport service that have this server configured as a source server. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -886,7 +966,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -896,6 +975,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all the Send connectors in the Front End Transport service that have this server configured as a source server. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -918,7 +1000,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -928,6 +1009,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogPath parameter specifies the location of the protocol log directory for all Send connectors in the Front End Transport service that have this server configured as a source server. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\ProtocolLog\\SmtpSend. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for any Send connector in the Front End Transport service that has this server configured as a source server. To disable protocol logging for these Send connectors, use the value None for the following parameters: @@ -939,7 +1023,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -949,13 +1032,15 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryCount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransientFailureRetryCount parameter specifies the maximum number of immediate connection retries attempted when the server encounters a connection failure with a remote server. The default value is 6. The valid input range for this parameter is from 0 through 15. When the value of this parameter is set to 0, the server doesn't immediately attempt to retry an unsuccessful connection. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -965,6 +1050,9 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransientFailureRetryInterval parameter controls the connection interval between each connection attempt specified by the TransientFailureRetryCount parameter. For the Front End Transport service, the default value of the TransientFailureRetryInterval parameter is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -975,7 +1063,6 @@ For example, to specify 8 minutes for this parameter, use 00:08:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -985,13 +1072,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-GlobalAddressList.md b/exchange/exchange-ps/ExchangePowerShell/Set-GlobalAddressList.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-GlobalAddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Set-GlobalAddressList.md index b4bbb3747e..81ea55b283 100644 --- a/exchange/exchange-ps/exchange/Set-GlobalAddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-GlobalAddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-globaladdresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-GlobalAddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-globaladdresslist +schema: 2.0.0 +title: Set-GlobalAddressList --- # Set-GlobalAddressList @@ -78,6 +79,9 @@ This example assigns a new name, GALwithNewName, to the GAL with the GUID 96d0c5 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the global address list that you want to modify. You can use any value that uniquely identifies the GAL. For example: - Name @@ -88,7 +92,6 @@ The Identity parameter specifies the global address list that you want to modify Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -ConditionalCompany + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -110,7 +116,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -132,7 +140,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -154,7 +164,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -176,7 +188,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -198,7 +212,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,6 +221,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -220,7 +236,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +245,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -242,7 +260,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -252,6 +269,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -264,7 +284,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -274,6 +293,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -286,7 +308,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -296,6 +317,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -308,7 +332,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -318,6 +341,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -330,7 +356,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -340,6 +365,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -352,7 +380,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -362,6 +389,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -374,7 +404,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -384,6 +413,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -396,7 +428,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -406,6 +437,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -418,7 +452,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -428,6 +461,9 @@ Accept wildcard characters: False ``` ### -ConditionalCustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -440,7 +476,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -450,6 +485,9 @@ Accept wildcard characters: False ``` ### -ConditionalDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -462,7 +500,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -472,6 +509,9 @@ Accept wildcard characters: False ``` ### -ConditionalStateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. You can specify multiple values separated by commas. When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. @@ -484,7 +524,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -494,6 +533,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -503,7 +545,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -513,6 +554,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -521,7 +565,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -531,6 +574,9 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. @@ -539,7 +585,6 @@ The ForceUpgrade switch suppresses the confirmation message that appears if the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -549,6 +594,9 @@ Accept wildcard characters: False ``` ### -IncludedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. Valid values are: - AllRecipients: This value can be used only by itself. @@ -564,7 +612,6 @@ You can specify multiple values separated by commas. When you use multiple value Type: WellKnownRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -574,13 +621,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name of the GAL. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -590,6 +639,9 @@ Accept wildcard characters: False ``` ### -RecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecipientContainer parameter specifies a filter that's based on the recipient's location in Active Directory. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -605,7 +657,6 @@ If you don't use this parameter, the default value is the OU where the object wa Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -615,6 +666,9 @@ Accept wildcard characters: False ``` ### -RecipientFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientFilter parameter specifies an OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -630,7 +684,6 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -640,13 +693,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Group.md b/exchange/exchange-ps/ExchangePowerShell/Set-Group.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-Group.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Group.md index 25c66b6124..f585acbe6c 100644 --- a/exchange/exchange-ps/exchange/Set-Group.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Group.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-group applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-Group -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-group +schema: 2.0.0 +title: Set-Group --- # Set-Group @@ -69,6 +70,9 @@ This example specifies that the group Human Resources is a hierarchical group an ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name @@ -80,7 +84,6 @@ The Identity parameter specifies the group that you want to modify. You can use Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -101,7 +107,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -120,7 +128,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill Description Description }} @@ -138,7 +148,6 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only if the group is mail-enabled. @@ -156,7 +168,6 @@ This parameter is meaningful only if the group is mail-enabled. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -176,7 +190,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,6 +199,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -199,7 +215,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +224,15 @@ Accept wildcard characters: False ``` ### -IsHierarchicalGroup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The IsHierarchicalGroup parameter specifies whether the group is part of a hierarchical address book. Valid values are $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -225,6 +242,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies an owner for the group. A group must have at least one owner. If you don't use this parameter to specify the owner when you create the group, the user account that created the group is the owner. The group owner is able to: - Modify the properties of the group @@ -258,7 +278,6 @@ Owners that you specify with this parameter are not added as group members. You Type: GeneralRecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -268,13 +287,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the group. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -284,13 +305,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,13 +323,15 @@ Accept wildcard characters: False ``` ### -PhoneticDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -316,13 +341,15 @@ Accept wildcard characters: False ``` ### -SeniorityIndex + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + 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. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -332,6 +359,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -346,7 +376,6 @@ This parameter is meaningful only if the group is mail-enabled. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -356,13 +385,15 @@ Accept wildcard characters: False ``` ### -Universal + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Universal switch changes the scope of the group from Global or DomainLocal to Universal. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -372,13 +403,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -388,6 +421,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -399,7 +435,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-HoldCompliancePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HoldCompliancePolicy.md index d1f0720b66..33d71e298c 100644 --- a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HoldCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-holdcompliancepolicy applicable: Security & Compliance -title: Set-HoldCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-holdcompliancepolicy +schema: 2.0.0 +title: Set-HoldCompliancePolicy --- # Set-HoldCompliancePolicy @@ -70,6 +71,9 @@ This example makes the following changes to the existing preservation policy nam ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -80,7 +84,6 @@ The Identity parameter specifies the preservation policy that you want to modify Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -100,7 +106,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes. Valid values are: - A mailbox @@ -128,7 +136,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -AddPublicFolderLocation + +> Applicable: Security & Compliance + The AddPublicFolderLocation parameter specifies that you want to add all public folders to the preservation policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation + +> Applicable: Security & Compliance + The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -164,7 +176,6 @@ SharePoint sites can't be added to the policy until they have been indexed. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -174,13 +185,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -190,6 +203,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -199,7 +215,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -209,6 +224,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -218,7 +236,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -236,7 +256,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -246,6 +265,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter specifies the existing mailboxes to remove from the policy. Valid values are: - A mailbox @@ -264,7 +286,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -274,13 +295,15 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation + +> Applicable: Security & Compliance + The RemovePublicFolderLocation parameter specifies that you want to remove all public folders from the preservation policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -290,6 +313,9 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation + +> Applicable: Security & Compliance + The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -298,7 +324,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -308,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-HoldComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-HoldComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HoldComplianceRule.md index e86f4d51b9..fd20b54fec 100644 --- a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HoldComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-holdcompliancerule applicable: Security & Compliance -title: Set-HoldComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-holdcompliancerule +schema: 2.0.0 +title: Set-HoldComplianceRule --- # Set-HoldComplianceRule @@ -51,6 +52,9 @@ This example changes the hold duration for the existing preservation rule named ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the preservation rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the preservation rule that you want to modify. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -96,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -ContentDateFrom + +> Applicable: Security & Compliance + The ContentDateFrom parameter specifies the start date of the date range for content to include. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -114,7 +124,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -ContentDateTo + +> Applicable: Security & Compliance + The ContentDateTo parameter specifies the end date of the date range for content to include. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -132,7 +144,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -142,6 +153,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -150,7 +164,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -160,13 +173,15 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter specifies whether the preservation rule is enabled or disabled. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -176,6 +191,9 @@ Accept wildcard characters: False ``` ### -HoldContent + +> Applicable: Security & Compliance + The HoldContent parameter specifies the hold duration for the preservation rule. Valid values are: - An integer: The hold duration in days. @@ -185,7 +203,6 @@ The HoldContent parameter specifies the hold duration for the preservation rule. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -195,6 +212,9 @@ Accept wildcard characters: False ``` ### -HoldDurationDisplayHint + +> Applicable: Security & Compliance + The HoldDurationDisplayHint parameter specifies the units that are used to display the preservation duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. - Days @@ -207,7 +227,6 @@ For example, if this parameter is set to the value Years, and the HoldContent pa Type: HoldDurationHint Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -217,13 +236,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-HostedConnectionFilterPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HostedConnectionFilterPolicy.md index 8c66cec8fe..90a43832ac 100644 --- a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HostedConnectionFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedconnectionfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-HostedConnectionFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hostedconnectionfilterpolicy +schema: 2.0.0 +title: Set-HostedConnectionFilterPolicy --- # Set-HostedConnectionFilterPolicy @@ -61,6 +62,9 @@ This example modifies the connection filter policy named Default with the follow ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the connection filter policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -73,7 +77,6 @@ Typically, you only have one connection filter policy: the default policy named Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -83,13 +86,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). The maximum length is 255 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -ConfigurationXmlRaw + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -124,7 +134,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -EnableSafeList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -IPAllowList + +> Applicable: Exchange Online, Exchange Online Protection + The IPAllowList parameter specifies IP addresses from which messages are always allowed. Messages from the IP addresses you specify won't be identified as spam, despite any other spam characteristics of the messages. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -164,7 +178,6 @@ You can specify multiple IP addresses of the same type separated by commas. For Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -IPBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The IPBlockList parameter specifies IP addresses from which messages are never allowed. Messages from the IP addresses you specify are blocked without any further spam scanning. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -188,7 +204,6 @@ You can specify multiple IP addresses of the same type separated by commas. For Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -198,13 +213,15 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -214,13 +231,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterPolicy.md index d8cfd90e6b..ba1f227f67 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedcontentfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-HostedContentFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hostedcontentfilterpolicy +schema: 2.0.0 +title: Set-HostedContentFilterPolicy --- # Set-HostedContentFilterPolicy @@ -102,6 +103,9 @@ This example modifies the spam filter policy named Contoso Executives with the f ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -112,7 +116,6 @@ The Identity parameter specifies the spam filter policy that you want to modify. Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -122,6 +125,9 @@ Accept wildcard characters: False ``` ### -AddXHeaderValue + +> Applicable: Exchange Online, Exchange Online Protection + The AddXHeaderValue parameter specifies the X-header name (not value) to add to spam messages when a spam filtering verdict parameter is set to the value AddXHeader. The following spam filtering verdict parameters can use the AddXHeader action: - BulkSpamAction @@ -141,7 +147,6 @@ Note that this setting is independent of the AddXHeader value of the TestModeAct Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,13 +156,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -167,6 +174,9 @@ Accept wildcard characters: False ``` ### -AllowedSenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with `SFV:SKA` in the `X-Forefront-Antispam-Report header` and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. **Caution**: Think very carefully before you add domains here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). @@ -179,7 +189,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -189,6 +198,9 @@ Accept wildcard characters: False ``` ### -AllowedSenders + +> Applicable: Exchange Online, Exchange Online Protection + The AllowedSenders parameter specifies a list of trusted senders that skip spam filtering. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses. **Caution**: Think very carefully before you add senders here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). @@ -201,7 +213,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -211,6 +222,9 @@ Accept wildcard characters: False ``` ### -BlockedSenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with `SFV:SKB` value in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP domains. **Note**: Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). @@ -223,7 +237,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +246,9 @@ Accept wildcard characters: False ``` ### -BlockedSenders + +> Applicable: Exchange Online, Exchange Online Protection + The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with `SFV:SKB` in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP email addresses. **Note**: Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). @@ -245,7 +261,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,6 +270,9 @@ Accept wildcard characters: False ``` ### -BulkQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The BulkQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as bulk email (the BulkSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -271,7 +289,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -281,6 +298,9 @@ Accept wildcard characters: False ``` ### -BulkSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The BulkSpamAction parameter specifies the action to take on messages that are marked as bulk email (also known as gray mail) based on the bulk complaint level (BCL) of the message, and the BCL threshold you configure in the BulkThreshold parameter. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. @@ -295,7 +315,6 @@ The BulkSpamAction parameter specifies the action to take on messages that are m Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -305,6 +324,9 @@ Accept wildcard characters: False ``` ### -BulkThreshold + +> Applicable: Exchange Online, Exchange Online Protection + The BulkThreshold parameter specifies the BCL on messages that triggers the action specified by the BulkSpamAction parameter (greater than or equal to the specified BCL value). A valid value is an integer from 1 to 9. The default value is 7, which means a BCL of 7, 8, or 9 on messages will trigger the action that's specified by the BulkSpamAction parameter. A higher BCL indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see [Bulk complaint level (BCL) in EOP](https://learn.microsoft.com/defender-office-365/anti-spam-bulk-complaint-level-bcl-about). @@ -313,7 +335,6 @@ A higher BCL indicates the message is more likely to generate complaints (and is Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,6 +344,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -332,7 +356,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -342,13 +365,15 @@ Accept wildcard characters: False ``` ### -DownloadLink + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -358,13 +383,15 @@ Accept wildcard characters: False ``` ### -EnableEndUserSpamNotifications + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -374,6 +401,9 @@ Accept wildcard characters: False ``` ### -EnableLanguageBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The EnableLanguageBlockList parameter enables or disables marking messages that were written in specific languages as spam. Valid values are: - $true: Mark messages hat were written in the languages specified by the LanguageBlockList parameter as spam. @@ -383,7 +413,6 @@ The EnableLanguageBlockList parameter enables or disables marking messages that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -393,6 +422,9 @@ Accept wildcard characters: False ``` ### -EnableRegionBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The EnableRegionBlockList parameter enables or disables marking messages that are sent from specific countries or regions as spam. Valid values are: - $true: Mark messages from senders in the RegionBlockList parameter as spam. @@ -402,7 +434,6 @@ The EnableRegionBlockList parameter enables or disables marking messages that ar Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -412,13 +443,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -428,13 +461,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromName + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -444,13 +479,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomSubject + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -460,12 +497,14 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -475,13 +514,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLanguage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: EsnLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -491,13 +532,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLimit + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -507,6 +550,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishAction + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. @@ -516,7 +562,6 @@ The HighConfidencePhishAction parameter specifies the action to take on messages Type: PhishFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -526,6 +571,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence phishing (the HighConfidencePhishAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -542,7 +590,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -552,6 +599,9 @@ Accept wildcard characters: False ``` ### -HighConfidenceSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidenceSpamAction parameter specifies the action to take on messages that are marked as high confidence spam (not spam, bulk email, phishing, or high confidence phishing). Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). @@ -565,7 +615,6 @@ The HighConfidenceSpamAction parameter specifies the action to take on messages Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -575,6 +624,9 @@ Accept wildcard characters: False ``` ### -HighConfidenceSpamQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence spam (the HighConfidenceSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -591,7 +643,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -601,6 +652,9 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithBizOrInfoUrls + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -611,7 +665,6 @@ The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -621,6 +674,9 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithImageLinks + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -631,7 +687,6 @@ The IncreaseScoreWithImageLinks parameter increases the spam score of messages t Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -641,6 +696,9 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithNumericIps + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -651,7 +709,6 @@ The IncreaseScoreWithNumericIps parameter increases the spam score of messages t Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -661,6 +718,9 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithRedirectToOtherPort + +> Applicable: Exchange Online, Exchange Online Protection + The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -671,7 +731,6 @@ The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of m Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -681,6 +740,9 @@ Accept wildcard characters: False ``` ### -InlineSafetyTipsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The InlineSafetyTipsEnabled parameter specifies whether to enable or disable safety tips that are shown to recipients in messages. Valid values are: - $true: Safety tips are enabled. This is the default value. @@ -690,7 +752,6 @@ The InlineSafetyTipsEnabled parameter specifies whether to enable or disable saf Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -700,6 +761,9 @@ Accept wildcard characters: False ``` ### -IntraOrgFilterState + +> Applicable: Exchange Online, Exchange Online Protection + The IntraOrgFilterState parameter specifies whether to enable anti-spam filtering for messages sent between internal users (users in the same organization). The action that's configured in the policy for the specified spam filter verdicts is taken on messages sent between internal users. Valid values are: - Default: This is the default value. Currently, HighConfidencePhish. @@ -713,7 +777,6 @@ The IntraOrgFilterState parameter specifies whether to enable anti-spam filterin Type: IntraOrgFilterState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -723,6 +786,9 @@ Accept wildcard characters: False ``` ### -LanguageBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported uppercase ISO 639-1 two-letter language code: AF, AR, AZ, BE, BG, BN, BR, BS, CA, CS, CY, DA, DE, EL, EN, EO, ES, ET, EU, FA, FI, FO, FR, FY, GA, GL, GU, HA, HE, HI, HR, HU, HY, ID, IS, IT, JA, KA, KK, KL, KN, KO, KU, KY, LA, LB, LT, LV, MI, MK, ML, MN, MR, MS, MT, NB, NL, NN, PA, PL, PS, PT, RM, RO, RU, SE, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TL, TR, UK, UR, UZ, VI, WEN, YI, ZH-CN, ZH-TW, and ZU. @@ -739,7 +805,6 @@ To empty the list, use the value $null. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -749,6 +814,9 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Online, Exchange Online Protection + The MakeDefault switch makes the specified spam filter policy the default spam filter policy. You don't need to specify a value with this switch. The default spam filter policy is applied to everyone (no corresponding spam filter rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). @@ -757,7 +825,6 @@ The default spam filter policy is applied to everyone (no corresponding spam fil Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -767,6 +834,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamBulkMail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamBulkMail parameter allows spam filtering to act on bulk email messages. Valid values are: - Off: The message is stamped with the BCL, but no action is taken for a bulk email filtering verdict. In effect, the values of the BulkThreshold and BulkSpamAction parameters are irrelevant. @@ -777,7 +847,6 @@ The MarkAsSpamBulkMail parameter allows spam filtering to act on bulk email mess Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -787,6 +856,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmbedTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -797,7 +869,6 @@ The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -807,6 +878,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmptyMessages + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -817,7 +891,6 @@ The MarkAsSpamEmptyMessages parameter marks a message as spam when the message c Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -827,6 +900,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFormTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -837,7 +913,6 @@ The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -847,6 +922,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFramesInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML \ or \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -857,7 +935,6 @@ The MarkAsSpamFramesInHtml parameter marks a message as spam when the message co Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -867,6 +944,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFromAddressAuthFail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -876,7 +956,6 @@ The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -886,6 +965,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamJavaScriptInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -896,7 +978,6 @@ The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the messag Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -906,6 +987,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamNdrBackscatter + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as *backscatter*). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -915,7 +999,6 @@ The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -925,6 +1008,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamObjectTagsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -935,7 +1021,6 @@ The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the messag Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -945,6 +1030,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSensitiveWordList + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -955,7 +1043,6 @@ The MarkAsSpamSensitiveWordList parameter marks a message as spam when the messa Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -965,6 +1052,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSpfRecordHardFail + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -974,7 +1064,6 @@ The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF recor Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -984,6 +1073,9 @@ Accept wildcard characters: False ``` ### -MarkAsSpamWebBugsInHtml + +> Applicable: Exchange Online, Exchange Online Protection + The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -994,7 +1086,6 @@ The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message c Type: SpamFilteringOption Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1004,6 +1095,9 @@ Accept wildcard characters: False ``` ### -ModifySubjectValue + +> Applicable: Exchange Online, Exchange Online Protection + The ModifySubjectValue parameter specifies the text to prepend to the existing subject of messages when a spam filtering verdict parameter is set to the value ModifySubject. The following spam filtering verdict parameters can use the ModifySubject action: - BulkSpamAction @@ -1017,7 +1111,6 @@ If the value contains spaces, enclose the value in quotation marks ("). Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1027,6 +1120,9 @@ Accept wildcard characters: False ``` ### -PhishQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The PhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as phishing (the PhishSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -1043,7 +1139,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1053,6 +1148,9 @@ Accept wildcard characters: False ``` ### -PhishSpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The PhishSpamAction parameter specifies the action to take on messages that are marked as phishing (not high confidence phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. @@ -1066,7 +1164,6 @@ The PhishSpamAction parameter specifies the action to take on messages that are Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1076,6 +1173,9 @@ Accept wildcard characters: False ``` ### -PhishZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The PhishZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect phishing in already delivered messages in Exchange Online mailboxes. Valid values are: - $true: ZAP for phishing messages is enabled. This is the default value. The result depends on the spam filtering verdict action for phishing messages: MoveToJmf = Read and unread phishing messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Read and unread phishing messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. @@ -1087,7 +1187,6 @@ You configure ZAP for spam with the SpamZapEnabled parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1097,6 +1196,9 @@ Accept wildcard characters: False ``` ### -QuarantineRetentionPeriod + +> Applicable: Exchange Online, Exchange Online Protection + The QuarantineRetentionPeriod parameter specifies the number of days that spam messages remain in quarantine when a spam filtering verdict parameter is set to the value Quarantine. All spam filtering verdict parameters can use the Quarantine action: - BulkSpamAction @@ -1113,7 +1215,6 @@ After the time period expires, the message is deleted. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1123,6 +1224,9 @@ Accept wildcard characters: False ``` ### -RedirectToRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The RedirectToRecipients parameter specifies the email addresses of replacement recipients when a spam filtering verdict parameter is set to the value Redirect. The following spam filtering verdict parameters can use the Redirect action: - BulkSpamAction @@ -1136,7 +1240,6 @@ You can specify multiple email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1146,6 +1249,9 @@ Accept wildcard characters: False ``` ### -RegionBlockList + +> Applicable: Exchange Online, Exchange Online Protection + The RegionBlockList parameter specifies the source countries or regions that are marked as spam when the EnableRegionBlockList parameter value is $true. A valid value is a supported ISO 3166-1 two-letter country code: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XE, XJ, XS, YE, YT, ZA, ZM, and ZW. @@ -1162,7 +1268,6 @@ To empty the list, use the value $null. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1172,6 +1277,9 @@ Accept wildcard characters: False ``` ### -SpamAction + +> Applicable: Exchange Online, Exchange Online Protection + The SpamAction parameter specifies the action to take on messages that are marked as spam (not high confidence spam, bulk email, phishing, or high confidence phishing). Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). @@ -1185,7 +1293,6 @@ The SpamAction parameter specifies the action to take on messages that are marke Type: SpamFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1195,6 +1302,9 @@ Accept wildcard characters: False ``` ### -SpamQuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + The SpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as spam (the SpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -1211,7 +1321,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1221,6 +1330,9 @@ Accept wildcard characters: False ``` ### -SpamZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SpamZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect spam in already delivered messages in Exchange Online mailboxes. Valid values are: - $true: ZAP for spam is enabled. This is the default value. The result depends on the spam filtering verdict action for spam messages: MoveToJmf = Unread spam messages are moved to the Junk Email folder. Delete, Redirect, or Quarantine = Unread spam messages are quarantined. AddXHeader or ModifySubject = no action is taken on the message. @@ -1232,7 +1344,6 @@ You configure ZAP for phishing messages with the PhishZapEnabled parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1242,6 +1353,9 @@ Accept wildcard characters: False ``` ### -TestModeAction + +> Applicable: Exchange Online, Exchange Online Protection + The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\* or MarkAsSpam\* ASF parameters are set to the value Test. Valid values are: - None: This is the default value, and we recommend that you don't change it. @@ -1252,7 +1366,6 @@ The TestModeAction parameter specifies the additional action to take on messages Type: SpamFilteringTestModeAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1262,6 +1375,9 @@ Accept wildcard characters: False ``` ### -TestModeBccToRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. Valid input for this parameter is an email address. Separate multiple email addresses with commas. @@ -1272,7 +1388,6 @@ This parameter is meaningful only when the value of the TestModeAction parameter Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1282,13 +1397,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterRule.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterRule.md index 991cf73ca1..120a069048 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HostedContentFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection -title: Set-HostedContentFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hostedcontentfilterrule +schema: 2.0.0 +title: Set-HostedContentFilterRule --- # Set-HostedContentFilterRule @@ -55,6 +56,9 @@ This example adds an exception to the spam filter rule named Contoso Recipients ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the spam filter rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the spam filter rule that you want to modify. Y Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -100,7 +108,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception for the rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -141,7 +153,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception for the rule that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -168,7 +182,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -HostedContentFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedContentFilterPolicy parameter specifies the spam filter policy (content filter policy) that's associated with the rule. You can use any value that uniquely identifies the policy. For example, you can specify the name, GUID, or distinguished name (DN) of the spam filter policy. @@ -188,7 +204,6 @@ You can't specify the default spam filter policy. And, you can't specify a spam Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. @@ -206,7 +224,6 @@ Don't use the following characters in the name value: `\ % & * + / = ? { } | < > Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -216,6 +233,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -230,7 +250,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -240,13 +259,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -256,6 +277,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition for the rule that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -271,7 +295,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -281,6 +304,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -298,7 +324,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -308,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterPolicy.md index 5a570aaa15..fe113889c6 100644 --- a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-HostedOutboundSpamFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hostedoutboundspamfilterpolicy +schema: 2.0.0 +title: Set-HostedOutboundSpamFilterPolicy --- # Set-HostedOutboundSpamFilterPolicy @@ -55,6 +56,9 @@ This example configures the following settings in the outbound spam filter polic ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter policy you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the outbound spam filter policy you want to mod Type: HostedOutboundSpamFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -ActionWhenThresholdReached + +> Applicable: Exchange Online, Exchange Online Protection + The ActionWhenThresholdReach parameter specifies the action to take when any of the limits specified in the policy are reached. Valid values are: - Alert: No action, alert only. @@ -86,7 +92,6 @@ Type: OutboundRecipientLimitsExceededAction Parameter Sets: (All) Aliases: Accepted values: Alert, BlockUserForToday, BlockUser -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -AutoForwardingMode + +> Applicable: Exchange Online, Exchange Online Protection + The AutoForwardingMode specifies how the policy controls automatic email forwarding to external recipients. Valid values are: - Automatic: This is the default value. This value is now the same as Off. When this value was originally introduced, it was equivalent to On. Over time, thanks to the principles of [secure by default](https://learn.microsoft.com/defender-office-365/secure-by-default), the effect of this value was eventually changed to Off for all customers. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/all-you-need-to-know-about-automatic-email-forwarding-in/ba-p/2074888). @@ -125,7 +135,6 @@ Type: AutoForwardingMode Parameter Sets: (All) Aliases: Accepted values: Automatic, Off, On -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -BccSuspiciousOutboundAdditionalRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The BccSuspiciousOutboundAdditionalRecipients parameter specifies an email address to add to the Bcc field of outgoing spam messages. You can specify multiple email addresses separated by commas. The specified recipients are added to the Bcc field of outgoing spam messages when the value of the BccSuspiciousOutboundMail parameter is $true. @@ -143,7 +155,6 @@ The specified recipients are added to the Bcc field of outgoing spam messages wh Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -153,6 +164,9 @@ Accept wildcard characters: False ``` ### -BccSuspiciousOutboundMail + +> Applicable: Exchange Online, Exchange Online Protection + The BccSuspiciousOutboundMail parameter specifies whether to add recipients to the Bcc field of outgoing spam messages. Valid values are: - $true: The recipients specified by the BccSuspiciousOutboundAdditionalRecipients parameter are added to outgoing spam messages. @@ -162,7 +176,6 @@ The BccSuspiciousOutboundMail parameter specifies whether to add recipients to t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,6 +185,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -181,7 +197,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -191,6 +206,9 @@ Accept wildcard characters: False ``` ### -NotifyOutboundSpam + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: This setting has been replaced by the default alert policy named **User restricted from sending email**, which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see [Verify the alert settings for restricted users](https://learn.microsoft.com/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). The NotifyOutboundSpam parameter specify whether to notify admins when outgoing spam is detected. Valid values are: @@ -202,7 +220,6 @@ The NotifyOutboundSpam parameter specify whether to notify admins when outgoing Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,6 +229,9 @@ Accept wildcard characters: False ``` ### -NotifyOutboundSpamRecipients + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: This setting has been replaced by the default alert policy named **User restricted from sending email**, which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see [Verify the alert settings for restricted users](https://learn.microsoft.com/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). The NotifyOutboundSpamRecipients parameter specifies the email addresses of admins to notify when an outgoing spam is detected. You can specify multiple email addresses separated by commas. @@ -222,7 +242,6 @@ The specified recipients receive notifications when the value of the NotifyOutbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -232,13 +251,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitExternalPerHour + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientLimitExternalPerHour parameter specifies the maximum number of external recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,13 +269,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitInternalPerHour + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -264,13 +287,15 @@ Accept wildcard characters: False ``` ### -RecipientLimitPerDay + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientLimitInternalPerHour parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,13 +305,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterRule.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterRule.md index fd8d912dd6..f404f720ce 100644 --- a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HostedOutboundSpamFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection -title: Set-HostedOutboundSpamFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hostedoutboundspamfilterrule +schema: 2.0.0 +title: Set-HostedOutboundSpamFilterRule --- # Set-HostedOutboundSpamFilterRule @@ -52,6 +53,9 @@ This example adds an exception to the existing rule named Contoso Executives. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the outbound spam filter rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the outbound spam filter rule that you want to Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfFrom parameter specifies an exception that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -122,7 +132,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfFromMemberOf parameter specifies an exception that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: - Name @@ -147,7 +159,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -157,13 +168,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -173,6 +186,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Online, Exchange Online Protection + The From parameter specifies a condition that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: - Name @@ -188,7 +204,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Exchange Online, Exchange Online Protection + The FromMemberOf parameter specifies a condition that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: - Name @@ -213,7 +231,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -223,6 +240,9 @@ Accept wildcard characters: False ``` ### -HostedOutboundSpamFilterPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The HostedOutboundSpamFilterPolicy parameter specifies the outbound spam filter policy that's associated with the outbound spam filter rule. You can use any value that uniquely identifies the policy. For example: @@ -237,7 +257,6 @@ You can't specify the default outbound spam filter policy, and you can't specify Type: HostedOutboundSpamFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -247,6 +266,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the outbound spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). Don't use the following characters: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. @@ -255,7 +277,6 @@ Don't use the following characters: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -279,7 +303,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -289,13 +312,15 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Exchange Online, Exchange Online Protection + The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -305,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HybridConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-HybridConfiguration.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-HybridConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-HybridConfiguration.md index 7b0b227234..b9750e5e1b 100644 --- a/exchange/exchange-ps/exchange/Set-HybridConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-HybridConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-hybridconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-HybridConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-hybridconfiguration +schema: 2.0.0 +title: Set-HybridConfiguration --- # Set-HybridConfiguration @@ -72,6 +73,9 @@ This example specifies that the hybrid deployment uses a defined TLS certificate ## PARAMETERS ### -ClientAccessServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in Exchange Server 2010. The ClientAccessServers parameter specifies the Hub Transport servers in Exchange Server 2010 SP2 or later that are configured to support hybrid deployment features. You need to specify at least one Client Access server that's accessible from the internet on TCP ports 80 and 443. The servers are configured to enable the following features: @@ -86,7 +90,6 @@ You can specify multiple servers separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -105,7 +111,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -Domains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Domains parameter specifies the domain namespaces used in the hybrid deployment. These domains must be configured as accepted domains in either on-premises Exchange or Exchange Online. The domains are used in configuring the organization relationships and Send and Receive connectors used by the hybrid configuration. You can specify multiple domains separated by commas. @@ -139,7 +149,6 @@ You can specify multiple domains separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -ExternalIPAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalIPAddresses parameter is a legacy parameter that specifies the publicly accessible inbound IP address of Microsoft Exchange Server 2010 Hub Transport servers. You should use this parameter to change or clear legacy Exchange 2010 Hub Transport server IP address values only. IPv6 addresses aren't supported. @@ -157,7 +169,6 @@ You should use this parameter to change or clear legacy Exchange 2010 Hub Transp Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -Features + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Features parameter specifies the features that are enabled for the hybrid configuration. Valid values are: - OnlineArchive: Enables the Exchange Online archive for on-premises Exchange and Exchange Online users. @@ -184,7 +198,6 @@ You can specify multiple values separated by commas. When you use the Hybrid Con Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. There can be only one HybridConfiguration object in an Exchange organization. @@ -202,7 +218,6 @@ There can be only one HybridConfiguration object in an Exchange organization. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,13 +227,15 @@ Accept wildcard characters: False ``` ### -OnPremisesSmartHost + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OnPremisesSmartHost parameter specifies the FQDN of the on-premises Exchange Mailbox server used for secure mail transport between on-premises Exchange and Exchange Online. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -ReceivingTransportServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceivingTransportServers parameter specifies the Mailbox servers defined in the outbound connector configuration in Exchange Online. Valid values are: - The Mailbox server FQDN (for example, mbx.corp.contoso.com). @@ -243,7 +263,6 @@ The value of this parameter must be blank ($null) when you use the EdgeTransport Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -253,6 +272,9 @@ Accept wildcard characters: False ``` ### -SecureMailCertificateThumbprint + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The SecureMailCertificateThumbprint parameter specifies the thumbprint of the X.509 certificate to be used as the certificate for hybrid deployment secure message transport. This certificate cannot be self-signed, must be obtained from a trusted certificate authority (CA), and must be installed on all Hub Transport servers defined in the TransportServers parameter. @@ -261,7 +283,6 @@ The SecureMailCertificateThumbprint parameter specifies the thumbprint of the X. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -271,6 +292,9 @@ Accept wildcard characters: False ``` ### -SendingTransportServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendingTransportServers parameter specifies the Mailbox servers defined in the inbound connector configuration in Exchange Online. Valid values are: - The Mailbox server FQDN (for example, mbx.corp.contoso.com). @@ -286,7 +310,6 @@ The value of this parameter must be blank ($null) when you use the EdgeTransport Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,6 +319,9 @@ Accept wildcard characters: False ``` ### -ServiceInstance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is meaningful only in Office 365 operated by 21Vianet in China. To manually configure a hybrid deployment with Office 365 operated by 21Vianet in China, set the value of this parameter to 1. Otherwise, the default value is 0. @@ -306,7 +332,6 @@ All other Microsoft 365 organizations should use the Hybrid Configuration wizard Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,6 +341,9 @@ Accept wildcard characters: False ``` ### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. Valid syntax for this parameter is `"X.500IssuerX.500Subject"`: - `X.500Issuer`: The value in the certificate's Issuer field. @@ -329,7 +357,6 @@ Or, after you run Get-ExchangeCertificate to find the thumbprint value of the ce Type: SmtpX509Identifier Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -339,6 +366,9 @@ Accept wildcard characters: False ``` ### -TransportServers + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The TransportServers parameter specifies the Hub Transport servers in Exchange Server 2010 SP2 or later that are configured to support hybrid deployment features. @@ -351,7 +381,6 @@ You can specify multiple servers separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -361,13 +390,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -377,6 +408,9 @@ Accept wildcard characters: False ``` ### -EdgeTransportServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EdgeTransportServers parameter specifies the Edge Transport servers that are configured to support the hybrid deployment features. The Edge Transport server must be externally accessible from the Internet on port 25. The accepted values for the EdgeTransportServers parameter are either the full or short computer name of an Edge Transport server, for example, either edge.corp.contoso.com or EDGE. Separate server names with a comma if defining more than one Edge Transport server. When configuring the EdgeTransportServers parameter, you must configure the ReceivingTransportServers and SendingTransportServers parameter values to $null. @@ -385,7 +419,6 @@ When configuring the EdgeTransportServers parameter, you must configure the Rece Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-IPAllowListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListConfig.md index 0c7a6349a0..98ff7468b6 100644 --- a/exchange/exchange-ps/exchange/Set-IPAllowListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipallowlistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPAllowListConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipallowlistconfig +schema: 2.0.0 +title: Set-IPAllowListConfig --- # Set-IPAllowListConfig @@ -47,6 +48,9 @@ This example configures connection filtering to use the IP Allow list on message ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -56,7 +60,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -74,7 +80,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the IP Allow list is used for content filtering. Valid input for this parameter is $true or $false. The default value is $true. By default, the IP Allow list is used for content filtering. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalMailEnabled parameter specifies whether messages from connections outside of the Exchange organization are evaluated by the IP Allow list. Valid input for this parameter is $true or $false. The default value is $true. By default, messages from external connections are evaluated by the IP Allow list. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalMailEnabled parameter specifies whether messages from connections inside the Exchange organization are evaluated by the IP Allow list. Valid input for this parameter is $true or $false. The default value is $false. By default, messages from internal connections are not evaluated by the IP Allow list. Authenticated partner messages aren't considered internal mail. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvider.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-IPAllowListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvider.md index 4ede592a05..af75586dea 100644 --- a/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipallowlistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPAllowListProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipallowlistprovider +schema: 2.0.0 +title: Set-IPAllowListProvider --- # Set-IPAllowListProvider @@ -57,6 +58,9 @@ This example sets the priority to 1 for the existing IP Allow list provider name ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the IP Allow list provider that you want to modify. You can use any value that uniquely identifies the IP Allow list provider. For example: - Name @@ -67,7 +71,6 @@ The Identity parameter specifies the IP Allow list provider that you want to mod Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -AnyMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnyMatch parameter specifies whether any response by the allow list provider is treated as a match. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, and connection filtering sends the IP address of the connecting SMTP server to the allow list provider, any response code returned by the allow list provider causes connection filtering to allow messages from that source. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -BitmaskMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BitmaskMatch parameter specifies the bit mask status code that's returned by the allow list provider. Use this parameter if the allow list provider returns bitmask responses. Valid input for this parameter is a single IP address in the format 127.0.0.1. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -118,7 +128,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -136,7 +148,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,13 +157,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the Connection Filtering agent queries the IP Allow list provider according to the priority set for this IP Allow list provider configuration. Valid input for this parameter is $true or $false. The default value is $true. By default, the Connection Filtering agent queries the IP Allow list provider according to the priority set for this IP Allow list provider configuration. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +175,9 @@ Accept wildcard characters: False ``` ### -IPAddressesMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddressesMatch parameter specifies the IP address status codes that are returned by the allow list provider. Use this parameter if the allow list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -172,7 +188,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,13 +197,15 @@ Accept wildcard characters: False ``` ### -LookupDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LookupDomain parameter specifies the host name that's required to use the allow list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An example value is allowlist.spamservice.com. The actual value you need to use is provided by the allow list provider. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,13 +215,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a descriptive name for the IP Allow list provider. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -214,6 +233,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the order that the Connection Filtering agent queries the IP Allow list providers that you've configured. By default, every time that you add a new IP Allow list provider, the entry is assigned a priority of N+1, where N is the number of IP Allow list providers you've configured. If you set the Priority parameter to a value that's the same as another IP Allow list provider, the priority of the IP Allow list provider that you added first is incremented by 1. @@ -222,7 +244,6 @@ If you set the Priority parameter to a value that's the same as another IP Allow Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -232,13 +253,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvidersConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvidersConfig.md index 214711a0f1..02de75f25d 100644 --- a/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPAllowListProvidersConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipallowlistprovidersconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPAllowListProvidersConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipallowlistprovidersconfig +schema: 2.0.0 +title: Set-IPAllowListProvidersConfig --- # Set-IPAllowListProvidersConfig @@ -47,6 +48,9 @@ This example configures connection filtering to use IP Allow list providers on m ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -56,7 +60,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -74,7 +80,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether IP Allow list providers are used for content filtering. Valid input for this parameter is $true or $false. The default value is $true. The default value is $true. By default, IP Allow list providers are used for content filtering. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalMailEnabled parameter specifies whether messages from connections outside of the Exchange organization are evaluated by IP Allow list providers. Valid input for this parameter is $true or $false. The default value is $true. By default, messages from external connections are evaluated by IP Allow list providers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalMailEnabled parameter specifies whether messages from connections inside the Exchange organization are evaluated by IP Allow list providers. Valid input for this parameter is $true or $false. The default value is $false. By default, messages from internal connections are not evaluated by IP Allow list providers. Authenticated partner messages aren't considered internal mail. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListConfig.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-IPBlockListConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListConfig.md index af8ccda55d..07b5a80820 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipblocklistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPBlockListConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipblocklistconfig +schema: 2.0.0 +title: Set-IPBlockListConfig --- # Set-IPBlockListConfig @@ -49,6 +50,9 @@ This example configures connection filtering to use the IP Block list on message ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -58,7 +62,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -76,7 +82,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the IP Block list is used for content filtering. Valid input for this parameter is $true or $false. The default value is $true. By default, the IP Block list is used for content filtering. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalMailEnabled parameter specifies whether messages from connections outside of the Exchange organization are evaluated by the IP Block list. Valid input for this parameter is $true or $false. The default value is $true. By default, messages from external connections are evaluated by the IP Block list. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalMailEnabled parameter specifies whether messages from connections inside the Exchange organization are evaluated by the IP Block list. Valid input for this parameter is $true or $false. The default value is $false. By default, messages from internal connections are not evaluated by the IP Block list. Authenticated partner messages aren't considered internal mail. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +145,15 @@ Accept wildcard characters: False ``` ### -MachineEntryRejectionResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MachineEntryRejectionResponse parameter specifies customized text in the non-delivery report (NDR) for messages that are blocked by connection filtering due to IP addresses in the IP Block list that were added by sender reputation. The value can't exceed 240 characters. If the value contains spaces, enclose the value in double quotation marks ("). ```yaml Type: AsciiString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +163,15 @@ Accept wildcard characters: False ``` ### -StaticEntryRejectionResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The StaticEntryRejectionResponse parameter specifies a customized text in the NDR for messages that are blocked by connection filtering due to IP addresses in the IP Block list. The value can't exceed 240 characters. If the value contains spaces, enclose the value in double quotation marks ("). ```yaml Type: AsciiString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +181,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvider.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-IPBlockListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvider.md index f7394da090..7768c0863f 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipblocklistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPBlockListProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipblocklistprovider +schema: 2.0.0 +title: Set-IPBlockListProvider --- # Set-IPBlockListProvider @@ -58,6 +59,9 @@ This example sets the priority value to 1 for the IP Block list provider named C ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the IP Block list provider that you want to modify. You can use any value that uniquely identifies the IP Block list provider. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the IP Block list provider that you want to mod Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AnyMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnyMatch parameter specifies whether any response by the block list provider is treated as a match. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true and connection filtering sends the IP address of the connecting SMTP server to the block list provider, any response code returned by the block list provider causes connection filtering to block messages from that source. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -BitmaskMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BitmaskMatch parameter specifies the bit mask status code that's returned by the block list provider. Use this parameter if the block list provider returns bitmask responses. Valid input for this parameter is a single IP address in the format 127.0.0.1. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -119,7 +129,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -137,7 +149,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the connection filtering uses this IP Block list provider. Valid input for this parameter is $true or $false. The default value is $true. By default, connection filtering uses new IP Block list providers that you create. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +176,9 @@ Accept wildcard characters: False ``` ### -IPAddressesMatch + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddressesMatch parameter specifies the IP address status codes that are returned by the block list provider. Use this parameter if the block list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -173,7 +189,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -183,13 +198,15 @@ Accept wildcard characters: False ``` ### -LookupDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LookupDomain parameter specifies the host name that's required to use the block list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An example value is blocklist.spamservice.com. The actual value you need to use is provided by the block list provider. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,13 +216,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a descriptive name for the IP Block list provider. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,6 +234,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the order that the Connection Filtering agent queries the IP Block list providers. A lower priority integer value indicates a higher priority. By default, every time that you add a new IP Block list provider, the entry is assigned a priority of N+1, where N is the number of IP Block list provider services that you have configured. If you set the Priority parameter to a value that's the same as another IP Block list provider service, the priority of the IP Block list provider that you add first is incremented by 1. @@ -223,7 +245,6 @@ If you set the Priority parameter to a value that's the same as another IP Block Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,6 +254,9 @@ Accept wildcard characters: False ``` ### -RejectionResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RejectionResponse parameter specifies the text that you want to include in the SMTP rejection response when messages are blocked by connection filtering. The argument can't exceed 240 characters. If the value contains spaces, enclose the value in quotation marks ("). You should always specify the block list provider in the response so that legitimate senders can contact the block list provider for removal instructions. For example, "Source IP address is listed at the Contoso.com block list provider". @@ -241,7 +265,6 @@ You should always specify the block list provider in the response so that legiti Type: AsciiString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,13 +274,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvidersConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvidersConfig.md index 50419ac6d6..6ff657f659 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IPBlockListProvidersConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ipblocklistprovidersconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-IPBlockListProvidersConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ipblocklistprovidersconfig +schema: 2.0.0 +title: Set-IPBlockListProvidersConfig --- # Set-IPBlockListProvidersConfig @@ -58,6 +59,9 @@ This example makes the following changes to the list of bypassed recipients: ## PARAMETERS ### -BypassedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassedRecipients parameter specifies the email addresses of internal recipients that are exempted from filtering by IP Block list providers. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -68,7 +72,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -87,7 +93,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -105,7 +113,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether IP Block list providers are used for content filtering. Valid input for this parameter is $true or $false. The default value is $true. The default value is $true. By default, IP Block list providers are used for content filtering. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalMailEnabled parameter specifies whether messages from connections outside of the Exchange organization are evaluated by IP Block list providers. Valid input for this parameter is $true or $false. The default value is $true. By default, messages from external connections are evaluated by IP Bock list providers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalMailEnabled parameter specifies whether messages from connections inside the Exchange organization are evaluated by IP Block list providers. Valid input for this parameter is $true or $false. The default value is $false. By default, messages from internal connections are not evaluated by IP Block list providers. Authenticated partner messages aren't considered internal mail. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-IRMConfiguration.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-IRMConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IRMConfiguration.md index 76f288110e..84722adaa4 100644 --- a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IRMConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-irmconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-IRMConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-irmconfiguration +schema: 2.0.0 +title: Set-IRMConfiguration --- # Set-IRMConfiguration @@ -81,6 +82,9 @@ This example enables licensing for external messages. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Identity parameter specifies the organization's IRM configuration object to modify. The valid value for this parameter is "ControlPoint Configuration". @@ -89,7 +93,6 @@ The Identity parameter specifies the organization's IRM configuration object to Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -AutomaticServiceUpdateEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AutomaticServiceUpdateEnabled parameter specifies whether to allow the automatic addition of new features within Azure Information Protection for your cloud-based organization. Valid values are: @@ -110,7 +116,6 @@ The AutomaticServiceUpdateEnabled parameter specifies whether to allow the autom Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -AzureRMSLicensingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AzureRMSLicensingEnabled parameter specifies whether the Exchange Online organization can to connect directly to Azure Rights Management. Valid values are: @@ -131,7 +139,6 @@ The AzureRMSLicensingEnabled parameter specifies whether the Exchange Online org Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -ClientAccessServerEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ClientAccessServerEnabled parameter specifies whether Exchange Client Access servers are allowed to authenticate clients that do not have direct access to AD RMS (for example, Outlook on the web, Exchange ActiveSync or remote Outlook Anywhere clients). Valid values are: @@ -152,7 +162,6 @@ The ClientAccessServerEnabled parameter specifies whether Exchange Client Access Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -171,7 +183,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -DecryptAttachmentForEncryptOnly + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The DecryptAttachmentForEncryptOnly parameter specifies whether mail recipients have unrestricted rights on the attachment or not for Encrypt-only mails sent using Microsoft Purview Message Encryption. Valid values are: @@ -194,7 +208,6 @@ This parameter replaces the deprecated DecryptAttachmentFromPortal parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -204,6 +217,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -212,7 +228,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +237,9 @@ Accept wildcard characters: False ``` ### -EDiscoverySuperUserEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EDiscoverySuperUserEnabled parameter specifies whether members of the Discovery Management role group can access IRM-protected messages in a discovery mailbox that were returned by a discovery search. Valid values are: - $true: Members of the Discovery Management role group can access IRM-protected messages in discovery mailboxes. @@ -233,7 +251,6 @@ For more information about In-Place eDiscovery and IRM-protected messages, see [ Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,6 +260,9 @@ Accept wildcard characters: False ``` ### -EnablePdfEncryption + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The EnablePdfEncryption parameter specifies whether to enable the encryption of PDF attachments using Microsoft Purview Message Encryption. Valid values are: @@ -254,7 +274,6 @@ The EnablePdfEncryption parameter specifies whether to enable the encryption of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -264,6 +283,9 @@ Accept wildcard characters: False ``` ### -EnablePortalTrackingLogs + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. **Note**: This parameter is available only in organizations with Microsoft Purview Advanced Message Encryption. For more information, see [Advanced Message Encryption](https://learn.microsoft.com/purview/ome-advanced-message-encryption). @@ -277,7 +299,6 @@ The EnablePortalTrackingLogs parameter specifies whether to turn on auditing for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -287,6 +308,9 @@ Accept wildcard characters: False ``` ### -ExternalLicensingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ExternalLicensingEnabled parameter specifies whether Exchange will try to acquire licenses from clusters other than the one it is configured to use. Without this setting, if Exchange receives many messages protected with a random key, the server will devote excessive resources to validating signatures and decrypting messages, even if the keys aren't valid. @@ -300,7 +324,6 @@ Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -310,6 +333,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you modify the InternalLicensingEnabled parameter. @@ -318,7 +344,6 @@ Use this switch to hide the confirmation prompt when you modify the InternalLice Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -328,6 +353,9 @@ Accept wildcard characters: False ``` ### -InternalLicensingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + **Note**: In Exchange Online, this parameter affects both internal and external messages. In on-premises Exchange, this parameter only affects internal messages. The InternalLicensingEnabled parameter specifies whether to enable IRM features for messages that are sent to internal recipients. Valid values are: @@ -339,7 +367,6 @@ The InternalLicensingEnabled parameter specifies whether to enable IRM features Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -349,6 +376,9 @@ Accept wildcard characters: False ``` ### -JournalReportDecryptionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The JournalReportDecryptionEnabled parameter specifies whether to enable journal report decryption. Valid values are: - $true: Journal report encryption is enabled. A decrypted copy of the IRM-protected message is attached to the journal report. This is the default value. Note that journal report decryption requires additional configuration on AD RMS servers. For more information, see [Journal report decryption](https://learn.microsoft.com/exchange/journal-report-decryption-exchange-2013-help). @@ -358,7 +388,6 @@ The JournalReportDecryptionEnabled parameter specifies whether to enable journal Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -368,6 +397,9 @@ Accept wildcard characters: False ``` ### -LicensingLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The LicensingLocation parameter specifies the RMS licensing URLs. You can specify multiple URL values separated by commas. Typically, in on-premises Exchange, you only need to use this parameter in cross-forest deployments of AD RMS licensing servers. @@ -378,7 +410,6 @@ Typically, in on-premises Exchange, you only need to use this parameter in cross Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -388,6 +419,9 @@ Accept wildcard characters: False ``` ### -RefreshServerCertificates + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RefreshServerCertificates switch clears all Rights Account Certificates (RACs), Computer Licensor Certificates (CLCs), and cached AD RMS templates from all Exchange servers in the organization. You don't need to specify a value with this switch. @@ -398,7 +432,6 @@ Clearing RACs, CLCs, and cached templates might be required during troubleshooti Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -408,6 +441,9 @@ Accept wildcard characters: False ``` ### -RejectIfRecipientHasNoRights + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RejectIfRecipientHasNoRights Description }} @@ -416,7 +452,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -426,6 +461,9 @@ Accept wildcard characters: False ``` ### -RMSOnlineKeySharingLocation + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RMSOnlineKeySharingLocation parameter specifies the Azure Rights Management URL that's used to get the trusted publishing domain (TPD) for the Exchange Online organization. @@ -434,7 +472,6 @@ The RMSOnlineKeySharingLocation parameter specifies the Azure Rights Management Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -444,6 +481,9 @@ Accept wildcard characters: False ``` ### -SearchEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SearchEnabled parameter specifies whether to enable searching of IRM-encrypted messages in Outlook on the web (formerly known as Outlook Web App). Valid values are: - $true: Searching IRM-encrypted messages in Outlook on the web is enabled. This is the default value. @@ -453,7 +493,6 @@ The SearchEnabled parameter specifies whether to enable searching of IRM-encrypt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -463,6 +502,9 @@ Accept wildcard characters: False ``` ### -SimplifiedClientAccessDoNotForwardDisabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The SimplifiedClientAccessDoNotForwardDisabled parameter specifies whether to disable **Do not forward** in Outlook on the web. Valid values are: @@ -474,7 +516,6 @@ The SimplifiedClientAccessDoNotForwardDisabled parameter specifies whether to di Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -484,6 +525,9 @@ Accept wildcard characters: False ``` ### -SimplifiedClientAccessEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The SimplifiedClientAccessEnabled parameter specifies whether to enable the Protect button in Outlook on the web. Valid values are: @@ -495,7 +539,6 @@ The SimplifiedClientAccessEnabled parameter specifies whether to enable the Prot Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -505,6 +548,9 @@ Accept wildcard characters: False ``` ### -SimplifiedClientAccessEncryptOnlyDisabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The SimplifiedClientAccessEncryptOnlyDisabled parameter specifies whether to disable **Encrypt only** in Outlook on the web. Valid values are: @@ -516,7 +562,6 @@ The SimplifiedClientAccessEncryptOnlyDisabled parameter specifies whether to dis Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -526,6 +571,9 @@ Accept wildcard characters: False ``` ### -TransportDecryptionSetting + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TransportDecryptionSetting parameter specifies the transport decryption configuration. Valid values are: - Disabled: Transport decryption is disabled for internal and external messages. @@ -536,7 +584,6 @@ The TransportDecryptionSetting parameter specifies the transport decryption conf Type: TransportDecryptionSetting Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -546,13 +593,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ImapSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-ImapSettings.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-ImapSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ImapSettings.md index d6a70cad13..8e5266dbf8 100644 --- a/exchange/exchange-ps/exchange/Set-ImapSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ImapSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-imapsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ImapSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-imapsettings +schema: 2.0.0 +title: Set-ImapSettings --- # Set-ImapSettings @@ -102,6 +103,9 @@ This example specifies the certificate that contains mail.contoso.com is used to ## PARAMETERS ### -AuthenticatedConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AuthenticatedConnectionTimeout parameter specifies the period of time to wait before closing an idle authenticated connection. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -112,7 +116,6 @@ Valid values are 00:00:30 to 1:00:00. The default setting is 00:30:00 (30 minute Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +125,15 @@ Accept wildcard characters: False ``` ### -Banner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Banner parameter specifies the text string that's displayed to connecting IMAP4 clients. The default value is: The Microsoft Exchange IMAP4 service is ready. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -CalendarItemRetrievalOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarItemRetrievalOption parameter specifies how calendar items are presented to IMAP4 clients. Valid values are: - 0 or iCalendar. This is the default value. @@ -151,7 +159,6 @@ If you specify 3 or Custom, you need to specify a value for the OwaServerUrl par Type: CalendarItemRetrievalOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,6 +168,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -170,7 +180,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -180,13 +189,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,6 +207,9 @@ Accept wildcard characters: False ``` ### -EnableExactRFC822Size + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnableExactRFC822Size parameter specifies how message sizes are presented to IMAP4 clients. Valid values are: - $true: Calculate the exact message size. Because this setting can negatively affect performance, you should configure it only if it's required by your IMAP4 clients. @@ -205,7 +219,6 @@ The EnableExactRFC822Size parameter specifies how message sizes are presented to Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -215,6 +228,9 @@ Accept wildcard characters: False ``` ### -EnableGSSAPIAndNTLMAuth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnableGSSAPIAndNTLMAuth parameter specifies whether connections can use Integrated Windows authentication (NTLM) using the Generic Security Services application programming interface (GSSAPI). This setting applies to connections where Transport Layer Security (TLS) is disabled. Valid values are: - $true: NTLM for IMAP4 connections is enabled. This is the default value. @@ -224,7 +240,6 @@ The EnableGSSAPIAndNTLMAuth parameter specifies whether connections can use Inte Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -234,6 +249,9 @@ Accept wildcard characters: False ``` ### -EnforceCertificateErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnforceCertificateErrors parameter specifies whether to enforce valid Secure Sockets Layer (SSL) certificate validation failures. Valid values are: The default setting is $false. @@ -245,7 +263,6 @@ The default setting is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +272,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionPolicy parameter specifies how Extended Protection for Authentication is used. Valid values are: - None: Extended Protection for Authentication isn't used. This is the default value. @@ -267,7 +287,6 @@ Extended Protection for Authentication enhances the protection and handling of c Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,6 +296,9 @@ Accept wildcard characters: False ``` ### -ExternalConnectionSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by external IMAP4 clients (IMAP4 connections from outside your corporate network). This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). @@ -293,7 +315,6 @@ The combination of encryption methods and ports that are specified for this para Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -303,6 +324,9 @@ Accept wildcard characters: False ``` ### -InternalConnectionSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by internal IMAP4 clients (IMAP4 connections from inside your corporate network). This setting is also used when a IMAP4 connection is forwarded to another Exchange server that's running the Microsoft Exchange IMAP4 service. This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). @@ -319,7 +343,6 @@ The combination of encryption methods and ports that are specified for this para Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -329,6 +352,9 @@ Accept wildcard characters: False ``` ### -LogFileLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogFileLocation parameter specifies the location for the IMAP4 protocol log files. The default location is %ExchangeInstallPath%Logging\\Imap4. This parameter is only meaningful when the ProtocolLogEnabled parameter value is $true. @@ -337,7 +363,6 @@ This parameter is only meaningful when the ProtocolLogEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -347,6 +372,9 @@ Accept wildcard characters: False ``` ### -LogFileRollOverSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogFileRollOverSettings parameter specifies how frequently IMAP4 protocol logging creates a new log file. Valid values are: - 1 or Hourly. This is the default value in Exchange 2019 and Exchange 2016. @@ -360,7 +388,6 @@ This parameter is only meaningful when the LogPerFileSizeQuota parameter value i Type: LogFileRollOver Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -370,6 +397,9 @@ Accept wildcard characters: False ``` ### -LoginType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LoginType parameter specifies the authentication method for IMAP4 connections. Valid values are: - 1 or PlainTextLogin. @@ -380,7 +410,6 @@ The LoginType parameter specifies the authentication method for IMAP4 connection Type: LoginOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -390,6 +419,9 @@ Accept wildcard characters: False ``` ### -LogPerFileSizeQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogPerFileSizeQuota parameter specifies the maximum size of a IMAP4 protocol log file. When you enter a value, qualify the value with one of the following units: @@ -410,7 +442,6 @@ This parameter is only meaningful when the ProtocolLogEnabled parameter value is Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -420,13 +451,15 @@ Accept wildcard characters: False ``` ### -MaxCommandSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxCommandSize parameter specifies the maximum size in bytes of a single IMAP4 command. Valid values are from 1024 through 16384. The default value is 10240. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -436,13 +469,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionFromSingleIP + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConnectionFromSingleIP parameter specifies the maximum number of IMAP4 connections that are accepted by the Exchange server from a single IP address. Valid values are from 1 through 2147483647. The default value is 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -452,13 +487,15 @@ Accept wildcard characters: False ``` ### -MaxConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConnections parameter specifies the maximum number of IMAP4 connections that are accepted by the Exchange server. Valid values are from 1 through 2147483647. The default value is 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,13 +505,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionsPerUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConnectionsPerUser parameter specifies the maximum number of IMAP4 connections that are allowed for each user. Valid values are from 1 through 2147483647. The default value is 16. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -484,6 +523,9 @@ Accept wildcard characters: False ``` ### -MessageRetrievalMimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages. Valid values are: - 0 or TextOnly. @@ -498,7 +540,6 @@ The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages Type: MimeTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -508,13 +549,15 @@ Accept wildcard characters: False ``` ### -OwaServerUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaServerUrl parameter specifies the URL that's used to retrieve calendar information for instances of custom Outlook on the web calendar items. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -524,6 +567,9 @@ Accept wildcard characters: False ``` ### -PreAuthenticatedConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PreAuthenticatedConnectionTimeout parameter specifies the period of time to wait before closing an idle IMAP4 connection that isn't authenticated. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -534,7 +580,6 @@ Valid values are00:00:30 to 1:00:00. The default value is 00:01:00 (one minute). Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -544,6 +589,9 @@ Accept wildcard characters: False ``` ### -ProtocolLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProtocolLogEnabled parameter specifies whether to enable protocol logging for IMAP4. Valid values are: - $true: IMAP4 protocol logging is enabled. @@ -553,7 +601,6 @@ The ProtocolLogEnabled parameter specifies whether to enable protocol logging fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -563,13 +610,15 @@ Accept wildcard characters: False ``` ### -ProxyTargetPort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProxyTargetPort parameter specifies the port on the Microsoft Exchange IMAP4 Backend service that listens for client connections that are proxied from the Microsoft Exchange IMAP4 service. The default value is 1993. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -579,6 +628,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -592,7 +644,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -602,6 +653,9 @@ Accept wildcard characters: False ``` ### -ShowHiddenFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ShowHiddenFoldersEnabled parameter specifies whether hidden mailbox folders are visible. Valid values are: - $true: Hidden folders are visible. @@ -611,7 +665,6 @@ The ShowHiddenFoldersEnabled parameter specifies whether hidden mailbox folders Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -621,6 +674,9 @@ Accept wildcard characters: False ``` ### -SSLBindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SSLBindings parameter specifies the IP address and TCP port that's used for IMAP4 connection that's always encrypted by SSL/TLS. This parameter uses the syntax `IPv4OrIPv6Address:Port`. The default value is `[::]:993,0.0.0.0:993`. @@ -633,7 +689,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -643,6 +698,9 @@ Accept wildcard characters: False ``` ### -SuppressReadReceipt + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuppressReadReceipt parameter specifies whether to stop duplicate read receipts from being sent to IMAP4 clients that have the Send read receipts for messages I send setting configured in their IMAP4 email program. Valid values are: - $true: The sender receives a read receipt only when the recipient opens the message. @@ -652,7 +710,6 @@ The SuppressReadReceipt parameter specifies whether to stop duplicate read recei Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -662,6 +719,9 @@ Accept wildcard characters: False ``` ### -UnencryptedOrTLSBindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UnencryptedOrTLSBindings parameter specifies the IP address and TCP port that's used for unencrypted IMAP4 connections, or IMAP4 connections that are encrypted by using opportunistic TLS (STARTTLS) after the initial unencrypted protocol handshake. This parameter uses the syntax `IPv4OrIPv6Address:Port`. The default value is `[::]:143,0.0.0.0:143`. @@ -674,7 +734,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -684,13 +743,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -700,6 +761,9 @@ Accept wildcard characters: False ``` ### -X509CertificateName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The X509CertificateName parameter specifies the certificate that's used for encrypting IMAP4 client connections. A valid value for this parameter is the FQDN from the ExternalConnectionSettings or InternalConnectionSettings parameters (for example, mail.contoso.com or mailbox01.contoso.com). @@ -712,7 +776,6 @@ If you use a wildcard certificate, you don't need to assign the certificate to t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-InboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-InboundConnector.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-InboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-InboundConnector.md index 285ba184d1..ab649d275a 100644 --- a/exchange/exchange-ps/exchange/Set-InboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-InboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-inboundconnector applicable: Exchange Online, Exchange Online Protection -title: Set-InboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-inboundconnector +schema: 2.0.0 +title: Set-InboundConnector --- # Set-InboundConnector @@ -69,13 +70,15 @@ Require that the TLS certificate that is used to encrypt communications contain ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Inbound connector you want to change. ```yaml Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssociatedAcceptedDomains + +> Applicable: Exchange Online, Exchange Online Protection + The AssociatedAcceptedDomains parameter restricts the source domains that use the connector to the specified accepted domains. A valid value is an SMTP domain that's configured as an accepted domain in your Microsoft 365 organization. You can specify multiple values separated by commas. @@ -93,7 +99,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -116,7 +124,6 @@ Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,13 +133,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -151,7 +163,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -ConnectorSource + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorSource parameter specifies how the connector is created. Valid input for this parameter includes the following values: - Default: The connector is manually created. This is the default value. @@ -173,7 +187,6 @@ We recommended that you don't change this value. Type: TenantConnectorSource Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,6 +196,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid input for this parameter includes the following values: - Partner: The connector services domains that are external to your organization. @@ -192,7 +208,6 @@ The ConnectorType parameter specifies a category for the domains that are servic Type: TenantConnectorType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -EFSkipIPs + +> Applicable: Exchange Online, Exchange Online Protection + the EFSkipIPs parameter specifies the source IP addresses to skip in Enhanced Filtering for Connectors when the EFSkipLastIP parameter value is $false. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -214,7 +232,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -224,6 +241,9 @@ Accept wildcard characters: False ``` ### -EFSkipLastIP + +> Applicable: Exchange Online, Exchange Online Protection + The EFSkipIPs parameter specifies the behavior of Enhanced Filtering for Connectors. Valid values are: - $true: Only the last message source is skipped. @@ -233,7 +253,6 @@ The EFSkipIPs parameter specifies the behavior of Enhanced Filtering for Connect Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,13 +262,15 @@ Accept wildcard characters: False ``` ### -EFSkipMailGateway + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -259,13 +280,15 @@ Accept wildcard characters: False ``` ### -EFTestMode + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -275,6 +298,9 @@ Accept wildcard characters: False ``` ### -EFUsers + +> Applicable: Exchange Online, Exchange Online Protection + The EFUsers parameter specifies the recipients that Enhanced Filtering for Connectors applies to. The default value is blank ($null), which means Enhanced Filtering for Connectors is applied to all recipients. You can specify multiple recipient email addresses separated by commas. @@ -283,7 +309,6 @@ You can specify multiple recipient email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -293,6 +318,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter enables or disables the connector. Valid values are: - $true: The connector is enabled. This is the default value. @@ -302,7 +330,6 @@ The Enabled parameter enables or disables the connector. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -312,13 +339,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies a descriptive name for the connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -328,6 +357,9 @@ Accept wildcard characters: False ``` ### -RequireTls + +> Applicable: Exchange Online, Exchange Online Protection + The RequireTLS parameter specifies whether to require TLS transmission for all messages that are received by a Partner type connector. Valid values are: - $true: Reject messages if they aren't sent over TLS. This is the default value @@ -339,7 +371,6 @@ The RequireTLS parameter specifies whether to require TLS transmission for all m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -349,6 +380,9 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToCertificate + +> Applicable: Exchange Online, Exchange Online Protection + The RestrictDomainsToCertificate parameter specifies whether the Subject value of the TLS certificate is checked before messages can use the Partner type connector. Valid values are: - $true: Mail is allowed to use the connector only if the Subject value of the TLS certificate that the source email server uses to authenticate matches the TlsSenderCertificateName parameter value. @@ -360,7 +394,6 @@ The RestrictDomainsToCertificate parameter specifies whether the Subject value o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -370,6 +403,9 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToIPAddresses + +> Applicable: Exchange Online, Exchange Online Protection + The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that comes from unknown source IP addresses for Partner type connectors. Valid values are: - $true: Automatically reject mail from domains that are specified by the SenderDomains parameter if the source IP address isn't also specified by the SenderIPAddress parameter. @@ -381,7 +417,6 @@ The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -391,13 +426,15 @@ Accept wildcard characters: False ``` ### -ScanAndDropRecipients + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -407,6 +444,9 @@ Accept wildcard characters: False ``` ### -SenderDomains + +> Applicable: Exchange Online, Exchange Online Protection + The SenderDomains parameter specifies the source domains that a Partner type connector accepts messages for (limits the scope of a Partner type connector). A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, `*.contoso.com`). However, you can't embed the wildcard character (for example, `domain.*.contoso.com` isn't valid). You can specify multiple domains separated by commas. @@ -415,7 +455,6 @@ You can specify multiple domains separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -425,6 +464,9 @@ Accept wildcard characters: False ``` ### -SenderIPAddresses + +> Applicable: Exchange Online, Exchange Online Protection + The SenderIPAddresses parameter specifies the source IPV4 IP addresses that the Partner type connector accepts messages from when the value of the RestrictDomainsToIPAddresses parameter is $true. Valid values are: - Single IP address: For example, 192.168.1.1. @@ -439,7 +481,6 @@ IPv6 addresses are not supported. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -449,13 +490,15 @@ Accept wildcard characters: False ``` ### -TlsSenderCertificateName + +> Applicable: Exchange Online, Exchange Online Protection + The TlsSenderCertificateName parameter specifies the TLS certificate that's used when the value of the RequireTls parameter is $true. A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com is not valid). ```yaml Type: TlsCertificate Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -465,6 +508,9 @@ Accept wildcard characters: False ``` ### -TreatMessagesAsInternal + +> Applicable: Exchange Online, Exchange Online Protection + The TreatMessagesAsInternal parameter specifies an alternative method to identify messages sent from an on-premises organization as internal messages. You should only consider using this parameter when your on-premises organization doesn't use Exchange. Valid values are: - $true: Messages are considered internal if the sender's domain matches a domain that's configured in Microsoft 365. This setting allows internal mail flow between Microsoft 365 and on-premises organizations that don't have Exchange Server 2010 or later installed. However, this setting has potential security risks (for example, internal messages bypass antispam filtering), so use caution when configuring this setting. @@ -481,7 +527,6 @@ In hybrid environments, you don't need to use this parameter, because the Hybrid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -491,6 +536,9 @@ Accept wildcard characters: False ``` ### -TrustedOrganizations + +> Applicable: Exchange Online, Exchange Online Protection + The TrustedOrganizations parameter specifies other Microsoft 365 organizations that are trusted mail sources (for example, after acquisitions and mergers). This parameter works only for mail flow between two Microsoft 365 organizations, so no other parameters are used. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -501,7 +549,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -511,13 +558,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-InboxRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-InboxRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-InboxRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-InboxRule.md index fbbb29f2cb..59223edb84 100644 --- a/exchange/exchange-ps/exchange/Set-InboxRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-InboxRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-InboxRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-inboxrule +schema: 2.0.0 +title: Set-InboxRule --- # Set-InboxRule @@ -113,6 +114,9 @@ This example modifies the action of the existing Inbox rule ProjectContoso. The ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Inbox rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -124,7 +128,6 @@ The Identity parameter specifies the Inbox rule that you want to modify. You can Type: InboxRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -134,13 +137,15 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -150,6 +155,9 @@ Accept wildcard characters: False ``` ### -ApplyCategory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApplyCategory parameter specifies an action for the Inbox rule that applies the specified category to messages. A valid value is any text value that you want to define as a category. You can specify multiple categories separated by commas. If the value contains spaces, enclose the value in quotation marks ("). The categories that you specify for this parameter are defined in the mailbox (they aren't shared between mailboxes). @@ -158,7 +166,6 @@ The categories that you specify for this parameter are defined in the mailbox (t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -168,6 +175,9 @@ Accept wildcard characters: False ``` ### -ApplySystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApplySystemCategory parameter specifies an action for the Inbox rule that applies the specified system category to messages. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -203,7 +213,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -213,6 +222,9 @@ Accept wildcard characters: False ``` ### -BodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -227,7 +239,6 @@ The corresponding exception parameter to this condition is ExceptIfBodyContainsW Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -237,6 +248,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -246,7 +260,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -256,6 +269,9 @@ Accept wildcard characters: False ``` ### -CopyToFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CopyToFolder parameter specifies an action for the Inbox rule that copies messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -277,7 +293,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,6 +302,9 @@ Accept wildcard characters: False ``` ### -DeleteSystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeleteSystemCategory parameter specifies an action for the Inbox rule that deletes the specified system category from messages. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -320,7 +338,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -330,6 +347,9 @@ Accept wildcard characters: False ``` ### -DeleteMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeleteMessage parameter specifies an action for the Inbox rule that sends messages to the Deleted Items folder. Valid values are: - $true: Messages that match the conditions of the rule are moved to the Deleted Items folder. @@ -339,7 +359,6 @@ The DeleteMessage parameter specifies an action for the Inbox rule that sends me Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -349,6 +368,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -357,7 +379,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -367,6 +388,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -381,7 +405,6 @@ The corresponding condition parameter to this exception is BodyContainsWords. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -391,6 +414,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFlaggedForAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfFlaggedForAction parameter specifies an exception for the Inbox rule that looks messages with the specified message flag. Valid values are: - Any @@ -411,7 +437,6 @@ The corresponding condition parameter to this exception is FlaggedForAction. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -421,6 +446,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: - Name @@ -438,7 +466,6 @@ The corresponding condition parameter to this exception is From. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -448,6 +475,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -462,7 +492,6 @@ The corresponding condition parameter to this exception is FromAddressContainsWo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -472,6 +501,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasAttachment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfHasAttachment parameter specifies an exception for the Inbox rule that looks for messages with attachments. Valid values are: - $true: The rule action isn't applied to messages that have attachments. @@ -483,7 +515,6 @@ The corresponding condition parameter to this exception is HasAttachment. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -493,6 +524,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfHasClassification parameter specifies an exception for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. The corresponding condition parameter to this exception is HasClassification. @@ -501,7 +535,6 @@ The corresponding condition parameter to this exception is HasClassification. Type: MessageClassificationIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -511,6 +544,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -525,7 +561,6 @@ The corresponding condition parameter to this exception is HeaderContainsWords. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -535,6 +570,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfMessageTypeMatches parameter specifies an exception for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply @@ -555,7 +593,6 @@ The corresponding condition parameter to this exception is MessageTypeMatches. Type: InboxRuleMessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -565,6 +602,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfMyNameInCcBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the Cc field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is in the Cc field. @@ -576,7 +616,6 @@ The corresponding condition parameter to this exception is MyNameInCcBox. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -586,6 +625,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfMyNameInToBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the To field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is in the To field. @@ -597,7 +639,6 @@ The corresponding condition parameter to this exception is MyNameInToBox. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -607,6 +648,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameInToOrCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfMyNameInToOrCcBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner is in the To or Cc fields Valid values are. - $true: The rule action isn't applied to messages where the mailbox owner is in the To or Cc fields. @@ -618,7 +662,6 @@ The corresponding condition parameter to this exception is MyNameInToOrCcBox. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -628,6 +671,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMyNameNotInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfMyNameNotInToBox parameter specifies an exception for the Inbox rule that looks for messages where the mailbox owner isn't in the To field. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner isn't in the To field. @@ -639,7 +685,6 @@ The corresponding condition parameter to this exception is MyNameNotInToBox. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -649,6 +694,9 @@ Accept wildcard characters: False ``` ### -ExceptIfReceivedAfterDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfReceivedAfterDate parameter specifies an exception for the Inbox rule that looks for messages received after the specified date. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -659,7 +707,6 @@ The corresponding condition parameter to this exception is ReceivedAfterDate. Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -669,6 +716,9 @@ Accept wildcard characters: False ``` ### -ExceptIfReceivedBeforeDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfReceivedBeforeDate parameter specifies an exception for the Inbox rule that looks for messages received before the specified date. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -679,7 +729,6 @@ The corresponding condition parameter to this exception is ReceivedBeforeDate. Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -689,6 +738,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfRecipientAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in recipient email addresses. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -703,7 +755,6 @@ The corresponding condition parameter to this exception is RecipientAddressConta Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -713,6 +764,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentOnlyToMe + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfSentOnlyToMe parameter specifies an exception for the Inbox rule that looks for messages where the only recipient is the mailbox owner. Valid values are: - $true: The rule action isn't applied to messages where the mailbox owner is the only recipient. @@ -724,7 +778,6 @@ The corresponding condition parameter to this exception is SentOnlyToMe. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -734,6 +787,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -751,7 +807,6 @@ The corresponding condition parameter to this exception is SentTo. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -761,6 +816,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -775,7 +833,6 @@ The corresponding condition parameter to this exception is SubjectContainsWords. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -785,6 +842,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -799,7 +859,6 @@ The corresponding condition parameter to this exception is SubjectOrBodyContains Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -809,6 +868,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfWithImportance parameter specifies an exception for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High @@ -821,7 +883,6 @@ The corresponding condition parameter to this exception is WithImportance. Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -831,6 +892,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithinSizeRangeMaximum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfWithinSizeRangeMaximum parameter specifies part of an exception for the Inbox rule that looks for messages that smaller than specified maximum size. When you enter a value, qualify the value with one of the following units: @@ -851,7 +915,6 @@ The corresponding condition parameter to this exception is WithinSizeRangeMaximu Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -861,6 +924,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithinSizeRangeMinimum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfWithinSizeRangeMinimum parameter specifies part of an exception for the Inbox rule that looks for messages that are larger than the specified minimum size. When you enter a value, qualify the value with one of the following units: @@ -881,7 +947,6 @@ The corresponding condition parameter to this exception is WithinSizeRangeMinimu Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -891,6 +956,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithSensitivity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExceptIfWithSensitivity parameter specifies an exception for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal @@ -904,7 +972,6 @@ The corresponding condition parameter to this exception is WithSensitivity. Type: Sensitivity Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -914,6 +981,9 @@ Accept wildcard characters: False ``` ### -FlaggedForAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FlaggedForAction parameter specifies a condition for the Inbox rule that looks for messages with the specified message flag. Valid values are: - Any @@ -932,7 +1002,6 @@ The FlaggedForAction parameter specifies a condition for the Inbox rule that loo Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -942,6 +1011,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. @@ -950,7 +1022,6 @@ A confirmation prompt warns you if the mailbox contains rules that were created Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -960,6 +1031,9 @@ Accept wildcard characters: False ``` ### -ForwardAsAttachmentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForwardAsAttachmentTo parameter specifies an action for the Inbox rule that forwards the message to the specified recipient as an attachment. You can use any value that uniquely identifies the recipient. For example: - Name @@ -975,7 +1049,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -985,6 +1058,9 @@ Accept wildcard characters: False ``` ### -ForwardTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForwardTo parameter specifies an action for the Inbox rule that forwards the message to the specified recipient. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1000,7 +1076,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1010,6 +1085,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The From parameter specifies a condition for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: - Name @@ -1027,7 +1105,6 @@ The corresponding exception parameter to this condition is ExceptIfFrom. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1037,6 +1114,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1051,7 +1131,6 @@ The corresponding exception parameter to this condition is ExceptIfFromAddressCo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1061,6 +1140,9 @@ Accept wildcard characters: False ``` ### -HasAttachment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HasAttachment parameter specifies a condition for the Inbox rule that looks for messages with attachments. Valid values are: - $true: The rule action is applied to messages that have attachments. @@ -1072,7 +1154,6 @@ The corresponding exception parameter to this condition is ExceptIfHasAttachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1082,6 +1163,9 @@ Accept wildcard characters: False ``` ### -HasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HasClassification parameter specifies a condition for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. The corresponding exception parameter to this condition is ExceptIfHasClassification. @@ -1090,7 +1174,6 @@ The corresponding exception parameter to this condition is ExceptIfHasClassifica Type: MessageClassificationIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1100,6 +1183,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1114,7 +1200,6 @@ The corresponding exception parameter to this condition is ExceptIfHeaderContain Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1124,6 +1209,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -1141,7 +1229,6 @@ The Mailbox parameter specifies the mailbox that contains the Inbox rule. You ca Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1151,6 +1238,9 @@ Accept wildcard characters: False ``` ### -MarkAsRead + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MarkAsRead parameter specifies an action for the Inbox rule that marks messages as read. Valid values are: - $true: Messages that match the conditions of the rule are marked as read. @@ -1160,7 +1250,6 @@ The MarkAsRead parameter specifies an action for the Inbox rule that marks messa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1170,6 +1259,9 @@ Accept wildcard characters: False ``` ### -MarkImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MarkImportance parameter specifies an action for the Inbox rule that marks messages with the specified importance flag. Valid values are: - Low @@ -1180,7 +1272,6 @@ The MarkImportance parameter specifies an action for the Inbox rule that marks m Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1190,6 +1281,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MessageTypeMatches parameter specifies a condition for the Inbox rule that looks for messages of the specified type. Valid values are: - AutomaticReply @@ -1210,7 +1304,6 @@ The corresponding exception parameter to this condition is ExceptIfMessageTypeMa Type: InboxRuleMessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1220,6 +1313,9 @@ Accept wildcard characters: False ``` ### -MoveToFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MoveToFolder parameter specifies an action for the Inbox rule that moves messages to the specified mailbox folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -1241,7 +1337,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1251,6 +1346,9 @@ Accept wildcard characters: False ``` ### -MyNameInCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MyNameInCcBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the Cc field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is in the Cc field. @@ -1262,7 +1360,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInCcBox Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1272,6 +1369,9 @@ Accept wildcard characters: False ``` ### -MyNameInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MyNameInToBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the To field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is in the To field. @@ -1283,7 +1383,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInToBox Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1293,6 +1392,9 @@ Accept wildcard characters: False ``` ### -MyNameInToOrCcBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MyNameInToOrCcBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner is in the To or Cc fields Valid values are. - $true: The rule action is applied to messages where the mailbox owner is in the To or Cc fields. @@ -1304,7 +1406,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameInToOrC Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1314,6 +1415,9 @@ Accept wildcard characters: False ``` ### -MyNameNotInToBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MyNameNotInToBox parameter specifies a condition for the Inbox rule that looks for messages where the mailbox owner isn't in the To field. Valid values are: - $true: The rule action is applied to messages where the mailbox owner isn't in the To field. @@ -1325,7 +1429,6 @@ The corresponding exception parameter to this condition is ExceptIfMyNameNotInTo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1335,13 +1438,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a name for the Inbox rule. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1351,6 +1456,9 @@ Accept wildcard characters: False ``` ### -PinMessage + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PinMessage parameter specifies an action for the Inbox rule that pins messages to the top of the Inbox. Valid values are: - $true: Message that match the conditions of the rule are pinned to the top of the Inbox. @@ -1360,7 +1468,6 @@ The PinMessage parameter specifies an action for the Inbox rule that pins messag Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1370,13 +1477,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Priority parameter specifies a priority for the Inbox rule that determines the order of rule processing. A lower integer value indicates a higher priority, ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1386,6 +1495,9 @@ Accept wildcard characters: False ``` ### -ReceivedAfterDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReceivedAfterDate parameter specifies a condition for the Inbox rule that looks for messages received after the specified date. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -1396,7 +1508,6 @@ The corresponding exception parameter to this condition is ExceptIfReceivedAfter Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1406,6 +1517,9 @@ Accept wildcard characters: False ``` ### -ReceivedBeforeDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReceivedBeforeDate parameter specifies a condition for the Inbox rule that looks for messages received before the specified date. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -1416,7 +1530,6 @@ The corresponding exception parameter to this condition is ExceptIfReceivedBefor Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1426,6 +1539,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in recipient email addresses. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -1440,7 +1556,6 @@ The corresponding exception parameter to this condition is ExceptIfRecipientAddr Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1450,6 +1565,9 @@ Accept wildcard characters: False ``` ### -RedirectTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RedirectTo parameter specifies an action for the Inbox rule that redirects the message to the specified recipient. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1465,7 +1583,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1475,6 +1592,9 @@ Accept wildcard characters: False ``` ### -SendTextMessageNotificationTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SendTextMessageNotificationTo parameter specifies an action for the Inbox rule that send a text message notification to the specified telephone number. @@ -1487,7 +1607,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1497,6 +1616,9 @@ Accept wildcard characters: False ``` ### -SentOnlyToMe + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SentOnlyToMe parameter specifies a condition for the Inbox rule that looks for messages where the only recipient is the mailbox owner. Valid values are: - $true: The rule action is applied to messages where the mailbox owner is the only recipient. @@ -1508,7 +1630,6 @@ The corresponding exception parameter to this condition is ExceptIfSentOnlyToMe. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1518,6 +1639,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SentTo parameter specifies a condition for the Inbox rule that looks for messages with the specified recipients. You can use any value that uniquely identifies the recipient. For example: - Name @@ -1535,7 +1659,6 @@ The corresponding exception parameter to this condition is ExceptIfSentTo. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1545,6 +1668,9 @@ Accept wildcard characters: False ``` ### -SoftDeleteMessage + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SoftDeleteMessage Description }} @@ -1553,7 +1679,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1563,6 +1688,9 @@ Accept wildcard characters: False ``` ### -StopProcessingRules + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StopProcessingRules parameter specifies an action for the Inbox rule that stops processing additional rules if the conditions of this Inbox rule are met. Valid values are:If set to $true, the StopProcessingRules parameter instructs Exchange to stop processing additional rules if the conditions of this Inbox rule are met. - $true: Stop processing more rules. @@ -1572,7 +1700,6 @@ The StopProcessingRules parameter specifies an action for the Inbox rule that st Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1582,6 +1709,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1596,7 +1726,6 @@ The corresponding exception parameter to this condition is ExceptIfSubjectContai Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1606,6 +1735,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. @@ -1620,7 +1752,6 @@ The corresponding exception parameter to this condition is ExceptIfSubjectOrBody Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1630,13 +1761,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1646,6 +1779,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WithImportance parameter specifies a condition for the Inbox rule that looks for messages with the specified importance level. Valid values are: - High @@ -1658,7 +1794,6 @@ The corresponding exception parameter to this condition is ExceptIfWithImportanc Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1668,6 +1803,9 @@ Accept wildcard characters: False ``` ### -WithinSizeRangeMaximum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WithinSizeRangeMaximum parameter specifies part of a condition for the Inbox rule that looks for messages that are smaller than specified maximum size. When you enter a value, qualify the value with one of the following units: @@ -1688,7 +1826,6 @@ The corresponding exception parameter to this condition is ExceptIfWithinSizeRan Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1698,6 +1835,9 @@ Accept wildcard characters: False ``` ### -WithinSizeRangeMinimum + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WithinSizeRangeMinimum parameter specifies part of a condition for the Inbox rule that looks for messages that are larger than the specified minimum size. When you enter a value, qualify the value with one of the following units: @@ -1718,7 +1858,6 @@ The corresponding exception parameter to this condition is ExceptIfWithinSizeRan Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1728,6 +1867,9 @@ Accept wildcard characters: False ``` ### -WithSensitivity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WithSensitivity parameter specifies a condition for the Inbox rule that looks for messages with the specified sensitivity level. Valid values are: - Normal @@ -1741,7 +1883,6 @@ The corresponding exception parameter to this condition is ExceptIfWithSensitivi Type: Sensitivity Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-InformationBarrierPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-InformationBarrierPolicy.md index 2fbe4dd044..f9a9ae0ea5 100644 --- a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-InformationBarrierPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-informationbarrierpolicy applicable: Security & Compliance -title: Set-InformationBarrierPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-informationbarrierpolicy +schema: 2.0.0 +title: Set-InformationBarrierPolicy --- # Set-InformationBarrierPolicy @@ -81,6 +82,9 @@ This example activates the specified inactive information barrier policy. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the information barrier policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -91,7 +95,6 @@ The Identity parameter specifies the information barrier policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -101,13 +104,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,13 +122,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -141,7 +151,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -ModerationAllowed + +> Applicable: Security & Compliance + {{ Fill ModerationAllowed Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -SegmentsAllowed + +> Applicable: Security & Compliance + The SegmentsAllowed parameter specifies the segments that are allowed to communicate with the segment in this policy (users defined by the AssignedSegment parameter). Only these specified segments can communicate with the segment in this policy. You identify the segment by its Name value. If the value contains spaces, enclose the value in quotation marks ("). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). @@ -177,7 +191,6 @@ You can't use this parameter with the SegmentsBlocked parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsAllowed Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -187,13 +200,15 @@ Accept wildcard characters: False ``` ### -SegmentAllowedFilter + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: OrganizationSegmentAllowedFilter Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -203,6 +218,9 @@ Accept wildcard characters: False ``` ### -SegmentsBlocked + +> Applicable: Security & Compliance + The SegmentsBlocked parameter specifies the segments that aren't allowed to communicate with the segment in this policy (users defined by the AssignedSegment parameter). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). You identify the segment by its Name value. If the value contains spaces, enclose the value in quotation marks ("). You can specify multiple segments separated by commas ("Segment1","Segment2",..."SegmentN"). @@ -213,7 +231,6 @@ You can't use this parameter with the SegmentsAllowed parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsBlocked Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -223,6 +240,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Security & Compliance + The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: - Active @@ -233,7 +253,6 @@ Type: EopInformationBarrierPolicyState Parameter Sets: (All) Aliases: Accepted values: Inactive, Active -Applicable: Security & Compliance Required: False Position: Named @@ -243,13 +262,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -271,4 +292,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-IntraOrganizationConnector.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-IntraOrganizationConnector.md index 5216746dff..fb7f1e6a95 100644 --- a/exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-IntraOrganizationConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-intraorganizationconnector applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-IntraOrganizationConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-intraorganizationconnector +schema: 2.0.0 +title: Set-IntraOrganizationConnector --- # Set-IntraOrganizationConnector @@ -49,6 +50,9 @@ This example disables the Intra-Organization connector named "MainCloudConnector ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the Intra-Organization connector that you want to modify. You can use any value that uniquely identifies the connector. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the Intra-Organization connector that you want Type: IntraOrganizationConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DiscoveryEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DiscoveryEndpoint parameter specifies the externally accessible URL used for the Autodiscover service for the domain configured in the IntraOrganization Connector. This parameter is automatically populated with the TargetAutodiscoverEpr value from the Get-FederationInformation cmdlet for the defined domain. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -112,7 +122,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter enables or disabled the Intra-organization connector. The valid values for this parameter are $true or $false. The default value is $true. When you set the value to $false, you completely stop connectivity for the specific connection. @@ -130,7 +142,6 @@ When you set the value to $false, you completely stop connectivity for the speci Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -TargetAddressDomains + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -156,6 +169,9 @@ Accept wildcard characters: False ``` ### -TargetSharingEpr + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services that will be used in the Intra-Organization connector. @@ -164,7 +180,6 @@ The TargetSharingEpr parameter specifies the URL of the target Exchange Web Serv Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-JournalRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-JournalRule.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-JournalRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-JournalRule.md index 3c8d9f1233..7cd7eda4b9 100644 --- a/exchange/exchange-ps/exchange/Set-JournalRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-JournalRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-journalrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-JournalRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-journalrule +schema: 2.0.0 +title: Set-JournalRule --- # Set-JournalRule @@ -56,6 +57,9 @@ This example modifies the journal email address for all journal rules. The Get-J ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -64,7 +68,6 @@ The Identity parameter is a positional parameter. When using positional paramete Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -83,7 +89,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -101,7 +109,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -JournalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The JournalEmailAddress parameter specifies a journal recipient. Journal reports for the specified rule are sent to the journal recipient. You can use any value that uniquely identifies the recipient. For example: - Name @@ -124,7 +134,6 @@ The JournalEmailAddress parameter specifies a journal recipient. Journal reports Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -Recipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or received from a recipient are journaled. To journal messages from all recipients, use the value $null for this parameter. @@ -158,7 +172,6 @@ To journal messages from all recipients, use the value $null for this parameter. Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -168,6 +181,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Scope parameter specifies the scope of email messages to which the journal rule is applied. You can use the following values: - Global: Global rules process all email messages that pass through a Transport service. This includes email messages that were already processed by the external and internal rules. @@ -178,7 +194,6 @@ The Scope parameter specifies the scope of email messages to which the journal r Type: JournalRuleScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Label.md b/exchange/exchange-ps/ExchangePowerShell/Set-Label.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-Label.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Label.md index 8424874e92..fd2b100f35 100644 --- a/exchange/exchange-ps/exchange/Set-Label.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Label.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/policy-and-compliance/set-label applicable: Security & Compliance -title: Set-Label -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/policy-and-compliance/set-label +schema: 2.0.0 +title: Set-Label --- # Set-Label @@ -125,6 +126,9 @@ This example removes the localized label name and label Tooltips for "Label1" in ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the sensitivity label that you want to modify. You can use any value that uniquely identifies the label. For example: - Name @@ -135,7 +139,6 @@ The Identity parameter specifies the sensitivity label that you want to modify. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -145,6 +148,9 @@ Accept wildcard characters: False ``` ### -AdvancedSettings + +> Applicable: Security & Compliance + The AdvancedSettings parameter enables specific features and capabilities for a sensitivity label. Specify this parameter with the identity (name or GUID) of the sensitivity label, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. @@ -177,7 +183,6 @@ For more information to help you configure advanced settings for a label, see [P Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -187,6 +192,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterAlignment + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterAlignment parameter specifies the footer alignment. Valid values are: - Left @@ -199,7 +207,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -209,6 +216,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterEnabled + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterEnabled parameter enables or disables the Apply Content Marking Footer action for the label. Valid values are: - $true: The Apply Content Marking Footer action is enabled. @@ -218,7 +228,6 @@ The ApplyContentMarkingFooterEnabled parameter enables or disables the Apply Con Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -228,6 +237,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontColor + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontColor parameter specifies the color of the footer text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -236,7 +248,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -246,6 +257,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontName + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontName parameter specifies the font of the footer text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -256,7 +270,6 @@ This parameter is supported only by the Azure Information Protection unified lab Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -266,6 +279,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterFontSize + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterFontSize parameter specifies the font size (in points) of the footer text. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -274,7 +290,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -284,6 +299,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterMargin + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterMargin parameter specifies the size (in points) of the footer margin. This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -294,7 +312,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -304,6 +321,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingFooterText + +> Applicable: Security & Compliance + The ApplyContentMarkingFooterText parameter specifies the footer text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. @@ -312,7 +332,6 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -322,6 +341,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderAlignment + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderAlignment parameter specifies the header alignment. Valid values are: - Left @@ -334,7 +356,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -344,6 +365,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderEnabled + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderEnabled parameter enables or disables the Apply Content Marking Header action for the label. Valid values are: - $true: The Apply Content Marking Header action is enabled. @@ -353,7 +377,6 @@ The ApplyContentMarkingHeaderEnabled parameter enables or disables the Apply Con Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -363,6 +386,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontColor + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontColor parameter specifies the color of the header text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -371,7 +397,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -381,6 +406,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontName + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontName parameter specifies the font of the header text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -389,7 +417,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -399,6 +426,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderFontSize + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderFontSize parameter specifies the font size (in points) of the header text. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -407,7 +437,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -417,6 +446,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderMargin + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderMargin parameter specifies the size (in points) of the header margin. This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -427,7 +459,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -437,6 +468,9 @@ Accept wildcard characters: False ``` ### -ApplyContentMarkingHeaderText + +> Applicable: Security & Compliance + The ApplyContentMarkingHeaderText parameter specifies the header text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. @@ -445,7 +479,6 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -455,6 +488,9 @@ Accept wildcard characters: False ``` ### -ApplyDynamicWatermarkingEnabled + +> Applicable: Security & Compliance + **Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. The ApplyDynamicWatermarkingEnabled parameter enables dynamic watermarking for a specific label that applies encryption. Valid values are: @@ -468,7 +504,6 @@ You set the watermark text with the DynamicWatermarkDisplay parameter. For more Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -478,6 +513,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingEnabled + +> Applicable: Security & Compliance + The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarking Header action for the label. Valid values are: - $true: The Apply Watermarking Header action is enabled. @@ -487,7 +525,6 @@ The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarkin Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -497,6 +534,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontColor + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontColor parameter specifies the color of the watermark text. This parameter accepts a hexadecimal color code value in the format `#xxxxxx`. The default value is `#000000`. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -505,7 +545,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -515,6 +554,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontName + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontName parameter specifies the font of the watermark text. If the value contains spaces, enclose the value in quotation marks ("). For example `"Courier New"`. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -523,7 +565,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -533,6 +574,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingFontSize + +> Applicable: Security & Compliance + The ApplyWaterMarkingFontSize parameter specifies the font size (in points) of the watermark text. This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -541,7 +585,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -551,6 +594,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingLayout + +> Applicable: Security & Compliance + The ApplyWaterMarkingLayout parameter specifies the watermark alignment. Valid values are: - Horizontal @@ -562,7 +608,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -572,6 +617,9 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingText + +> Applicable: Security & Compliance + The ApplyWaterMarkingText parameter specifies the watermark text. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. @@ -580,7 +628,6 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -590,13 +637,15 @@ Accept wildcard characters: False ``` ### -ColumnAssetCondition + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -606,13 +655,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -622,13 +673,15 @@ Accept wildcard characters: False ``` ### -Conditions + +> Applicable: Security & Compliance + The Conditions parameter is used for automatic labeling of files and email for data in use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -638,6 +691,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -647,7 +703,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -657,6 +712,9 @@ Accept wildcard characters: False ``` ### -ContentType + +> Applicable: Security & Compliance + The ContentType parameter specifies where the sensitivity label can be applied. Valid values are: - File @@ -673,7 +731,6 @@ Values can be combined, for example: "File, Email, PurviewAssets". Type: MipLabelContentType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -683,13 +740,15 @@ Accept wildcard characters: False ``` ### -DefaultContentLabel + +> Applicable: Security & Compliance + The DefaultContentLabel specifies a label that can be automatically applied to meetings created in a labeled Teams channel. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -699,13 +758,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Security & Compliance + The DisplayName parameter specifies the display name for the sensitivity label. The display name appears in any client that supports sensitivity labels. This includes Word, Excel, PowerPoint, Outlook, SharePoint, Teams, and Power BI. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -715,6 +776,9 @@ Accept wildcard characters: False ``` ### -DynamicWatermarkDisplay + +> Applicable: Security & Compliance + **Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. The DynamicWatermarkDisplay parameter specifies the watermark text to display for a given label. This parameter supports text and the following special tokens: @@ -730,7 +794,6 @@ This parameter is meaningful only when the ApplyDynamicWatermarkingEnabled param Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -740,6 +803,9 @@ Accept wildcard characters: False ``` ### -EncryptionContentExpiredOnDateInDaysOrNever + +> Applicable: Security & Compliance + The EncryptionContentExpiredOnDateInDaysOrNever parameter specifies when the encrypted content expires. Valid values are: - An integer (number of days) @@ -751,7 +817,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -761,6 +826,9 @@ Accept wildcard characters: False ``` ### -EncryptionDoNotForward + +> Applicable: Security & Compliance + The EncryptionDoNotForward parameter specifies whether the Do Not Forward template is applied. Valid values are: - $true: The Do Not Forward template is applied. @@ -772,7 +840,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -782,13 +849,15 @@ Accept wildcard characters: False ``` ### -EncryptionDoubleKeyEncryptionUrl + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -798,6 +867,9 @@ Accept wildcard characters: False ``` ### -EncryptionEnabled + +> Applicable: Security & Compliance + The EncryptionEnabled parameter specifies whether encryption in enabled. Valid values are: - $true: Encryption is enabled. @@ -807,7 +879,6 @@ The EncryptionEnabled parameter specifies whether encryption in enabled. Valid v Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -817,6 +888,9 @@ Accept wildcard characters: False ``` ### -EncryptionEncryptOnly + +> Applicable: Security & Compliance + The EncryptionEncryptOnly parameter specifies whether the encrypt-only template is applied. Valid values are: - $true: The encrypt-only template is applied. @@ -828,7 +902,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -838,6 +911,9 @@ Accept wildcard characters: False ``` ### -EncryptionOfflineAccessDays + +> Applicable: Security & Compliance + The EncryptionOfflineAccessDays parameter specifies the number of days that offline access is allowed. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -846,7 +922,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -856,6 +931,9 @@ Accept wildcard characters: False ``` ### -EncryptionPromptUser + +> Applicable: Security & Compliance + The EncryptionPromptUser parameter specifies whether to set the label with user defined permission in Word, Excel, and PowerPoint. Valid values are: - $true: The label is set with user defined permissions in Word, Excel and PowerPoint. @@ -867,7 +945,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -877,6 +954,9 @@ Accept wildcard characters: False ``` ### -EncryptionProtectionType + +> Applicable: Security & Compliance + The EncryptionProtectionType parameter specifies the protection type for encryption. Valid values are: - Template @@ -889,7 +969,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -899,6 +978,9 @@ Accept wildcard characters: False ``` ### -EncryptionRightsDefinitions + +> Applicable: Security & Compliance + The EncryptionRightsDefinitions parameter specifies the rights users have when accessing protected. This parameter uses the syntax `Identity1:Rights1,Rights2;Identity2:Rights3,Rights4`. For example, `john@contoso.com:VIEW,EDIT;microsoft.com:VIEW`. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false and the EncryptionProtectionType parameter value is Template. @@ -907,7 +989,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: EncryptionRightsDefinitionsParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -917,6 +998,9 @@ Accept wildcard characters: False ``` ### -EncryptionRightsUrl + +> Applicable: Security & Compliance + The EncryptionRightsUrl parameter specifies the URL for hold your own key (HYOK) protection. This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -925,7 +1009,6 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -935,13 +1018,15 @@ Accept wildcard characters: False ``` ### -LabelActions + +> Applicable: Security & Compliance + The LabelActions parameter is used to specify actions that can be performed on labels. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -951,6 +1036,9 @@ Accept wildcard characters: False ``` ### -LocaleSettings + +> Applicable: Security & Compliance + The LocaleSettings parameter specifies one or more localized label names and label Tooltips in different languages. Regions include all region codes supported in Office Client applications. Valid values use the following syntax (JSON): - Label display names: `{"localeKey":"DisplayName","Settings":[{"Key":"en-us","Value":"English display name"},{"Key":"de-de","Value":"Deutscher Anzeigename"},{"Key":"es-es","Value":"Nombre para mostrar en Español"}]}` @@ -962,7 +1050,6 @@ To remove a language, you need to enter an empty value for that language. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -972,13 +1059,15 @@ Accept wildcard characters: False ``` ### -MigrationId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -988,13 +1077,15 @@ Accept wildcard characters: False ``` ### -NextLabel + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1004,6 +1095,9 @@ Accept wildcard characters: False ``` ### -ParentId + +> Applicable: Security & Compliance + The ParentId parameter specifies the parent label that you want this label to be under (a sublabel). You can use any value that uniquely identifies the parent sensitivity label. For example: - Name @@ -1014,7 +1108,6 @@ The ParentId parameter specifies the parent label that you want this label to be Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1024,13 +1117,15 @@ Accept wildcard characters: False ``` ### -PreviousLabel + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1040,13 +1135,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the sensitivity label that determines the order of label processing. A higher integer value indicates a higher priority. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1056,13 +1153,15 @@ Accept wildcard characters: False ``` ### -SchematizedDataCondition + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1072,13 +1171,15 @@ Accept wildcard characters: False ``` ### -Setting + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1088,13 +1189,15 @@ Accept wildcard characters: False ``` ### -Settings + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1104,6 +1207,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowAccessToGuestUsers + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowAccessToGuestUsers parameter enables or disables access to guest users. Valid values are: - $true: Guest access is enabled. @@ -1115,7 +1221,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1125,6 +1230,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowEmailFromGuestUsers + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowEmailFromGuestUsers parameter enables or disables email from guest users. Valid values are: - $true: Email from guest users is enabled. @@ -1136,7 +1244,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1146,6 +1253,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowFullAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowFullAccess parameter enables or disables full access. Valid values are: - $true: Full access is enabled. @@ -1157,7 +1267,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1167,6 +1276,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionAllowLimitedAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionAllowLimitedAccess parameter enables or disables limited access. Valid values are: - $true: Limited access is enabled. @@ -1178,7 +1290,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1188,6 +1299,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionBlockAccess + +> Applicable: Security & Compliance + The SiteAndGroupProtectionBlockAccess parameter blocks access. Valid values are: - $true: Access is blocked. @@ -1199,7 +1313,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1209,6 +1322,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionEnabled + +> Applicable: Security & Compliance + The SiteAndGroupProtectionEnabled parameter enables or disables the Site and Group Protection action for the label. Valid values are: - $true: The Site and Group Protection action is enabled. @@ -1218,7 +1334,6 @@ The SiteAndGroupProtectionEnabled parameter enables or disables the Site and Gro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1228,13 +1343,15 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionLevel + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: SiteAndGroupProtectionLevelParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1244,6 +1361,9 @@ Accept wildcard characters: False ``` ### -SiteAndGroupProtectionPrivacy + +> Applicable: Security & Compliance + The SiteAndGroupProtectionPrivacy parameter specifies the privacy level for the labe. Valid values are: - Public @@ -1255,7 +1375,6 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1265,6 +1384,9 @@ Accept wildcard characters: False ``` ### -SiteExternalSharingControlType + +> Applicable: Security & Compliance + The SiteExternalSharingControlType parameter specifies the external user sharing setting for the label. Valid values are: - ExternalUserAndGuestSharing @@ -1283,7 +1405,6 @@ These correspond to the following settings through the admin center: Type: Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1293,6 +1414,9 @@ Accept wildcard characters: False ``` ### -TeamsAllowedPresenters + +> Applicable: Security & Compliance + The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Valid values are: - Everyone @@ -1305,7 +1429,6 @@ The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AllowedPresenters Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1315,6 +1438,9 @@ Accept wildcard characters: False ``` ### -TeamsAllowMeetingChat + +> Applicable: Security & Compliance + The TeamsAllowMeetingChat parameter controls whether chat is available in Teams meetings. Valid values are: - Enabled @@ -1326,7 +1452,6 @@ The TeamsAllowMeetingChat parameter controls whether chat is available in Teams Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.MeetingChatMode Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1336,13 +1461,15 @@ Accept wildcard characters: False ``` ### -TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch + +> Applicable: Security & Compliance + {{ Fill TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1352,6 +1479,9 @@ Accept wildcard characters: False ``` ### -TeamsBypassLobbyForDialInUsers + +> Applicable: Security & Compliance + The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for dial-in users who join Teams meetings. Valid values are: - $true: Dial in users bypass the lobby when joining Teams meetings. @@ -1362,7 +1492,6 @@ The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for d Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1372,13 +1501,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelProtectionEnabled + +> Applicable: Security & Compliance + {{ Fill TeamsChannelProtectionEnabled Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1388,13 +1519,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithExternalTenants + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithExternalTenants Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1404,13 +1537,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithPrivateTeamsOnly + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1420,13 +1555,15 @@ Accept wildcard characters: False ``` ### -TeamsChannelSharedWithSameLabelOnly + +> Applicable: Security & Compliance + {{ Fill TeamsChannelSharedWithSameLabelOnly Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1436,6 +1573,9 @@ Accept wildcard characters: False ``` ### -TeamsCopyRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: - $true: Chat messages can be copied to the clipboard. @@ -1445,7 +1585,6 @@ The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Tea Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1455,6 +1594,9 @@ Accept wildcard characters: False ``` ### -TeamsEndToEndEncryptionEnabled + +> Applicable: Security & Compliance + The TeamsEndToEndEncryptionEnabled parameter controls video stream encryption in Teams meetings. Valid values are: - $true: Video stream encryption is enabled. @@ -1465,7 +1607,6 @@ The TeamsEndToEndEncryptionEnabled parameter controls video stream encryption in Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1475,6 +1616,9 @@ Accept wildcard characters: False ``` ### -TeamsLobbyBypassScope + +> Applicable: Security & Compliance + The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Teams meetings. Valid values are: - Everyone @@ -1489,7 +1633,6 @@ The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.LobbyBypassScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1499,6 +1642,9 @@ Accept wildcard characters: False ``` ### -TeamsLobbyRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass the lobby when joining Teams meetings. Valid values are: - $true: Users bypass the lobby when joining Teams meetings. @@ -1509,7 +1655,6 @@ The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1519,6 +1664,9 @@ Accept wildcard characters: False ``` ### -TeamsPresentersRestrictionEnforced + +> Applicable: Security & Compliance + The TeamsPresentersRestrictionEnforced parameter controls whether presenter restrictions are enabled in Teams meetings. Valid values are: - $true: Presenter restrictions are enabled in Teams meetings. @@ -1529,7 +1677,6 @@ The TeamsPresentersRestrictionEnforced parameter controls whether presenter rest Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1539,6 +1686,9 @@ Accept wildcard characters: False ``` ### -TeamsProtectionEnabled + +> Applicable: Security & Compliance + The TeamsProtectionEnabled parameter controls whether Teams protection is enabled in Teams meetings. Valid values are: - $true: Teams protection is enabled in Teams meetings. @@ -1548,7 +1698,6 @@ The TeamsProtectionEnabled parameter controls whether Teams protection is enable Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1558,6 +1707,9 @@ Accept wildcard characters: False ``` ### -TeamsRecordAutomatically + +> Applicable: Security & Compliance + The TeamsRecordAutomatically parameter controls whether Teams meetings are automatically recorded after they start. Valid values are: - $true: Teams meetings are automatically recorded after they start. @@ -1568,7 +1720,6 @@ The TeamsRecordAutomatically parameter controls whether Teams meetings are autom Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1578,6 +1729,9 @@ Accept wildcard characters: False ``` ### -TeamsVideoWatermark + +> Applicable: Security & Compliance + The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams meetings. Valid values are: - None @@ -1589,7 +1743,6 @@ The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WaterMarkProtectionValues Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1599,6 +1752,9 @@ Accept wildcard characters: False ``` ### -TeamsWhoCanRecord + +> Applicable: Security & Compliance + The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid values are: - Organizer @@ -1610,7 +1766,6 @@ The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid va Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WhoCanRecordOptions Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1620,13 +1775,15 @@ Accept wildcard characters: False ``` ### -Tooltip + +> Applicable: Security & Compliance + The ToolTip parameter specifies the default tooltip and sensitivity label description that's seen by users. It the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1636,13 +1793,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -1662,4 +1821,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-Label](https://learn.microsoft.com/powershell/module/exchange/new-label) +[New-Label](https://learn.microsoft.com/powershell/module/exchangepowershell/new-label) diff --git a/exchange/exchange-ps/exchange/Set-LabelPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-LabelPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-LabelPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-LabelPolicy.md index 5b190d2637..8646340ea5 100644 --- a/exchange/exchange-ps/exchange/Set-LabelPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-LabelPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-labelpolicy applicable: Security & Compliance -title: Set-LabelPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-labelpolicy +schema: 2.0.0 +title: Set-LabelPolicy --- # Set-LabelPolicy @@ -104,6 +105,9 @@ This example configures the specified advanced setting for the sensitivity label ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the policy that you want to view. You can use any value that uniquely identifies the policy. For example: - Name @@ -114,7 +118,6 @@ The Identity parameter specifies the policy that you want to view. You can use a Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -124,6 +127,9 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -134,7 +140,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. A valid value is a mailbox. To specify the mailbox, you can use any value that uniquely identifies it. For example: @@ -159,7 +167,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -169,6 +176,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocationException + +> Applicable: Security & Compliance + The AddExchangeLocationException parameter specifies the mailboxes to add to the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. A valid value is a mailbox. To specify the mailbox, you can use any value that uniquely identifies it. For example: @@ -184,7 +194,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -194,6 +203,9 @@ Accept wildcard characters: False ``` ### -AddLabels + +> Applicable: Security & Compliance + The AddLabels parameter specifies the sensitivity labels that you want to add to the policy. You can use any value that uniquely identifies the label. For example: - Name @@ -206,7 +218,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -216,6 +227,9 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocation + +> Applicable: Security & Compliance + The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups. To identify the Microsoft 365 Group, you must use the primary SMTP address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -224,7 +238,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -234,13 +247,15 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -250,13 +265,15 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -266,13 +283,15 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -282,13 +301,15 @@ Accept wildcard characters: False ``` ### -AddPublicFolderLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -298,13 +319,15 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -314,13 +337,15 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -330,13 +355,15 @@ Accept wildcard characters: False ``` ### -AddSkypeLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -346,13 +373,15 @@ Accept wildcard characters: False ``` ### -AddSkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -362,6 +391,9 @@ Accept wildcard characters: False ``` ### -AdvancedSettings + +> Applicable: Security & Compliance + The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. Specify this parameter with the identity (name or GUID) of the policy, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. @@ -398,7 +430,6 @@ Additionally, for Power BI: Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -408,13 +439,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity, AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -424,6 +457,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -433,7 +469,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -443,6 +478,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -451,7 +489,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -461,13 +498,15 @@ Accept wildcard characters: False ``` ### -MigrationId + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -477,6 +516,9 @@ Accept wildcard characters: False ``` ### -NextLabelPolicy + +> Applicable: Security & Compliance + The NextLabelPolicy parameter updates the policy order so the policy that's specified by this parameter is after the current policy that you're modifying. You can use any value that uniquely identifies the policy. For example: - Name @@ -487,7 +529,6 @@ The NextLabelPolicy parameter updates the policy order so the policy that's spec Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -497,6 +538,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. @@ -505,7 +549,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -515,6 +558,9 @@ Accept wildcard characters: False ``` ### -PreviousLabelPolicy + +> Applicable: Security & Compliance + The PreviousLabelPolicy parameter updates the policy order so the policy that's specified by this parameter is before the current policy that you're modifying. You can use any value that uniquely identifies the policy. For example: - Name @@ -525,7 +571,6 @@ The PreviousLabelPolicy parameter updates the policy order so the policy that's Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -535,6 +580,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -553,7 +601,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -563,6 +610,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocationException + +> Applicable: Security & Compliance + The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you're using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -581,7 +631,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -591,6 +640,9 @@ Accept wildcard characters: False ``` ### -RemoveLabels + +> Applicable: Security & Compliance + The RemoveLabels parameter specifies the sensitivity labels that you want to remove from the policy. You can use any value that uniquely identifies the label. For example: - Name @@ -603,7 +655,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -613,6 +664,9 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocation + +> Applicable: Security & Compliance + The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups. To identify the Microsoft 365 Group, you must use the primary SMTP address. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -621,7 +675,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -631,13 +684,15 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -647,13 +702,15 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -663,13 +720,15 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -679,13 +738,15 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -695,13 +756,15 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -711,13 +774,15 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -727,13 +792,15 @@ Accept wildcard characters: False ``` ### -RemoveSkypeLocation + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -743,13 +810,15 @@ Accept wildcard characters: False ``` ### -RemoveSkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -759,13 +828,15 @@ Accept wildcard characters: False ``` ### -Setting + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -775,13 +846,15 @@ Accept wildcard characters: False ``` ### -Settings + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -791,13 +864,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-LinkedUser.md b/exchange/exchange-ps/ExchangePowerShell/Set-LinkedUser.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-LinkedUser.md rename to exchange/exchange-ps/ExchangePowerShell/Set-LinkedUser.md index ab7afd569b..63c3c474f2 100644 --- a/exchange/exchange-ps/exchange/Set-LinkedUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-LinkedUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-linkeduser applicable: Exchange Online, Exchange Online Protection -title: Set-LinkedUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-linkeduser +schema: 2.0.0 +title: Set-LinkedUser --- # Set-LinkedUser @@ -45,6 +46,9 @@ This example modifies the certificate subject for the linked user "GALSync-Servi ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the linked user. You can use any value that uniquely identifies the linked user, for example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the linked user. You can use any value that uni Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -CertificateSubject + +> Applicable: Exchange Online + The CertificateSubject parameter specifies the value of the subject field of the user's digital certificate. The syntax of the CertificateSubject value is `X509:IssuerSubject`. The values of Issuer and Subject are required and must be in X.500 format. To remove the value of CertificateSubject, specify the value $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -89,7 +97,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicy.md index db10ad8518..ef3f52b177 100644 --- a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicy applicable: Exchange Online, Exchange Online Protection -title: Set-M365DataAtRestEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-m365dataatrestencryptionpolicy +schema: 2.0.0 +title: Set-M365DataAtRestEncryptionPolicy --- # Set-M365DataAtRestEncryptionPolicy @@ -66,6 +67,9 @@ This example updates the Microsoft 365 data-at-rest encryption policy named Tena ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the data-at-rest encryption policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -76,7 +80,6 @@ The Identity parameter specifies the data-at-rest encryption policy that you wan Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -95,7 +101,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Online + The Description parameter specifies an optional description for the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -146,7 +158,6 @@ The Enabled parameter specifies whether the policy is enabled or disabled. Valid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -164,7 +178,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: DCAdminPurgeKeyRequest, TenantAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the Microsoft 365 data-at-rest encryption policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -190,13 +205,15 @@ Accept wildcard characters: False ``` ### -Refresh + +> Applicable: Exchange Online + Use the Refresh switch to update the Microsoft 365 data-at-rest encryption policy in Exchange Online after you rotate any of the associated keys in the Azure Key Vault. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: RefreshKey Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -206,13 +223,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md b/exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicyAssignment.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicyAssignment.md index d5a82bfdda..b33473efcb 100644 --- a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-M365DataAtRestEncryptionPolicyAssignment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicyassignment applicable: Exchange Online -title: Set-M365DataAtRestEncryptionPolicyAssignment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-m365dataatrestencryptionpolicyassignment +schema: 2.0.0 +title: Set-M365DataAtRestEncryptionPolicyAssignment --- # Set-M365DataAtRestEncryptionPolicyAssignment @@ -39,6 +40,9 @@ This example assigns the Microsoft 365 data-at-rest encryption policy named Cont ## PARAMETERS ### -DataEncryptionPolicy + +> Applicable: Exchange Online + The DataEncryptionPolicy parameter specifies the Microsoft 365 data-at-rest encryption policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -49,7 +53,6 @@ The DataEncryptionPolicy parameter specifies the Microsoft 365 data-at-rest encr Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailContact.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailContact.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-MailContact.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailContact.md index e699c9dec7..5d26ad05db 100644 --- a/exchange/exchange-ps/exchange/Set-MailContact.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailContact.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailcontact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailContact -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailcontact +schema: 2.0.0 +title: Set-MailContact --- # Set-MailContact @@ -106,6 +107,9 @@ This example sets John Rodman's external email address to john@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail contact that you want to modify. You can use any value that uniquely identifies the mail contact. For example: - Name @@ -119,7 +123,6 @@ The Identity parameter specifies the mail contact that you want to modify. You c Type: MailContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -129,6 +132,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -152,7 +158,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -162,6 +167,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -185,7 +193,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -195,6 +202,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -220,7 +230,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -230,6 +239,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -254,7 +266,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -264,6 +275,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -283,7 +297,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +306,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -314,7 +330,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -324,6 +339,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -333,7 +351,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -343,6 +360,9 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: @@ -354,7 +374,6 @@ The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-fre Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -364,13 +383,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -380,13 +401,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -396,13 +419,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -412,13 +437,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -428,13 +455,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -444,13 +473,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -460,13 +491,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -476,13 +509,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -492,13 +527,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,13 +545,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -524,13 +563,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -540,13 +581,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -556,13 +599,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -572,13 +617,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -588,13 +635,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -604,13 +653,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the mail contact. The display name is visible in the Exchange admin center (EAC) and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -620,6 +671,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -628,7 +682,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -638,6 +691,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -665,7 +721,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -675,6 +730,9 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: @@ -686,7 +744,6 @@ The EmailAddressPolicyEnabled parameter specifies whether to apply email address Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -696,6 +753,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -708,7 +768,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -718,6 +777,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -730,7 +792,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -740,6 +801,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -752,7 +816,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -762,6 +825,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -774,7 +840,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -784,6 +849,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -796,7 +864,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -806,6 +873,9 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. @@ -816,7 +886,6 @@ When you use the ExternalEmailAddress parameter to change the external email add Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -826,13 +895,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -842,6 +913,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mail contact. Although messages sent on behalf of the mail contact clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the mail contact, not the sender. The sender you specify for this parameter must a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the sender. For example: @@ -867,7 +941,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -877,6 +950,9 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. @@ -886,7 +962,6 @@ The HiddenFromAddressListsEnabled parameter specifies whether this recipient is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -896,6 +971,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -909,7 +987,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -919,6 +996,9 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: - BinHex (This is the default value) @@ -935,7 +1015,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -945,6 +1024,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -956,7 +1038,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -966,6 +1047,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -980,7 +1064,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -990,6 +1073,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail contact. Messages larger than the maximum size are rejected. @@ -1013,7 +1099,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1023,6 +1108,9 @@ Accept wildcard characters: False ``` ### -MaxRecipientPerMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxRecipientPerMessage parameter specifies the maximum number of recipients allowed in messages sent by the mail contact. @@ -1035,7 +1123,6 @@ The value unlimited indicates the maximum number of recipients per message for t Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1045,6 +1132,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail contact. @@ -1068,7 +1158,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1078,6 +1167,9 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -1093,7 +1185,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1103,6 +1194,9 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -1119,7 +1213,6 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1129,6 +1222,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1148,7 +1244,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1158,6 +1253,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -1169,7 +1267,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1179,13 +1276,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the mail contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1195,6 +1294,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. @@ -1209,7 +1311,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1219,6 +1320,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1242,7 +1346,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1252,6 +1355,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1275,7 +1381,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1285,6 +1390,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1310,7 +1418,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1320,6 +1427,9 @@ Accept wildcard characters: False ``` ### -RemovePicture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemovePicture switch removes the picture from the mail contact. You don't need to specify a value with this switch. @@ -1330,7 +1440,6 @@ You can add a picture to a mail contact by using the Import-RecipientDataPropert Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1340,6 +1449,9 @@ Accept wildcard characters: False ``` ### -RemoveSpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoveSpokenName switch removes the spoken name from the mail contact. You don't need to specify a value with this switch. @@ -1350,7 +1462,6 @@ You can add a sound file to a mail contact by using the Import-RecipientDataProp Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1360,6 +1471,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1369,7 +1483,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1379,6 +1492,9 @@ Accept wildcard characters: False ``` ### -SecondaryAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SecondaryAddress parameter specifies the secondary address that's used by the Unified Messaging (UM)-enabled mail contact. @@ -1387,7 +1503,6 @@ The SecondaryAddress parameter specifies the secondary address that's used by th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1397,6 +1512,9 @@ Accept wildcard characters: False ``` ### -SecondaryDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. @@ -1405,7 +1523,6 @@ The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1415,6 +1532,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -1427,7 +1547,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1437,6 +1556,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -1449,7 +1571,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1459,6 +1580,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -1479,7 +1603,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1489,6 +1612,9 @@ Accept wildcard characters: False ``` ### -UseMapiRichTextFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The UseMapiRichTextFormat parameter specifies what to do with messages that are sent to the mail user or mail contact in MAPI rich text format, also known as Outlook Rich Text or Transport Neutral Encapsulation Format (TNEF). Valid values are: - Always: TNEF is used for all messages sent to the mail user or mail contact. @@ -1501,7 +1627,6 @@ The default value is UseDefaultSettings. Type: UseMapiRichTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1511,6 +1636,9 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are: - $true: Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact. @@ -1520,7 +1648,6 @@ The UsePreferMessageFormat specifies whether the message format settings configu Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1530,6 +1657,9 @@ Accept wildcard characters: False ``` ### -UserCertificate + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. @@ -1538,7 +1668,6 @@ The UserCertificate parameter specifies the digital certificate used to sign a u Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1548,6 +1677,9 @@ Accept wildcard characters: False ``` ### -UserSMimeCertificate + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. @@ -1556,7 +1688,6 @@ The UserSMimeCertificate parameter specifies the S/MIME certificate that's used Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1566,13 +1697,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1582,6 +1715,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -1593,7 +1729,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailPublicFolder.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-MailPublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailPublicFolder.md index 8dd27b3503..7b5cf8c9e7 100644 --- a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailPublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailpublicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailPublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailpublicfolder +schema: 2.0.0 +title: Set-MailPublicFolder --- # Set-MailPublicFolder @@ -120,6 +121,9 @@ This example removes the secondary email address MyPublicFolder@fabrikam.com fro ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -128,7 +132,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: MailPublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -138,6 +141,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -161,7 +167,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -171,6 +176,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -194,7 +202,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -204,6 +211,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -229,7 +239,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -239,6 +248,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -263,7 +275,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -273,6 +284,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ArbitrationMailbox parameter specifies the mailbox used to manage the moderation process. You can use any value that uniquely identifies the mailbox. For example: @@ -292,7 +306,6 @@ The ArbitrationMailbox parameter specifies the mailbox used to manage the modera Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -302,6 +315,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -323,7 +339,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -333,6 +348,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -342,7 +360,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -352,6 +369,9 @@ Accept wildcard characters: False ``` ### -Contacts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Contacts parameter specifies the contacts for the public folder. Contacts are persons about whom you can save several types of information, such as addresses, telephone numbers, and web page URLs. Valid values for this parameter are recipients in your organization. You can use any value that uniquely identifies the recipient. For example: @@ -369,7 +389,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -379,13 +398,15 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010 + The CreateDTMFMap parameter specifies that a dual tone multi-frequency (DTMF) map be created for the user. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -395,13 +416,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,13 +434,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -427,13 +452,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -443,13 +470,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -459,13 +488,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -475,13 +506,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -491,13 +524,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -507,13 +542,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -523,13 +560,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -539,13 +578,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -555,13 +596,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -571,13 +614,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -587,13 +632,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -603,13 +650,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -619,13 +668,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -635,6 +686,9 @@ Accept wildcard characters: False ``` ### -DeliverToMailboxAndForward + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeliverToMailboxAndForward parameter specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress or ForwardingSmtpAddress parameters. Valid values are: - $true: Messages are delivered to this public folder and forwarded to the specified recipient or email address. @@ -646,7 +700,6 @@ The default value is $false. The value of this parameter is meaningful only if y Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -656,13 +709,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DisplayName parameter specifies the display name of the Public Folder Proxy object. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -672,6 +727,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -680,7 +738,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -690,6 +747,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -717,7 +777,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -727,6 +786,9 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: - $true: Email address policies are applied to this recipient. This is the default value. @@ -736,7 +798,6 @@ The EmailAddressPolicyEnabled parameter specifies whether to apply email address Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -746,13 +807,15 @@ Accept wildcard characters: False ``` ### -EntryId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EntryId parameter specifies the EntryID value for the public folder. You use this parameter to correct an existing EntryID that points to a folder that can't be found. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -762,6 +825,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -774,7 +840,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -784,6 +849,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -796,7 +864,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -806,6 +873,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -818,7 +888,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -828,6 +897,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -840,7 +912,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -850,6 +921,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -862,7 +936,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -872,13 +945,15 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalEmailAddress parameter specifies an email address outside the organization. ```yaml Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -888,6 +963,9 @@ Accept wildcard characters: False ``` ### -ForwardingAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForwardingAddress parameter specifies a forwarding address for messages that are sent to this public folder. A valid value for this parameter is a recipient in your organization. You can use any value that uniquely identifies the recipient. For example: - Name @@ -908,7 +986,6 @@ The default value is blank ($null), which means no forwarding recipient is confi Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -918,6 +995,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this public folder. Although messages sent on behalf of the mail user clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the public folder, not the sender. The sender you specify for this parameter must a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the sender. For example: @@ -943,7 +1023,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -953,6 +1032,9 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. @@ -962,7 +1044,6 @@ The HiddenFromAddressListsEnabled parameter specifies whether this recipient is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -972,6 +1053,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -983,7 +1067,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -993,6 +1076,9 @@ Accept wildcard characters: False ``` ### -IgnoreMissingFolderLink + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreMissingFolderLink parameter specifies whether to exclude the mail-enabled public folder from a specific validation check that's used during a public folder migration. Valid values are: - $true: Skip the validation check. If the Active Directory object for the mail-enabled public folder doesn't have EntryId or ContentMailbox property values, the public folder is ignored, and the public folder migration can continue. @@ -1002,7 +1088,6 @@ The IgnoreMissingFolderLink parameter specifies whether to exclude the mail-enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1012,6 +1097,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -1023,7 +1111,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1033,6 +1120,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -1047,7 +1137,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1057,6 +1146,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the public folder. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -1076,7 +1168,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1086,6 +1177,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxSendSize parameter specifies the maximum size of a message that can be sent by the public folder. When you enter a value, qualify the value with one of the following units: @@ -1105,7 +1199,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1115,6 +1208,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1134,7 +1230,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1144,6 +1239,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -1155,7 +1253,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1165,13 +1262,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name of the public folder. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1181,13 +1280,15 @@ Accept wildcard characters: False ``` ### -OnPremisesObjectId + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The OnPremisesObjectId parameter specifies the ObjectID (GUID) value of the mail-enabled public folder from the on-premises environment. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1197,13 +1298,15 @@ Accept wildcard characters: False ``` ### -PhoneticDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1213,6 +1316,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the public folder are no longer automatically updated by email address policies. @@ -1223,7 +1329,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1233,6 +1338,9 @@ Accept wildcard characters: False ``` ### -PublicFolderType + +> Applicable: Exchange Server 2010 + The PublicFolderType parameter specifies which of the following four types is assigned to the public folder: - GeneralPurpose @@ -1244,7 +1352,6 @@ The PublicFolderType parameter specifies which of the following four types is as Type: PublicFolderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1254,6 +1361,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1277,7 +1387,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1287,6 +1396,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1310,7 +1422,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1320,6 +1431,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1345,7 +1459,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1355,6 +1468,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1364,7 +1480,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1374,6 +1489,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -1386,7 +1504,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1396,6 +1513,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -1409,7 +1529,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1419,6 +1538,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -1431,7 +1553,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1441,6 +1562,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The UMDtmfMap parameter specifies if you want to create a user-defined DTMF map for the UM-enabled user. @@ -1449,7 +1573,6 @@ The UMDtmfMap parameter specifies if you want to create a user-defined DTMF map Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1459,13 +1582,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1475,6 +1600,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -1486,7 +1614,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailUser.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailUser.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-MailUser.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailUser.md index ab267d41fa..ffe35144e9 100644 --- a/exchange/exchange-ps/exchange/Set-MailUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailuser +schema: 2.0.0 +title: Set-MailUser --- # Set-MailUser @@ -958,6 +959,9 @@ This example modifies the external email address for the mail user named John Wo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mail user that you want to modify. You can use any value that uniquely identifies the mail user. For example: - Name @@ -971,7 +975,6 @@ The Identity parameter specifies the mail user that you want to modify. You can Type: MailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -981,6 +984,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1004,7 +1010,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1014,6 +1019,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1037,7 +1045,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1047,6 +1054,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -1072,7 +1082,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1082,6 +1091,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -1106,7 +1118,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1116,6 +1127,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -1135,7 +1149,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1145,13 +1158,15 @@ Accept wildcard characters: False ``` ### -ArchiveGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1161,6 +1176,9 @@ Accept wildcard characters: False ``` ### -ArchiveName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1169,7 +1187,6 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1179,6 +1196,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -1200,7 +1220,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1210,6 +1229,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -1219,7 +1241,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1229,6 +1250,9 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: @@ -1240,7 +1264,6 @@ The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-fre Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1250,13 +1273,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1266,13 +1291,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1282,13 +1309,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1298,13 +1327,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1314,13 +1345,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1330,13 +1363,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1346,13 +1381,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1362,13 +1399,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1378,13 +1417,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1394,13 +1435,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1410,13 +1453,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1426,13 +1471,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1442,13 +1489,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1458,13 +1507,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1474,13 +1525,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1490,6 +1543,9 @@ Accept wildcard characters: False ``` ### -DataEncryptionPolicy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DataEncryptionPolicy parameter specifies the data encryption policy that's applied to the mail user. You can use any value that uniquely identifies the policy. For example: @@ -1504,7 +1560,6 @@ You can use the Get-DataEncryptionPolicy cmdlet to view the available policies. Type: DataEncryptionPolicyIdParameter Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1514,13 +1569,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1530,6 +1587,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -1538,7 +1598,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1548,6 +1607,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -1575,7 +1637,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1585,6 +1646,9 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: @@ -1596,7 +1660,6 @@ The EmailAddressPolicyEnabled parameter specifies whether to apply email address Type: Boolean Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1606,6 +1669,9 @@ Accept wildcard characters: False ``` ### -EnableLitigationHoldForMigration + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The EnableLitigationHoldForMigration switch is used in cross-tenant mailbox migrations to increase the quota on the Recoverable Items folder to 100 GB (and also enable Litigation Hold) prior to migration. You don't need to specify a value with this switch. @@ -1616,7 +1682,6 @@ This feature is not available in hybrid tenants. Type: SwitchParameter Parameter Sets: EnableLitigationHoldForMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -1626,13 +1691,15 @@ Accept wildcard characters: False ``` ### -ExchangeGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1642,6 +1709,9 @@ Accept wildcard characters: False ``` ### -ExcludeFromAllOrgHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ExcludeFromAllOrgHolds switch specifies whether to exclude the soft-deleted mail user from all organization-wide Microsoft 365 retention policies. You don't need to specify a value with this switch. @@ -1656,7 +1726,6 @@ When you use this switch, use one of the following values to uniquely identify t Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1666,6 +1735,9 @@ Accept wildcard characters: False ``` ### -ExcludeFromOrgHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill ExcludeFromOrgHolds Description }} @@ -1674,7 +1746,6 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: ExcludeFromOrgHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1684,6 +1755,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -1696,7 +1770,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1706,6 +1779,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -1718,7 +1794,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1728,6 +1803,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -1740,7 +1818,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1750,6 +1827,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -1762,7 +1842,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1772,6 +1851,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -1784,7 +1866,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1794,6 +1875,9 @@ Accept wildcard characters: False ``` ### -ExternalEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. @@ -1804,7 +1888,6 @@ When you use the ExternalEmailAddress parameter to change the external email add Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1814,6 +1897,9 @@ Accept wildcard characters: False ``` ### -FederatedIdentity + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The FederatedIdentity parameter associates an on-premises Active Directory user with a user in the cloud. @@ -1822,7 +1908,6 @@ The FederatedIdentity parameter associates an on-premises Active Directory user Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1832,13 +1917,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1848,6 +1935,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mail user. Although messages sent on behalf of the mail user clearly show the sender in the From field (` on behalf of `, replies to these messages are delivered to the mail user, not the sender. The sender you specify for this parameter must a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the sender. For example: @@ -1873,7 +1963,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1883,6 +1972,9 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. @@ -1892,7 +1984,6 @@ The HiddenFromAddressListsEnabled parameter specifies whether this recipient is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1902,6 +1993,9 @@ Accept wildcard characters: False ``` ### -HVEAccount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The HVEAccount switch specifies that this mail user account is specifically used for the [High volume email service](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365). You don't need to specify a value with this switch. @@ -1910,7 +2004,6 @@ The HVEAccount switch specifies that this mail user account is specifically used Type: SwitchParameter Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Position: Named Default value: None @@ -1920,6 +2013,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -1933,7 +2029,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1943,6 +2038,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -1951,7 +2049,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1961,6 +2058,9 @@ Accept wildcard characters: False ``` ### -JournalArchiveAddress + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1969,7 +2069,6 @@ This parameter is reserved for internal Microsoft use. Type: SmtpAddress Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1979,6 +2078,9 @@ Accept wildcard characters: False ``` ### -LOBAppAccount + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1987,7 +2089,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1997,6 +2098,9 @@ Accept wildcard characters: False ``` ### -MacAttachmentFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: - BinHex (This is the default value) @@ -2013,7 +2117,6 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2023,6 +2126,9 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2031,7 +2137,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2041,6 +2146,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -2052,7 +2160,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2062,6 +2169,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -2076,7 +2186,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2086,6 +2195,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail user. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -2105,7 +2217,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2115,6 +2226,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail user. When you enter a value, qualify the value with one of the following units: @@ -2134,7 +2248,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2144,6 +2257,9 @@ Accept wildcard characters: False ``` ### -MessageBodyFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -2159,7 +2275,6 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2169,6 +2284,9 @@ Accept wildcard characters: False ``` ### -MessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are: - Text @@ -2185,7 +2303,6 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2195,6 +2312,9 @@ Accept wildcard characters: False ``` ### -MicrosoftOnlineServicesID + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments. @@ -2203,7 +2323,6 @@ The MicrosoftOnlineServicesID parameter specifies the user ID for the object. Th Type: SmtpAddress Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2213,6 +2332,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -2232,7 +2354,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2242,6 +2363,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -2253,7 +2377,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2263,13 +2386,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the mail user. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2279,6 +2404,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Password parameter allows users to change their own password. You can use the following methods as a value for this parameter: @@ -2293,7 +2421,6 @@ You can't use this parameter to change another user's password (the parameter is Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2303,6 +2430,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. @@ -2317,7 +2447,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2327,6 +2456,9 @@ Accept wildcard characters: False ``` ### -RecalculateInactiveMailUser + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RecalculateInactiveMailUser Description }} @@ -2335,7 +2467,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailUser Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2345,6 +2476,9 @@ Accept wildcard characters: False ``` ### -RecipientLimits + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The RecipientLimits parameter specifies the maximum number of recipients allowed in messages sent by the mail user. @@ -2357,7 +2491,6 @@ The value unlimited indicates the maximum number of recipients per message for t Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2367,6 +2500,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder for a mail user that has a corresponding remote mailbox or remote archive mailbox in the cloud-based service. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages. @@ -2389,7 +2525,6 @@ The RecoverableItemsQuota value must be greater than or equal to the Recoverable Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2399,6 +2534,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for a mail user that has a corresponding remote mailbox or remote archive mailbox in the cloud-based service. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log. @@ -2421,7 +2559,6 @@ The RecoverableItemsQuota value must be greater than or equal to the Recoverable Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2431,6 +2568,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -2454,7 +2594,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2464,6 +2603,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -2487,7 +2629,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2497,6 +2638,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -2522,7 +2666,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2532,6 +2675,9 @@ Accept wildcard characters: False ``` ### -RemoveComplianceTagHoldApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveComplianceTagHoldApplied Description }} @@ -2540,7 +2686,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveComplianceTagHoldApplied Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2550,6 +2695,9 @@ Accept wildcard characters: False ``` ### -RemoveDelayHoldApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveDelayHoldApplied Description }} @@ -2558,7 +2706,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveDelayHoldApplied Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2568,6 +2715,9 @@ Accept wildcard characters: False ``` ### -RemoveDelayReleaseHoldApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveDelayReleaseHoldApplied Description }} @@ -2576,7 +2726,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveDelayReleaseHoldApplied Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2586,6 +2735,9 @@ Accept wildcard characters: False ``` ### -RemoveDisabledArchive + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RemoveDisabledArchive switch specifies whether to remove the disabled archive that's associated with the mail user. You don't need to specify a value with this switch. @@ -2594,7 +2746,6 @@ The RemoveDisabledArchive switch specifies whether to remove the disabled archiv Type: SwitchParameter Parameter Sets: RemoveDisabledArchive Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2604,6 +2755,9 @@ Accept wildcard characters: False ``` ### -RemoveLitigationHoldEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RemoveLitigationHoldEnabled switch specifies whether to remove litigation hold from all mailbox locations of a mail user, including online archive, in an Exchange hybrid environment. You don't need to specify a value with this switch. @@ -2614,7 +2768,6 @@ This switch is useful in scenarios where admins can't permanently delete mail us Type: SwitchParameter Parameter Sets: RemoveLitigationHoldEnabled Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2624,6 +2777,9 @@ Accept wildcard characters: False ``` ### -RemoveMailboxProvisioningConstraint + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveMailboxProvisioningConstraint Description }} @@ -2632,7 +2788,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2642,6 +2797,9 @@ Accept wildcard characters: False ``` ### -RemoveOrphanedHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveOrphanedHolds Description }} @@ -2650,7 +2808,6 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2660,6 +2817,9 @@ Accept wildcard characters: False ``` ### -RemovePicture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemovePicture switch removes the picture from the mail user. You don't need to specify a value with this switch. @@ -2670,7 +2830,6 @@ You can add a picture to a mail user by using the Import-RecipientDataProperty c Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2680,6 +2839,9 @@ Accept wildcard characters: False ``` ### -RemoveSpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoveSpokenName switch removes the spoken name from the mail user. You don't need to specify a value with this switch. @@ -2690,7 +2852,6 @@ You can add a sound file to a mail user by using the Import-RecipientDataPropert Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2700,6 +2861,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -2709,7 +2873,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2719,6 +2882,9 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ResetPasswordOnNextLogon parameter allows users to require themselves to change their password the next time they log on. Valid values are: @@ -2732,7 +2898,6 @@ You can't use this parameter to require another user to change their password (t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2742,6 +2907,9 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. @@ -2750,7 +2918,6 @@ The SamAccountName parameter (also known as the pre-Windows 2000 user account or Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2760,6 +2927,9 @@ Accept wildcard characters: False ``` ### -SecondaryAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Online Protection + This parameter is available only in on-premises Exchange. The SecondaryAddress parameter specifies the secondary address used by the Unified Messaging (UM)-enabled user. @@ -2768,7 +2938,6 @@ The SecondaryAddress parameter specifies the secondary address used by the Unifi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Online Protection Required: False Position: Named @@ -2778,6 +2947,9 @@ Accept wildcard characters: False ``` ### -SecondaryDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. @@ -2786,7 +2958,6 @@ The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2796,6 +2967,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -2808,7 +2982,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2818,6 +2991,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -2830,7 +3006,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2840,6 +3015,9 @@ Accept wildcard characters: False ``` ### -SkipDualWrite + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in Exchange 2016 or later. This parameter is reserved for internal Microsoft use. @@ -2848,7 +3026,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2858,6 +3035,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -2878,7 +3058,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2888,6 +3067,9 @@ Accept wildcard characters: False ``` ### -UnblockForwardSyncPostCrossTenantMigration + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill UnblockForwardSyncPostCrossTenantMigration Description }} @@ -2896,7 +3078,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: UnblockForwardSyncPostCrossTenantMigration Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2906,6 +3087,9 @@ Accept wildcard characters: False ``` ### -UseMapiRichTextFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The UseMapiRichTextFormat parameter specifies what to do with messages that are sent to the mail user or mail contact in MAPI rich text format, also known as Outlook Rich Text or Transport Neutral Encapsulation Format (TNEF). Valid values are: - Always: TNEF is used for all messages sent to the mail user or mail contact. @@ -2918,7 +3102,6 @@ The default value is UseDefaultSettings. Type: UseMapiRichTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2928,6 +3111,9 @@ Accept wildcard characters: False ``` ### -UsePreferMessageFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are: - $true: Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact. @@ -2937,7 +3123,6 @@ The UsePreferMessageFormat specifies whether the message format settings configu Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2947,13 +3132,15 @@ Accept wildcard characters: False ``` ### -UserCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2963,6 +3150,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. @@ -2971,7 +3161,6 @@ The UserPrincipalName parameter specifies the logon name for the user account. T Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2981,13 +3170,15 @@ Accept wildcard characters: False ``` ### -UserSMimeCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2997,13 +3188,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3013,6 +3206,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -3024,7 +3220,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-Mailbox.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-Mailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Mailbox.md index f24e40f01c..725de59a98 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Mailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-Mailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailbox +schema: 2.0.0 +title: Set-Mailbox --- # Set-Mailbox @@ -1190,6 +1191,9 @@ In Exchange Online, this example removes the delay hold that's applied to Asraf' ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -1207,7 +1211,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -1217,6 +1220,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1240,7 +1246,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1250,6 +1255,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1273,7 +1281,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1283,6 +1290,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -1308,7 +1318,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1318,6 +1327,9 @@ Accept wildcard characters: False ``` ### -AccountDisabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The AccountDisabled parameter specifies whether to disable the account that's associated with the mailbox. Valid values are: @@ -1329,7 +1341,6 @@ The AccountDisabled parameter specifies whether to disable the account that's as Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1339,6 +1350,9 @@ Accept wildcard characters: False ``` ### -AddressBookPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AddressBookPolicy parameter specifies the address book policy that's applied to the mailbox. You can use any value that uniquely identifies the address book policy. For example: - Name @@ -1351,7 +1365,6 @@ For more information about address book policies, see [Address book policies in Type: AddressBookMailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1361,6 +1374,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -1385,7 +1401,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1395,6 +1410,9 @@ Accept wildcard characters: False ``` ### -AntispamBypassEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AntispamBypassEnabled parameter specifies whether to skip anti-spam processing on the mailbox. Valid values are: @@ -1406,7 +1424,6 @@ The AntispamBypassEnabled parameter specifies whether to skip anti-spam processi Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1416,6 +1433,9 @@ Accept wildcard characters: False ``` ### -ApplyMandatoryProperties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApplyMandatoryProperties switch specifies whether to update the msExchVersion attribute of the mailbox. You don't need to specify a value with this switch. You might need to use this switch to fix inaccessible mailboxes or mailboxes that were created in previous versions of Exchange. @@ -1424,7 +1444,6 @@ You might need to use this switch to fix inaccessible mailboxes or mailboxes tha Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1434,6 +1453,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Arbitration switch is required to modify arbitration mailboxes. You don't need to specify a value with this switch. @@ -1446,7 +1468,6 @@ To modify arbitration mailboxes that are used to store audit log settings or dat Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1456,6 +1477,9 @@ Accept wildcard characters: False ``` ### -ArbitrationMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox. For example: @@ -1475,7 +1499,6 @@ The ArbitrationMailbox parameter specifies the arbitration mailbox that's used t Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1485,6 +1508,9 @@ Accept wildcard characters: False ``` ### -ArchiveDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArchiveDatabase parameter specifies the Exchange database that contains the archive that's associated with this mailbox. You can use any value that uniquely identifies the database. For example: @@ -1497,7 +1523,6 @@ The ArchiveDatabase parameter specifies the Exchange database that contains the Type: DatabaseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1507,6 +1532,9 @@ Accept wildcard characters: False ``` ### -ArchiveDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArchiveDomain parameter specifies the domain in the cloud-based service where the archive that's associated with this mailbox exists. For example, if the SMTP email address of the user is tony@contoso.com, the SMTP domain could be archive.contoso.com. @@ -1517,7 +1545,6 @@ Only use this parameter if the archive is hosted in the cloud-based service. Type: SmtpDomain Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1527,6 +1554,9 @@ Accept wildcard characters: False ``` ### -ArchiveName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). In on-premises Exchange, the following default values are used based on the version of Exchange: @@ -1543,7 +1573,6 @@ In Outlook in Exchange Online, the value of this parameter is ignored. The name Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1553,6 +1582,9 @@ Accept wildcard characters: False ``` ### -ArchiveQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArchiveQuota parameter specifies the maximum size for the user's archive mailbox. If the archive mailbox reaches or exceeds this size, it no longer accepts messages. @@ -1573,7 +1605,6 @@ The ArchiveQuota value must be greater than or equal to the ArchiveWarningQuota Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1583,6 +1614,9 @@ Accept wildcard characters: False ``` ### -ArchiveStatus + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This cmdlet is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1591,7 +1625,6 @@ This parameter is reserved for internal Microsoft use. Type: ArchiveStatusFlags Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1601,6 +1634,9 @@ Accept wildcard characters: False ``` ### -ArchiveWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArchiveWarningQuota parameter specifies the warning threshold for the size of the user's archive mailbox. If the archive mailbox reaches or exceeds this size, the user receives a descriptive warning message. @@ -1621,7 +1657,6 @@ The ArchiveWarningQuota value must be less than or equal to the ArchiveQuota val Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1631,6 +1666,9 @@ Accept wildcard characters: False ``` ### -AttributesToClear + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1639,7 +1677,6 @@ This parameter is reserved for internal Microsoft use. Type: SetMailbox+ClearableADAttributes[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1649,6 +1686,9 @@ Accept wildcard characters: False ``` ### -AuditAdmin + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AuditAdmin parameter specifies the mailbox operations to log for administrators as part of mailbox audit logging. Valid values are: - None @@ -1682,7 +1722,6 @@ The AuditEnabled parameter must be set to $true to enable mailbox audit logging. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1692,6 +1731,9 @@ Accept wildcard characters: False ``` ### -AuditDelegate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AuditDelegate parameter specifies the mailbox operations to log for delegate users as part of mailbox audit logging. Valid values are: - None @@ -1722,7 +1764,6 @@ The AuditEnabled parameter must be set to $true to enable mailbox audit logging. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1732,6 +1773,9 @@ Accept wildcard characters: False ``` ### -AuditEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AuditEnabled parameter specifies whether to enable or disable mailbox audit logging for the mailbox. If auditing is enabled, actions specified in the AuditAdmin, AuditDelegate, and AuditOwner parameters are logged. Valid values are: - $true: Mailbox audit logging is enabled. @@ -1743,7 +1787,6 @@ The AuditEnabled parameter specifies whether to enable or disable mailbox audit Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1753,6 +1796,9 @@ Accept wildcard characters: False ``` ### -AuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuditLog switch is required to modify audit log mailboxes. You don't need to specify a value with this switch. @@ -1765,7 +1811,6 @@ To modify other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1775,6 +1820,9 @@ Accept wildcard characters: False ``` ### -AuditLogAgeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AuditLogAgeLimit parameter specifies the maximum age of audit log entries for the mailbox. Log entries older than the specified value are removed. The default value is 90 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1785,7 +1833,6 @@ For example, to specify 60 days for this parameter, use 60.00:00:00. Setting thi Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1795,6 +1842,9 @@ Accept wildcard characters: False ``` ### -AuditOwner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AuditOwner parameter specifies the mailbox operations to log for mailbox owners as part of mailbox audit logging. Valid values include: - None (This is the default value in Exchange 2010, Exchange 2013, and Exchange 2016.) @@ -1826,7 +1876,6 @@ The AuditEnabled parameter must be set to $true to enable mailbox audit logging. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1836,6 +1885,9 @@ Accept wildcard characters: False ``` ### -AuxAuditLog + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuxAuditLog switch is required to modify auxiliary audit log mailboxes. You don't need to specify a value with this switch. @@ -1848,7 +1900,6 @@ To modify other types of arbitration mailboxes, don't use this switch. Instead, Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1858,6 +1909,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -1879,7 +1933,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1889,6 +1942,9 @@ Accept wildcard characters: False ``` ### -CalendarLoggingQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CalendarLoggingQuota parameter specifies the maximum size of the log in the Recoverable Items folder of the mailbox that stores changes to calendar items. When the log exceeds this size, calendar logging is disabled until messaging records management (MRM) removes older calendar logs to free up more space. @@ -1913,7 +1969,6 @@ When the UseDatabaseQuotaDefaults parameter on the mailbox is set to the value $ Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1923,6 +1978,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairDisabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CalendarRepairDisabled parameter specifies whether to prevent calendar items in the mailbox from being repaired by the Calendar Repair Assistant. Valid values are: - $true: The Calendar Repair Assistant doesn't repair calendar items in the mailbox. @@ -1932,7 +1990,6 @@ The CalendarRepairDisabled parameter specifies whether to prevent calendar items Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1942,6 +1999,9 @@ Accept wildcard characters: False ``` ### -CalendarVersionStoreDisabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CalendarVersionStoreDisabled parameter specifies whether to prevent calendar changes in the mailbox from being logged. Valid values are: - $true: Changes to a calendar item aren't recorded. @@ -1951,7 +2011,6 @@ The CalendarVersionStoreDisabled parameter specifies whether to prevent calendar Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1961,6 +2020,9 @@ Accept wildcard characters: False ``` ### -ClearThrottlingPolicyAssignment + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ClearThrottlingPolicyAssignment switch specifies whether to clear any throttling policy assignments for the mailbox. You don't need to specify a value with this switch. @@ -1971,7 +2033,6 @@ Admins can contact Microsoft Support to assign a throttling policy to a mailbox, Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1981,6 +2042,9 @@ Accept wildcard characters: False ``` ### -ClientExtensions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ClientExtensions parameter specifies whether the organization-wide client extensions (also called Apps for Outlook) will be installed in the arbitration mailbox (also called the organization mailbox). Only one arbitration mailbox in the organization can be configured to store client extensions. You can use this parameter only on an arbitration mailbox. @@ -1991,7 +2055,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2001,6 +2064,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -2010,7 +2076,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2020,6 +2085,9 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: @@ -2031,7 +2099,6 @@ The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-fre Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2041,13 +2108,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2057,13 +2126,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2073,13 +2144,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2089,13 +2162,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2105,13 +2180,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2121,13 +2198,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2137,13 +2216,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2153,13 +2234,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2169,13 +2252,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2185,13 +2270,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2201,13 +2288,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2217,13 +2306,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2233,13 +2324,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2249,13 +2342,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2265,13 +2360,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2281,6 +2378,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Database parameter specifies the mailbox database that contains the mailbox. You can use any value that uniquely identifies the database. For example: @@ -2295,7 +2395,6 @@ Use the Get-MailboxDatabase cmdlet to see the available mailbox databases. Type: DatabaseIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2305,6 +2404,9 @@ Accept wildcard characters: False ``` ### -DataEncryptionPolicy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DataEncryptionPolicy parameter specifies the data encryption policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example: @@ -2319,7 +2421,6 @@ You can use the Get-DataEncryptionPolicy cmdlet to view the available policies. Type: DataEncryptionPolicyIdParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2329,6 +2430,9 @@ Accept wildcard characters: False ``` ### -DefaultAuditSet + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DefaultAuditSet parameter specifies whether to revert the mailbox operations that are logged in the mailbox audit log back to the set of default operations for the specified logon type. Valid values are: @@ -2343,7 +2447,6 @@ With on-by-default mailbox auditing in the cloud-based service, a set of mailbox Type: MultiValuedProperty Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2353,6 +2456,9 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultPublicFolderMailbox parameter assigns a specific public folder mailbox to the user. You can use any value that uniquely identifies the public folder mailbox. For example: - Name @@ -2368,7 +2474,6 @@ By default, the public folder mailbox used by a user is automatically selected b Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2378,6 +2483,9 @@ Accept wildcard characters: False ``` ### -DeliverToMailboxAndForward + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeliverToMailboxAndForward parameter specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress or ForwardingSmtpAddress parameters. Valid values are: - $true: Messages are delivered to this mailbox and forwarded to the specified recipient or email address. @@ -2389,7 +2497,6 @@ The default value is $false. The value of this parameter is meaningful only if y Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2399,6 +2506,9 @@ Accept wildcard characters: False ``` ### -DisableThrottling + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DisableThrottling parameter enables or disables sender rate throttling for the mailbox. Valid values are: @@ -2410,7 +2520,6 @@ The DisableThrottling parameter enables or disables sender rate throttling for t Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2420,13 +2529,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2436,6 +2547,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -2444,7 +2558,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2454,6 +2567,9 @@ Accept wildcard characters: False ``` ### -DowngradeHighPriorityMessagesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DowngradeHighPriorityMessagesEnabled parameter specifies whether to prevent the mailbox from sending high priority messages to an X.400 mail system. Valid values are: @@ -2465,7 +2581,6 @@ The DowngradeHighPriorityMessagesEnabled parameter specifies whether to prevent Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2475,6 +2590,9 @@ Accept wildcard characters: False ``` ### -DumpsterMessagesPerFolderCountReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DumpsterMessagesPerFolderCountReceiveQuota parameter specifies the maximum number of messages that can be contained in each folder in the Recoverable Items folder (called the dumpster in previous versions of Exchange). When a folder exceeds this limit, it can't store new messages. For example, if the Deletions folder in the Recoverable Items folder has exceeded the message count limit and the mailbox owner attempts to permanently delete items from their mailbox, the deletion will fail. @@ -2485,7 +2603,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2495,6 +2612,9 @@ Accept wildcard characters: False ``` ### -DumpsterMessagesPerFolderCountWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DumpsterMessagesPerFolderCountWarningQuota parameters specifies the number of messages that each folder in the Recoverable Items folder (called the dumpster in previous versions of Exchange) can hold before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day. @@ -2505,7 +2625,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2515,6 +2634,9 @@ Accept wildcard characters: False ``` ### -ElcProcessingDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ElcProcessingDisabled parameter specifies whether to prevent the Managed Folder Assistant from processing the mailbox. Valid values are: @@ -2526,7 +2648,6 @@ The ElcProcessingDisabled parameter specifies whether to prevent the Managed Fol Type: Boolean Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2536,6 +2657,9 @@ Accept wildcard characters: False ``` ### -EmailAddressDisplayNames + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill EmailAddressDisplayNames Description }} @@ -2544,7 +2668,6 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2554,6 +2677,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -2581,7 +2707,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2591,6 +2716,9 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: @@ -2602,7 +2730,6 @@ The EmailAddressPolicyEnabled parameter specifies whether to apply email address Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2612,6 +2739,9 @@ Accept wildcard characters: False ``` ### -EnableRoomMailboxAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: @@ -2627,7 +2757,6 @@ A room mailbox in Exchange Online is created with associated an account that has Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2637,6 +2766,9 @@ Accept wildcard characters: False ``` ### -EndDateForRetentionHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EndDateForRetentionHold parameter specifies the end date for retention hold for messaging records management (MRM). To use this parameter, you need to set the RetentionHoldEnabled parameter to the value $true. **Important**: Using this parameter does not change the _RetentionHoldEnabled_ value to $false after the specified date. The _RentionHoldEnabled_ will still be $true on the mailbox after the specified date, but MRM will start processing mailbox items as normal. @@ -2647,7 +2779,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2657,6 +2788,9 @@ Accept wildcard characters: False ``` ### -EnforcedTimestamps + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill EnforcedTimestamps Description }} @@ -2665,7 +2799,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2675,6 +2808,9 @@ Accept wildcard characters: False ``` ### -ExcludeFromAllOrgHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in Exchange Online. The ExcludeFromAllOrgHolds switch excludes the mailbox from all organization-wide Microsoft 365 retention policies. This switch can only be used for inactive mailboxes. You don't need to specify a value with this switch. @@ -2685,7 +2821,6 @@ When you use this switch, use the DistinguishedName or ExchangeGuid property val Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2695,6 +2830,9 @@ Accept wildcard characters: False ``` ### -ExcludeFromOrgHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in Exchange Online. The ExcludeFromOrgHolds parameter excludes the mailbox from one or more organization-wide Microsoft 365 retention policies. This parameter can only be used for inactive mailboxes. A valid value for this parameter is the GUID of the organization-wide Microsoft 365 retention policy that the inactive mailbox is excluded from. To find the GUID values of organization-wide Microsoft 365 retention policies, run the command Get-OrganizationConfig | Format-List InplaceHolds. Note that retention policies assigned to mailboxes are prefaced by 'mbx'. @@ -2707,7 +2845,6 @@ When you use this parameter, use the DistinguishedName or ExchangeGuid property Type: String[] Parameter Sets: ExcludeFromOrgHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2717,6 +2854,9 @@ Accept wildcard characters: False ``` ### -ExtendedPropertiesCountQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ExtendedPropertiesCountQuota property is used to configure the Named Properties and NonMAPI Named Properties quotas for a mailbox. This should typically only be done if you are experiencing QuotaExceededException or MapiExceptionNamedPropsQuotaExceeded errors. @@ -2725,7 +2865,6 @@ The ExtendedPropertiesCountQuota property is used to configure the Named Propert Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2735,6 +2874,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -2747,7 +2889,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2757,6 +2898,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -2769,7 +2913,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2779,6 +2922,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -2791,7 +2937,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2801,6 +2946,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -2813,7 +2961,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2823,6 +2970,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -2835,7 +2985,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2845,6 +2994,9 @@ Accept wildcard characters: False ``` ### -ExternalOofOptions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalOofOptions parameter specifies the automatic replies or Out of Office (also known OOF) message options that are available for the mailbox. Valid values are: - External: Automatic replies can be configured for external senders. This is the default value. @@ -2854,7 +3006,6 @@ The ExternalOofOptions parameter specifies the automatic replies or Out of Offic Type: ExternalOofOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2864,6 +3015,9 @@ Accept wildcard characters: False ``` ### -FolderHierarchyChildrenCountReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The FolderHierarchyChildrenCountReceiveQuota parameter specifies the maximum number of subfolders that can be created in a mailbox folder. The mailbox owner won't be able to create a new subfolder when this limit is reached. @@ -2874,7 +3028,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2884,6 +3037,9 @@ Accept wildcard characters: False ``` ### -FolderHierarchyChildrenCountWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The FolderHierarchyChildrenCountWarningQuota parameter specifies the number of subfolders that can be created in a mailbox folder before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day. @@ -2894,7 +3050,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2904,6 +3059,9 @@ Accept wildcard characters: False ``` ### -FolderHierarchyDepthReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The FolderHierarchyDepthReceiveQuota parameter specifies the maximum number of levels in the folder hierarchy of a mailbox folder. The mailbox owner won't be able to create another level in the folder hierarchy of the mailbox folder when this limit is reached. @@ -2914,7 +3072,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2924,6 +3081,9 @@ Accept wildcard characters: False ``` ### -FolderHierarchyDepthWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The FolderHierarchyDepthWarningQuota parameter specifies the number of levels in the folder hierarchy of a mailbox folder that can be created before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day. @@ -2934,7 +3094,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2944,6 +3103,9 @@ Accept wildcard characters: False ``` ### -FoldersCountReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The FoldersCountReceiveQuota parameter is used to specify a maximum number of folders within a mailbox, typically a public folder mailbox. If this value is configured and the limit is reached, no new folders will be able to be created. @@ -2954,7 +3116,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2964,6 +3125,9 @@ Accept wildcard characters: False ``` ### -FoldersCountWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The FoldersCountWarningQuota parameter is used to display a warning message that the folder hierarchy is full when the value specified for this parameter is reached. This parameter is typically used for public folder mailboxes. @@ -2974,7 +3138,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2984,6 +3147,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -2992,7 +3158,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3002,6 +3167,9 @@ Accept wildcard characters: False ``` ### -ForwardingAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForwardingAddress parameter specifies a forwarding address in your organization for messages that are sent to this mailbox. You can use any value that uniquely identifies the internal recipient. For example: - Name @@ -3024,7 +3192,6 @@ If you configure values for both the ForwardingAddress and ForwardingSmtpAddress Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3034,6 +3201,9 @@ Accept wildcard characters: False ``` ### -ForwardingSmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForwardingSmtpAddress parameter specifies a forwarding SMTP address for messages that are sent to this mailbox. Typically, you use this parameter to specify external email addresses that aren't validated. How messages are delivered and forwarded is controlled by the DeliverToMailboxAndForward parameter. @@ -3049,7 +3219,6 @@ If you configure values for both the ForwardingAddress and ForwardingSmtpAddress Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3059,6 +3228,9 @@ Accept wildcard characters: False ``` ### -GMGen + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The GMGen parameter specifies whether the arbitration mailbox (also called an organization mailbox) is used for group metrics generation for the organization. In MailTips, group metrics information is used to indicate the number of recipients in a message or whether recipients are outside your organization. You can use this parameter only on an arbitration mailbox. @@ -3069,7 +3241,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3079,6 +3250,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mailbox. Although messages send on behalf of the mailbox clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the mailbox, not the sender. The sender you specify for this parameter must a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the sender. For example: @@ -3104,7 +3278,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3114,6 +3287,9 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. @@ -3122,7 +3298,6 @@ The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't ne Type: MailboxIdParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3132,6 +3307,9 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. @@ -3141,7 +3319,6 @@ The HiddenFromAddressListsEnabled parameter specifies whether this recipient is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3151,6 +3328,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -3164,7 +3344,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3174,6 +3353,9 @@ Accept wildcard characters: False ``` ### -ImListMigrationCompleted + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ImListMigrationCompleted parameter specifies whether a user's Lync or Skype for Business contact list is stored in their mailbox. @@ -3191,7 +3373,6 @@ If you migrate an Exchange 2013 mailbox back to Exchange 2010 while the user's L Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3201,6 +3382,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -3209,7 +3393,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3219,6 +3402,9 @@ Accept wildcard characters: False ``` ### -InactiveMailbox + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The InactiveMailbox switch specifies that the mailbox is an inactive mailbox. You don't need to specify a value with this switch. @@ -3235,7 +3421,6 @@ You can't use this switch to modify other properties on inactive mailboxes. Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3245,6 +3430,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromServingHierarchy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsExcludedFromServingHierarchy parameter prevents users from accessing the public folder hierarchy on this public folder mailbox. For load-balancing purposes, users are equally distributed across public folder mailboxes by default. When this parameter is set on a public folder mailbox, that mailbox isn't included in this automatic load-balancing and 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. @@ -3253,7 +3441,6 @@ You should use this parameter only during public folder migrations. Don't use th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3263,6 +3450,9 @@ Accept wildcard characters: False ``` ### -IsHierarchyReady + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -3271,7 +3461,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3281,6 +3470,9 @@ Accept wildcard characters: False ``` ### -IsHierarchySyncEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -3289,7 +3481,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3299,6 +3490,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -3321,7 +3515,6 @@ In on-premises Exchange, the default value of this parameter is unlimited. When Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3331,6 +3524,9 @@ Accept wildcard characters: False ``` ### -JournalArchiveAddress + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -3339,7 +3535,6 @@ This parameter is reserved for internal Microsoft use. Type: SmtpAddress Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3349,6 +3544,9 @@ Accept wildcard characters: False ``` ### -Languages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -3361,7 +3559,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3371,6 +3568,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the credentials used to access the domain controller specified by the LinkedDomainController parameter. @@ -3381,7 +3581,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3391,6 +3590,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if the mailbox is a linked mailbox. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter. Use the fully qualified domain name (FQDN) of the domain controller that you want to use as the value for this parameter. @@ -3399,7 +3601,6 @@ The LinkedDomainController parameter specifies the domain controller in the fore Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3409,6 +3610,9 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: @@ -3422,7 +3626,6 @@ The LinkedMasterAccount parameter specifies the master account in the forest whe Type: UserIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3432,6 +3635,9 @@ Accept wildcard characters: False ``` ### -LitigationHoldDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LitigationHoldDate parameter specifies the date that the mailbox is placed on litigation hold. The parameter is populated automatically when you place a mailbox on litigation hold. The date you specify can be used for informational or reporting purposes. When you use the LitigationHoldEnabled parameter to place the mailbox on litigation hold, you can specify any date using the LitigationHoldDate parameter. However, the mailbox is actually placed on litigation hold when you run the command to place the mailbox on litigation hold. @@ -3440,7 +3646,6 @@ When you use the LitigationHoldEnabled parameter to place the mailbox on litigat Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3450,6 +3655,9 @@ Accept wildcard characters: False ``` ### -LitigationHoldDuration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The LitigationHoldDuration parameter specifies how long mailbox items are held if the mailbox is placed on litigation hold. The duration is calculated from the date a mailbox item is received or created. A valid value is an integer that represents the number of days, or the value unlimited. The default value is unlimited, which means items are held indefinitely or until the hold is removed. @@ -3458,7 +3666,6 @@ A valid value is an integer that represents the number of days, or the value unl Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3468,6 +3675,9 @@ Accept wildcard characters: False ``` ### -LitigationHoldEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The LitigationHoldEnabled parameter specifies whether to place the mailbox on litigation hold. Valid values are: - $true: The mailbox is on litigation hold. @@ -3481,7 +3691,6 @@ Placing public folder mailboxes on Litigation Hold isn't supported. To place pub Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3491,13 +3700,15 @@ Accept wildcard characters: False ``` ### -LitigationHoldOwner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The LitigationHoldOwner parameter specifies the user who placed the mailbox on litigation hold. If you don't use this parameter when you place the mailbox on litigation hold, the value is populated automatically. If you use this parameter when you place the mailbox on litigation hold, you can specify a text value. If the value contains spaces, include the value in quotation marks ("). You can use this value for informational and reporting purposes. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3507,6 +3718,9 @@ Accept wildcard characters: False ``` ### -MailboxMessagesPerFolderCountReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is an available only in on-premises Exchange. The MailboxMessagesPerFolderCountReceiveQuota parameter specifies the maximum number of messages for a mailbox folder. When this limit is reached, the folder can't receive new messages. @@ -3519,7 +3733,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3529,6 +3742,9 @@ Accept wildcard characters: False ``` ### -MailboxMessagesPerFolderCountWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is an available only in on-premises Exchange. The MailboxMessagesPerFolderCountWarningQuota parameter specifies the number of messages that a mailbox folder can hold before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day. @@ -3541,7 +3757,6 @@ To see the current value of this property, run the command `Get-MailboxStatistic Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3551,6 +3766,9 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxRegion parameter specifies the geo location for the mailbox in multi-geo environments. @@ -3563,7 +3781,6 @@ To see the list of configured geo locations in Microsoft 365 Multi-Geo, run the Type: String Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3573,6 +3790,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -3584,7 +3804,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3594,6 +3813,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -3608,7 +3830,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3618,6 +3839,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicy + +> Applicable: Exchange Server 2010 + This parameter is functional only in Exchange Server 2010. The ManagedFolderMailboxPolicy parameter specifies a managed folder mailbox policy that controls MRM for the mailbox. If the parameter is set to $null, Exchange removes the managed folder mailbox policy from the mailbox but any managed folders in the mailbox remain. @@ -3626,7 +3850,6 @@ The ManagedFolderMailboxPolicy parameter specifies a managed folder mailbox poli Type: MailboxPolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -3636,6 +3859,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicyAllowed + +> Applicable: Exchange Server 2010 + This parameter is functional only in Exchange Server 2010. The ManagedFolderMailboxPolicyAllowed switch bypasses the warning that MRM features aren't supported for clients running versions of Outlook earlier than Outlook 2007. You don't need to specify a value with this switch. @@ -3648,7 +3874,6 @@ Although Outlook 2003 Service Pack 3 clients are supported, they have limited MR Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -3658,6 +3883,9 @@ Accept wildcard characters: False ``` ### -Management + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Management parameter specifies whether the arbitration mailbox (also call an organization mailbox) is used to manage mailbox moves and mailbox migrations. You can use this parameter only on an arbitration mailbox. @@ -3668,7 +3896,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3678,6 +3905,9 @@ Accept wildcard characters: False ``` ### -MaxBlockedSenders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxBlockedSenders parameter specifies the maximum number of senders that can be included in the blocked senders list. Blocked senders are senders that are considered junk senders by the mailbox and are used in junk email rules. This parameter is validated only when the junk email rules are updated using Outlook on the web or Exchange Web Services. @@ -3686,7 +3916,6 @@ The MaxBlockedSenders parameter specifies the maximum number of senders that can Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3696,6 +3925,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -3721,7 +3953,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3731,6 +3962,9 @@ Accept wildcard characters: False ``` ### -MaxSafeSenders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxSafeSenders parameter specifies the maximum number of senders that can be included in the safe senders list. Safe senders are senders that are trusted by the mailbox and are used in junk email rules. This parameter is validated only when the junk email rules are updated using cloud-based organizations or services. @@ -3739,7 +3973,6 @@ The MaxSafeSenders parameter specifies the maximum number of senders that can be Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3749,6 +3982,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mailbox. When you enter a value, qualify the value with one of the following units: @@ -3774,7 +4010,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3784,6 +4019,9 @@ Accept wildcard characters: False ``` ### -MessageCopyForSendOnBehalfEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: Previously, this parameter was available only for shared mailboxes. In Exchange Online or Exchange 2016 CU6 or later, this parameter is also available for user mailboxes. This parameter is not available for linked user mailboxes. The MessageCopyForSendOnBehalfEnabled parameter specifies whether to copy the sender for messages that are sent from a mailbox by users that have the "send on behalf of" permission. Valid values are: @@ -3797,7 +4035,6 @@ You give users permission to send on behalf of a mailbox by using the GrantSendO Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3807,6 +4044,9 @@ Accept wildcard characters: False ``` ### -MessageCopyForSentAsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: Previously, this parameter was available only for shared mailboxes. In Exchange Online or Exchange 2016 CU6 or later, this parameter is also available for user mailboxes. This parameter is not available for linked user mailboxes. The MessageCopyForSentAsEnabled parameter specifies whether to copy the sender for messages that are sent from a mailbox by users that have the "send as" permission. Valid values are: @@ -3822,7 +4062,6 @@ In on-premises Exchange, you give a user permission to send as a mailbox by runn Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3832,6 +4071,9 @@ Accept wildcard characters: False ``` ### -MessageCopyForSMTPClientSubmissionEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MessageCopyForSMTPClientSubmissionEnabled parameter specifies whether to copy the sender for messages that are sent using SMTP client submission (SMTP AUTH). Valid values are: @@ -3843,7 +4085,6 @@ The MessageCopyForSMTPClientSubmissionEnabled parameter specifies whether to cop Type: Boolean Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3853,6 +4094,9 @@ Accept wildcard characters: False ``` ### -MessageTracking + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MessageTracking parameter specifies whether the arbitration mailbox (also called an organization mailbox) is the anchor mailbox that's used for cross-organizational message tracking scenarios. By default, the message tracking organizational capability is assigned to the arbitration mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}. You can use this parameter only on an arbitration mailbox. @@ -3863,7 +4107,6 @@ Valid values are$true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: FalseNamed Position: @@ -3873,6 +4116,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingReadStatusEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MessageTrackingReadStatusEnabled parameter specifies whether to include detailed information in delivery reports for messages sent to the mailbox. Valid values are: - $true: The read status of the message and the date-time that the message was delivered is shown in the delivery report for messages sent to this mailbox. This is the default value. @@ -3882,7 +4128,6 @@ The MessageTrackingReadStatusEnabled parameter specifies whether to include deta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3892,6 +4137,9 @@ Accept wildcard characters: False ``` ### -MicrosoftOnlineServicesID + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MicrosoftOnlineServicesID parameter specifies the Microsoft work or school account for the mailbox (for example, lila@contoso.onmicrosoft.com). @@ -3900,7 +4148,6 @@ The MicrosoftOnlineServicesID parameter specifies the Microsoft work or school a Type: SmtpAddress Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3910,6 +4157,9 @@ Accept wildcard characters: False ``` ### -Migration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Migration switch is required to modify migration mailboxes. You don't need to specify a value with this switch. @@ -3918,7 +4168,6 @@ The Migration switch is required to modify migration mailboxes. You don't need t Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3928,6 +4177,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -3947,7 +4199,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3957,6 +4208,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -3968,7 +4222,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3978,6 +4231,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). In the cloud-based service, many special characters aren't allowed in the Name value (for example, ö, ü, or ä). For more information, see [Error when you try to create a username that contains a special character in Microsoft 365](https://learn.microsoft.com/office/troubleshoot/office-suite-issues/username-contains-special-character). @@ -3986,7 +4242,6 @@ In the cloud-based service, many special characters aren't allowed in the Name v Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3996,6 +4251,9 @@ Accept wildcard characters: False ``` ### -NewPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The NewPassword parameter is used with the OldPassword parameter when a user changes their own password in Outlook on the web. By default, the NewPassword and OldPassword parameters are also available to members of the Help Desk and Organization Management role groups via the User Options role. However, administrators use the Password parameter to reset a user's password, because that parameter doesn't require the user's current password. @@ -4010,7 +4268,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4020,6 +4277,9 @@ Accept wildcard characters: False ``` ### -NonCompliantDevices + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill NonCompliantDevices Description }} @@ -4028,7 +4288,6 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4038,6 +4297,9 @@ Accept wildcard characters: False ``` ### -OABGen + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The OABGen parameter specifies whether the arbitration mailbox (also called an organization mailbox) is used for offline address book (OAB) file generation and storage for the organization. OAB requests are sent to the server where this arbitration mailbox is located. You can use this parameter only on an arbitration mailbox. @@ -4048,7 +4310,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4058,13 +4319,15 @@ Accept wildcard characters: False ``` ### -Office + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Office parameter specifies the user's physical office name or number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4074,6 +4337,9 @@ Accept wildcard characters: False ``` ### -OfflineAddressBook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The OfflineAddressBook parameter specifies the offline address book (OAB) that's associated with the mailbox. You can use any value that uniquely identifies the OAB. For example: @@ -4088,7 +4354,6 @@ Use the Get-OfflineAddressBook cmdlet to see the available offline address books Type: OfflineAddressBookIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4098,6 +4363,9 @@ Accept wildcard characters: False ``` ### -OldPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The OldPassword parameter is used with the NewPassword parameter when a user changes their own password in Outlook on the web. By default, the NewPassword and OldPassword parameters are also available to members of the Help Desk and Organization Management role groups via the User Options role. However, administrators typically use the Password parameter to reset a user's password, because that parameter doesn't require the user's current password. @@ -4112,7 +4380,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4122,6 +4389,9 @@ Accept wildcard characters: False ``` ### -OMEncryption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -4130,7 +4400,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4140,6 +4409,9 @@ Accept wildcard characters: False ``` ### -OMEncryptionStore + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. PARAMVALUE: Boolean @@ -4148,7 +4420,6 @@ PARAMVALUE: Boolean Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4158,6 +4429,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Password parameter resets the password of the user account that's associated with the mailbox to the value you specify. To use this parameter on a mailbox other than your own, consider the following options: - Exchange Online: You can't use this parameter to change another user's password. Use the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. @@ -4173,7 +4447,6 @@ You can use the following methods as a value for this parameter: Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4183,6 +4456,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. @@ -4195,7 +4471,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4205,6 +4480,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ProhibitSendQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send new messages, and the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -4227,7 +4505,6 @@ In on-premises Exchange, the default value of this parameter is unlimited. When Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4237,6 +4514,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -4259,7 +4539,6 @@ In on-premises Exchange, the default value of this parameter is unlimited. When Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4269,6 +4548,9 @@ Accept wildcard characters: False ``` ### -ProvisionedForOfficeGraph + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -4277,7 +4559,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -4287,6 +4568,9 @@ Accept wildcard characters: False ``` ### -PstProvider + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -4295,7 +4579,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4305,6 +4588,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublicFolder switch is required to modify public folder mailboxes. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -4313,7 +4599,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4323,6 +4608,9 @@ Accept wildcard characters: False ``` ### -QueryBaseDN + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -4331,7 +4619,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationalUnitIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4341,6 +4628,9 @@ Accept wildcard characters: False ``` ### -RecalculateInactiveMailbox + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecalculateInactiveMailbox switch specifies whether to recalculate the hold status of an inactive mailbox. You don't need to specify a value with this switch. @@ -4353,7 +4643,6 @@ You use this switch with the InactiveMailbox switch and the Identity parameter ( Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4363,6 +4652,9 @@ Accept wildcard characters: False ``` ### -RecipientLimits + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientLimits parameter specifies the maximum number of recipients allowed in messages sent by the mailbox. In on-premises Exchange, a valid value is an integer or the value unlimited. The default value is unlimited, which indicates the maximum number of recipients per message for the mailbox is controlled elsewhere (for example, organization, server, or connector limits). @@ -4373,7 +4665,6 @@ In the cloud-based service, a valid value is an integer from 1 to 1000. The defa Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4383,6 +4674,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder of the mailbox. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages. @@ -4407,7 +4701,6 @@ When the UseDatabaseQuotaDefaults parameter is set to the value $true (the defau Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4417,6 +4710,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for the mailbox. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log. @@ -4441,7 +4737,6 @@ When the UseDatabaseQuotaDefaults parameter is set to the value $true (the defau Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4451,6 +4746,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -4474,7 +4772,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4484,6 +4781,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -4507,7 +4807,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4517,6 +4816,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -4542,7 +4844,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4552,6 +4853,9 @@ Accept wildcard characters: False ``` ### -RemoteRecipientType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -4560,7 +4864,6 @@ This parameter is reserved for internal Microsoft use. Type: RemoteRecipientType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4570,6 +4873,9 @@ Accept wildcard characters: False ``` ### -RemoveDelayHoldApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RemoveDelayHoldApplied switch specifies whether to remove delay holds on email-related data (generated by Outlook or Outlook on the web) from the mailbox. You don't need to specify a value with this switch. @@ -4583,7 +4889,6 @@ For more information, see [Managing mailboxes on delay hold](https://learn.micro Type: SwitchParameter Parameter Sets: RemoveDelayHoldApplied Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4593,6 +4898,9 @@ Accept wildcard characters: False ``` ### -RemoveDelayReleaseHoldApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RemoveDelayReleaseHoldApplied switch specifies whether to remove delay holds on cloud data generated by non-Exchange apps (such as Teams, Forms, and Viva Engage) from the mailbox. Data generated by a non-Exchange cloud-based app is typically stored in a hidden folder in the mailbox. You don't need to specify a value with this switch. @@ -4607,7 +4915,6 @@ For more information, see [Managing mailboxes on delay hold](https://learn.micro Type: SwitchParameter Parameter Sets: RemoveDelayReleaseHoldApplied Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4617,6 +4924,9 @@ Accept wildcard characters: False ``` ### -RemoveDisabledArchive + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The RemoveDisabledArchive switch specifies whether to remove the disabled archive that's associated with the mailbox. You don't need to specify a value with this switch. @@ -4625,7 +4935,6 @@ The RemoveDisabledArchive switch specifies whether to remove the disabled archiv Type: SwitchParameter Parameter Sets: RemoveDisabledArchive Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -4635,6 +4944,9 @@ Accept wildcard characters: False ``` ### -RemoveMailboxProvisioningConstraint + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill RemoveMailboxProvisioningConstraint Description }} @@ -4643,7 +4955,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4653,6 +4964,9 @@ Accept wildcard characters: False ``` ### -RemoveManagedFolderAndPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoveManagedFolderAndPolicy switch specifies whether to remove all MRM policies and attributes from a mailbox. You don't need to specify a value with this switch. @@ -4661,7 +4975,6 @@ The RemoveManagedFolderAndPolicy switch specifies whether to remove all MRM poli Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4671,6 +4984,9 @@ Accept wildcard characters: False ``` ### -RemoveOrphanedHolds + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RemoveOrphanedHolds parameter is used to remove the mailbox (typically, an inactive mailbox) from In-Place Holds that no longer exist, but are still applied to the mailbox. You identify the In-Place Hold by using its GUID value. You can specify multiple GUID values separated by commas. @@ -4683,7 +4999,6 @@ In an Exchange hybrid deployment, In-Place Holds that are created in the on-prem Type: String[] Parameter Sets: RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4693,6 +5008,9 @@ Accept wildcard characters: False ``` ### -RemovePicture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemovePicture switch specifies whether to remove the picture from the mailbox. You don't need to specify a value with this switch. @@ -4703,7 +5021,6 @@ You can add a picture to a mailbox by using the Import-RecipientDataProperty cmd Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4713,6 +5030,9 @@ Accept wildcard characters: False ``` ### -RemoveSpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RemoveSpokenName parameter specifies whether to remove the spoken name from the mailbox. You don't need to specify a value with this switch. @@ -4723,7 +5043,6 @@ You can add a sound file to a mailbox by using the Import-RecipientDataProperty Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4733,6 +5052,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -4742,7 +5064,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4752,6 +5073,9 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ResetPasswordOnNextLogon parameter specifies whether the user is required to change their password the next time they log on to their mailbox. Valid values are: @@ -4765,7 +5089,6 @@ In Exchange Online, administrators can require users to reset their password the Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4775,13 +5098,15 @@ Accept wildcard characters: False ``` ### -ResourceCapacity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResourceCapacity parameter specifies the capacity of the resource mailbox. For example, you can use this parameter to identify the number of seats in a conference room (room mailbox) or in a vehicle (equipment mailbox). A valid value is an integer. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4791,6 +5116,9 @@ Accept wildcard characters: False ``` ### -ResourceCustom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResourceCustom parameter specifies one or more custom resource properties to add to the resource mailbox. You can use this parameter only on resource mailboxes. You use the Set-ResourceConfig and Get-ResourceConfig cmdlets to create and view custom resource properties. @@ -4805,7 +5133,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4815,6 +5142,9 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsFor + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetainDeletedItemsFor parameter specifies the length of time to keep soft-deleted items for the mailbox. Soft-deleted items are items that have been deleted by using any of these methods: - Deleting items from the Deleted Items folder. @@ -4837,7 +5167,6 @@ In on-premises Exchange, when the UseDatabaseQuotaDefaults parameter on the mail Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4847,6 +5176,9 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsUntilBackup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RetainDeletedItemsUntilBackup parameter specifies whether to keep items in the Recoverable Items\\Deletions folder of the mailbox until the next database backup occurs. Valid values are: @@ -4862,7 +5194,6 @@ For more information, see [Recoverable Items folder in Exchange Server](https:// Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -4872,6 +5203,9 @@ Accept wildcard characters: False ``` ### -RetentionComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RetentionComment parameter specifies a comment that's displayed in Outlook regarding the user's retention hold status. In on-premises Exchange, you can only use this parameter if the RetentionHoldEnabled parameter is set to $true. @@ -4884,7 +5218,6 @@ This comment should be localized to the user's preferred language. If the commen Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4894,6 +5227,9 @@ Accept wildcard characters: False ``` ### -RetentionHoldEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionHoldEnabled parameter specifies whether the mailbox is placed on retention hold. Placing the mailbox on retention hold temporarily suspends the processing of retention policies or managed folder mailbox policies for the mailbox (for example, when the user is on vacation). Valid values are: - $true: The mailbox is placed on retention hold. Retention policies and managed folder policies are suspended for the mailbox, and purging items from the mailbox isn't possible (even using MFCMapi). @@ -4905,7 +5241,6 @@ To set the start date for retention hold, use the StartDateForRetentionHold para Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4915,6 +5250,9 @@ Accept wildcard characters: False ``` ### -RetentionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionPolicy parameter specifies the retention policy that you want applied to this mailbox. You can use any value that uniquely identifies the policy. For example: - Name @@ -4929,7 +5267,6 @@ Use the Get-RetentionPolicy cmdlet to see the available retention policies. Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4939,6 +5276,9 @@ Accept wildcard characters: False ``` ### -RetentionUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RetentionUrl parameter specifies the URL or an external web page with additional details about the organization's messaging retention policies. This URL can be used to expose details regarding retention policies in general, which is usually a customized legal or IT website for the company. @@ -4947,7 +5287,6 @@ This URL can be used to expose details regarding retention policies in general, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4957,6 +5296,9 @@ Accept wildcard characters: False ``` ### -RoleAssignmentPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RoleAssignmentPolicy parameter specifies the role assignment policy that's assigned to the mailbox. You can use any value that uniquely identifies the role assignment policy. For example: - Name @@ -4971,7 +5313,6 @@ Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment pol Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -4981,6 +5322,9 @@ Accept wildcard characters: False ``` ### -RoomMailboxPassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. Use the RoomMailboxPassword parameter to configure the password for the account that's associated with the room mailbox when that account is enabled and able to log in (the EnableRoomMailboxAccount parameter is set to the value $true). @@ -5005,7 +5349,6 @@ To configure the password for a room mailbox account in Exchange Online, use the Type: SecureString Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5015,6 +5358,9 @@ Accept wildcard characters: False ``` ### -RulesQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RulesQuota parameter specifies the limit for the size of Inbox rules for the mailbox. When you enter a value, qualify the value with one of the following: A valid value is a number from 32 to 256 kilobytes (32768 to 262144 bytes). When you enter a value, qualify the value with one of the following units: @@ -5034,7 +5380,6 @@ The quota for Inbox rules applies only to enabled rules. There is no restriction Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5044,6 +5389,9 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. @@ -5052,7 +5400,6 @@ The SamAccountName parameter (also known as the pre-Windows 2000 user account or Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5062,6 +5409,9 @@ Accept wildcard characters: False ``` ### -SchedulerAssistant + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SchedulerAssistant Description }} @@ -5070,7 +5420,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -5080,6 +5429,9 @@ Accept wildcard characters: False ``` ### -SCLDeleteEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SCLDeleteEnabled parameter specifies whether to silently delete messages that meet or exceed the spam confidence level (SCL) specified by the SCLDeleteThreshold parameter. Valid values are: @@ -5092,7 +5444,6 @@ The SCLDeleteEnabled parameter specifies whether to silently delete messages tha Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5102,6 +5453,9 @@ Accept wildcard characters: False ``` ### -SCLDeleteThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SCLDeleteThreshold parameter specifies the SCL delete threshold. When the SCLDeleteEnabled parameter is set to $true, messages with an SCL greater than or equal to the specified value are silently deleted. @@ -5112,7 +5466,6 @@ A valid value is an integer from 0 through 9. This value should be greater than Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5122,6 +5475,9 @@ Accept wildcard characters: False ``` ### -SCLJunkEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SCLJunkEnabled parameter specifies whether messages that exceed(not meet) the SCL specified by the SCLJunkThreshold parameter are moved to the Junk Email folder. Valid values are: @@ -5134,7 +5490,6 @@ The SCLJunkEnabled parameter specifies whether messages that exceed(not meet) th Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5144,6 +5499,9 @@ Accept wildcard characters: False ``` ### -SCLJunkThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SCLJunkThreshold parameter specifies the SCL Junk Email folder threshold. When the SCLJunkEnabled parameter is set to $true, messages with an SCL greater than (not equal to) the specified value are moved to the Junk Email folder. @@ -5154,7 +5512,6 @@ A valid value is an integer from 0 through 9. This value should be less than the Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5164,6 +5521,9 @@ Accept wildcard characters: False ``` ### -SCLQuarantineEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SCLQuarantineEnabled parameter specifies whether messages that meet or exceed the SCL specified by the SCLQuarantineThreshold parameter are quarantined. If a message is quarantined, it's sent to the quarantine mailbox where administrators can review it. Valid values are: @@ -5178,7 +5538,6 @@ To configure the quarantine mailbox, see [Configure a spam quarantine mailbox](h Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5188,6 +5547,9 @@ Accept wildcard characters: False ``` ### -SCLQuarantineThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SCLQuarantineThreshold parameter specifies the SCL quarantine threshold. When the SCLQuarantineEnabled parameter is set to $true, messages with an SCL greater than or equal to the specified value are quarantined. @@ -5198,7 +5560,6 @@ A valid value is an integer from 0 through 9. This value should be less than the Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5208,6 +5569,9 @@ Accept wildcard characters: False ``` ### -SCLRejectEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SCLRejectEnabled parameter specifies whether messages that meet or exceed the SCL specified by the SCLRejectThreshold parameter are rejected. Valid values are: @@ -5220,7 +5584,6 @@ The SCLRejectEnabled parameter specifies whether messages that meet or exceed th Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5230,6 +5593,9 @@ Accept wildcard characters: False ``` ### -SCLRejectThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SCLRejectThreshold parameter specifies the SCL reject threshold. When the SCLRejectEnabled parameter is set to $true, messages with an SCL greater than or equal to the specified value are rejected, and an NDR is sent to the sender. @@ -5240,7 +5606,6 @@ A valid value is an integer from 0 through 9. This value should be less than the Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5250,6 +5615,9 @@ Accept wildcard characters: False ``` ### -SecondaryAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. @@ -5258,7 +5626,6 @@ The SecondaryAddress parameter specifies the secondary address used by the UM-en Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5268,6 +5635,9 @@ Accept wildcard characters: False ``` ### -SecondaryDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. @@ -5276,7 +5646,6 @@ The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5286,6 +5655,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: - Always: Notify all senders when their messages aren't approved. This is the default value. @@ -5298,7 +5670,6 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5308,6 +5679,9 @@ Accept wildcard characters: False ``` ### -SharingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SharingPolicy parameter specifies the sharing policy that's assigned to the mailbox. You can use any value that uniquely identifies the sharing policy. For example: - Name @@ -5320,7 +5694,6 @@ Use the Get-SharingPolicy cmdlet to see the available sharing policies. Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5330,6 +5703,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -5342,7 +5718,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5352,6 +5727,9 @@ Accept wildcard characters: False ``` ### -SingleItemRecoveryEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SingleItemRecoveryEnabled parameter specifies whether to prevent the Recoverable Items folder from being purged. Valid values are: - $true: Single item recovery is enabled. The Recoverable Items folder can't be purged, and deleted or edited items can't be removed. This is the default value in Exchange Online. For more information, see [Enable or disable single item recovery for a mailbox in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-single-item-recovery). @@ -5361,7 +5739,6 @@ The SingleItemRecoveryEnabled parameter specifies whether to prevent the Recover Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5371,6 +5748,9 @@ Accept wildcard characters: False ``` ### -SkipDualWrite + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange This parameter is reserved for internal Microsoft use. @@ -5379,7 +5759,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5389,6 +5768,9 @@ Accept wildcard characters: False ``` ### -StartDateForRetentionHold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartDateForRetentionHold parameter specifies the start date for the retention hold that's placed on the mailbox. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -5399,7 +5781,6 @@ To use this parameter, you need to set the RetentionHoldEnabled parameter to val Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5409,13 +5790,15 @@ Accept wildcard characters: False ``` ### -StsRefreshTokensValidFrom + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5425,6 +5808,9 @@ Accept wildcard characters: False ``` ### -SystemMessageSizeShutoffQuota + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -5433,7 +5819,6 @@ This parameter is reserved for internal Microsoft use. Type: Int64 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5443,6 +5828,9 @@ Accept wildcard characters: False ``` ### -SystemMessageSizeWarningQuota + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -5451,7 +5839,6 @@ This parameter is reserved for internal Microsoft use. Type: Int64 Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5461,6 +5848,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ThrottlingPolicy parameter specifies the throttling policy that's assigned to the mailbox. You can use any value that uniquely identifies the throttling policy. For example: @@ -5475,7 +5865,6 @@ Use the Get-ThrottlingPolicy cmdlet to see the available throttling policies. Type: ThrottlingPolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5485,6 +5874,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Type parameter specifies the mailbox type for the mailbox. Valid values are: - Equipment @@ -5498,7 +5890,6 @@ The Type parameter specifies the mailbox type for the mailbox. Valid values are: Type: ConvertibleMailboxSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5508,6 +5899,9 @@ Accept wildcard characters: False ``` ### -UMDataStorage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMDataStorage parameter specifies whether the arbitration mailbox (also called an organization mailbox) is used to store UM call data records and UM custom prompts. This capability can be assigned to only one arbitration mailbox for the organization. You can use this parameter only on an arbitration mailbox. @@ -5518,7 +5912,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5528,6 +5921,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -5548,7 +5944,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5558,6 +5953,9 @@ Accept wildcard characters: False ``` ### -UMGrammar + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMGrammar parameter specifies whether the arbitration mailbox (also called an organization mailbox) is used for UM directory speech grammar generation for the organization. UM directory speech grammars will be generated and used on the Mailbox server of this arbitration mailbox. UM directory speech grammars are used in speech-enabled directory search features, such as UM auto attendants. You can use this parameter only on an arbitration mailbox. @@ -5568,7 +5966,6 @@ Valid values are $true or $false. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5578,6 +5975,9 @@ Accept wildcard characters: False ``` ### -UpdateEnforcedTimestamp + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill UpdateEnforcedTimestamp Description }} @@ -5586,7 +5986,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5596,6 +5995,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseQuotaDefaults + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UseDatabaseQuotaDefaults parameter specifies whether applicable quotas for the mailbox are determined by the quota values on the mailbox or the corresponding quota values on the mailbox database (not all mailbox quotas are configurable on the mailbox database). Valid values are: - $true: The mailbox uses the applicable quota values that are configured on the mailbox database. Any corresponding quotas that are configured on the mailbox are ignored. In on-premises Exchange, this is the default value. @@ -5614,7 +6016,6 @@ The following quotas are affected by this parameter: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5624,6 +6025,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseRetentionDefaults + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The UseDatabaseRetentionDefaults parameter specifies whether the retention settings for items in the Recoverable Items folder in the mailbox are determined by the settings on the mailbox or the corresponding settings on the mailbox database. Valid values are: @@ -5645,7 +6049,6 @@ The following retention settings are affected by this parameter: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5655,13 +6058,15 @@ Accept wildcard characters: False ``` ### -UserCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5671,6 +6076,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. @@ -5679,7 +6087,6 @@ The UserPrincipalName parameter specifies the logon name for the user account. T Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5689,13 +6096,15 @@ Accept wildcard characters: False ``` ### -UserSMimeCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -5705,13 +6114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5721,6 +6132,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -5732,7 +6146,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxAuditBypassAssociation.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxAuditBypassAssociation.md index bf087d92fa..2ea3be04e4 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxAuditBypassAssociation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxAuditBypassAssociation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxauditbypassassociation +schema: 2.0.0 +title: Set-MailboxAuditBypassAssociation --- # Set-MailboxAuditBypassAssociation @@ -54,13 +55,15 @@ This example removes the bypass association for the Svc-MyApplication account. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies a user or computer account to be bypassed from mailbox audit logging. ```yaml Type: MailboxAuditBypassAssociationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -AuditBypassEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AuditBypassEnabled parameter specifies whether audit bypass is enabled for the user or computer. Valid values include the following: - $true: Enables mailbox audit logging bypass @@ -79,7 +85,6 @@ The AuditBypassEnabled parameter specifies whether audit bypass is enabled for t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxAutoReplyConfiguration.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxAutoReplyConfiguration.md index 24d0f4377e..5ca39110ff 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxAutoReplyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxautoreplyconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxAutoReplyConfiguration -schema: 2.0.0 -search.appverid: MET150 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxautoreplyconfiguration +schema: 2.0.0 +search.appverid: MET150 +title: Set-MailboxAutoReplyConfiguration --- # Set-MailboxAutoReplyConfiguration @@ -67,6 +68,9 @@ This example configures Automatic Replies for Tony's mailbox to be sent, specifi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -84,7 +88,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AutoDeclineFutureRequestsWhenOOF + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The AutoDeclineFutureRequestsWhenOOF parameter specifies whether to automatically decline new meeting requests that are sent to the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: @@ -107,7 +113,6 @@ You can use this parameter only when the AutoReplyState parameter is set to Sche Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -AutoReplyState + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AutoReplyState parameter specifies whether the mailbox is enabled for Automatic Replies. Valid values are: - Enabled: Automatic Replies are sent for the mailbox. @@ -132,7 +140,6 @@ The Enabled and Scheduled values require these additional settings: Type: OofState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -151,7 +161,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -161,6 +170,9 @@ Accept wildcard characters: False ``` ### -CreateOOFEvent + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The CreateOOFEvent parameter specifies whether to create a calendar event that corresponds to the scheduled time period when Automatic Replies are being sent for the mailbox. Valid values are: @@ -172,7 +184,6 @@ The CreateOOFEvent parameter specifies whether to create a calendar event that c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -DeclineAllEventsForScheduledOOF + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The DeclineAllEventsForScheduledOOF parameter specifies whether to decline all existing calendar events in the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: @@ -197,7 +211,6 @@ You can't use this parameter with the EventsToDeleteIDs parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -207,6 +220,9 @@ Accept wildcard characters: False ``` ### -DeclineEventsForScheduledOOF + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The DeclineEventsForScheduledOOF parameter specifies whether it's possible to decline existing calendar events in the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: @@ -223,7 +239,6 @@ You can use this parameter only when the AutoReplyState parameter is set to Sche Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -233,6 +248,9 @@ Accept wildcard characters: False ``` ### -DeclineMeetingMessage + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The DeclineMeetingMessage parameter specifies the text in the message when meetings requests that are sent to the mailbox are automatically declined. For example: @@ -248,7 +266,6 @@ To clear the value of this parameter, use the value $null. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -258,6 +275,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -266,7 +286,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,6 +295,9 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EndTime parameter specifies the end date and time that Automatic Replies are sent for the mailbox. You use this parameter only when the AutoReplyState parameter is set to Scheduled, and the value of this parameter is meaningful only when AutoReplyState is Scheduled. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -284,7 +306,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -294,6 +315,9 @@ Accept wildcard characters: False ``` ### -EventsToDeleteIDs + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The EventsToDeleteIDs parameter specifies the calendar events to delete from the mailbox when the DeclineEventsForScheduledOOF parameter is set to $true. @@ -306,7 +330,6 @@ You can't use this parameter with the DeclineAllEventsForScheduledOOF parameter. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -316,6 +339,9 @@ Accept wildcard characters: False ``` ### -ExternalAudience + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalAudience parameter specifies whether Automatic Replies are sent to external senders. Valid values are: - None: Automatic Replies aren't sent to any external senders. @@ -328,7 +354,6 @@ The value of this parameter is meaningful only when the AutoReplyState parameter Type: ExternalAudience Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -338,6 +363,9 @@ Accept wildcard characters: False ``` ### -ExternalMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalMessage parameter specifies the Automatic Replies message that's sent to external senders or senders outside the organization. If the value contains spaces, enclose the value in quotation marks ("). HTML tags are automatically added to the text. For example, if you enter the text, "I'm on vacation", the value automatically becomes: `I'm on vacation`. Additional HTML tags are supported if you enclose the value in quotation marks. For example, `"I'm on vacation. I'll respond when I return."`. @@ -353,7 +381,6 @@ To clear the value of this parameter when it's no longer required (for example, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -363,6 +390,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -374,7 +404,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -384,6 +413,9 @@ Accept wildcard characters: False ``` ### -InternalMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InternalMessage parameter specifies the Automatic Replies message that's sent to internal senders or senders within the organization. If the value contains spaces, enclose the value in quotation marks ("). HTML tags are automatically added to the text. For example, if you enter the text: "I'm on vacation", the value automatically becomes: `I'm on vacation`. Additional HTML tags are supported if you enclose the value in quotation marks. For example, `"I'm on vacation. Please contact my manager."`. @@ -396,7 +428,6 @@ To clear the value of this parameter when it's no longer required (for example, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -406,6 +437,9 @@ Accept wildcard characters: False ``` ### -OOFEventSubject + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The OOFEventSubject parameter specifies the subject for the calendar event that's automatically created when the CreateOOFEvent parameter is set to $true. @@ -416,7 +450,6 @@ If the value contains spaces, enclose the value in quotation marks ("). To clear Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -426,6 +459,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartTime parameter specifies the start date and time that Automatic Replies are sent for the specified mailbox. You use this parameter only when the AutoReplyState parameter is set to Scheduled, and the value of this parameter is meaningful only when AutoReplyState is Scheduled. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -434,7 +470,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -444,13 +479,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarConfiguration.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarConfiguration.md index 78d43a57d3..72fd48a291 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxcalendarconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxCalendarConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxcalendarconfiguration +schema: 2.0.0 +title: Set-MailboxCalendarConfiguration --- # Set-MailboxCalendarConfiguration @@ -185,6 +186,9 @@ This example sets the working day's starting hour to 7 A.M. for the calendar of ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -202,7 +206,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -212,13 +215,15 @@ Accept wildcard characters: False ``` ### -AgendaMailEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -228,6 +233,9 @@ Accept wildcard characters: False ``` ### -AgendaMailIntroductionEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AgendaMailIntroductionEnabled Description }} @@ -236,7 +244,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -246,6 +253,9 @@ Accept wildcard characters: False ``` ### -AgendaPaneEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -254,7 +264,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -264,6 +273,9 @@ Accept wildcard characters: False ``` ### -AutoDeclineWhenBusy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AutoDeclineWhenBusy Description }} @@ -272,7 +284,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -282,6 +293,9 @@ Accept wildcard characters: False ``` ### -CalendarFeedsPreferredLanguage + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The CalendarFeedsPreferredLanguage parameter specifies the preferred language for calendar feeds. A valid value is an ISO 639-1 lowercase two-letter language code (for example, en for English). @@ -290,7 +304,6 @@ The CalendarFeedsPreferredLanguage parameter specifies the preferred language fo Type: String Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -300,6 +313,9 @@ Accept wildcard characters: False ``` ### -CalendarFeedsPreferredRegion + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The CalendarFeedsPreferredRegion specifies the preferred region for calendar feeds. A valid value is an ISO 3166-1 two-letter country code (for example, AU for Australia). @@ -310,7 +326,6 @@ A reference for two-letter country codes is available at [Country Codes List](ht Type: String Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -320,6 +335,9 @@ Accept wildcard characters: False ``` ### -CalendarFeedsRootPageId + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The CalendarFeedsRootPageId parameter specifies the root page ID for calendar feeds. @@ -328,7 +346,6 @@ The CalendarFeedsRootPageId parameter specifies the root page ID for calendar fe Type: String Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -338,6 +355,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -347,7 +367,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -357,6 +376,9 @@ Accept wildcard characters: False ``` ### -ConversationalSchedulingEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConversationalSchedulingEnabled parameter specifies whether to enable or disable conversational scheduling. Valid values are: - $true: Conversational scheduling is enabled. This is the default value. @@ -366,7 +388,6 @@ The ConversationalSchedulingEnabled parameter specifies whether to enable or dis Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -376,6 +397,9 @@ Accept wildcard characters: False ``` ### -CreateEventsFromEmailAsPrivate + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The CreateEventsFromEmailAsPrivate parameter specifies whether to create events from email messages as Normal or Private. Valid values are: @@ -387,7 +411,6 @@ The CreateEventsFromEmailAsPrivate parameter specifies whether to create events Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -397,13 +420,15 @@ Accept wildcard characters: False ``` ### -DailyAgendaMailSchedule + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: AgendaMailSchedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -413,13 +438,15 @@ Accept wildcard characters: False ``` ### -DefaultMeetingDuration + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -429,6 +456,9 @@ Accept wildcard characters: False ``` ### -DefaultMinutesToReduceLongEventsBy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DefaultMinutesToReduceLongEventsBy Description }} @@ -437,7 +467,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -447,6 +476,9 @@ Accept wildcard characters: False ``` ### -DefaultMinutesToReduceShortEventsBy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DefaultMinutesToReduceShortEventsBy Description }} @@ -455,7 +487,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -465,6 +496,9 @@ Accept wildcard characters: False ``` ### -DefaultOnlineMeetingProvider + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DefaultOnlineMeetingProvider parameter specifies the default provider for online meetings. Valid values are: @@ -490,7 +524,6 @@ The DefaultOnlineMeetingProvider parameter specifies the default provider for on Type: OnlineMeetingProviderType Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -500,6 +533,9 @@ Accept wildcard characters: False ``` ### -DefaultReminderTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultReminderTime parameter specifies the length of time before a meeting or appointment when the reminder is first displayed. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -529,7 +565,6 @@ This parameter is ignored when the RemindersEnabled parameter is set to $false. Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -539,6 +574,9 @@ Accept wildcard characters: False ``` ### -DeleteMeetingRequestOnRespond + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DeleteMeetingRequestOnRespond Description }} @@ -547,7 +585,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -557,6 +594,9 @@ Accept wildcard characters: False ``` ### -DiningEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DiningEventsFromEmailEnabled parameter specifies whether to create dining reservation events from email messages. Valid values are: @@ -570,7 +610,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -580,6 +619,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -588,7 +630,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -598,6 +639,9 @@ Accept wildcard characters: False ``` ### -EntertainmentEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EntertainmentEventsFromEmailEnabled parameter specifies whether to create entertainment reservation events from email messages. Valid values are: @@ -611,7 +655,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -621,6 +664,9 @@ Accept wildcard characters: False ``` ### -EventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EventsFromEmailEnabled parameter specifies whether to enable events to be created from email messages. Valid values are: @@ -641,7 +687,6 @@ When this setting is enabled, you can enable or disable creating specific types Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -651,6 +696,9 @@ Accept wildcard characters: False ``` ### -FirstWeekOfYear + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FirstWeekOfYear parameter specifies the first week of the year. Valid values are: - FirstDay: Week numbers start on the first day of the year. This is the default value. @@ -664,7 +712,6 @@ You configure the first day of the week by using the WeekStartDay parameter. Type: FirstWeekRules Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -674,6 +721,9 @@ Accept wildcard characters: False ``` ### -FlightEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FlightEventsFromEmailEnabled parameter specifies whether to create flight reservation events from email messages. Valid values are: @@ -687,7 +737,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -697,6 +746,9 @@ Accept wildcard characters: False ``` ### -HotelEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The HotelEventsFromEmailEnabled parameter specifies whether to create hotel reservation events from email messages. Valid values are: @@ -710,7 +762,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -720,6 +771,9 @@ Accept wildcard characters: False ``` ### -InvoiceEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The InvoiceEventsFromEmailEnabled parameter specifies whether to allow creating invoices from email messages. Valid values are: @@ -731,7 +785,6 @@ The InvoiceEventsFromEmailEnabled parameter specifies whether to allow creating Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -741,6 +794,9 @@ Accept wildcard characters: False ``` ### -LocationDetailsInFreeBusy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The LocationDetailsInFreeBusy parameter specifies the level of work location information that's returned as part of a user's availability. Work location information is visible across several Microsoft 365 application experiences, and the level of location information that's shown to other users in the organization is controlled by this parameter. Valid values are: @@ -753,7 +809,6 @@ The LocationDetailsInFreeBusy parameter specifies the level of work location inf Type: LocationDetailsPermissionInFreeBusy Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -763,6 +818,9 @@ Accept wildcard characters: False ``` ### -MailboxLocation + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill MailboxLocation Description }} @@ -771,7 +829,6 @@ This parameter is available only in the cloud-based service. Type: MailboxLocationIdParameter Parameter Sets: MailboxLocation Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -781,6 +838,9 @@ Accept wildcard characters: False ``` ### -OnlineMeetingsByDefaultEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetings as Teams or Skype for Business by default during meeting creation. Currently, this parameter sets the default value, so if the user has already directly interacted with this setting from an Outlook client, this default value will be ignored. Eventually, this parameter will override the Outlook-configured setting. @@ -797,7 +857,6 @@ Setting this parameter enables the display of the **Add online meeting to all me Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -807,6 +866,9 @@ Accept wildcard characters: False ``` ### -PackageDeliveryEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PackageDeliveryEventsFromEmailEnabled parameter specifies whether to create package delivery events from email messages. Valid values are: @@ -820,7 +882,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -830,6 +891,9 @@ Accept wildcard characters: False ``` ### -PreserveDeclinedMeetings + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill PreserveDeclinedMeetings Description }} @@ -838,7 +902,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -848,6 +911,9 @@ Accept wildcard characters: False ``` ### -RemindersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemindersEnabled parameter enables or disables reminders for calendar items. Valid values are: - $true: Reminders are enabled. This is the default value. @@ -859,7 +925,6 @@ When the reminder is first displayed is controlled by the DefaultReminderTime pa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -869,6 +934,9 @@ Accept wildcard characters: False ``` ### -ReminderSoundEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReminderSoundEnabled parameter specifies whether a sound is played along with the reminder. Valid values are: - $true: A sound is played with the reminder. This is the default value. @@ -880,7 +948,6 @@ This parameter is ignored when the RemindersEnabled parameter is set to $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -890,6 +957,9 @@ Accept wildcard characters: False ``` ### -RentalCarEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The RentalCarEventsFromEmailEnabled parameter specifies whether to create rental car reservation events from email messages. Valid values are: @@ -903,7 +973,6 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -913,6 +982,9 @@ Accept wildcard characters: False ``` ### -ServiceAppointmentEventsFromEmailEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ServiceAppointmentEventsFromEmailEnabled Description }} @@ -921,7 +993,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -931,6 +1002,9 @@ Accept wildcard characters: False ``` ### -ShortenEventScopeDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ShortenEventScopeDefault Description }} @@ -939,7 +1013,6 @@ This parameter is available only in the cloud-based service. Type: ShortenEventScopeOption Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -949,6 +1022,9 @@ Accept wildcard characters: False ``` ### -ShowWeekNumbers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowWeekNumbers parameter specifies whether the week number is displayed in the Outlook on the web calendar. Valid values are: - $true: The week number is displayed. @@ -958,7 +1034,6 @@ The ShowWeekNumbers parameter specifies whether the week number is displayed in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -968,13 +1043,15 @@ Accept wildcard characters: False ``` ### -SkipAgendaMailOnFreeDays + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -984,6 +1061,9 @@ Accept wildcard characters: False ``` ### -TimeIncrement + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TimeIncrement parameter specifies the scale that the Outlook on the web calendar uses to show time. Valid values are: - FifteenMinutes @@ -993,7 +1073,6 @@ The TimeIncrement parameter specifies the scale that the Outlook on the web cale Type: HourIncrement Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1003,6 +1082,9 @@ Accept wildcard characters: False ``` ### -UseBrightCalendarColorThemeInOwa + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The UseBrightCalendarColorThemeInOwa parameter specifies whether to use light colors or bright colors for the calendar in Outlook on the web. Valid values are: - $true: Use bright colors in the calendar. @@ -1012,7 +1094,6 @@ The UseBrightCalendarColorThemeInOwa parameter specifies whether to use light co Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1022,6 +1103,9 @@ Accept wildcard characters: False ``` ### -WeatherEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WeatherEnabled specifies whether weather is displayed in the calendar in Outlook on the web. Valid values are: @@ -1034,7 +1118,6 @@ The WeatherEnabled specifies whether weather is displayed in the calendar in Out Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1044,6 +1127,9 @@ Accept wildcard characters: False ``` ### -WeatherLocationBookmark + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WeatherLocationBookmark parameter specifies the default weather information that's displayed in the calendar in Outlook on the web. This parameter is based on an index value of the configured weather locations. The first weather location has the index value 0, the second weather location has the index value 1, and so on. @@ -1054,7 +1140,6 @@ A valid value for this parameter depends on the number of weather locations that Type: Int32 Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1064,6 +1149,9 @@ Accept wildcard characters: False ``` ### -WeatherLocations + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WeatherLocations parameter specifies one or more locations to display the weather for in the calendar in Outlook on the web. @@ -1082,7 +1170,6 @@ You can configure a maximum of 5 weather locations. Type: MultiValuedProperty Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1092,6 +1179,9 @@ Accept wildcard characters: False ``` ### -WeatherUnit + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WeatherUnit parameter specifies the temperature scale that's used to display the weather in the calendar in Outlook on the web. Valid values are: @@ -1104,7 +1194,6 @@ The WeatherUnit parameter specifies the temperature scale that's used to display Type: WeatherTemperatureUnit Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1114,6 +1203,9 @@ Accept wildcard characters: False ``` ### -WeekStartDay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WeekStartDay parameter specifies the first day of the week. Valid values are: - Sunday (This is the default value) @@ -1128,7 +1220,6 @@ The WeekStartDay parameter specifies the first day of the week. Valid values are Type: DayOfWeek Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1138,13 +1229,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1154,6 +1247,9 @@ Accept wildcard characters: False ``` ### -WorkDays + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WorkDays parameter specifies the work days in the calendar. Valid values are: - None @@ -1174,7 +1270,6 @@ You can specify multiple values separated by commas, but redundant values are ig Type: DaysOfWeek Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1184,6 +1279,9 @@ Accept wildcard characters: False ``` ### -WorkingHoursEndTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WorkingHoursEndTime parameter specifies the time that the work day ends. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1194,7 +1292,6 @@ The default value is 17:00:00 (5:00 P.M.). Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1204,6 +1301,9 @@ Accept wildcard characters: False ``` ### -WorkingHoursStartTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WorkingHoursStartTime parameter specifies the time that the work day starts. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1214,7 +1314,6 @@ The default value is 08:00:00(8:00 A.M.). Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1224,6 +1323,9 @@ Accept wildcard characters: False ``` ### -WorkingHoursTimeZone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WorkingHoursTimeZone parameter specifies the time zone that's used by the WorkingHoursStartTime and WorkingHoursEndTime parameters. A valid value for this parameter is a supported time zone key name (for example, "Pacific Standard Time"). @@ -1236,7 +1338,6 @@ If the value contains spaces, enclose the value in quotation marks ("). The defa Type: ExTimeZoneValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1246,6 +1347,9 @@ Accept wildcard characters: False ``` ### -WorkspaceUserEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill WorkspaceUserEnabled Description }} @@ -1254,7 +1358,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarFolder.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarFolder.md index 7a30ee7341..d2fe92983d 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxCalendarFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxcalendarfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxCalendarFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxcalendarfolder +schema: 2.0.0 +title: Set-MailboxCalendarFolder --- # Set-MailboxCalendarFolder @@ -66,6 +67,9 @@ This example enables the calendar in Kai's mailbox to be searchable on the web. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the calendar folder that you want to modify. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -87,7 +91,6 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Cal Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -106,7 +112,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -DetailLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DetailLevel parameter specifies the level of calendar detail that's published and available to anonymous users. Valid values are: - AvailabilityOnly (default) @@ -128,7 +136,6 @@ This parameter is meaningful only when the PublishEnabled parameter value is $tr Type: DetailLevelEnumType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -146,7 +156,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +165,9 @@ Accept wildcard characters: False ``` ### -PublishDateRangeFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublishDateRangeFrom parameter specifies the start date of calendar information to publish (past information). Valid values are: - OneDay @@ -172,7 +184,6 @@ This parameter is meaningful only when the PublishEnabled parameter value is $tr Type: DateRangeEnumType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -PublishDateRangeTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublishDateRangeTo parameter specifies the end date of calendar information to publish (future information). Valid values are: - OneDay @@ -198,7 +212,6 @@ This parameter is meaningful only when the PublishEnabled parameter value is $tr Type: DateRangeEnumType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,6 +221,9 @@ Accept wildcard characters: False ``` ### -PublishEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublishEnabled parameter specifies whether to publish the specified calendar information. Valid values are: - $true: The calendar information is published. @@ -217,7 +233,6 @@ The PublishEnabled parameter specifies whether to publish the specified calendar Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -227,13 +242,15 @@ Accept wildcard characters: False ``` ### -ResetUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResetUrl switch replaces the existing non-public URL with a new URL for a calendar that has been published without being publicly searchable. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -243,6 +260,9 @@ Accept wildcard characters: False ``` ### -SearchableUrlEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SearchableUrlEnabled parameter specifies whether the published calendar URL is discoverable on the web. - $true: The published calendar URL is discoverable on the web. @@ -254,7 +274,6 @@ This parameter is meaningful only when the PublishEnabled parameter value is $tr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -264,13 +283,15 @@ Accept wildcard characters: False ``` ### -SetAsSharingSource + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SetAsSharingSource switch specifies whether to set the calendar folder as a sharing source. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -SharedCalendarSyncStartDate + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. **Note**: This parameter is supported only for shared calendars that have been upgraded as described in [Calendar sharing in Microsoft 365](https://support.microsoft.com/office/365-b576ecc3-0945-4d75-85f1-5efafb8a37b4), and is not applicable to any other type of calendar or mailbox folder. @@ -302,7 +326,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -312,6 +335,9 @@ Accept wildcard characters: False ``` ### -UseHttps + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The UseHttps switch specifies whether to use HTTPS for the published URL of the calendar folder. You don't need to specify a value with this switch. This switch is meaningful only when the PublishEnabled parameter value is $true. @@ -320,7 +346,6 @@ This switch is meaningful only when the PublishEnabled parameter value is $true. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -330,13 +355,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabase.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-MailboxDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabase.md index bf3cb3151f..8678125dd0 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxdatabase +schema: 2.0.0 +title: Set-MailboxDatabase --- # Set-MailboxDatabase @@ -80,11 +81,14 @@ Set-MailboxDatabase -RpcClientAccessServer Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox database that you want to modify. You can use any value that uniquely identifies the database. For example: - Name @@ -95,7 +99,6 @@ The Identity parameter specifies the mailbox database that you want to modify. Y Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -AllowFileRestore + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AllowFileRestore parameter specifies whether to allow a database to be restored from a backup. Valid values are: - $true: You can replace an existing database with a newly-created database. You can mount a database that doesn't match the database entry in Active Directory. @@ -114,7 +120,6 @@ The AllowFileRestore parameter specifies whether to allow a database to be resto Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -AutoDagExcludeFromMonitoring + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDagExcludedFromMonitoring parameter specifies whether to exclude the mailbox database from the ServerOneCopyMonitor, which alerts an administrator when a replicated database has only one healthy copy available. Valid values are: - $true: No alert is issued when there's only one healthy copy of the replicated database. @@ -133,7 +141,6 @@ The AutoDagExcludedFromMonitoring parameter specifies whether to exclude the mai Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,13 +150,15 @@ Accept wildcard characters: False ``` ### -AutoDatabaseMountDial + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: AutoDatabaseMountDial Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -BackgroundDatabaseMaintenance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BackgroundDatabaseMaintenance parameter specifies whether the Extensible Storage Engine (ESE) performs database maintenance. Valid values are: - $true: The mailbox database reads the object during database mount and initializes the database to perform background maintenance. This is the default value. @@ -168,7 +180,6 @@ The BackgroundDatabaseMaintenance parameter specifies whether the Extensible Sto Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,6 +189,9 @@ Accept wildcard characters: False ``` ### -CalendarLoggingQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarLoggingQuota parameter specifies the maximum size of the log in the Recoverable Items folder of the mailbox that stores changes to calendar items. When the log exceeds this size, calendar logging is disabled until messaging records management (MRM) removes older calendar logs to free up more space. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 6 gigabytes (6442450944 bytes). @@ -200,7 +214,6 @@ This setting applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,6 +223,9 @@ Accept wildcard characters: False ``` ### -CircularLoggingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CircularLoggingEnabled parameter specifies whether circular logging is enabled for the database. Valid values are: - $true: Circular logging is enabled. @@ -221,7 +237,6 @@ For more information about circular logging, see [Exchange Native Data Protectio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -240,7 +258,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -250,13 +267,15 @@ Accept wildcard characters: False ``` ### -DatabaseGroup + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -266,6 +285,9 @@ Accept wildcard characters: False ``` ### -DataMoveReplicationConstraint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DataMoveReplicationConstraint parameter specifies the throttling behavior for high availability mailbox moves. Valid values are: - None: Moves shouldn't be throttled to ensure high availability. Use this setting if the database isn't part of a database availability group (DAG). @@ -283,7 +305,6 @@ Any value other than None enables the Microsoft Exchange Mailbox Replication ser Type: DataMoveReplicationConstraintParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,6 +314,9 @@ Accept wildcard characters: False ``` ### -DeletedItemRetention + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeletedItemRetention parameter specifies the length of time to keep deleted items in the Recoverable Items\\Deletions folder in mailboxes. Items are moved to this folder when the user deletes items from the Deleted Items folder, empties the Deleted Items folder, or deletes items by using Shift+Delete. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -307,7 +331,6 @@ For more information, see [Recoverable Items folder in Exchange Server](https:// Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,13 +340,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -333,6 +358,9 @@ Accept wildcard characters: False ``` ### -EventHistoryRetentionPeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EventHistoryRetentionPeriod parameter specifies the length of time to keep event data. This event data is stored in the event history table in the Exchange store. It includes information about changes to various objects in the mailbox database. You can use this parameter to prevent the event history table from becoming too large and using too much disk space. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -343,7 +371,6 @@ Valid values are 00:00:01 to 30.00:00:00. The default value is 7.00:00:00 (7 day Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -353,6 +380,9 @@ Accept wildcard characters: False ``` ### -IndexEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange 2016 or earlier. The IndexEnabled parameter specifies whether Exchange Search indexes the mailbox database. Valid values are: @@ -364,7 +394,6 @@ The IndexEnabled parameter specifies whether Exchange Search indexes the mailbox Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -374,13 +403,15 @@ Accept wildcard characters: False ``` ### -IsExcludedFromInitialProvisioning + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -390,6 +421,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsExcludedFromProvisioning parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases. Valid values are: - $true: The database is excluded from new or move mailbox operations when you don't specify the target mailbox database. @@ -401,7 +435,6 @@ The value is automatically set to $true when you set the IsExcludedFromProvision Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -411,6 +444,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioningByOperator + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The IIsExcludedFromProvisioningByOperator parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases. Valid values are: @@ -427,7 +463,6 @@ Note that setting this parameter to the value $true has these additional effects Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -437,6 +472,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioningDueToLogicalCorruption + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The IsExcludedFromProvisioningDueToLogicalCorruption parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases. Valid values are: @@ -454,7 +492,6 @@ Note that setting this parameter to the value $true has these additional effects Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -464,6 +501,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioningReason + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The IsExcludedFromProvisioningReason parameter specifies the reason why you excluded the mailbox database from the mailbox provisioning load balancer. If the value contains spaces, enclose the value in quotation marks ("). The value must contain at least 10 characters. This parameter requires a value when you set any of the following parameters to $true: @@ -476,7 +516,6 @@ This parameter requires a value when you set any of the following parameters to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -486,6 +525,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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: @@ -506,7 +548,6 @@ This setting applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -516,6 +557,9 @@ Accept wildcard characters: False ``` ### -IsSuspendedFromProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsSuspendedFromProvisioning parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases. Valid values are: - $true: Indicates that you don't want the exclusion to be permanent. The database is excluded from new or move mailbox operations when you don't specify the target mailbox database. @@ -530,7 +574,6 @@ Note that setting this parameter to the value $true has these additional effects Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -540,6 +583,9 @@ Accept wildcard characters: False ``` ### -JournalRecipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The JournalRecipient parameter specifies the journal recipient to use for per-database journaling for all mailboxes on the database. You can use any value that uniquely identifies the recipient. For example: - Name @@ -553,7 +599,6 @@ The JournalRecipient parameter specifies the journal recipient to use for per-da Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -563,6 +608,9 @@ Accept wildcard characters: False ``` ### -MailboxRetention + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxRetention parameter specifies the length of time to keep deleted mailboxes before they are permanently deleted or purged. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -573,7 +621,6 @@ Valid values are 00:00:00 to 24855.03:14:07. The default value is 30.00:00:00 (3 Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -583,6 +630,9 @@ Accept wildcard characters: False ``` ### -MaintenanceSchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The MaintenanceSchedule parameter specifies when maintenance will be performed on the mailbox database. Maintenance includes online defragmentation, removing items that have passed their retention period, removing unused indexes and other cleanup tasks. @@ -611,7 +661,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -621,6 +670,9 @@ Accept wildcard characters: False ``` ### -MetaCacheDatabaseMaxCapacityInBytes + +> Applicable: Exchange Server 2019 + The MetaCacheDatabaseMaxCapacityInBytes parameter specifies the size of the metacache database in bytes. To convert gigabytes to bytes, multiply the value by 1024^3. For terabytes to bytes, multiply by 1024^4. The default value is blank ($null). @@ -629,7 +681,6 @@ The default value is blank ($null). Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -639,6 +690,9 @@ Accept wildcard characters: False ``` ### -MountAtStartup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MountAtStartup parameter specifies whether to mount the mailbox database when the Microsoft Exchange Information Store service starts. Valid values are: - $true: The database is mounted when the service starts. This is the default value. @@ -648,7 +702,6 @@ The MountAtStartup parameter specifies whether to mount the mailbox database whe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -658,13 +711,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name of the mailbox database. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -674,6 +729,9 @@ Accept wildcard characters: False ``` ### -OfflineAddressBook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OfflineAddressBook parameter specifies the offline address book that's associated with the mailbox database. You can use any value that uniquely identifies the offline address book. For example: - Name @@ -686,7 +744,6 @@ By default, this setting is blank ($null). Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -696,6 +753,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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: @@ -716,7 +776,6 @@ This settings applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -726,6 +785,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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: @@ -746,7 +808,6 @@ This setting applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -756,6 +817,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The PublicFolderDatabase parameter specifies the associated public folder database for this mailbox database. You can use any value that uniquely identifies the public folder database. For example: @@ -768,7 +832,6 @@ The PublicFolderDatabase parameter specifies the associated public folder databa Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -778,6 +841,9 @@ Accept wildcard characters: False ``` ### -QuotaNotificationSchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The QuotaNotificationSchedule parameter specifies when quota messages are sent to mailboxes that have reached one of the quota values. @@ -806,7 +872,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -816,6 +881,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder of the mailbox. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 30 gigabytes (32212254720 bytes). @@ -838,7 +906,6 @@ This settings applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -848,6 +915,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for the mailbox. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 20 gigabytes (21474836480 bytes). @@ -870,7 +940,6 @@ This settings applies to all mailboxes in the database that don't have their own Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -880,6 +949,9 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsUntilBackup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RetainDeletedItemsUntilBackup parameter specifies whether to keep items in the Recoverable Items\\Deletions folder of the mailbox until the next database backup occurs. Valid values are: - $true: Deleted items in mailboxes are kept until the next mailbox database backup. This value could effectively override the deleted DeletedItemRetention and RecoverableItemsQuota parameter values. @@ -898,7 +970,6 @@ For more information, see [Recoverable Items folder in Exchange Server](https:// Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -908,6 +979,9 @@ Accept wildcard characters: False ``` ### -RpcClientAccessServer + +> Applicable: Exchange Server 2010 + This parameter is functional only in Exchange Server 2010. The RpcClientAccessServer parameter specifies the Client Access server or Client Access server array through which RPC clients (for example, Microsoft Office Outlook 2007 clients) access their mailboxes. This feature is supported for all versions of Outlook. @@ -918,7 +992,6 @@ When connecting with Outlook 2003 clients, RPC encryption is disabled by default Type: ClientAccessServerOrArrayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -928,13 +1001,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabaseCopy.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabaseCopy.md index 7a63396766..f8ef8e0bf2 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxdatabasecopy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxDatabaseCopy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxdatabasecopy +schema: 2.0.0 +title: Set-MailboxDatabaseCopy --- # Set-MailboxDatabaseCopy @@ -57,13 +58,15 @@ This example configures an activation preference of 3 for the copy of the databa ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the database whose copy is being modified. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -ActivationPreference + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActivationPreference parameter value is used as part of Active Manager's best copy selection process and to redistribute active mailbox databases throughout the database availability group (DAG) when using the RedistributeActiveDatabases.ps1 script. The value for the ActivationPreference parameter is a number equal to or greater than 1, where 1 is at the top of the preference order. The position number can't be larger than the number of database copies of the mailbox database. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -ReplayLagTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReplayLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service should wait before replaying log files that have been copied to the passive database copy. Setting this parameter to a value greater than 0 creates a lagged database copy. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -136,7 +148,6 @@ For example, to specify a 14-day replay lag period, enter 14.00:00:00. The defau Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -TruncationLagTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TruncationLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service should wait before truncating log files that have replayed into the passive copy of the database. The time period begins after the log has been successfully replayed into the copy of the database. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -156,7 +170,6 @@ The default value is 00.00:00:00, which specifies that there's no truncation lag Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,13 +197,15 @@ Accept wildcard characters: False ``` ### -DatabaseCopyAutoActivationPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: DatabaseCopyAutoActivationPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,6 +215,9 @@ Accept wildcard characters: False ``` ### -ReplayLagMaxDelay + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ReplayLagMaxDelay parameter specifies the maximum delay for lagged database copy play down (also known as deferred lagged copy play down). If the disk read IO latency is greater than 25 ms, lagged copy play down is delayed up to the value of this parameter. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -210,7 +230,6 @@ Note that when the disk is running out of space, the value of this parameter is Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxExportRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxExportRequest.md index 400403f687..9800ba7cc0 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxExportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxexportrequest +schema: 2.0.0 +title: Set-MailboxExportRequest --- # Set-MailboxExportRequest @@ -70,13 +71,15 @@ This example changes the second export request Ayla\\MailboxExport1 to accept up ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). If you specify a name for the export request, use the following syntax: `Alias\Name`. ```yaml Type: MailboxExportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -96,7 +102,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -116,7 +124,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,13 +133,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BatchName parameter specifies the name of the batch. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -151,7 +163,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -161,13 +172,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default value is 30 days. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,13 +208,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,6 +226,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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: @@ -224,7 +244,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -234,6 +253,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: - Lowest @@ -249,7 +271,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,6 +280,9 @@ Accept wildcard characters: False ``` ### -RehomeRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RehomeRequest switch tells the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox that's being exported. You don't need to specify a value with this switch. This switch is used primarily for debugging purposes. @@ -267,7 +291,6 @@ This switch is used primarily for debugging purposes. Type: SwitchParameter Parameter Sets: Rehome Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -277,13 +300,15 @@ Accept wildcard characters: False ``` ### -RemoteCredential + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: PSCredential Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +318,15 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,13 +336,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipMerging parameter specifies steps in the export that should be skipped. This parameter is used primarily for debugging purposes. ```yaml Type: SkippableMergeComponent[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,6 +354,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -338,7 +370,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -348,13 +379,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxFolderPermission.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxFolderPermission.md index 52df63f5f3..a49cfbab41 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxFolderPermission.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxFolderPermission -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxfolderpermission +schema: 2.0.0 +title: Set-MailboxFolderPermission --- # Set-MailboxFolderPermission @@ -82,6 +83,9 @@ In Exchange Online, this example changes an existing user's permissions to Edito ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the target mailbox and folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -103,7 +107,6 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Inb Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -AccessRights + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AccessRights parameter specifies the permissions that you want to modify for the user on the mailbox folder. The values that you specify replace the existing permissions for the user on the folder. You can specify individual folder permissions or roles, which are combinations of permissions. You can specify multiple permissions and roles separated by commas. @@ -153,7 +159,6 @@ When the Editor role is applied to calendar folders, delegates can accept or dec Type: MailboxFolderAccessRight[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -163,6 +168,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. For the best results, we recommend using the following values: @@ -183,7 +191,6 @@ Otherwise, you can use any value that uniquely identifies the user or group. For Type: MailboxFolderUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -193,6 +200,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -202,7 +212,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +221,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -220,7 +232,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,6 +241,9 @@ Accept wildcard characters: False ``` ### -SendNotificationToUser + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SendNotificationToUser parameter specifies whether to send a sharing invitation to the user when you modify their calendar permissions. The message will be a normal calendar sharing invitation that can be accepted by the recipient. Valid values are: @@ -248,7 +262,6 @@ This parameter only applies to calendar folders and can only be used with the fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -258,6 +271,9 @@ Accept wildcard characters: False ``` ### -SharingPermissionFlags + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SharingPermissionFlags parameter assigns calendar delegate permissions. This parameter only applies to calendar folders and can only be used when the AccessRights parameter value is Editor. Valid values are: @@ -272,7 +288,6 @@ You can specify multiple values separated by commas. Type: MailboxFolderPermissionFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -282,13 +297,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -314,10 +331,10 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-mailboxfolderpermission) -[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/add-mailboxfolderpermission) -[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/remove-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchangepowershell/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxIRMAccess.md similarity index 96% rename from exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxIRMAccess.md index aab760df38..4d967f1dc5 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxIRMAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxirmaccess applicable: Exchange Online -title: Set-MailboxIRMAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxirmaccess +schema: 2.0.0 +title: Set-MailboxIRMAccess --- # Set-MailboxIRMAccess @@ -42,6 +43,9 @@ This example prevents delegate Chris from reading IRM-protected messages in Lyne ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AccessLevel + +> Applicable: Exchange Online + The AccessLevel parameter specifies what delegates can do to IRM-protected messages in the mailbox that's specified by the Identity parameter. The only value for this parameter is Block, which means you can only use this cmdlet to block delegate access to IRM-protected messages in the mailbox. @@ -80,7 +86,6 @@ Type: IRMAccessLevel Parameter Sets: (All) Aliases: Accepted values: Block -Applicable: Exchange Online Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Online + **Note**: Delegates that you specify with this parameter must already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). The User parameter specifies the delegate who is blocked from reading IRM-protected messages in the mailbox. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: @@ -109,7 +117,6 @@ The User parameter specifies the delegate who is blocked from reading IRM-protec Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxImportRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxImportRequest.md index 07b606b809..2bcc2e87e1 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxImportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MailboxImportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboximportrequest +schema: 2.0.0 +title: Set-MailboxImportRequest --- # Set-MailboxImportRequest @@ -78,13 +79,15 @@ This example finds all import requests that have a status of Suspended, and then ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specified a name for the import request with the New-MailboxImportRequest cmdlet, use the following syntax: `Alias\Name`. ```yaml Type: MailboxImportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AzureSharedAccessSignatureToken + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -102,7 +108,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AzureImportRequest Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later or Exchange Online, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -122,7 +130,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -144,7 +154,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,13 +163,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter specifies the name of the batch. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,13 +181,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +199,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -195,7 +211,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -205,6 +220,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -213,7 +231,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -223,6 +240,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -231,7 +251,6 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +260,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -258,7 +280,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -268,6 +289,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -285,7 +309,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -295,6 +318,9 @@ Accept wildcard characters: False ``` ### -RehomeRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RehomeRequest parameter tells the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox being imported. You don't need to specify a value with this switch. @@ -305,7 +331,6 @@ This switch is used primarily for debugging purposes. Type: SwitchParameter Parameter Sets: Rehome Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -315,6 +340,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -328,7 +356,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -338,6 +365,9 @@ Accept wildcard characters: False ``` ### -SkipInitialConnectionValidation + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service This parameter is reserved for internal Microsoft use. @@ -346,7 +376,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -356,13 +385,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipMerging parameter specifies the steps in the import that should be skipped. This parameter is used primarily for debugging purposes. ```yaml Type: SkippableMergeComponent[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -372,6 +403,9 @@ Accept wildcard characters: False ``` ### -SkippedItemApprovalTime + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service This parameter is reserved for internal Microsoft use. @@ -380,7 +414,6 @@ This parameter is reserved for internal Microsoft use. Type: System.DateTime Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -390,13 +423,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxJunkEmailConfiguration.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxJunkEmailConfiguration.md index 5c32a37cd8..5dde63a4e1 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxJunkEmailConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxjunkemailconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxJunkEmailConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxjunkemailconfiguration +schema: 2.0.0 +title: Set-MailboxJunkEmailConfiguration --- # Set-MailboxJunkEmailConfiguration @@ -81,6 +82,9 @@ This example identifies mailboxes where contacts are treated as trusted senders ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -98,7 +102,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -BlockedSendersAndDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BlockedSendersAndDomains parameter specifies the Blocked Senders list, which is a list of sender email addresses and domains whose messages are automatically sent to the Junk Email folder. This parameter corresponds to the Outlook on the web setting: Move email from these senders or domains to my Junk Email folder. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -118,7 +124,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -137,7 +145,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -ContactsTrusted + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ContactsTrusted parameter specifies whether the contacts in the Contacts folder are treated as trusted senders. This parameter corresponds to the Outlook on the web setting: Trust email from my contacts. Valid values are: - $true: Messages from contacts in the Contacts folder that reach the mailbox are never delivered to the Junk Email folder, regardless of the content. @@ -156,7 +166,6 @@ The ContactsTrusted parameter specifies whether the contacts in the Contacts fol Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -174,7 +186,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter enables or disables the junk email rule on the mailbox (a hidden Inbox rule named Junk E-mail Rule). Valid values are: - $true: The junk email rule is enabled in the mailbox. This value corresponds to the Outlook on the web setting: Automatically filter junk email. This is the default value. @@ -209,7 +223,6 @@ The state of the junk email rule on the mailbox doesn't affect the client-side j Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -219,6 +232,9 @@ Accept wildcard characters: False ``` ### -FailOnError + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill FailOnError Description }} @@ -227,7 +243,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -237,6 +252,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -248,7 +266,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -258,6 +275,9 @@ Accept wildcard characters: False ``` ### -SenderScreeningEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SenderScreeningEnabled Description }} @@ -266,7 +286,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -276,6 +295,9 @@ Accept wildcard characters: False ``` ### -TrustedListsOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TrustedListsOnly parameter specifies that only messages from senders in the Safe Senders list are delivered to the Inbox. All other messages are treated as junk email. This parameter corresponds to the Outlook on the web setting: Don't trust email unless it comes from someone in my Safe Senders and Recipients list. Valid values are: - $true: Only messages from email address or domain entries in the Safe Senders list and the Safe Recipients list are delivered to the Inbox. All other messages are automatically delivered to the Junk Email folder. @@ -285,7 +307,6 @@ The TrustedListsOnly parameter specifies that only messages from senders in the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -295,13 +316,15 @@ Accept wildcard characters: False ``` ### -TrustedRecipientsAndDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -311,6 +334,9 @@ Accept wildcard characters: False ``` ### -TrustedSendersAndDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TrustedSendersAndDomains parameter specifies the Safe Senders list and Safe Recipients list, which are lists of email addresses and domains. Messages from these senders that reach the mailbox are never delivered to the Junk Email folder, regardless of the content. This parameter corresponds to the Outlook on the web setting: Don't move email from these senders or domains to my Junk Email folder. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -329,7 +355,6 @@ To empty the list of email addresses and domains, use the value $null. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -339,13 +364,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxMessageConfiguration.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxMessageConfiguration.md index 047f4af452..eb2d6eb0aa 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxMessageConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxmessageconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxMessageConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxmessageconfiguration +schema: 2.0.0 +title: Set-MailboxMessageConfiguration --- # Set-MailboxMessageConfiguration @@ -114,6 +115,9 @@ This example sets the compose email message form to always show the Bcc field in ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -131,7 +135,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -141,6 +144,9 @@ Accept wildcard characters: False ``` ### -AfterMoveOrDeleteBehavior + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AfterMoveOrDeleteBehavior parameter specifies the behavior after moving or deleting an email item in Outlook on the web. You can use the following values: - OpenPreviousItem @@ -153,7 +159,6 @@ The default value is OpenNextItem. Type: AfterMoveOrDeleteBehavior Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -163,6 +168,9 @@ Accept wildcard characters: False ``` ### -AlwaysShowBcc + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlwaysShowBcc parameter shows or hides the blind carbon copy (Bcc) field when the user creates messages in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -171,7 +179,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -181,6 +188,9 @@ Accept wildcard characters: False ``` ### -AlwaysShowFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlwaysShowFrom parameter shows or hides the From field when the user creates messages in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -189,7 +199,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -199,6 +208,9 @@ Accept wildcard characters: False ``` ### -AutoAddSignature + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. The AutoAddSignature parameter specifies whether to automatically add signatures to new email messages created in Outlook on the web. Valid values are: @@ -212,7 +224,6 @@ The email signature specified by the SignatureText parameter is added to plain t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -222,6 +233,9 @@ Accept wildcard characters: False ``` ### -AutoAddSignatureOnMobile + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. The AutoAddSignatureOnMobile parameter automatically adds the signature specified by the SignatureTextOnMobile parameter to messages when the user creates messages in Outlook on the web for devices. @@ -232,7 +246,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -242,6 +255,9 @@ Accept wildcard characters: False ``` ### -AutoAddSignatureOnReply + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AutoAddSignature parameter specifies whether to automatically add signatures to reply email messages created in Outlook on the web. Valid values are: - $true: Email signatures are automatically added to reply messages. @@ -253,7 +269,6 @@ The email signature specified by the SignatureText parameter is added to plain t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -263,6 +278,9 @@ Accept wildcard characters: False ``` ### -CheckForForgottenAttachments + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CheckForForgottenAttachments parameter shows or hides the attachment warning prompt when the user creates messages in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $true. @@ -273,7 +291,6 @@ For example, the user creates a message that includes the text "Please see the a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -283,6 +300,9 @@ Accept wildcard characters: False ``` ### -CheckForReportJunkDialog + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill CheckForReportJunkDialog Description }} @@ -291,7 +311,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -301,6 +320,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -310,7 +332,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -320,6 +341,9 @@ Accept wildcard characters: False ``` ### -ConversationSortOrder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConversationSortOrder parameter specifies the sorting of messages in the reading pane in Conversation view for the user in Outlook on the web. You can use the following values: - Chronological @@ -336,7 +360,6 @@ The default value is ChronologicalNewestOnTop. Type: ConversationSortOrder Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -346,6 +369,9 @@ Accept wildcard characters: False ``` ### -DefaultFontColor + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultFontColor parameter specifies the default text color when the user creates messages in Outlook on the web. This parameter accepts a hexadecimal color code value in the format #xxxxxx. The default value is #000000. If the string value is unrecognized, the browser application uses a default font color to display the text. @@ -354,7 +380,6 @@ If the string value is unrecognized, the browser application uses a default font Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -364,6 +389,9 @@ Accept wildcard characters: False ``` ### -DefaultFontFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultFontFlags parameter specifies the default text effect when the user creates messages in Outlook on the web. You can use the following values: - Normal @@ -378,7 +406,6 @@ The default value is Normal. Type: FontFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -388,6 +415,9 @@ Accept wildcard characters: False ``` ### -DefaultFontName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultFontName parameter specifies the default font when the user creates messages in Outlook on the web. The default value is Calibri. If the font name value is unrecognized, the browser application uses a default font to display the text. @@ -396,7 +426,6 @@ The default value is Calibri. If the font name value is unrecognized, the browse Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -406,6 +435,9 @@ Accept wildcard characters: False ``` ### -DefaultFontSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultFontSize parameter specifies the default text size when the user creates messages in Outlook on the web. Valid input for this parameter is an integer between 1 and 7. The default value is 3, which corresponds to a 12 point font size. @@ -414,7 +446,6 @@ Valid input for this parameter is an integer between 1 and 7. The default value Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -424,13 +455,15 @@ Accept wildcard characters: False ``` ### -DefaultFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultFormat parameter specifies the default message format when the user creates messages in Outlook on the web. Accepted values are Html and PlainText. The default value is Html. ```yaml Type: MailFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -440,6 +473,9 @@ Accept wildcard characters: False ``` ### -DefaultSignature + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DefaultSignature Description }} @@ -448,7 +484,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -458,6 +493,9 @@ Accept wildcard characters: False ``` ### -DefaultSignatureOnReply + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DefaultSignatureOnReply Description }} @@ -466,7 +504,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -476,6 +513,9 @@ Accept wildcard characters: False ``` ### -DeleteSignatureName + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DeleteSignatureName Description }} @@ -484,7 +524,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -494,6 +533,9 @@ Accept wildcard characters: False ``` ### -DisplayDensityMode + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill DisplayDensityMode Description }} @@ -502,7 +544,6 @@ This parameter is available only in the cloud-based service. Type: DisplayDensityMode Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -512,6 +553,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -520,7 +564,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -530,6 +573,9 @@ Accept wildcard characters: False ``` ### -EchoGroupMessageBackToSubscribedSender + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EchoGroupMessageBackToSubscribedSender parameter controls whether subscribed members of Microsoft 365 Groups receive copies of messages that they send to those Groups. Valid values are: @@ -541,7 +587,6 @@ The EchoGroupMessageBackToSubscribedSender parameter controls whether subscribed Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -551,6 +596,9 @@ Accept wildcard characters: False ``` ### -EmailComposeMode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The EmailComposeMode parameter specifies how the user creates messages in Outlook on the web. You can use the following values: @@ -562,7 +610,6 @@ The EmailComposeMode parameter specifies how the user creates messages in Outloo Type: EmailComposeMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -572,6 +619,9 @@ Accept wildcard characters: False ``` ### -EmptyDeletedItemsOnLogoff + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EmptyDeletedItemsOnLogoff parameter specifies whether to delete items from the Deleted Items folder when the user logs out of Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -580,7 +630,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -590,6 +639,9 @@ Accept wildcard characters: False ``` ### -FavoritesBitFlags + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill FavoritesBitFlags Description }} @@ -598,7 +650,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -608,6 +659,9 @@ Accept wildcard characters: False ``` ### -GlobalReadingPanePosition + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in Exchange 2016 or later. It doesn't work in Exchange Online. The GlobalReadingPanePosition specifies the default location of the reading pane in Outlook on the web. Valid values are: @@ -620,7 +674,6 @@ The GlobalReadingPanePosition specifies the default location of the reading pane Type: MailReadingPanePosition Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -630,6 +683,9 @@ Accept wildcard characters: False ``` ### -HideDeletedItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HideDeletedItems parameter shows or hides deleted messages in Conversation view for the user in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -638,7 +694,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -648,6 +703,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -659,7 +717,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -669,6 +726,9 @@ Accept wildcard characters: False ``` ### -IsDarkModeTheme + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IsDarkModeTheme Description }} @@ -677,7 +737,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -687,6 +746,9 @@ Accept wildcard characters: False ``` ### -IsFavoritesFolderTreeCollapsed + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsFavoritesFolderTreeCollapsed parameter specifies whether to collapse the Favorites folder tree by default in Outlook on the web. Valid values are: - $true: The Favorites folder tree is collapsed by default. @@ -696,7 +758,6 @@ The IsFavoritesFolderTreeCollapsed parameter specifies whether to collapse the F Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -706,6 +767,9 @@ Accept wildcard characters: False ``` ### -IsFocusedInboxEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill IsFocusedInboxEnabled Description }} @@ -714,7 +778,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -724,6 +787,9 @@ Accept wildcard characters: False ``` ### -IsMailRootFolderTreeCollapsed + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsMailRootFolderTreeCollapsed parameter specifies whether to collapse the Mail root folder tree by default in Outlook on the web. Valid values are: - $true: The Mail root folder tree is collapsed by default. @@ -733,7 +799,6 @@ The IsMailRootFolderTreeCollapsed parameter specifies whether to collapse the Ma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -743,6 +808,9 @@ Accept wildcard characters: False ``` ### -IsReplyAllTheDefaultResponse + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsReplyAllTheDefaultResponse parameter specifies whether Reply All is the default response for messages in Outlook on the web. Valid values are: - $true: Reply All is the default response option for messages in the reading pane. This is the default value. @@ -752,7 +820,6 @@ The IsReplyAllTheDefaultResponse parameter specifies whether Reply All is the de Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -762,6 +829,9 @@ Accept wildcard characters: False ``` ### -LinkPreviewEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The LinkPreviewEnabled parameter specifies whether link preview of URLs in email messages is enabled for the user in Outlook on the web. Valid values are: - $true: Link preview of URLs in email messages is enabled for the user. This is the default value. @@ -773,7 +843,6 @@ This parameter depends on the value of the LinkPreviewEnabled parameter on the S Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -783,6 +852,9 @@ Accept wildcard characters: False ``` ### -MailFolderPaneExpanded + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailFolderPaneExpanded parameter specifies whether the Mail folder pane is expanded by default in Outlook on the web. Valid values are: - $true: The Mail folder pane is expanded by default. This is the default value. @@ -792,7 +864,6 @@ The MailFolderPaneExpanded parameter specifies whether the Mail folder pane is e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -802,6 +873,9 @@ Accept wildcard characters: False ``` ### -MailSendUndoInterval + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MailSendUndoInterval Description }} @@ -810,7 +884,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -820,6 +893,9 @@ Accept wildcard characters: False ``` ### -ManuallyPickCertificate + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ManuallyPickCertificate Description }} @@ -828,7 +904,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -838,6 +913,9 @@ Accept wildcard characters: False ``` ### -NavigationBarWidth + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill NavigationBarWidth Description }} @@ -846,7 +924,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -856,6 +933,9 @@ Accept wildcard characters: False ``` ### -NavigationPaneViewOption + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The NavigationPaneViewOption parameter specifies the default navigation pane view in Outlook on the web. Valid values are: - Default: This is the default value @@ -868,7 +948,6 @@ The NavigationPaneViewOption parameter specifies the default navigation pane vie Type: NavigationPaneView Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -878,6 +957,9 @@ Accept wildcard characters: False ``` ### -NewEnabledPonts + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill NewEnabledPonts Description }} @@ -886,7 +968,6 @@ This parameter is available only in the cloud-based service. Type: PontType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -896,6 +977,9 @@ Accept wildcard characters: False ``` ### -NewItemNotification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NewItemNotification parameter specifies how to provide notification for the arrival of new items for the user in Outlook on the web. You can use the following values: - Sound @@ -911,7 +995,6 @@ The default value is All. Type: NewItemNotification Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -921,6 +1004,9 @@ Accept wildcard characters: False ``` ### -PreferAccessibleContent + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PreferAccessibleContent parameter specifies whether to prefer accessible content in Outlook on the web. Valid values are: - $true: Prefer accessible content. @@ -930,7 +1016,6 @@ The PreferAccessibleContent parameter specifies whether to prefer accessible con Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -940,6 +1025,9 @@ Accept wildcard characters: False ``` ### -PreviewMarkAsReadBehavior + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PreviewMarkAsReadBehavior parameter specifies the options for marking an item as Read in the reading pane for the user in Outlook on the web. You can use the following values: - Delayed: This value uses the delay interval specified by the PreviewMarkAsReadDelaytime parameter. @@ -952,7 +1040,6 @@ The default value is OnSelectionChange. Type: PreviewMarkAsReadBehavior Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -962,6 +1049,9 @@ Accept wildcard characters: False ``` ### -PreviewMarkAsReadDelaytime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PreviewMarkAsReadDelaytime parameter specifies the time in seconds to wait before marking an item as Read for the user in Outlook on the web. Valid input for this parameter is an integer between 0 and 30. The default value is 5 seconds. @@ -972,7 +1062,6 @@ This parameter is meaningful only if you set the PreviewMarkAsReadBehavior param Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -982,6 +1071,9 @@ Accept wildcard characters: False ``` ### -ReadReceiptResponse + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReadReceiptResponse parameter specifies how to respond to requests for read receipts for the user in Outlook on the web. You can use the following values: - DoNotAutomaticallySend @@ -994,7 +1086,6 @@ The default value is DoNotAutomaticallySend. Type: ReadReceiptResponse Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1004,6 +1095,9 @@ Accept wildcard characters: False ``` ### -ReportJunkSelected + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ReportJunkSelected Description }} @@ -1012,7 +1106,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1022,6 +1115,9 @@ Accept wildcard characters: False ``` ### -SendAddressDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SendAddressDefault parameter specifies the default From email address when the user has POP, IMAP, or Hotmail subscriptions configured on their mailbox. Users can override the default From address when they create an email message in Outlook on the web. @@ -1043,7 +1139,6 @@ You can find the available values for SendAddressDefault on a mailbox by running Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1053,6 +1148,9 @@ Accept wildcard characters: False ``` ### -ShowConversationAsTree + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowConversationAsTree parameter specifies how to sort messages in the list view in an expanded conversation for the user in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -1061,7 +1159,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1071,6 +1168,9 @@ Accept wildcard characters: False ``` ### -ShowInlinePreviews + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ShowInlinePreviews Description }} @@ -1079,7 +1179,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1089,6 +1188,9 @@ Accept wildcard characters: False ``` ### -ShowNotificationBar + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ShowNotificationBar Description }} @@ -1097,7 +1199,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1107,6 +1208,9 @@ Accept wildcard characters: False ``` ### -ShowPreviewTextInListView + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowPreviewTextInListView parameter specifies whether to show preview text for messages in list view in Outlook on the web. Valid values are: - $true: Show preview text for messages in list view. This is the default value. @@ -1116,7 +1220,6 @@ The ShowPreviewTextInListView parameter specifies whether to show preview text f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1126,6 +1229,9 @@ Accept wildcard characters: False ``` ### -ShowReadingPaneOnFirstLoad + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowReadingPaneOnFirstLoad parameter specifies whether to show the reading pane when the user opens in Outlook on the web for the first time. Valid values are: - $true: Show the reading pane when the user opens Outlook on the web for the first time. @@ -1135,7 +1241,6 @@ The ShowReadingPaneOnFirstLoad parameter specifies whether to show the reading p Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1145,6 +1250,9 @@ Accept wildcard characters: False ``` ### -ShowSenderOnTopInListView + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowSenderOnTopInListView parameter specifies whether to show the message sender on top in list view in Outlook on the web. Valid values are: - $true: Show the message sender on top in list view. This is the default value. @@ -1154,7 +1262,6 @@ The ShowSenderOnTopInListView parameter specifies whether to show the message se Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1164,6 +1271,9 @@ Accept wildcard characters: False ``` ### -ShowUpNext + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ShowUpNext parameter specifies whether the next upcoming event should be shown above the mail list view in Outlook on the web. Valid values are: - $true: Show the next upcoming event above the mail list view. This is the default value. @@ -1173,7 +1283,6 @@ The ShowUpNext parameter specifies whether the next upcoming event should be sho Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1183,6 +1292,9 @@ Accept wildcard characters: False ``` ### -SignatureHtml + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. The SignatureHtml parameter specifies the email signature that's available to the user in HTML-formatted messages in Outlook on the web. You can use plain text or text with HTML tags. However, any JavaScript code is removed. @@ -1193,7 +1305,6 @@ To automatically add this email signature to HTML-formatted messages created by Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1203,6 +1314,9 @@ Accept wildcard characters: False ``` ### -SignatureHtmlBody + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SignatureHtmlBody Description }} @@ -1211,7 +1325,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1221,6 +1334,9 @@ Accept wildcard characters: False ``` ### -SignatureName + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SignatureName Description }} @@ -1229,7 +1345,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1239,6 +1354,9 @@ Accept wildcard characters: False ``` ### -SignatureText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. The SignatureText parameter specifies the email signature that's available to the user in plain text messages in Outlook on the web. This parameter supports all Unicode characters. @@ -1249,7 +1367,6 @@ To automatically add the email signature to plain text messages created by the u Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1259,6 +1376,9 @@ Accept wildcard characters: False ``` ### -SignatureTextOnMobile + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. The SignatureTextOnMobile parameter specifies the email signature that's available in messages created by the user in Outlook on the web for devices. This parameter supports all Unicode characters. @@ -1269,7 +1389,6 @@ To automatically add the email signature to messages created by the user in Outl Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1279,6 +1398,9 @@ Accept wildcard characters: False ``` ### -SigningCertificateId + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SigningCertificateId Description }} @@ -1287,7 +1409,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1297,6 +1418,9 @@ Accept wildcard characters: False ``` ### -SigningCertificateSubject + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SigningCertificateSubject Description }} @@ -1305,7 +1429,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1315,6 +1438,9 @@ Accept wildcard characters: False ``` ### -SmimeEncrypt + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SmimeEncrypt Description }} @@ -1323,7 +1449,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1333,6 +1458,9 @@ Accept wildcard characters: False ``` ### -SmimeSign + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SmimeSign Description }} @@ -1341,7 +1469,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1351,6 +1478,9 @@ Accept wildcard characters: False ``` ### -UseDefaultSignatureOnMobile + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UseDefaultSignatureOnMobile parameter specifies whether to add the default email signature to messages created by the user in Outlook on the web for devices. The user configures the default signature in Outlook. Valid input for this parameter is $true or $false. The default value is $false. @@ -1359,7 +1489,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1369,6 +1498,9 @@ Accept wildcard characters: False ``` ### -WebSuggestedRepliesEnabledForUser + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill WebSuggestedRepliesEnabledForUser Description }} @@ -1377,7 +1509,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1387,13 +1518,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxPlan.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxPlan.md similarity index 96% rename from exchange/exchange-ps/exchange/Set-MailboxPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxPlan.md index 96b60c149b..0edf3ce269 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxplan applicable: Exchange Online, Exchange Online Protection -title: Set-MailboxPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxplan +schema: 2.0.0 +title: Set-MailboxPlan --- # Set-MailboxPlan @@ -59,6 +60,9 @@ This example lowers the default mailbox quotas in the mailbox plan named Exchang ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox plan that you want to modify. You can use any value that uniquely identifies the mailbox plan. For example: - Name @@ -71,7 +75,6 @@ The Identity parameter specifies the mailbox plan that you want to modify. You c Type: MailboxPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -90,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -108,7 +116,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Online + The IsDefault switch specifies that the mailbox plan is the default mailbox plan. You don't need to specify a value with this switch. New and newly-enabled mailboxes receive the settings in the default mailbox plan. @@ -126,7 +136,6 @@ New and newly-enabled mailboxes receive the settings in the default mailbox plan Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Online + The IssueWarningQuota parameter specifies the warning threshold for the size of the mailboxes that are created or enabled using the mailbox plan. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -156,7 +168,6 @@ The maximum value is determined by the mailbox plan. You can lower the value, an Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Online + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -188,7 +202,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Online + The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mailbox. When you enter a value, qualify the value with one of the following units: @@ -220,7 +236,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -230,6 +245,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendQuota + +> Applicable: Exchange Online + The ProhibitSendQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send new messages, and the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -250,7 +268,6 @@ The maximum value is determined by the mailbox plan. You can lower the value, an Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -260,6 +277,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota + +> Applicable: Exchange Online + The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -280,7 +300,6 @@ The maximum value is determined by the mailbox plan. You can lower the value, bu Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -290,13 +309,15 @@ Accept wildcard characters: False ``` ### -RecipientLimits + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -306,6 +327,9 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsFor + +> Applicable: Exchange Online + The RetainDeletedItemsFor parameter specifies the length of time to keep soft-deleted items for the mailbox. Soft-deleted items are items that have been deleted by using any of these methods: - Deleting items from the Deleted Items folder. @@ -324,7 +348,6 @@ The default value is 14 days (14.00:00:00). In Exchange Online, you can increase Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -334,6 +357,9 @@ Accept wildcard characters: False ``` ### -RetentionPolicy + +> Applicable: Exchange Online + The RetentionPolicy parameter specifies the retention policy that's applied to new mailboxes that you create. You can use any value that uniquely identifies the policy. For example: - Name @@ -358,7 +384,6 @@ For more information, see [Mailbox plans in Exchange Online](https://learn.micro Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -368,6 +393,9 @@ Accept wildcard characters: False ``` ### -RoleAssignmentPolicy + +> Applicable: Exchange Online + The RoleAssignmentPolicy parameter specifies the role assignment policy that's applied to the mailbox. You can use any value that uniquely identifies the role assignment policy. For example: - Name @@ -382,7 +410,6 @@ To see the available role assignment policies, use the Get-RoleAssignmentPolicy Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -392,13 +419,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxRegionalConfiguration.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxRegionalConfiguration.md index ef75fd3f02..3349fad8d4 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxRegionalConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxRegionalConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxregionalconfiguration +schema: 2.0.0 +title: Set-MailboxRegionalConfiguration --- # Set-MailboxRegionalConfiguration @@ -104,6 +105,9 @@ This example sets Megan Bowen mailbox language to Spanish Argentina, sets the da ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -121,7 +125,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -131,6 +134,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill Archive Description }} @@ -139,7 +145,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -149,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -158,7 +166,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,6 +175,9 @@ Accept wildcard characters: False ``` ### -DateFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DateFormat parameter specifies a valid date format based on the current or specified language for the mailbox. For example, if the language is set to en-US, valid DateFormat parameter values include: - M/d/yyyy: This is the default value for en-US. @@ -184,7 +194,6 @@ For more information about the date format strings, see [Standard Date and Time Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -194,6 +203,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -202,7 +214,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,6 +223,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Language parameter specifies the language for the mailbox. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -220,7 +234,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +243,9 @@ Accept wildcard characters: False ``` ### -MailboxLocation + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill MailboxLocation Description }} @@ -238,7 +254,6 @@ This parameter is available only in the cloud-based service. Type: MailboxLocationIdParameter Parameter Sets: MailboxLocation Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,13 +263,15 @@ Accept wildcard characters: False ``` ### -LocalizeDefaultFolderName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LocalizeDefaultFolderName switch localizes the default folder names of the mailbox in the current or specified language. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -264,6 +281,9 @@ Accept wildcard characters: False ``` ### -TimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TimeFormat parameter specifies a valid time format based on the current or specified language value for the mailbox. For example, if the language is set to en-us, valid TimeFormat parameter values include: - h:mm tt: This is the default value for en-US. @@ -277,7 +297,6 @@ For more information about the time format strings, see [Standard Date and Time Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,6 +306,9 @@ Accept wildcard characters: False ``` ### -TimeZone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TimeZone parameter specifies the time zone for the mailbox. A valid value for this parameter is a supported time zone key name (for example, "Pacific Standard Time"). @@ -299,7 +321,6 @@ If the value contains spaces, enclose the value in quotation marks ("). The defa Type: ExTimeZoneValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -309,6 +330,9 @@ Accept wildcard characters: False ``` ### -UseCustomRouting + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} @@ -317,7 +341,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -327,13 +350,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxRestoreRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxRestoreRequest.md index a874cb3a60..31a09c45f0 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxRestoreRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxRestoreRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxrestorerequest +schema: 2.0.0 +title: Set-MailboxRestoreRequest --- # Set-MailboxRestoreRequest @@ -81,6 +82,9 @@ This example changes the first restore request for Kweku's mailbox to skip 100 c ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name` If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -89,7 +93,6 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: MailboxRestoreRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later or Exchange Online, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -109,7 +115,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -131,7 +139,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter specifies the name of the batch. Use this parameter to change, create, or remove a batch name. To remove a batch name, set the BatchName parameter value to an empty string or to null, for example, -BatchName "" or -BatchName $null. @@ -149,7 +159,6 @@ To remove a batch name, set the BatchName parameter value to an empty string or Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -159,13 +168,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the status of a completed restore request is set to Completed. If this parameter is set to a value of 0, the status is cleared immediately instead of changing it to Completed. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -184,7 +198,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -202,7 +218,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -220,7 +238,6 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,6 +247,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -247,7 +267,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -257,6 +276,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -274,7 +296,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -284,6 +305,9 @@ Accept wildcard characters: False ``` ### -RehomeRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The RehomeRequest switch moves the mailbox restore request to a different mailbox database. You don't need to specify a value with this switch. @@ -294,7 +318,6 @@ Use this switch to edit a mailbox restore request in the case where the source m Type: SwitchParameter Parameter Sets: Rehome Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -304,13 +327,15 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -320,6 +345,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -333,7 +361,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -343,6 +370,9 @@ Accept wildcard characters: False ``` ### -SkipInitialConnectionValidation + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -351,7 +381,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -361,6 +390,9 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipMerging parameter specifies folder-related items to skip when restoring the mailbox. Use one of the following values: - FolderACLs @@ -374,7 +406,6 @@ Use this parameter only if a restore request fails because of folder rules, fold Type: SkippableMergeComponent[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -384,6 +415,9 @@ Accept wildcard characters: False ``` ### -SkippedItemApprovalTime + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -392,7 +426,6 @@ This parameter is reserved for internal Microsoft use. Type: DateTime Parameter Sets: Identity, Rehome Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -402,6 +435,9 @@ Accept wildcard characters: False ``` ### -SourceWlmLevel + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SourceWlmLevel Description }} @@ -410,7 +446,6 @@ This parameter is available only in the cloud-based service. Type: WlmLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -420,6 +455,9 @@ Accept wildcard characters: False ``` ### -TargetWlmLevel + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill TargetWlmLevel Description }} @@ -428,7 +466,6 @@ This parameter is available only in the cloud-based service. Type: WlmLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -438,13 +475,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSearch.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxSearch.md index ee2ec50572..87fa9b177c 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSearch.md @@ -1,15 +1,16 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/Set-MailboxSearch +schema: 2.0.0 +title: Set-MailboxSearch --- -# Set-Mailboxsearch +# Set-MailboxSearch ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. @@ -23,7 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Set-Mailboxsearch [-Identity] +Set-MailboxSearch [-Identity] [-AllPublicFolderSources ] [-AllSourceMailboxes ] [-Confirm] @@ -87,13 +88,15 @@ In on-premises Exchange, this example adds all public folders to the existing ma ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the mailbox search that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: SearchObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -AllPublicFolderSources + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllPublicFolderSources parameter specifies whether to include all public folders in the organization in the search. Valid values are: - $true: All public folders are included in the search. This value is required when the value of the AllSourceMailboxes parameter is $falseand you don't specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value is blank [$null]). @@ -112,7 +118,6 @@ The AllPublicFolderSources parameter specifies whether to include all public fol Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -AllSourceMailboxes + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllSourceMailboxes parameter specifies whether to include all mailboxes in the search. Valid values are: - $true: All mailboxes are included in the search. This value is required when the value of the AllPublicFolderSources parameter is $falseand you don't specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value is blank [$null]). @@ -131,7 +139,6 @@ The AllSourceMailboxes parameter specifies whether to include all mailboxes in t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -150,7 +160,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,13 +169,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Description parameter specifies a description for the search. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -184,7 +198,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -DoNotIncludeArchive + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The DoNotIncludeArchive switch excludes items in the user's Archive mailbox from mailbox searches. You don't need to specify a value with this switch. @@ -204,7 +220,6 @@ By default, items in the user's Archive mailbox are included in mailbox searches Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -214,6 +229,9 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -224,7 +242,6 @@ To clear the end date, use the value $null. Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -234,13 +251,15 @@ Accept wildcard characters: False ``` ### -EstimateOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EstimateOnly switch provides only an estimate of the number of items that will be returned without copying message to the target mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -250,6 +269,9 @@ Accept wildcard characters: False ``` ### -ExcludeDuplicateMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExcludeDuplicateMessages parameter eliminates duplication of messages across mailboxes in an In-Place eDiscovery search. Valid values are: - $true: Copy a single instance of a message if the same message exists in multiple folders or mailboxes. This is the default value. @@ -259,7 +281,6 @@ The ExcludeDuplicateMessages parameter eliminates duplication of messages across Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -269,6 +290,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this to switch to hide the confirmation prompt that indicates the previous search results will be removed from the target mailbox, and that the search will be restarted. @@ -277,7 +301,6 @@ Use this to switch to hide the confirmation prompt that indicates the previous s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,13 +310,15 @@ Accept wildcard characters: False ``` ### -IncludeKeywordStatistics + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeKeywordStatistics switch returns keyword statistics (number of instances for each keyword). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -303,6 +328,9 @@ Accept wildcard characters: False ``` ### -IncludeUnsearchableItems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IncludeUnsearchableItems parameter specifies whether items that couldn't be indexed by Exchange Search should be included in the results. Valid values are: - $true: Unsearchable items are included in the results. @@ -314,7 +342,6 @@ Unsearchable items aren't placed on hold for a query-based In-Place Hold. If you Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -324,6 +351,9 @@ Accept wildcard characters: False ``` ### -InPlaceHoldEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The InPlaceHoldEnabled parameter specifies whether to set an In-Place Hold on items in the search results. Valid values are: - $true: In-Place Hold is enabled on the search results. @@ -337,7 +367,6 @@ If you attempt to place a hold but don't specify mailboxes using the SourceMailb Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -347,6 +376,9 @@ Accept wildcard characters: False ``` ### -ItemHoldPeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold onthe mailbox items (all items or the mailbox items that are returned in the search query results). You use this parameter with the InPlaceHoldEnabled parameter to set an In-Place Hold. The duration is calculated from the time the item is received or created in the mailbox. Valid values are: - An integer. @@ -356,7 +388,6 @@ The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -366,6 +397,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Language parameter specifies a locale for the mailbox search. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -374,7 +408,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -384,6 +417,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LogLevel parameter specifies a logging level for the mailbox search. Valid values are: - Basic: Basic details of the search are kept. This is the default value. @@ -394,7 +430,6 @@ The LogLevel parameter specifies a logging level for the mailbox search. Valid v Type: LoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -404,6 +439,9 @@ Accept wildcard characters: False ``` ### -MessageTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MessageTypes parameter specifies the message types to include in the search query. Valid values are: - Contacts @@ -423,7 +461,6 @@ The default value is blank ($null), which means all message types are included. Type: KindKeyword[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -433,6 +470,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a name for the search. If the value contains spaces, enclose the value in quotation marks ("). The value of this parameter is used to create the top-level folder that holds the search results in the target mailbox that's specified by the TargetMailbox parameter. @@ -441,7 +481,6 @@ The value of this parameter is used to create the top-level folder that holds th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -451,6 +490,9 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Recipients parameter specifies one or more recipients include in the search query. Messages that have the specified recipients in the To, Cc, and Bcc fields are returned in the search results. You can specify multiple recipients separated by commas. If the value contains spaces, enclose the value in quotation marks ("). @@ -461,7 +503,6 @@ To clear the recipients, use the value $null. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -471,6 +512,9 @@ Accept wildcard characters: False ``` ### -SearchDumpster + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The SearchDumpster parameter specifies whether the dumpster is searched. The dumpster is a storage area in the mailbox where deleted items are temporarily stored after being deleted or removed from the Deleted Items folder, or after being hard-deleted and before being purged from the mailbox based on Deleted Item Retention settings. @@ -481,7 +525,6 @@ Set the value to $true to enable searching the dumpster, or set to $false to dis Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -491,6 +534,9 @@ Accept wildcard characters: False ``` ### -SearchQuery + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). If you use this parameter with other search query parameters, the query combines these parameters by using the AND operator. @@ -507,7 +553,6 @@ The other search query parameters are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -517,6 +562,9 @@ Accept wildcard characters: False ``` ### -Senders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Senders parameter specifies one or more senders to include in the search query. Messages that have the specified sender are returned in the search results. Senders can include users, distribution groups (messages sent by members of the group), SMTP addresses, or domains. You can specify multiple senders separated by commas. If the value contains spaces, enclose the value in quotation marks ("). @@ -527,7 +575,6 @@ To clear the senders, use the value $null. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -537,6 +584,9 @@ Accept wildcard characters: False ``` ### -SourceMailboxes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceMailboxes parameter specifies the mailboxes to be searched. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -561,7 +611,6 @@ To enable In-Place Hold on the search results, you need to set the AllSourceMail Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -571,6 +620,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -581,7 +633,6 @@ To clear start date, use the value $null. Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -591,13 +642,15 @@ Accept wildcard characters: False ``` ### -StatisticsStartIndex + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StatisticsStartIndex parameter is used by the Exchange admin center (EAC) to retrieve keyword statistics in a paged operation. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -607,6 +660,9 @@ Accept wildcard characters: False ``` ### -StatusMailRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StatusMailRecipients parameter specifies one or more recipients to receive a status email message upon completion of the search. You can use any value that uniquely identifies the recipient. For example: - Name @@ -622,7 +678,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -632,6 +687,9 @@ Accept wildcard characters: False ``` ### -TargetMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetMailbox parameter specifies the destination mailbox where the search results are copied. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -649,7 +707,6 @@ The TargetMailbox parameter specifies the destination mailbox where the search r Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -659,13 +716,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSentItemsConfiguration.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxSentItemsConfiguration.md index fc78cfa732..144b54ea09 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSentItemsConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxsentitemsconfiguration applicable: Exchange Server 2010 -title: Set-MailboxSentItemsConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxsentitemsconfiguration +schema: 2.0.0 +title: Set-MailboxSentItemsConfiguration --- # Set-MailboxSentItemsConfiguration @@ -47,6 +48,9 @@ This example configures the shared mailbox named "Customer Support Feedback" so ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -56,7 +60,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the mailbox whose Sent Items configuration you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -99,7 +107,6 @@ The Identity parameter specifies the mailbox whose Sent Items configuration you Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -SendAsItemsCopiedTo + +> Applicable: Exchange Server 2010 + The SendAsItemsCopiedTo parameter specifies where messages that are sent from the mailbox using Send As permission are saved. Valid values are: - Sender: Messages sent from the mailbox are saved in the Sent Items folder of the user who sent the message. This is the default value. @@ -118,7 +128,6 @@ The SendAsItemsCopiedTo parameter specifies where messages that are sent from th Type: SentItemsCopiedTo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -SendOnBehalfOfItemsCopiedTo + +> Applicable: Exchange Server 2010 + The SendOnBehalfOfItemsCopiedTo parameter specifies where messages that are sent from the mailbox using Send On Behalf Of permission are saved. Valid values are: - Sender: Messages sent from the mailbox are saved in the Sent Items folder of the user who sent the message. This is the default value. @@ -137,7 +149,6 @@ The SendOnBehalfOfItemsCopiedTo parameter specifies where messages that are sent Type: SentItemsCopiedTo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxServer.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-MailboxServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxServer.md index 1e8ce40d3a..bed67ec315 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxserver +schema: 2.0.0 +title: Set-MailboxServer --- # Set-MailboxServer @@ -193,6 +194,9 @@ In Exchange 2010, this example throttles the TopN Words Assistant and the Unifie ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Mailbox server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -203,7 +207,6 @@ The Identity parameter specifies the Mailbox server that you want to modify. You Type: MailboxServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -213,13 +216,15 @@ Accept wildcard characters: False ``` ### -AutoDagServerConfigured + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -229,6 +234,9 @@ Accept wildcard characters: False ``` ### -AutoDatabaseMountDial + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDatabaseMountDial parameter specifies the automatic database mount behavior for a continuous replication environment after a database failover on the Mailbox server. You can use the following values: - BestAvailability: The database automatically mounts immediately after a failover if the copy queue length is less than or equal to 12. The copy queue length is the number of logs recognized by the passive copy that needs to be replicated. If the copy queue length is more than 12, the database doesn't automatically mount. When the copy queue length is less than or equal to 12, Exchange attempts to replicate the remaining logs to the passive copy and mounts the database. @@ -241,7 +249,6 @@ The default value is GoodAvailability. If you specify either BestAvailability or Type: AutoDatabaseMountDial Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,6 +258,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairIntervalEndWindow + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarRepairIntervalEndWindow parameter specifies the number of days into the future to repair calendar items in mailboxes on the Mailbox server. The default value in Exchange 2016 and Exchange 2019 is 7. This value means the Calendar Repair Assistant repairs meetings in calendars up to 7 days from now. Meetings that are scheduled to occur more than 7 days in the future aren't repaired. @@ -261,7 +271,6 @@ The default value in Exchange 2013 and Exchange 2010 is 30. This value means the Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -271,6 +280,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairLogDirectorySizeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarRepairLogDirectorySizeLimit parameter specifies the maximum size of calendar repair log directory on the Mailbox server. When the directory reaches its maximum size, the server deletes the oldest log files first. Calendar repair log files begin with the name prefix CRA. The maximum size of the calendar repair log directory is calculated as the total size of all log files that have the CRA name prefix. Other files aren't counted in the total directory size calculation. Renaming old log files or copying other files into the calendar repair log directory could cause the directory to exceed its specified maximum size. @@ -293,7 +305,6 @@ If you enter the value unlimited, no size limit is imposed on the calendar repai Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -303,6 +314,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarRepairLogEnabled parameter specifies whether the Calendar Repair Attendant logs items that it repairs on the Mailbox server. The repair log doesn't contain failed repair attempts. Valid input for this parameter is $true or $false. The default value is $true. @@ -318,7 +332,6 @@ The value of this parameter affects the following parameters: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -328,6 +341,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairLogFileAgeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarRepairLogFileAgeLimit parameter specifies the calendar repair log maximum file age on the Mailbox server. Log files older than the specified value are deleted. The default value is 10 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -338,7 +354,6 @@ For example, to specify 30 days, enter 30.00:00:00. The value 00:00:00 prevents Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -348,13 +363,15 @@ Accept wildcard characters: False ``` ### -CalendarRepairLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarRepairLogPath parameter specifies the location of the calendar repair log files on the Mailbox server. The default value is %ExchangeInstallPath%Logging\\Calendar Repair Assistant. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -364,13 +381,15 @@ Accept wildcard characters: False ``` ### -CalendarRepairLogSubjectLoggingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarRepairLogSubjectLoggingEnabled parameter specifies whether to include the subject of repaired calendar items in the calendar repair log on the Mailbox server. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -380,13 +399,15 @@ Accept wildcard characters: False ``` ### -CalendarRepairMissingItemFixDisabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarRepairMissingItemFixDisabled parameter specifies whether the Calendar Repair Assistant won't fix missing calendar items in mailboxes on the Mailbox server.Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -396,13 +417,15 @@ Accept wildcard characters: False ``` ### -CalendarRepairMode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarRepairMode parameter specifies the Calendar Repair Assistant mode on the Mailbox server. Valid values for this parameter are ValidateOnly or RepairAndValidate. The default value is RepairAndValidate. ```yaml Type: CalendarRepairType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -412,6 +435,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairSchedule + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CalendarRepairSchedule parameter specifies the intervals each week during which the Calendar Repair Assistant applies checks for calendar failures. @@ -441,7 +467,6 @@ Here are some examples: Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -451,6 +476,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The CalendarRepairWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be scanned by the Calendar Repair Assistant. The default value is 1 day. @@ -465,7 +493,6 @@ For example, to specify 2 days for this parameter, use 2.00:00:00. The Calendar Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -475,6 +502,9 @@ Accept wildcard characters: False ``` ### -CalendarRepairWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The CalendarRepairWorkCycleCheckpoint parameter specifies the time span at which all mailboxes on the Mailbox server will be identified as needing work completed on them. The default value is 1 day. @@ -487,7 +517,6 @@ For example, to specify 2 days for this parameter, use 2.00:00:00. The Calendar Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -497,6 +526,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -506,7 +538,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -516,6 +547,9 @@ Accept wildcard characters: False ``` ### -DarTaskStoreTimeBasedAssistantWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -524,7 +558,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -534,6 +567,9 @@ Accept wildcard characters: False ``` ### -DarTaskStoreTimeBasedAssistantWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -542,7 +578,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -552,6 +587,9 @@ Accept wildcard characters: False ``` ### -DatabaseCopyActivationDisabledAndMoveNow + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DatabaseCopyActivationDisabledAndMoveNow parameter specifies whether to prevent databases from being mounted on this Mailbox server if there are other healthy copies of the databases on other Mailbox servers. It will also immediately move any mounted databases on the server to other servers if copies exist and are healthy. Valid input for this parameter is $true or $false. The default value is $false. @@ -562,7 +600,6 @@ Setting this parameter to $true won't cause databases to move to a server that h Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -572,6 +609,9 @@ Accept wildcard characters: False ``` ### -DatabaseCopyAutoActivationPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DatabaseCopyAutoActivationPolicy parameter specifies the type of automatic activation available for mailbox database copies on the specified Mailbox server. Valid values for this parameter are: - Blocked: Databases can't be automatically activated on the specified Mailbox server. In Exchange 2013 prior to Cumulative Update 7 (CU7), this setting stops server locator requests to the specified server, which prevents all client access to manually activated databases on the server if all DAG members are configured with a value of Blocked. In Exchange 2013 CU7 or later versions of Exchange, server locator requests are sent to a blocked server if no other Mailbox servers are available, thus client access is not impacted. @@ -582,7 +622,6 @@ The DatabaseCopyAutoActivationPolicy parameter specifies the type of automatic a Type: DatabaseCopyAutoActivationPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -592,6 +631,9 @@ Accept wildcard characters: False ``` ### -DirectoryProcessorWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -600,7 +642,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -610,6 +651,9 @@ Accept wildcard characters: False ``` ### -DirectoryProcessorWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -618,7 +662,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -628,13 +671,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -644,13 +689,15 @@ Accept wildcard characters: False ``` ### -FaultZone + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -660,6 +707,9 @@ Accept wildcard characters: False ``` ### -FolderLogForManagedFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The FolderLogForManagedFoldersEnabled parameter specifies whether managed folder logging is enabled on the Mailbox server. Valid input for this parameter is$true or $false. The default value is $false. @@ -680,7 +730,6 @@ The value of this parameter affects the following parameters: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -690,6 +739,9 @@ Accept wildcard characters: False ``` ### -ForceGroupMetricsGeneration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ForceGroupMetricsGeneration parameter specifies that group metrics information must be generated on the Mailbox server regardless of whether that server generates an offline address book (OAB). Valid input for this parameter is $true or $false. The default value is $false. By default, group metrics are generated only on servers that generate OABs. Group metrics information is used by MailTips to inform senders about how many recipients their messages will be sent to. You need to set this parameter to $true if your organization doesn't generate OABs and you want the group metrics data to be available. @@ -698,7 +750,6 @@ By default, group metrics are generated only on servers that generate OABs. Grou Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -708,6 +759,9 @@ Accept wildcard characters: False ``` ### -GroupMailboxWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -716,7 +770,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -726,6 +779,9 @@ Accept wildcard characters: False ``` ### -GroupMailboxWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -734,7 +790,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -744,6 +799,9 @@ Accept wildcard characters: False ``` ### -GroupMetricsGenerationTime + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The GroupMetricsGenerationTime parameter specifies the time of day when group metrics data is generated on a Mailbox server. You must use the 24-hour clock notation (HH:MM) when specifying the generation time. @@ -752,7 +810,6 @@ The GroupMetricsGenerationTime parameter specifies the time of day when group me Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -762,6 +819,9 @@ Accept wildcard characters: False ``` ### -InferenceDataCollectionWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -770,7 +830,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -780,6 +839,9 @@ Accept wildcard characters: False ``` ### -InferenceDataCollectionWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -788,7 +850,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -798,6 +859,9 @@ Accept wildcard characters: False ``` ### -InferenceTrainingWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -806,7 +870,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -816,6 +879,9 @@ Accept wildcard characters: False ``` ### -InferenceTrainingWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -824,7 +890,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -834,6 +899,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogEnabled parameter enables or disables logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: @@ -845,7 +913,6 @@ The IrmLogEnabled parameter enables or disables logging of Information Rights Ma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -855,6 +922,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days. @@ -867,7 +937,6 @@ Setting the value of the IrmLogMaxAge parameter to 00:00:00 prevents the automat Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -877,6 +946,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 megabytes (MB). When you enter a value, qualify the value with one of the following units: @@ -895,7 +967,6 @@ The valid input range for either parameter is from 1 through 9223372036854775807 Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -905,6 +976,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -921,7 +995,6 @@ Unqualified values are treated as bytes. The value of the IrmLogMaxFileSize para Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -931,6 +1004,9 @@ Accept wildcard characters: False ``` ### -IrmLogPath + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IrmLogPath parameter specifies the default IRM log directory location. The default value is C:\\Program Files\\Microsoft\\Exchange Server\\ v14\\Logging\\IRMLogs. @@ -941,7 +1017,6 @@ If you set the value of the IrmLogPath parameter to $null, you effectively disab Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -951,6 +1026,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromProvisioning + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsExcludedFromProvisioning parameter specifies that the Mailbox server isn't considered by the OAB provisioning load balancer. Valid input for this parameter is $true or $false. The default value is $false. If you specify$true, the server won't be used for provisioning a new OAB or for moving existing OABs. @@ -959,7 +1037,6 @@ If you specify$true, the server won't be used for provisioning a new OAB or for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -969,6 +1046,9 @@ Accept wildcard characters: False ``` ### -JournalingLogForManagedFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The JournalingLogForManagedFoldersEnabled parameter specifies whether journaling activity is recorded in the managed folder log on the Mailbox server.Valid input for this parameter is$true or $false. The default value is $false. If you specify $true, information about messages that were journaled in managed folders is logged. The managed folder log directory is specified by the LogPathForManagedFolders parameter. @@ -977,7 +1057,6 @@ If you specify $true, information about messages that were journaled in managed Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -987,6 +1066,9 @@ Accept wildcard characters: False ``` ### -JunkEmailOptionsCommitterWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -995,7 +1077,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1005,6 +1086,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Locale parameter specifies the locale of the Mailbox server. A locale is a collection of language-related user preferences such as writing system, calendar, and date format. The following are examples: - en-US (English - United States) @@ -1021,7 +1105,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1031,6 +1114,9 @@ Accept wildcard characters: False ``` ### -LogDirectorySizeLimitForManagedFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The LogDirectorySizeLimitForManagedFolders parameter specifies the maximum size of all managed folder logs from a single mailbox database in the managed folder log directory on the Mailbox server. When a set of log files reaches its maximum size, the server deletes the oldest log files first. @@ -1053,7 +1139,6 @@ The default value is unlimited, which means no size limit is imposed on the mana Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1063,6 +1148,9 @@ Accept wildcard characters: False ``` ### -LogFileAgeLimitForManagedFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The LogFileAgeLimitForManagedFolders parameter specifies how long to retain managed folder logs on the Mailbox server. Log files older than the specified value are deleted. @@ -1075,7 +1163,6 @@ For example, to specify a 30 days, enter 30.00:00:00. The default value is 00:00 Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1085,6 +1172,9 @@ Accept wildcard characters: False ``` ### -LogFileSizeLimitForManagedFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The LogFileSizeLimitForManagedFolders parameter specifies the maximum size for each managed folder log file on the Mailbox server. When a log file reaches its maximum size, a new log file is created. The default value is 10 megabytes (MB). @@ -1105,7 +1195,6 @@ If you enter the value unlimited, no size limit is imposed on a managed folder l Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1115,6 +1204,9 @@ Accept wildcard characters: False ``` ### -LogPathForManagedFolders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The LogPathForManagedFolders parameter specifies the location of the managed folder log files on the Mailbox server. The default value is %ExchangeInstallPath%Logging\\ Managed Folder Assistant. @@ -1123,7 +1215,6 @@ The LogPathForManagedFolders parameter specifies the location of the managed fol Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1133,6 +1224,9 @@ Accept wildcard characters: False ``` ### -MailboxAssociationReplicationWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1141,7 +1235,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1151,6 +1244,9 @@ Accept wildcard characters: False ``` ### -MailboxAssociationReplicationWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1159,7 +1255,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1169,6 +1264,9 @@ Accept wildcard characters: False ``` ### -MailboxProcessorWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The MailboxProcessorWorkCycle parameter specifies how often to scan for locked mailboxes on the Mailbox server. The default value is 1 day. @@ -1179,7 +1277,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hou Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1189,6 +1286,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderAssistantSchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + **Note**: Although this parameter is available in Exchange 2016 and Exchange 2019, it's only used for coexistence with previous versions of Exchange. For more information, see [Configure and run the Managed Folder Assistant in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mrm/configure-managed-folder-assistant). The ManagedFolderAssistantSchedule parameter specifies the intervals each week during which the Managed Folder Assistant applies messaging records management (MRM) settings to managed folders in mailboxes on the Mailbox server. @@ -1220,7 +1320,6 @@ If the Managed Folder Assistant doesn't finish processing the mailboxes on the s Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1230,6 +1329,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The ManagedFolderWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be processed by the Managed Folder Assistant. The default value is 1 day. @@ -1244,7 +1346,6 @@ For example, to specify 2 days for this parameter, use 2.00:00:00. The Managed F Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1254,6 +1355,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The ManagedFolderWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 1 day. @@ -1268,7 +1372,6 @@ For example, to specify 2 days for this parameter, use 2.00:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1278,13 +1381,15 @@ Accept wildcard characters: False ``` ### -MAPIEncryptionRequired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MAPIEncryptionRequired parameter specifies whether Exchange blocks MAPI client connections to the Mailbox server that don't use encrypted remote procedure calls (RPCs). Valid input for this parameter is$true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1294,6 +1399,9 @@ Accept wildcard characters: False ``` ### -MaximumActiveDatabases + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaximumActiveDatabases parameter specifies the maximum number of databases that can be mounted on the Mailbox server. When the maximum number is reached, the database copies on the server won't be activated if a failover or switchover occurs. If the copies are already active on a server, the Information Store on the server won't allow databases to be mounted. @@ -1304,7 +1412,6 @@ The default value is blank ($null), which means no maximum value is configured. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1314,6 +1421,9 @@ Accept wildcard characters: False ``` ### -MaximumPreferredActiveDatabases + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaximumPreferredActiveDatabases parameter specifies a preferred maximum number of databases that theMailbox server should have. This value is different from the actual maximum, which is configured using the MaximumActiveDatabases parameter. The value of MaximumPreferredActiveDatabases is only honored during best copy and server selection, database and server switchovers, and when rebalancing the DAG. The default value is blank ($null), which means no maximum value is configured. @@ -1322,7 +1432,6 @@ The default value is blank ($null), which means no maximum value is configured. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1332,6 +1441,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogEnabled parameter specifies whether message tracking is enabled. The default value is $true. @@ -1340,7 +1452,6 @@ The MessageTrackingLogEnabled parameter specifies whether message tracking is en Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1350,6 +1461,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxAge + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogMaxAge parameter specifies the message tracking log maximum file age. Log files older than the specified value are deleted. The default value is 30 days. @@ -1362,7 +1476,6 @@ The valid input range for this parameter is 00:00:00 to 24855.03:14:07. Setting Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1372,6 +1485,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxDirectorySize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogMaxDirectorySize parameter specifies the maximum size of the message tracking log directory. When the maximum directory size is reached, the server deletes the oldest log files first. @@ -1394,7 +1510,6 @@ Unqualified values are treated as bytes. The value of the MessageTrackingLogMaxF Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1404,6 +1519,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxFileSize + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogMaxFileSize parameter specifies the maximum size of the message tracking log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1419,7 +1537,6 @@ Unqualified values are treated as bytes. The value of the MessageTrackingLogMaxF Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1429,6 +1546,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogPath + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogPath parameter specifies the location of the message tracking logs. The default location is C:\\Program Files\\Microsoft\\Exchange Server TransportRoles\\Logs\\MessageTracking. If you set the value of the MessageTrackingLogPath parameter to $null, you effectively disable message tracking. However, if you set the value of the MessageTrackingLogPath parameter to $null when the value of the MessageTrackingLogEnabled attribute is $true, event log errors occur. The preferred method to disable message tracking is to use the MessageTrackingLogEnabled parameter. @@ -1437,7 +1557,6 @@ The MessageTrackingLogPath parameter specifies the location of the message track Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1447,6 +1566,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogSubjectLoggingEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MessageTrackingLogSubjectLoggingEnabled parameter specifies if the message subject should be included in the message tracking log. The default value is $true. @@ -1455,7 +1577,6 @@ The MessageTrackingLogSubjectLoggingEnabled parameter specifies if the message s Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1465,13 +1586,15 @@ Accept wildcard characters: False ``` ### -MigrationLogFilePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1481,13 +1604,15 @@ Accept wildcard characters: False ``` ### -MigrationLogLoggingLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: MigrationEventType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1497,13 +1622,15 @@ Accept wildcard characters: False ``` ### -MigrationLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1513,13 +1640,15 @@ Accept wildcard characters: False ``` ### -MigrationLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1529,13 +1658,15 @@ Accept wildcard characters: False ``` ### -MigrationLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1545,6 +1676,9 @@ Accept wildcard characters: False ``` ### -OABGeneratorWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The OABGeneratorWorkCycle parameter specifies the time span in which the OAB generation on the Mailbox server will be processed. The default value is 8 hours. @@ -1557,7 +1691,6 @@ For example, to specify 16 hours for this parameter, use 16:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1567,6 +1700,9 @@ Accept wildcard characters: False ``` ### -OABGeneratorWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The OABGeneratorWorkCycleCheckpoint parameter specifies the time span at which to run OAB generation on the Mailbox server. The default value is 1 hour. @@ -1579,7 +1715,6 @@ For example, to specify 2 hours for this parameter, use 02:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1589,6 +1724,9 @@ Accept wildcard characters: False ``` ### -PeopleCentricTriageWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1597,7 +1735,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1607,6 +1744,9 @@ Accept wildcard characters: False ``` ### -PeopleCentricTriageWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1615,7 +1755,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1625,6 +1764,9 @@ Accept wildcard characters: False ``` ### -PeopleRelevanceWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1633,7 +1775,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1643,6 +1784,9 @@ Accept wildcard characters: False ``` ### -PeopleRelevanceWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1651,7 +1795,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1661,6 +1804,9 @@ Accept wildcard characters: False ``` ### -ProbeTimeBasedAssistantWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1669,7 +1815,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1679,6 +1824,9 @@ Accept wildcard characters: False ``` ### -ProbeTimeBasedAssistantWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1687,7 +1835,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1697,6 +1844,9 @@ Accept wildcard characters: False ``` ### -PublicFolderWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The PublicFolderWorkCycle parameter is used by the public folder assistant to determine how often the mailboxes in a database are processed by the assistant on the Mailbox server. The default value is 1 day. @@ -1707,7 +1857,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hou Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1717,6 +1866,9 @@ Accept wildcard characters: False ``` ### -PublicFolderWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The PublicFolderWorkCycleCheckpoint determines how often the mailbox list for a database is evaluated on the Mailbox server. The processing speed is also calculated. The default value is 1 day. @@ -1727,7 +1879,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hou Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1737,6 +1888,9 @@ Accept wildcard characters: False ``` ### -RetentionLogForManagedFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The RetentionLogForManagedFoldersEnabled parameter specifies whether retention policy activity is recorded in the managed folder log on the Mailbox server. Valid input for this parameter is$true or $false. The default value is $false. @@ -1747,7 +1901,6 @@ If you specify $true, information about messages in managed folders that have be Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1757,6 +1910,9 @@ Accept wildcard characters: False ``` ### -SearchIndexRepairTimeBasedAssistantWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1765,7 +1921,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1775,6 +1930,9 @@ Accept wildcard characters: False ``` ### -SearchIndexRepairTimeBasedAssistantWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1783,7 +1941,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1793,6 +1950,9 @@ Accept wildcard characters: False ``` ### -SharePointSignalStoreWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1801,7 +1961,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1811,6 +1970,9 @@ Accept wildcard characters: False ``` ### -SharePointSignalStoreWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -1819,7 +1981,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1829,6 +1990,9 @@ Accept wildcard characters: False ``` ### -SharingPolicySchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SharingPolicySchedule parameter specifies the intervals each week during which the sharing policy runs on the Mailbox server. The Sharing Policy Assistant checks permissions on shared calendar items and contact folders in users' mailboxes against the assigned sharing policy. The assistant lowers or removes permissions according to the policy. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. @@ -1856,7 +2020,6 @@ Here are some examples: Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1866,6 +2029,9 @@ Accept wildcard characters: False ``` ### -SharingPolicyWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The SharingPolicyWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be scanned by the Sharing Policy Assistant. The default value is 1 day. @@ -1880,7 +2046,6 @@ For example, to specify 2 days for this parameter, use 2.00:00:00. The Sharing P Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1890,6 +2055,9 @@ Accept wildcard characters: False ``` ### -SharingPolicyWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The SharingPolicyWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 1 day. @@ -1904,7 +2072,6 @@ For example, to specify 2 days for this parameter, use 2.00:00:00. The Sharing P Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1914,6 +2081,9 @@ Accept wildcard characters: False ``` ### -SharingSyncWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The SharingSyncWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be synced to the cloud-based service by the Sharing Sync Assistant. The default value is 3 hours. @@ -1928,7 +2098,6 @@ For example, to specify 8 hours for this parameter, use 08:00:00. The Sharing Sy Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1938,6 +2107,9 @@ Accept wildcard characters: False ``` ### -SharingSyncWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The SharingSyncWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 3 hours. @@ -1952,7 +2124,6 @@ For example, to specify 8 hours for this parameter, use 08:00:00. The Sharing Sy Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1962,6 +2133,9 @@ Accept wildcard characters: False ``` ### -SiteMailboxWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The SiteMailboxWorkCycle parameter specifies the time span in which the site mailbox information on the Mailbox server will be processed. The default value is 6 hours. @@ -1974,7 +2148,6 @@ For example, to specify 8 hours for this parameter, use 08:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -1984,6 +2157,9 @@ Accept wildcard characters: False ``` ### -SiteMailboxWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. The SiteMailboxWorkCycleCheckpoint parameter specifies the time span at which to refresh the site mailbox workcycle on the Mailbox server. The default value is 6 hours. @@ -1996,7 +2172,6 @@ For example, to specify 8 hours for this parameter, use 08:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2006,6 +2181,9 @@ Accept wildcard characters: False ``` ### -StoreDsMaintenanceWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2014,7 +2192,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2024,6 +2201,9 @@ Accept wildcard characters: False ``` ### -StoreDsMaintenanceWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2032,7 +2212,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2042,6 +2221,9 @@ Accept wildcard characters: False ``` ### -StoreIntegrityCheckWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2050,7 +2232,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2060,6 +2241,9 @@ Accept wildcard characters: False ``` ### -StoreIntegrityCheckWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2068,7 +2252,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2078,6 +2261,9 @@ Accept wildcard characters: False ``` ### -StoreMaintenanceWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2086,7 +2272,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2096,6 +2281,9 @@ Accept wildcard characters: False ``` ### -StoreMaintenanceWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2104,7 +2292,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2114,6 +2301,9 @@ Accept wildcard characters: False ``` ### -StoreScheduledIntegrityCheckWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2122,7 +2312,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2132,6 +2321,9 @@ Accept wildcard characters: False ``` ### -StoreScheduledIntegrityCheckWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2140,7 +2332,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2150,6 +2341,9 @@ Accept wildcard characters: False ``` ### -StoreUrgentMaintenanceWorkCycle + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2158,7 +2352,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2168,6 +2361,9 @@ Accept wildcard characters: False ``` ### -StoreUrgentMaintenanceWorkCycleCheckpoint + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -2176,7 +2372,6 @@ This parameter is reserved for internal Microsoft use. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -2186,6 +2381,9 @@ Accept wildcard characters: False ``` ### -SubjectLogForManagedFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1). The SubjectLogForManagedFoldersEnabled parameter specifies whether to include the subject of messages in the managed folder logs on the Mailbox server. Valid input for this parameter is$true or $false. The default value is $false. @@ -2196,7 +2394,6 @@ By default, the subject of messages is blank in the managed folder log. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2206,13 +2403,15 @@ Accept wildcard characters: False ``` ### -SubmissionServerOverrideList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2222,6 +2421,9 @@ Accept wildcard characters: False ``` ### -TopNWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The TopNWorkCycle parameter specifies the time span in which all mailboxes that have Unified Messaging on the Mailbox server will be scanned by the TopN Words Assistant. The default value is 7 days. @@ -2236,7 +2438,6 @@ For example, to specify 10 days for this parameter, use 10.00:00:00. The TopN Wo Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2246,6 +2447,9 @@ Accept wildcard characters: False ``` ### -TopNWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The TopNWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 1 day. @@ -2260,7 +2464,6 @@ For example, to specify 2 days for this parameter, use 2.00:00:00. The TopN Word Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2270,6 +2473,9 @@ Accept wildcard characters: False ``` ### -UMReportingWorkCycle + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The UMReportingWorkCycle parameter specifies the time span in which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} on the Mailbox server will be scanned by the Unified Messaging Reporting Assistant. The default value is 1 day. @@ -2286,7 +2492,6 @@ Changing the default work cycle for this assistant might impact the performance Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2296,6 +2501,9 @@ Accept wildcard characters: False ``` ### -UMReportingWorkCycleCheckpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The UMReportingWorkCycleCheckpoint parameter specifies the time span at which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} on the Mailbox server will be marked by processing. The default value is 1 day. @@ -2308,7 +2516,6 @@ For example, to specify 2 days for this parameter, use 2.00:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2318,6 +2525,9 @@ Accept wildcard characters: False ``` ### -WacDiscoveryEndpoint + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The WacDiscoveryEndpoint parameter specifies the discovery endpoint for Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server) for all mailboxes on the server. For example, `https://oos.internal.contoso.com/hosting/discovery`. Office Online Server enables users to view supported file attachments in Outlook on the web (formerly known as Outlook Web App). @@ -2326,7 +2536,6 @@ Office Online Server enables users to view supported file attachments in Outlook Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2336,13 +2545,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSpellingConfiguration.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxSpellingConfiguration.md index 975a5bcb45..5dc0433512 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxSpellingConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxspellingconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MailboxSpellingConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxspellingconfiguration +schema: 2.0.0 +title: Set-MailboxSpellingConfiguration --- # Set-MailboxSpellingConfiguration @@ -54,6 +55,9 @@ This example sets the spelling checker to ignore words containing numbers for me ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -71,7 +75,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -CheckBeforeSend + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CheckBeforeSend parameter specifies whether Outlook on the web checks the spelling for every message when the user clicks Send in the new message form. Valid values are$true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -106,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -DictionaryLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DictionaryLanguage parameter specifies the dictionary language to use when the spelling checker checks the spelling in messages. Valid values are: - Arabic @@ -144,7 +154,6 @@ The DictionaryLanguage parameter specifies the dictionary language to use when t Type: SpellCheckerSupportedLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -162,7 +174,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -IgnoreMixedDigits + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreMixedDigits parameter specifies whether the spelling checker ignores words that contain numbers. Valid values are $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -IgnoreUppercase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreUppercase parameter specifies whether the spelling checker ignores words that contain only uppercase letters, for example, acronyms. Valid values are $true or $false. The default value is $false. @@ -196,7 +212,6 @@ Valid values are $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MailboxTransportService.md b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxTransportService.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-MailboxTransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MailboxTransportService.md index ae787b004f..1cd0ab0e6a 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxTransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MailboxTransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxtransportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MailboxTransportService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mailboxtransportservice +schema: 2.0.0 +title: Set-MailboxTransportService --- # Set-MailboxTransportService @@ -85,13 +86,15 @@ This example sets the ReceiveProtocolLogPath parameter to C:\\SMTP Protocol Logs ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server that you want to modify. ```yaml Type: MailboxTransportServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -110,7 +116,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxAge parameter specifies the maximum age for the connectivity log file. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -146,7 +156,6 @@ For example, to specify 25 days for this parameter, use 25.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,6 +165,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all connectivity logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 1000 MB. When you enter a value, qualify the value with one of the following units: @@ -174,7 +186,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxFileSize parameter specifies the maximum size of each connectivity log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -202,7 +216,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,13 +225,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\Connectivity. Setting the value of this parameter to $null disables connectivity logging. However, setting this parameter to $null when the value of the ConnectivityLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,6 +243,9 @@ Accept wildcard characters: False ``` ### -ContentConversionTracingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service or in the Mailbox Transport service on the Mailbox server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of email messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: - Administrators: Full Control @@ -238,7 +256,6 @@ The ContentConversionTracingEnabled parameter specifies whether content conversi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -248,13 +265,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -264,13 +283,15 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryAgentLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryAgentLogEnabled parameter specifies whether the agent log for the Mailbox Transport Delivery service is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryAgentLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryAgentLogMaxAge parameter specifies the maximum age for the agent log file of the Mailbox Transport Delivery service. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -290,7 +314,6 @@ Setting the value of the MailboxDeliveryAgentLogMaxAge parameter to 00:00:00 pre Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,6 +323,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryAgentLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryAgentLogMaxDirectorySize parameter specifies the maximum size of all Mailbox Transport Delivery service agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -318,7 +344,6 @@ The value of the MailboxDeliveryAgentLogMaxFileSize parameter must be less than Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -328,6 +353,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryAgentLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryAgentLogMaxFileSize parameter specifies the maximum size of each agent log file for the Mailbox Transport Delivery service. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -346,7 +374,6 @@ The value of the MailboxDeliveryAgentLogMaxFileSize parameter must be less than Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +383,15 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryAgentLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryAgentLogPath parameter specifies the default agent log directory location for the Mailbox Transport Delivery service. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\AgentLog\\Delivery. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the MailboxDeliveryAgentLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -372,13 +401,15 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryConnectorMaxInboundConnection + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryConnectorMaxInboundConnection parameter specifies the maximum number of inbound connections for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. The default value is 5000. If you enter the value unlimited, no connection limit is imposed on the mailbox delivery Receive connector. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -388,6 +419,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryConnectorProtocolLoggingLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. Valid values are: - None: Protocol logging is disabled for the mailbox delivery Receive connector. This is the default value. @@ -397,7 +431,6 @@ The MailboxDeliveryConnectorProtocolLoggingLevel parameter enables or disables S Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -407,6 +440,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryConnectorSmtpUtf8Enabled + +> Applicable: Exchange Server 2019 + The MailboxDeliveryConnectorSmtpUtf8Enabled parameters or disables email address internationalization (EAI) support for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. Valid values are: - $true: Mail can be delivered to local mailboxes that have international characters in email addresses. This is the default value @@ -416,7 +452,6 @@ The MailboxDeliveryConnectorSmtpUtf8Enabled parameters or disables email address Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -426,13 +461,15 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryThrottlingLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryThrottlingLogEnabled parameter specifies whether the mailbox delivery throttling log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -442,6 +479,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryThrottlingLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryThrottlingLogMaxAge parameter specifies the maximum age for the mailbox delivery throttling log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -452,7 +492,6 @@ Setting the value of the MailboxDeliveryThrottlingLogMaxAge parameter to 00:00:0 Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -462,6 +501,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryThrottlingLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryThrottlingLogMaxDirectorySize parameter specifies the maximum size of all mailbox delivery throttling logs in the mailbox delivery throttling log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 200 MB. When you enter a value, qualify the value with one of the following units: @@ -480,7 +522,6 @@ The value of the MailboxDeliveryThrottlingLogMaxFileSize parameter must be less Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -490,6 +531,9 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryThrottlingLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryThrottlingLogMaxFileSize parameter specifies the maximum size of each mailbox delivery throttling log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -508,7 +552,6 @@ The value of the MailboxDeliveryThrottlingLogMaxFileSize parameter must be less Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -518,13 +561,15 @@ Accept wildcard characters: False ``` ### -MailboxDeliveryThrottlingLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxDeliveryThrottlingLogPath parameter specifies the default mailbox delivery throttling log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Throttling\\Delivery. Setting the value of this parameter to $null disables mailbox delivery throttling logging. However, setting this parameter to $null when the value of the MailboxDeliveryThrottlingLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -534,13 +579,15 @@ Accept wildcard characters: False ``` ### -MailboxSubmissionAgentLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxSubmissionAgentLogEnabled parameter specifies whether the agent log is enabled for the Mailbox Transport Submission service. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -550,6 +597,9 @@ Accept wildcard characters: False ``` ### -MailboxSubmissionAgentLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxSubmissionAgentLogMaxAge parameter specifies the maximum age for the agent log file of the Mailbox Transport Submission service. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -560,7 +610,6 @@ Setting the value of the MailboxSubmissionAgentLogMaxAge parameter to 00:00:00 p Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -570,6 +619,9 @@ Accept wildcard characters: False ``` ### -MailboxSubmissionAgentLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxSubmissionAgentLogMaxDirectorySize parameter specifies the maximum size of all Mailbox Transport Submission service agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -588,7 +640,6 @@ The value of the MailboxSubmissionAgentLogMaxFileSize parameter must be less tha Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -598,6 +649,9 @@ Accept wildcard characters: False ``` ### -MailboxSubmissionAgentLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxSubmissionAgentLogMaxFileSize parameter specifies the maximum size of each agent log file for the Mailbox Transport Submission service. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -616,7 +670,6 @@ The value of the MailboxSubmissionAgentLogMaxFileSize parameter must be less tha Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -626,13 +679,15 @@ Accept wildcard characters: False ``` ### -MailboxSubmissionAgentLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxSubmissionAgentLogPath parameter specifies the default agent log directory location for the Mailbox Transport Submission service. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\AgentLog\\Submission. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the MailboxSubmissionAgentLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -642,13 +697,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxDeliveries + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConcurrentMailboxDeliveries parameter specifies the maximum number of delivery threads that the transport service can have open at the same time to deliver messages to mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. We recommend that you don't modify the default value unless Microsoft Customer Service and Support advises you to do this. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -658,13 +715,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxSubmissions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConcurrentMailboxSubmissions parameter specifies the maximum number of submission threads that the transport service can have open at the same time to send messages from mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -674,13 +733,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipelineTracingEnabled parameter specifies whether to enable pipeline tracing. Pipeline tracing captures message snapshot files that record the changes made to the message by each transport agent configured in the transport service on the server. Pipeline tracing creates verbose log files that accumulate quickly. Pipeline tracing should only be enabled for a short time to provide in-depth diagnostic information that enables you to troubleshoot problems. In addition to troubleshooting, you can use pipeline tracing to validate changes that you make to the configuration of the transport service where you enable pipeline tracing. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -690,6 +751,9 @@ Accept wildcard characters: False ``` ### -PipelineTracingPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipelineTracingPath parameter specifies the location of the pipeline tracing logs. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\PipelineTracing. The path must be local to the Exchange server. Setting this parameter to the value $null disables pipeline tracing. However, setting this parameter to $null when the value of the PipelineTracingEnabled attribute is $true generates event log errors. The preferred method to disable pipeline tracing is to use the PipelineTracingEnabled parameter. @@ -704,7 +768,6 @@ Pipeline tracing captures the complete contents of email messages to the path sp Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -714,13 +777,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingSenderAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipelineTracingSenderAddress parameter specifies the sender email address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -730,6 +795,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxAge parameter specifies the maximum age of a protocol log file for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. Log files that are older than the specified value are automatically deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -744,7 +812,6 @@ This parameter is only meaningful when the MailboxDeliveryConnectorProtocolLoggi Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -754,6 +821,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -776,7 +846,6 @@ This parameter is only meaningful when the MailboxDeliveryConnectorProtocolLoggi Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -786,6 +855,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -808,7 +880,6 @@ This parameter is only meaningful when the MailboxDeliveryConnectorProtocolLoggi Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -818,6 +889,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogPath parameter specifies the location of the protocol log directory for the implicit and invisible mailbox delivery Receive connector in the Mailbox Transport Delivery service. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\ProtocolLog\\SmtpReceive. The log files are automatically stored in the Delivery subdirectory. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for the mailbox delivery Receive connector. To disable protocol logging for this connector, use the value None for the MailboxDeliveryConnectorProtocolLoggingLevel parameter. @@ -826,7 +900,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -836,6 +909,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxAge + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogMaxAge parameter specifies the maximum routing table log age. Log files older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -846,7 +922,6 @@ For example, to specify 5 days for this parameter, use 5.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -856,6 +931,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxDirectorySize + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the routing table log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -874,7 +952,6 @@ The valid input range for this parameter is from 1 through 9223372036854775807 b Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -884,13 +961,15 @@ Accept wildcard characters: False ``` ### -RoutingTableLogPath + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\Routing. Setting this parameter to $null disables routing table logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -900,6 +979,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxAge parameter specifies the maximum age of a protocol log file for the implicit and invisible intra-organization Send connector in the Mailbox Transport Submission service. Log files that are older than the specified value are automatically deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -912,7 +994,6 @@ This parameter is only meaningful when the IntraOrgConnectorProtocolLoggingLevel Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -922,6 +1003,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory for the implicit and invisible intra-organization Send connector in the Mailbox Transport Submission service. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -944,7 +1028,6 @@ This parameter is only meaningful when the IntraOrgConnectorProtocolLoggingLevel Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -954,6 +1037,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file for the implicit and invisible intra-organization Send connector in the Mailbox Transport Submission service. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -976,7 +1062,6 @@ This parameter is only meaningful when the IntraOrgConnectorProtocolLoggingLevel Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -986,6 +1071,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogPath parameter specifies the location of the protocol log directory for the implicit and invisible intra-organization Send connector in the Mailbox Transport Submission service. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\ProtocolLog\\SmtpSend. Log files are automatically stored in the following subdirectories: - Submission: Protocol log files for the intra-organization Send connector in the Mailbox Transport Submission service. @@ -997,7 +1085,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1007,13 +1094,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterPolicy.md index 97910b18d9..9dc6e6811f 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-malwarefilterpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MalwareFilterPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-malwarefilterpolicy +schema: 2.0.0 +title: Set-MalwareFilterPolicy --- # Set-MalwareFilterPolicy @@ -102,6 +103,9 @@ The last two commands remove the seventh file type that's displayed in the list. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter policy you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -112,7 +116,6 @@ The Identity parameter specifies the malware filter policy you want to modify. Y Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -122,6 +125,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Action parameter specifies the action to take when malware is detected in a message. Valid values are: @@ -134,7 +140,6 @@ The Action parameter specifies the action to take when malware is detected in a Type: MalwareFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +149,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,6 +167,9 @@ Accept wildcard characters: False ``` ### -BypassInboundMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BypassInboundMessages parameter enables or disables malware filtering on incoming messages (messages entering the organization). Valid values are: @@ -171,7 +181,6 @@ The BypassInboundMessages parameter enables or disables malware filtering on inc Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -BypassOutboundMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The BypassOutboundMessages parameter enables or disables malware filtering on outgoing messages (messages leaving the organization). Valid values are: @@ -192,7 +204,6 @@ The BypassOutboundMessages parameter enables or disables malware filtering on ou Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -211,7 +225,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -221,6 +234,9 @@ Accept wildcard characters: False ``` ### -CustomAlertText + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). @@ -231,7 +247,6 @@ This parameter is meaningful only when the value of the Action parameter is Dele Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +256,9 @@ Accept wildcard characters: False ``` ### -CustomExternalBody + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomExternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -252,7 +270,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -262,6 +279,9 @@ Accept wildcard characters: False ``` ### -CustomExternalSubject + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomExternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -273,7 +293,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -283,6 +302,9 @@ Accept wildcard characters: False ``` ### -CustomFromAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomFromAddress parameter specifies the custom From address to use in notification messages for malware detections in messages from internal or external senders. This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -296,7 +318,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -306,6 +327,9 @@ Accept wildcard characters: False ``` ### -CustomFromName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomFromName parameter specifies the custom From name to use in notification messages for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -319,7 +343,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -329,6 +352,9 @@ Accept wildcard characters: False ``` ### -CustomInternalBody + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomInternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -340,7 +366,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -350,6 +375,9 @@ Accept wildcard characters: False ``` ### -CustomInternalSubject + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomInternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: @@ -361,7 +389,6 @@ This parameter is meaningful only when the value of the CustomNotifications para Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -371,6 +398,9 @@ Accept wildcard characters: False ``` ### -CustomNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomNotifications parameter enables or disables the customization of notification messages for malware detections. Valid values are: - $true: Replace the default values used in notification messages with the values of the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. @@ -387,7 +417,6 @@ This parameter is meaningful only when the value of at least one of the followin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -397,6 +426,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -405,7 +437,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -415,6 +446,9 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderAdminNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: - $true: When malware attachments are detected in messages from external senders, a notification messages is sent to the email address that's specified by the ExternalSenderAdminAddress parameter. @@ -426,7 +460,6 @@ The EnableExternalSenderAdminNotifications parameter enables or disables sending Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -436,6 +469,9 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EnableExternalSenderNotifications parameter enables or disables sending notification messages to external senders for malware detections in their messages. Valid values are: @@ -447,7 +483,6 @@ The EnableExternalSenderNotifications parameter enables or disables sending noti Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -457,6 +492,9 @@ Accept wildcard characters: False ``` ### -EnableFileFilter + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The EnableFileFilter parameter enables or disables the common attachments filter (also known as common attachment blocking). Valid values are: @@ -472,7 +510,6 @@ You specify the action for detected files using the FileTypeAction parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -482,6 +519,9 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderAdminNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The EnableInternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: - $true: When malware attachments are detected in messages from internal senders, a notification messages is sent to the email address that's specified by the InternalSenderAdminAddress parameter. @@ -493,7 +533,6 @@ The EnableInternalSenderAdminNotifications parameter enables or disables sending Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -503,6 +542,9 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderNotifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EnableInternalSenderNotifications parameter enables or disables sending notification messages to internal senders for malware detections in their messages. Valid values are: @@ -514,7 +556,6 @@ The EnableInternalSenderNotifications parameter enables or disables sending noti Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -524,6 +565,9 @@ Accept wildcard characters: False ``` ### -ExternalSenderAdminAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from external senders. This parameter is meaningful only if the value of the EnableExternalSenderAdminNotifications parameter is $true. @@ -532,7 +576,6 @@ This parameter is meaningful only if the value of the EnableExternalSenderAdminN Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -542,6 +585,9 @@ Accept wildcard characters: False ``` ### -FileTypeAction + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The FileTypeAction parameter specifies what happens to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: @@ -555,7 +601,6 @@ This parameter is meaningful only when the value of the EnableFileFilter paramet Type: FileTypeFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -565,6 +610,9 @@ Accept wildcard characters: False ``` ### -FileTypes + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The FileTypes parameter specifies the file types that are automatically blocked by the common attachments filter, regardless of content. The default values are: @@ -583,7 +631,6 @@ To add or remove file types without affecting the other file type entries, see t Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -593,6 +640,9 @@ Accept wildcard characters: False ``` ### -InternalSenderAdminAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The InternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from internal senders. This parameter is meaningful only if the value of the EnableInternalSenderAdminNotifications parameter is $true. @@ -601,7 +651,6 @@ This parameter is meaningful only if the value of the EnableInternalSenderAdminN Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -611,13 +660,15 @@ Accept wildcard characters: False ``` ### -IsPolicyOverrideApplied + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -627,6 +678,9 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MakeDefault switch makes this malware filter policy the default policy. You don't need to specify a value with this switch. The default malware filter policy has no recipient filters (is applied to everyone) and has the Priority value Lowest. @@ -635,7 +689,6 @@ The default malware filter policy has no recipient filters (is applied to everyo Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -645,6 +698,9 @@ Accept wildcard characters: False ``` ### -QuarantineTag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware. You can use any value that uniquely identifies the quarantine policy. For example: @@ -663,7 +719,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -673,13 +728,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -689,6 +746,9 @@ Accept wildcard characters: False ``` ### -ZapEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The ZapEnabled parameter enables or disables zero-hour auto purge (ZAP) for malware in cloud mailboxes. ZAP detects malware in unread messages that have already been delivered to the user's Inbox. Valid values are: @@ -700,7 +760,6 @@ The ZapEnabled parameter enables or disables zero-hour auto purge (ZAP) for malw Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterRule.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-MalwareFilterRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterRule.md index 9589a6fc72..92dce6658f 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilterRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MalwareFilterRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-malwarefilterrule +schema: 2.0.0 +title: Set-MalwareFilterRule --- # Set-MalwareFilterRule @@ -56,13 +57,15 @@ This example adds an exception to the malware filter rule named Contoso Recipien ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the malware filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID, or distinguished name (DN) of the malware filter rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -115,7 +125,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -141,6 +152,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -156,7 +170,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -183,7 +199,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -193,6 +208,9 @@ Accept wildcard characters: False ``` ### -MalwareFilterPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule. You can use any value that uniquely identifies the policy. For example: @@ -207,7 +225,6 @@ You can't specify the default malware filter policy, and you can't specify a pol Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -217,13 +234,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies a unique name for the malware filter rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +252,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -247,7 +269,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,13 +278,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -273,6 +296,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -288,7 +314,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -298,6 +323,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -315,7 +343,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -325,13 +352,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilteringServer.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilteringServer.md index b524b8fc9c..dc4dd0fd54 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MalwareFilteringServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-malwarefilteringserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MalwareFilteringServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-malwarefilteringserver +schema: 2.0.0 +title: Set-MalwareFilteringServer --- # Set-MalwareFilteringServer @@ -57,6 +58,9 @@ This example sets the following Malware agent settings on the Mailbox server nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server where you want to configure the anti-malware settings. You can use any value that uniquely identifies the server. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the server where you want to configure the anti Type: MalwareFilteringServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -BypassFiltering + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassFiltering parameter temporarily bypasses malware filtering without disabling the Malware agent on the server. The Malware agent is still active, and the agent is still called for every message, but no malware filtering is actually performed. This allows you to temporarily disable and then enable malware filtering on the server without disrupting mail flow by restarting the Microsoft Exchange Transport service. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -103,7 +111,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -DeferAttempts + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeferAttempts parameter specifies the maximum number of times to defer a message that can't be scanned by the Malware agent. Valid input for this parameter is an integer between 1 and 5. The default value is 3. After the maximum number of deferrals is reached, the action taken by the Malware agent depends on the error. For scan timeouts and engine errors, the action is to fail the message and return a non-delivery report (NDR) to the sender immediately after the last defer attempt. For all other errors, the message is retried for up to 48 hours, with each retry attempt taking place one hour longer than the last one. For example, starting after the last defer attempt, the first retry attempt will occur in 1 hour, the next retry attempt will occur 2 hours after that, the next retry attempt will occur 3 hours after the second retry attempt, and so on for up to 48 hours. After 48 hours have elapsed, the action is to fail the message and return a non-delivery report (NDR) to the sender. @@ -121,7 +131,6 @@ After the maximum number of deferrals is reached, the action taken by the Malwar Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -DeferWaitTime + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeferWaitTime parameter specifies the time period in minutes to increase the interval to resubmit messages for malware filtering in an effort to reduce the workload on the server. For example, the first retry after the original failed scan occurs after the interval specified by the DeferWaitTime parameter. The second retry after the first retry occurs after two times the value of the DeferWaitTime parameter. The third retry after the second retry occurs after three times the value of the DeferWaitTime parameter and so on. The maximum number of retries is controlled by the DeferAttempts parameter. @@ -141,7 +153,6 @@ Valid input for this parameter is an integer between 0 and 15. The default value Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -159,7 +173,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -ForceRescan + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ForceRescan parameter specifies that messages should be scanned by the malware agent, even if the message was already scanned by cloud-based protection. Valid values are: - $true: Messages from cloud-based organizations are scanned by the malware agent. @@ -178,7 +194,6 @@ The ForceRescan parameter specifies that messages should be scanned by the malwa Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -MinimumSuccessfulEngineScans + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -PrimaryUpdatePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PrimaryUpdatePath parameter specifies where to download malware scanning engine updates. The default value is `http://forefrontdl.microsoft.com/server/scanengineupdate`. The location specified by the PrimaryUpdatePath parameter is always tried first. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -220,13 +239,15 @@ Accept wildcard characters: False ``` ### -ScanErrorAction + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ScanErrorAction parameter specifies the action to take when a message can't be scanned by the malware filter. Valid values for this parameter are Block or Allow. The default value is Block. ```yaml Type: MalwareScanErrorAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,13 +257,15 @@ Accept wildcard characters: False ``` ### -ScanTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ScanTimeout parameter specifies the timeout interval in seconds for messages that can't be scanned by the malware filter. Valid input for this parameter is an integer between 10 and 900. The default value is 300 (5 minutes). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,6 +275,9 @@ Accept wildcard characters: False ``` ### -SecondaryUpdatePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SecondaryUpdatePath parameter specifies an alternate download location for malware scanning engine updates. The default values is blank ($null). This means no alternate download location is specified. The alternate download location is used when the location specified by the PrimaryUpdatePath parameter is unavailable for the time period specified by the UpdateTimeout parameter. On the next malware scanning engine update, the location specified by the PrimaryUpdate path parameter is tried first. @@ -260,7 +286,6 @@ The alternate download location is used when the location specified by the Prima Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,13 +295,15 @@ Accept wildcard characters: False ``` ### -UpdateFrequency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UpdateFrequency parameter specifies the frequency interval in minutes to check for malware scanning engine updates. Valid input for this parameter is an integer between 1 and 38880 (27 days). The default value is 60 (one hour). The locations to check for updates are specified by the PrimaryUpdatePath and SecondaryUpdatePath parameters. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -286,6 +313,9 @@ Accept wildcard characters: False ``` ### -UpdateTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UpdateTimeout parameter specifies the timeout interval in seconds to use when checking for malware scanning engine updates. Valid input for this parameter is an integer between 60 and 300. The default value is 150 seconds (2.5 minutes). If the location specified by the PrimaryUpdatePath parameter is unavailable for the time period specified by the UpdateTimeout parameter value, the location specified by the SecondaryUpdatePath parameter is used. @@ -294,7 +324,6 @@ If the location specified by the PrimaryUpdatePath parameter is unavailable for Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,13 +333,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedContentSettings.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-ManagedContentSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagedContentSettings.md index 9606389193..ddf16e2394 100644 --- a/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedContentSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managedcontentsettings applicable: Exchange Server 2010 -title: Set-ManagedContentSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managedcontentsettings +schema: 2.0.0 +title: Set-ManagedContentSettings --- # Set-ManagedContentSettings @@ -41,7 +42,7 @@ Set-ManagedContentSettings [-Identity] ## DESCRIPTION Managed content settings are settings that you apply to managed folders to control the lifespan of items in users' mailboxes. For more information about managed content settings, see [Messaging Records Management](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123507(v=exchg.141)). -Although the New-ManagedContentSettings cmdlet has the MessageClass parameter, the Set-ManagedContentSettings cmdlet doesn't. If you want to change the message type to which content settings apply, you must delete and then re-create the content settings. For more information about the MessageClass parameter, see [New-ManagedContentSettings](https://learn.microsoft.com/powershell/module/exchange/new-managedcontentsettings). +Although the New-ManagedContentSettings cmdlet has the MessageClass parameter, the Set-ManagedContentSettings cmdlet doesn't. If you want to change the message type to which content settings apply, you must delete and then re-create the content settings. For more information about the MessageClass parameter, see [New-ManagedContentSettings](https://learn.microsoft.com/powershell/module/exchangepowershell/new-managedcontentsettings). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -57,13 +58,15 @@ This example specifies the address of the journaling recipient that's the destin ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed content settings. ```yaml Type: ELCContentSettingsIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -AddressForJournaling + +> Applicable: Exchange Server 2010 + The AddressForJournaling parameter specifies the journaling recipient where journaled messages are sent. You can use any value that uniquely identifies the recipient. For example: - Name @@ -86,7 +92,6 @@ The AddressForJournaling parameter specifies the journaling recipient where jour Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -AgeLimitForRetention + +> Applicable: Exchange Server 2010 + The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date that the item was delivered or the date that an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. @@ -104,7 +112,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -123,7 +133,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -JournalingEnabled + +> Applicable: Exchange Server 2010 + The JournalingEnabled parameter specifies that journaling is enabled when it's set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -LabelForJournaling + +> Applicable: Exchange Server 2010 + The LabelForJournaling parameter specifies a label that's attached to an item. This label is used by the destination store to determine the content of the item and enforce the appropriate policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -181,6 +196,9 @@ Accept wildcard characters: False ``` ### -MessageFormatForJournaling + +> Applicable: Exchange Server 2010 + The MessageFormatForJournaling parameter specifies the format in which an item should be journaled in. You can use the following values: - UseMsg Microsoft Outlook .MSG format @@ -190,7 +208,6 @@ The MessageFormatForJournaling parameter specifies the format in which an item s Type: JournalingFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -200,13 +217,15 @@ Accept wildcard characters: False ``` ### -MoveToDestinationFolder + +> Applicable: Exchange Server 2010 + The MoveToDestinationFolder parameter specifies the name of the destination folder for a retention action. ```yaml Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -216,13 +235,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies a unique name for the managed content settings. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -232,6 +253,9 @@ Accept wildcard characters: False ``` ### -RetentionAction + +> Applicable: Exchange Server 2010 + The RetentionAction parameter specifies one of the following actions to take when an item reaches its retention age limit, specified by the AgeLimitForRetention parameter. The following retention actions can be used: - Mark as past retention limit @@ -246,7 +270,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -256,13 +279,15 @@ Accept wildcard characters: False ``` ### -RetentionEnabled + +> Applicable: Exchange Server 2010 + The RetentionEnabled parameter specifies that retention is enabled when it's set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -272,6 +297,9 @@ Accept wildcard characters: False ``` ### -TriggerForRetention + +> Applicable: Exchange Server 2010 + The TriggerForRetention parameter specifies the date that's considered as the start date of the retention period. An item can reach its retention limit a specific number of days after the item was delivered or after it was moved into a specific folder. Valid values include: @@ -285,7 +313,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionDateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -295,13 +322,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagedFolder.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolder.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-ManagedFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolder.md index aef4960fcd..a5a7ff9c53 100644 --- a/exchange/exchange-ps/exchange/Set-ManagedFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managedfolder applicable: Exchange Server 2010 -title: Set-ManagedFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managedfolder +schema: 2.0.0 +title: Set-ManagedFolder --- # Set-ManagedFolder @@ -55,13 +56,15 @@ This example sets the storage quota for the managed folder MyManagedFolder to 10 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder. ```yaml Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -BaseFolderOnly + +> Applicable: Exchange Server 2010 + The BaseFolderOnly parameter specifies whether the managed content settings should be applied only to the managed folder or to the folder and all its subfolders. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010 + The Comment parameter specifies the default administrator comment to be displayed with the folder in Microsoft Office Outlook 2007. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -112,7 +122,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -FolderName + +> Applicable: Exchange Server 2010 + The FolderName parameter specifies the name of the folder object as it appears in users' mailboxes. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -LocalizedComment + +> Applicable: Exchange Server 2010 + The LocalizedComment parameter specifies localized administrator comments and their languages. Localized comments are displayed instead of the default comment when the language setting of any client that displays comments matches a language specified for this parameter value. Comments must be in the form ISOLanguageCode:Comment, for example, -LocalizedComment EN-US:"This is a localized comment in U.S. English." ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -170,13 +185,15 @@ Accept wildcard characters: False ``` ### -LocalizedFolderName + +> Applicable: Exchange Server 2010 + The LocalizedFolderName parameter specifies localized folder names and their languages. Localized folder names are displayed instead of the default folder name when the language setting of Outlook 2007 matches a language specified for this parameter value. Comments must be in the form ISOLanguageCode:Comment, for example, -LocalizedFolderName EN-US:"This is a localized folder name in U.S. English." ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -186,13 +203,15 @@ Accept wildcard characters: False ``` ### -MustDisplayCommentEnabled + +> Applicable: Exchange Server 2010 + The MustDisplayCommentEnabled parameter specifies whether to set a flag that's used by any client that displays comments and accepts this setting. If this parameter is set to $true, a flag is set that prevents users from minimizing a folder comment, which is visible in Outlook 2007 only. If the parameter isn't present or is set to $false, users can minimize the comment. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -202,13 +221,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies a unique name for the content settings. The Name parameter doesn't appear in users' mailboxes. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -218,13 +239,15 @@ Accept wildcard characters: False ``` ### -StorageQuota + +> Applicable: Exchange Server 2010 + The StorageQuota parameter specifies the storage size limit for the mailbox folder. When the folder size exceeds this limit, no additional items may be added. Mailbox sizes can be specified in kilobytes (KB) or megabytes (MB), for example, as 100KB or 5MB. The StorageQuota parameter is valid for managed custom folders in Outlook 2007. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -234,13 +257,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolderMailboxPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolderMailboxPolicy.md index 4e82b118b4..ab10d066e9 100644 --- a/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagedFolderMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managedfoldermailboxpolicy applicable: Exchange Server 2010 -title: Set-ManagedFolderMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managedfoldermailboxpolicy +schema: 2.0.0 +title: Set-ManagedFolderMailboxPolicy --- # Set-ManagedFolderMailboxPolicy @@ -54,13 +55,15 @@ This example links the managed custom folders Custom Folder 1 and Custom Folder ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -79,7 +85,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -ManagedFolderLinks + +> Applicable: Exchange Server 2010 + The ManagedFolderLinks parameter specifies managed folders to which the managed folder mailbox policy is to be linked. The managed folders that you link to a policy appear in all mailboxes to which the policy is applied. ```yaml Type: ELCFolderIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies a unique name for the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -137,13 +148,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleAssignment.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleAssignment.md index 44d3d2ad77..0c8c86b88c 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleAssignment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managementroleassignment applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-ManagementRoleAssignment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managementroleassignment +schema: 2.0.0 +title: Set-ManagementRoleAssignment --- # Set-ManagementRoleAssignment @@ -140,13 +141,15 @@ This example restricts the Distribution Groups\_Cairns Admins role assignment us ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the management role assignment to modify. If the name of the management role contains spaces, enclose it in quotation marks ("). ```yaml Type: RoleAssignmentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -156,6 +159,9 @@ Accept wildcard characters: False ``` ### -RecipientAdministrativeUnitScope + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only in the cloud-based service. The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the role assignment to. @@ -168,7 +174,6 @@ You can't use this parameter with any of the other scope parameters. Type: AdministrativeUnitIdParameter Parameter Sets: RecipientAdministrativeUnitScope Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -178,6 +183,9 @@ Accept wildcard characters: False ``` ### -RecipientGroupScope + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecipientGroupScope parameter specifies a group to consider for scoping the role assignment. Individual members of the specified group (not nested groups) are considered as in scope for the assignment. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, or DisplayName. @@ -186,7 +194,6 @@ The RecipientGroupScope parameter specifies a group to consider for scoping the Type: GroupIdParameter Parameter Sets: RecipientGroupScope Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -196,6 +203,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -205,7 +215,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,6 +224,9 @@ Accept wildcard characters: False ``` ### -CustomConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CustomConfigWriteScope parameter specifies the existing configuration management scope to associate with this management role assignment. If the management scope name contains spaces, enclose it in quotation marks ("). @@ -227,7 +239,6 @@ To remove a scope, specify a value of $null. Type: ManagementScopeIdParameter Parameter Sets: RelativeRecipientWriteScope, CustomRecipientWriteScope, RecipientOrganizationalUnitScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,6 +248,9 @@ Accept wildcard characters: False ``` ### -CustomRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CustomRecipientWriteScope parameter specifies the existing recipient-based management scope to associate with this management role assignment. If the management scope name contains spaces, enclose it in quotation marks ("). If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope, RecipientRelativeWriteScope, or ExclusiveRecipientWriteScope parameters, and any configured OU or predefined scope on the role assignment is overwritten. @@ -247,7 +261,6 @@ To remove a scope, specify a value of $null. Type: ManagementScopeIdParameter Parameter Sets: CustomRecipientWriteScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -257,6 +270,9 @@ Accept wildcard characters: False ``` ### -CustomResourceScope + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The CustomResourceScope parameter specifies the custom management scope to associate with this management role assignment. You can use any value that uniquely identifies the management scope. For example: @@ -273,7 +289,6 @@ You use this parameter with the App parameter to assign permissions to service p Type: ManagementScopeIdParameter Parameter Sets: App Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -283,6 +298,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -291,7 +309,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: RelativeRecipientWriteScope, CustomRecipientWriteScope, RecipientOrganizationalUnitScope, ExclusiveScope, RecipientAdministrativeUnitScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -301,13 +318,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether the management role assignment is enabled or disabled. The valid values are $true and $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -317,6 +336,9 @@ Accept wildcard characters: False ``` ### -ExclusiveConfigWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ExclusiveConfigWriteScope parameter specifies the existing configuration exclusive management scope to associate with this management role assignment. If the management scope name contains spaces, enclose it in quotation marks ("). @@ -329,7 +351,6 @@ To remove a scope, specify a value of $null. Type: ManagementScopeIdParameter Parameter Sets: ExclusiveScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -339,6 +360,9 @@ Accept wildcard characters: False ``` ### -ExclusiveRecipientWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ExclusiveRecipientWriteScope parameter specifies the existing recipient-based exclusive management scope to associate with this management role assignment. If the management scope name contains spaces, enclose it in quotation marks ("). If you use the ExclusiveRecipientWriteScope parameter, you can't use the CustomRecipientWriteScope, RecipientOrganizationalUnitScope, or RecipientRelativeWriteScope parameters and any configured OU or predefined scope on the role assignment is overwritten. @@ -349,7 +373,6 @@ To remove a scope, specify a value of $null. Type: ManagementScopeIdParameter Parameter Sets: ExclusiveScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -359,6 +382,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -369,7 +395,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -379,6 +404,9 @@ Accept wildcard characters: False ``` ### -RecipientOrganizationalUnitScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope, ExclusiveRecipientWriteScope, or RecipientRelativeWriteScope parameters and any predefined scopes or custom scopes on the role assignment are overwritten. @@ -389,7 +417,6 @@ To specify an OU, use the syntax: domain/ou. To remove an OU, specify a value of Type: OrganizationalUnitIdParameter Parameter Sets: RecipientOrganizationalUnitScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -399,6 +426,9 @@ Accept wildcard characters: False ``` ### -RecipientRelativeWriteScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientRelativeWriteScope parameter specifies the type of restriction to apply to a recipient scope. If you use the RecipientRelativeWriteScope parameter, you can't use the CustomRecipientWriteScope, ExclusiveRecipientWriteScope, or RecipientOrganizationalUnitScope parameters. @@ -411,7 +441,6 @@ Even though the NotApplicable, OU, MyDirectReports, CustomRecipientScope, MyExec Type: RecipientWriteScopeType Parameter Sets: RelativeRecipientWriteScope Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -421,13 +450,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleEntry.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleEntry.md index ee811f9b5f..de99ac0cc4 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementRoleEntry.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managementroleentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-ManagementRoleEntry -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managementroleentry +schema: 2.0.0 +title: Set-ManagementRoleEntry --- # Set-ManagementRoleEntry @@ -73,6 +74,9 @@ In on-premises Exchange, this example adds the Location parameter to the Mailbox ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the role entry that you want to modify. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). @@ -83,7 +87,6 @@ If the role entry name contains spaces, enclose it in quotation marks ("). Type: RoleEntryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AddParameter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AddParameter switch specifies that you're adding parameters to the specified role entry. You don't need to specify a value with this switch. Use the Parameters parameter to specify the parameters to add. @@ -103,7 +109,6 @@ You can't use the AddParameter switch and the RemoveParameter switch together in Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -122,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -140,7 +150,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -160,7 +172,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Parameters parameter specifies the parameters to be added to or removed from the role entry. The Parameters parameter has the following modes: @@ -184,7 +198,6 @@ You can specify multiple parameters, separated with commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -RemoveParameter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RemoveParameter switch specifies that you're removing parameters to the specified role entry. You don't need to specify a value with this switch. Use the Parameters parameter to specify the parameters to remove. @@ -204,7 +220,6 @@ You can't use the AddParameter switch and the RemoveParameter switch together in Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -214,6 +229,9 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -226,7 +244,6 @@ Unscoped top-level management roles can only contain custom scripts or non-Excha Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,13 +253,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ManagementScope.md b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementScope.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-ManagementScope.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ManagementScope.md index 7d84c230ae..30b702cd34 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementScope.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ManagementScope.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-managementscope applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-ManagementScope -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-managementscope +schema: 2.0.0 +title: Set-ManagementScope --- # Set-ManagementScope @@ -88,13 +89,15 @@ This example changes the Active Directory site used in the server restriction fi ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name of the management scope to modify. If the name contains spaces, enclose it in quotation marks ("). ```yaml Type: ManagementScopeIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -DatabaseRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DatabaseRestrictionFilter parameter uses OPATH filter syntax to specify the databases that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. @@ -123,7 +129,6 @@ You can't use this parameter with the RecipientRestrictionFilter, ServerRestrict Type: String Parameter Sets: DatabaseFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -133,6 +138,9 @@ Accept wildcard characters: False ``` ### -ServerRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ServerRestrictionFilter parameter uses OPATH filter syntax to specify the servers that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. @@ -152,7 +160,6 @@ You can't use this parameter wit the RecipientRestrictionFilter, RecipientRoot, Type: String Parameter Sets: ServerFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -162,6 +169,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -171,7 +181,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -189,7 +201,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,6 +210,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -209,7 +223,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,13 +232,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the name of the management scope. The management scope name can be a maximum of 64 characters. If the name contains spaces, enclose it in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -235,6 +250,9 @@ Accept wildcard characters: False ``` ### -RecipientRestrictionFilter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientRestrictionFilter parameter uses OPATH filter syntax to specify the recipients that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -252,7 +270,6 @@ You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, S Type: String Parameter Sets: RecipientFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -262,6 +279,9 @@ Accept wildcard characters: False ``` ### -RecipientRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. Valid input for this parameter is an OU or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name @@ -275,7 +295,6 @@ You can't use this parameter with the ServerRestrictionFilter or DatabaseRestric Type: OrganizationalUnitIdParameter Parameter Sets: RecipientFilter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -285,13 +304,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-MapiVirtualDirectory.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MapiVirtualDirectory.md index ec322afd70..0b55d95639 100644 --- a/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MapiVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mapivirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-MapiVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mapivirtualdirectory +schema: 2.0.0 +title: Set-MapiVirtualDirectory --- # Set-MapiVirtualDirectory @@ -53,6 +54,9 @@ This example makes the following configuration changes to the MAPI virtual direc ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the MAPI virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -65,7 +69,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -ApplyDefaults + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ApplyDefaults switch specifies whether to apply the correct defaults to the related internal IIS application settings. Typically, this switch is used only by Exchange Setup during the installation of Exchange Cumulative Updates or Service Packs and you shouldn't need to use it. This switch doesn't affect the values you configure by using the IISAuthenticationMethods, InternalUrl or ExternalUrl parameters. @@ -83,7 +89,6 @@ This switch doesn't affect the values you configure by using the IISAuthenticati Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -102,7 +110,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -140,7 +152,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -159,7 +173,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -181,7 +197,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,6 +206,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax `https:///mapi`(for example, `https://external.contoso.com/mapi`). @@ -201,7 +219,6 @@ When you use the InternalUrl or ExternalUrl parameters, you need to specify one Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,6 +228,9 @@ Accept wildcard characters: False ``` ### -IISAuthenticationMethods + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IISAuthenticationMethods parameter specifies the authentication methods that are enabled on the virtual directory in Internet Information Services (IIS). Valid values are: - Basic @@ -228,7 +248,6 @@ For more information about the different authentication methods, see [Understand Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,6 +257,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax `https:///mapi` (for example, `https://internal.contoso.com/mapi`). @@ -248,7 +270,6 @@ When you use the InternalUrl or ExternalUrl parameters, you need to specify one Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -258,13 +279,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MessageClassification.md b/exchange/exchange-ps/ExchangePowerShell/Set-MessageClassification.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-MessageClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MessageClassification.md index 4c48abce78..6c39983580 100644 --- a/exchange/exchange-ps/exchange/Set-MessageClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MessageClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-messageclassification applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MessageClassification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-messageclassification +schema: 2.0.0 +title: Set-MessageClassification --- # Set-MessageClassification @@ -54,6 +55,9 @@ This example makes the following configuration changes to the message classifica ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the message classification that you want to modify. You can use any value that uniquely identifies the message classification. For example: - Name @@ -64,7 +68,6 @@ The Identity parameter specifies the message classification that you want to mod Type: MessageClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -ClassificationID + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ClassificationID parameter specifies the classification ID (GUID) of an existing message classification that you want to import and use in your Exchange organization. Use this parameter if you're configuring message classifications that span two Exchange forests in the same organization. To find the ClassificationID value of the message classification, replace `` with the name of the message classification and run the following command: `Get-MessageClassification -Identity ""`. @@ -82,7 +88,6 @@ To find the ClassificationID value of the message classification, replace ` Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -101,7 +109,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DisplayName parameter specifies the title of the message classification that's displayed in Outlook and selected by users. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). The message classification XML file must be present on the sender's computer for the display name to be displayed. @@ -119,7 +129,6 @@ The message classification XML file must be present on the sender's computer for Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -DisplayPrecedence + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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 @@ -147,7 +159,6 @@ Although Outlook only lets a user specify a single classification for a message, Type: ClassificationDisplayPrecedenceLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -167,7 +181,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name for the message classification. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -193,6 +208,9 @@ Accept wildcard characters: False ``` ### -PermissionMenuVisible + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PermissionMenuVisible parameter specifies whether the values that you entered for the DisplayName and RecipientDescription parameters are displayed in Outlook as the user composes a message. Valid values are: - $true: Users can assign the message classification to messages before they're sent, and the classification information is displayed. This is the default value. @@ -202,7 +220,6 @@ The PermissionMenuVisible parameter specifies whether the values that you entere Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,13 +229,15 @@ Accept wildcard characters: False ``` ### -RecipientDescription + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RecipientDescription parameter specifies the detailed text that's shown to Outlook recipient when they receive a message that has the message classification applied. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -228,6 +247,9 @@ Accept wildcard characters: False ``` ### -RetainClassificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetainClassificationEnabled parameter specifies whether the message classification should persist with the message if the message is forwarded or replied to. The default value is $true. @@ -236,7 +258,6 @@ The default value is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,13 +267,15 @@ Accept wildcard characters: False ``` ### -SenderDescription + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SenderDescription parameter specifies the detailed text that's shown to Outlook senders when they select a message classification to apply to a message before they send the message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,13 +285,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationBatch.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MigrationBatch.md index 17981b8c20..9c8fc8ac44 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationBatch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationBatch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-migrationbatch +schema: 2.0.0 +title: Set-MigrationBatch --- # Set-MigrationBatch @@ -14,7 +15,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see [New-MigrationBatch](https://learn.microsoft.com/powershell/module/exchange/new-migrationbatch). +Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see [New-MigrationBatch](https://learn.microsoft.com/powershell/module/exchangepowershell/new-migrationbatch). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -75,6 +76,9 @@ This example updates MigrationBatch01 by approving all of the skipped items for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the migration batch that you want to modify. You can use any value that uniquely identifies the migration batch. For example: - Name (the Identity property value) @@ -84,7 +88,6 @@ The Identity parameter specifies the migration batch that you want to modify. Yo Type: MigrationBatchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AddUsers + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AddUsers Description }} @@ -102,7 +108,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -AllowIncrementalSyncs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AllowIncrementalSyncs parameter specifies whether to enable or disable incremental synchronization. Valid values are: @@ -123,7 +131,6 @@ The AllowIncrementalSyncs parameter specifies whether to enable or disable incre Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -AllowUnknownColumnsInCsv + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowUnknownColumnsInCsv parameter specifies whether to allow extra columns in the CSV file that aren't used by migration. Valid values are: - $true: The migration ignores (silently skips) unknown columns in the CSV file (including optional columns with misspelled column headers). All unknown columns are treated like extra columns that aren't used by migration. @@ -142,7 +152,6 @@ The AllowUnknownColumnsInCsv parameter specifies whether to allow extra columns Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -ApproveSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ApproveSkippedItems switch marks all of the skipped items that were discovered prior to the current time as approved. You don't need to specify a value with this switch. @@ -164,7 +176,6 @@ For more information about maximum message size values, see the following topic Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -174,6 +185,9 @@ Accept wildcard characters: False ``` ### -AutoRetryCount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AutoRetryCount parameter specifies the number of attempts to restart the migration batch to migrate mailboxes that encountered errors. @@ -182,7 +196,6 @@ The AutoRetryCount parameter specifies the number of attempts to restart the mig Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,6 +205,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the migration request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the migration request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the migration request again. @@ -202,7 +218,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -CompleteAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but completion won't start until the date/time you specify with this parameter. @@ -227,7 +245,6 @@ In Exchange Online PowerShell, if you specify a date/time value without a time z Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -237,6 +254,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -246,7 +266,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -256,6 +275,9 @@ Accept wildcard characters: False ``` ### -CSVData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -266,7 +288,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -276,6 +297,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -284,7 +308,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -294,6 +317,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the migration request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -309,7 +335,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -319,6 +344,9 @@ Accept wildcard characters: False ``` ### -MoveOptions + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The MoveOptions parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. Don't use this parameter with the SkipMoving parameter. @@ -327,7 +355,6 @@ Don't use this parameter with the SkipMoving parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -337,6 +364,9 @@ Accept wildcard characters: False ``` ### -NotificationEmails + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NotificationEmails parameter specifies one or more email addresses that migration status reports are sent to. If you don't use this parameter, the status report isn't sent. @@ -347,7 +377,6 @@ To enter multiple values and overwrite any existing entries, use the following s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -357,6 +386,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -365,7 +397,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -375,6 +406,9 @@ Accept wildcard characters: False ``` ### -ReportInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReportInterval parameter specifies how frequently emailed reports should be sent to the email addresses listed within NotificationEmails. By default, emailed reports are sent every 24 hours for a batch. Setting this value to 0 indicates that reports should never be sent for this batch. @@ -385,7 +419,6 @@ This parameter should only be used in the cloud-based service. Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -395,13 +428,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipMerging parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,6 +446,9 @@ Accept wildcard characters: False ``` ### -SkipMoving + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -419,7 +457,6 @@ The SkipMoving parameter specifies the stages of the migration that you want to Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -429,13 +466,15 @@ Accept wildcard characters: False ``` ### -SkipReports + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipReports switch specifies that you want to skip automatic reporting for the migration. You don't need to specify a value with this switch. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -445,6 +484,9 @@ Accept wildcard characters: False ``` ### -SourcePublicFolderDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SourcePublicFolderDatabase parameter specifies the source public folder database that's used in a public folder migration. You can use any value that uniquely identifies the database. For example: @@ -457,7 +499,6 @@ The SourcePublicFolderDatabase parameter specifies the source public folder data Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -467,6 +508,9 @@ Accept wildcard characters: False ``` ### -StartAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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". @@ -480,7 +524,6 @@ In Exchange Online PowerShell, if you specify a date/time value without a time z Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -490,6 +533,9 @@ Accept wildcard characters: False ``` ### -SyncNow + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SyncNow switch starts an immediate sync for users that have already reached Synced status, but doesn't resume any Failed users. You don't need to specify a value with this switch. You can use this switch to speed up onboarding moves by using the switch just before the completion of the move. For IMAP migrations, you can use this switch after MX record switchover. @@ -498,7 +544,6 @@ You can use this switch to speed up onboarding moves by using the switch just be Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -508,6 +553,9 @@ Accept wildcard characters: False ``` ### -Update + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Update switch sets the Update flag on the migration batch. You don't need to specify a value with this switch. The Update flag triggers the Migration Service to reapply all of the settings from the endpoint, batch, and user to the migration process. @@ -516,7 +564,6 @@ The Update flag triggers the Migration Service to reapply all of the settings fr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -526,13 +573,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MigrationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationConfig.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-MigrationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MigrationConfig.md index 99bb6f912b..0c567f3657 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-migrationconfig +schema: 2.0.0 +title: Set-MigrationConfig --- # Set-MigrationConfig @@ -54,6 +55,9 @@ This example sets the migration system to only allow 100 concurrent migrations. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -63,7 +67,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -81,7 +87,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Features + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Features parameter specifies the set of features to enable for the migration system. Use one of the following values: @@ -104,7 +112,6 @@ The Features parameter specifies the set of features to enable for the migration Type: MigrationFeature Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMigrations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxConcurrentMigrations parameter specifies the maximum number of active migrations that your organization can run at any specific time. @@ -122,7 +132,6 @@ The MaxConcurrentMigrations parameter specifies the maximum number of active mig Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -MaxNumberOfBatches + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxNumberOfBatches parameter specifies the maximum number of batches that your organization can migrate at any time. @@ -140,7 +152,6 @@ The MaxNumberOfBatches parameter specifies the maximum number of batches that yo Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -158,7 +172,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationEndpoint.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-MigrationEndpoint.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MigrationEndpoint.md index cade570874..219d487254 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationEndpoint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationendpoint applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationEndpoint -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-migrationendpoint +schema: 2.0.0 +title: Set-MigrationEndpoint --- # Set-MigrationEndpoint @@ -87,13 +88,15 @@ This example changes the MaxConcurrentMigrations setting to 10 on the Onboarding ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the migration endpoint you want to configure. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -AcceptUntrustedCertificates + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AcceptUntrustedCertificates Description }} @@ -111,7 +117,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -ApplicationId + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ApplicationId Description }} @@ -129,7 +137,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -AppSecretKeyVaultUrl + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AppSecretKeyVaultUrl Description }} @@ -147,7 +157,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Authentication parameter specifies the authentication method used by the remote mail server. @@ -165,7 +177,6 @@ The Authentication parameter specifies the authentication method used by the rem Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -184,7 +198,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -Credentials + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credentials parameter specifies the username and password for connecting to the remote endpoint. Credentials should be used when creating either a staged or cutover Exchange endpoint or a RemoteMove endpoint. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -202,7 +218,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -220,7 +238,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,6 +247,9 @@ Accept wildcard characters: False ``` ### -ExchangeServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeServer parameter specifies the on-premises source Exchange server for cutover and staged migrations. This parameter is applicable only to staged and cutover Exchange endpoints which don't use Autodiscovery. @@ -238,7 +258,6 @@ The ExchangeServer parameter specifies the on-premises source Exchange server fo Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,6 +267,9 @@ Accept wildcard characters: False ``` ### -MailboxPermission + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxPermission parameter specifies what permissions should be used to access the source mailbox during OutlookAnywhere onboarding (Staged Exchange Migration and Cutover Exchange Migration). This parameter is not for non-OutlookAnywhere migrations. @@ -261,7 +283,6 @@ The account specified must have the following permissions: Type: MigrationMailboxPermission Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -271,13 +292,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentIncrementalSyncs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed for this endpoint at a specified time. This value must be less or equal to MaxConcurrentMigrations parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -287,13 +310,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMigrations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxConcurrentMigrations parameter specifies the maximum number of mailboxes that will be migrated for this endpoint at a specified time. This parameter is applicable for all migration types. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -303,6 +328,9 @@ Accept wildcard characters: False ``` ### -NspiServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The NspiServer parameter specifies the FQDN of the remote Name Service Provider Interface (NSPI) server. This parameter is only applicable to staged and cutover Exchange endpoints that don't use Autodiscovery. @@ -311,7 +339,6 @@ The NspiServer parameter specifies the FQDN of the remote Name Service Provider Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -321,6 +348,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -329,7 +359,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -339,6 +368,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration, the Port parameter specifies the TCP port number used by the migration process to connect to the remote server. @@ -347,7 +379,6 @@ For an IMAP migration, the Port parameter specifies the TCP port number used by Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -357,6 +388,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabaseServerLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -365,7 +399,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -375,6 +408,9 @@ Accept wildcard characters: False ``` ### -RemoteServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoteServer parameter specifies the remote server depending on the protocol type for moves: - Exchange server moves: The FQDN of an Exchange server that has the Client Access role installed, a Client Access server array, or a group of Client Access servers that are located behind a supported network load balancer. @@ -384,7 +420,6 @@ The RemoteServer parameter specifies the remote server depending on the protocol Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -394,6 +429,9 @@ Accept wildcard characters: False ``` ### -RpcProxyServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For a staged Exchange migration, the RpcProxyServer parameter specifies the FQDN of the RPC proxy server for the on-premises Exchange server. This parameter is only applicable to staged and cutover Exchange endpoints that don't use Autodiscovery @@ -402,7 +440,6 @@ For a staged Exchange migration, the RpcProxyServer parameter specifies the FQDN Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -412,6 +449,9 @@ Accept wildcard characters: False ``` ### -Security + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl. @@ -420,7 +460,6 @@ For an IMAP migration, the Security parameter specifies the encryption method us Type: IMAPSecurityMechanism Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -430,6 +469,9 @@ Accept wildcard characters: False ``` ### -ServiceAccountKeyFileData + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. @@ -440,7 +482,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -450,13 +491,15 @@ Accept wildcard characters: False ``` ### -SkipVerification + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SkipVerification switch skips verifying that the remote server is reachable when creating a migration endpoint. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -466,6 +509,9 @@ Accept wildcard characters: False ``` ### -SourceMailboxLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SourceMailboxLegacyDN parameter specifies a mailbox on the target server. Use the LegacyExchangeDN for the on-premises test mailbox as the value for this parameter. The cmdlet tries to access this mailbox using the credentials for the administrator account on the target server. @@ -474,7 +520,6 @@ The SourceMailboxLegacyDN parameter specifies a mailbox on the target server. Us Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -484,6 +529,9 @@ Accept wildcard characters: False ``` ### -TestMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The TestMailbox parameter specifies a mailbox on the target server. Use the primary SMTP address as the value for this parameter. The cmdlet tries to access this mailbox using the credentials for the administrator account on the target server. @@ -492,7 +540,6 @@ The TestMailbox parameter specifies a mailbox on the target server. Use the prim Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -502,13 +549,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MigrationUser.md b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationUser.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-MigrationUser.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MigrationUser.md index 9a4d3dc9f8..06f2e1d789 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MigrationUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationuser applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-MigrationUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-migrationuser +schema: 2.0.0 +title: Set-MigrationUser --- # Set-MigrationUser @@ -59,6 +60,9 @@ This example approves all of the skipped items encountered for the user laura@co ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the email address of the user that's being migrated. You can also identify the user by the GUID value in the MigrationUser property from the output of the Get-MigrationUser cmdlet. This identification method is useful if you accidentally submitted the same user in multiple batches. @@ -67,7 +71,6 @@ You can also identify the user by the GUID value in the MigrationUser property f Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -ApproveSkippedItems + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ApproveSkippedItems switch marks all of the skipped items that were discovered prior to the current time as approved. You don't need to specify a value with this switch. @@ -91,7 +97,6 @@ You don't need to specify a value with this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the migration request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the migration request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the migration request again. @@ -111,7 +119,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -CompleteAfter + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The CompleteAfter parameter specifies a delay before the user is completed. Data migration for the user will start, but won't complete until the date/time you specify with this parameter. @@ -138,7 +148,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -157,7 +169,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -175,7 +189,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,6 +198,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the migration request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -200,7 +216,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -210,6 +225,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -218,7 +236,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -StartAfter + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The StartAfter parameter specifies a delay before the data migration for the user is started. The migration will be prepared, but the actual data migration for the user won't start until the date/time you specify with this parameter. @@ -245,7 +265,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -255,6 +274,9 @@ Accept wildcard characters: False ``` ### -SyncNow + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SyncNow switch specifies whether to trigger an incremental sync for the migrated user. You don't need to specify a value with this switch. An incremental sync copies any recent changes from the source mailbox to the target mailbox. You can perform an incremental sync before you complete the migration batch to reduce the time that's required for the completion. @@ -263,7 +285,6 @@ An incremental sync copies any recent changes from the source mailbox to the tar Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -273,13 +294,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-MobileDeviceMailboxPolicy.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MobileDeviceMailboxPolicy.md index 8b2c4058f0..8cb8193e53 100644 --- a/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MobileDeviceMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-mobiledevicemailboxpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MobileDeviceMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-mobiledevicemailboxpolicy +schema: 2.0.0 +title: Set-MobileDeviceMailboxPolicy --- # Set-MobileDeviceMailboxPolicy @@ -118,6 +119,9 @@ This example sets several policy settings for the mobile device mailbox policy D ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mobile device mailbox policy. You can use any value that uniquely identifies the policy. For example: - Name @@ -130,7 +134,6 @@ The name of the built-in mobile device mailbox policy is Default. Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -140,6 +143,9 @@ Accept wildcard characters: False ``` ### -AllowApplePushNotifications + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowApplePushNotifications parameter specifies whether push notifications are allowed for Apple mobile devices. Valid input for this parameter is $true or $false. The default value is $true. @@ -148,7 +154,6 @@ The AllowApplePushNotifications parameter specifies whether push notifications a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -158,6 +163,9 @@ Accept wildcard characters: False ``` ### -AllowBluetooth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile device. Valid values are: - Allow (this is the default value). @@ -172,7 +180,6 @@ The value Disable disables synchronization between Outlook for Android and the O Type: BluetoothType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,13 +189,15 @@ Accept wildcard characters: False ``` ### -AllowBrowser + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect non-Microsoft browsers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -198,13 +207,15 @@ Accept wildcard characters: False ``` ### -AllowCamera + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowCamera parameter specifies whether the mobile device's camera is allowed. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -214,13 +225,15 @@ Accept wildcard characters: False ``` ### -AllowConsumerEmail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using non-Microsoft mobile device email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,13 +243,15 @@ Accept wildcard characters: False ``` ### -AllowDesktopSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowDesktopSync parameter specifies whether the mobile device can synchronize with a desktop computer through a cable. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,13 +261,15 @@ Accept wildcard characters: False ``` ### -AllowExternalDeviceManagement + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the mobile device. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -262,6 +279,9 @@ Accept wildcard characters: False ``` ### -AllowGooglePushNotifications + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowGooglePushNotifications parameter controls whether the user can receive push notifications from Google for Outlook on the web for devices. Valid input for this parameter is $true or $false. The default value is $true. @@ -270,7 +290,6 @@ The AllowGooglePushNotifications parameter controls whether the user can receive Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,13 +299,15 @@ Accept wildcard characters: False ``` ### -AllowHTMLEmail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowHTMLEmail parameter specifies whether HTML-formatted email is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. If set to $false, all email is converted to plain text before synchronization occurs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -296,13 +317,15 @@ Accept wildcard characters: False ``` ### -AllowInternetSharing + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowInternetSharing parameter specifies whether the mobile device can be used as a modem to connect a computer to the Internet. This process is also known as tethering. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -312,13 +335,15 @@ Accept wildcard characters: False ``` ### -AllowIrDA + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -328,6 +353,9 @@ Accept wildcard characters: False ``` ### -AllowMicrosoftPushNotifications + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The AllowMicrosoftPushNotifications parameter specifies whether push notifications are enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. @@ -336,7 +364,6 @@ The AllowMicrosoftPushNotifications parameter specifies whether push notificatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -346,13 +373,15 @@ Accept wildcard characters: False ``` ### -AllowMobileOTAUpdate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowMobileOTAUpdate parameter specifies whether the policy can be sent to the mobile device over a cellular data connection. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -362,6 +391,9 @@ Accept wildcard characters: False ``` ### -AllowNonProvisionableDevices + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowNonProvisionableDevices parameter specifies whether all mobile devices can synchronize with Exchange. Valid input for this parameter is $true or $false. The default value is $true. When set to $true, this parameter enables all mobile devices to synchronize with Exchange, regardless of whether the device can enforce all settings that are defined by the policy. This also includes mobile devices managed by a separate device management system. When set to $false, this parameter blocks mobile devices that aren't provisioned from synchronizing with Exchange. @@ -370,7 +402,6 @@ When set to $true, this parameter enables all mobile devices to synchronize with Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -380,13 +411,15 @@ Accept wildcard characters: False ``` ### -AllowPOPIMAPEmail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by non-Microsoft email programs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -396,13 +429,15 @@ Accept wildcard characters: False ``` ### -AllowRemoteDesktop + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowRemoteDesktop parameter specifies whether the mobile device can initiate a remote desktop connection. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -412,13 +447,15 @@ Accept wildcard characters: False ``` ### -AllowSimplePassword + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSimplePassword parameter specifies whether a simple password is allowed on the mobile device. A simple password is a password that has a specific pattern, such as 1111 or 1234. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -428,6 +465,9 @@ Accept wildcard characters: False ``` ### -AllowSMIMEEncryptionAlgorithmNegotiation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSMIMEEncryptionAlgorithmNegotiation parameter specifies whether the messaging application on the mobile device can negotiate the encryption algorithm if a recipient's certificate doesn't support the specified encryption algorithm. Valid values for this parameter are: - AllowAnyAlgorithmNegotiation @@ -440,7 +480,6 @@ The default value is AllowAnyAlgorithmNegotiation. Type: SMIMEEncryptionAlgorithmNegotiationType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -450,13 +489,15 @@ Accept wildcard characters: False ``` ### -AllowSMIMESoftCerts + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -466,13 +507,15 @@ Accept wildcard characters: False ``` ### -AllowStorageCard + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowStorageCard parameter specifies whether the mobile device can access information stored on a storage card. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -482,13 +525,15 @@ Accept wildcard characters: False ``` ### -AllowTextMessaging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowTextMessaging parameter specifies whether text messaging is allowed from the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -498,13 +543,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedApplications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -514,13 +561,15 @@ Accept wildcard characters: False ``` ### -AllowUnsignedInstallationPackages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be executed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -530,13 +579,15 @@ Accept wildcard characters: False ``` ### -AllowWiFi + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowWiFi parameter specifies whether wireless Internet access is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -546,13 +597,15 @@ Accept wildcard characters: False ``` ### -AlphanumericPasswordRequired + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AlphanumericPasswordRequired parameter specifies whether the password for the mobile device must be alphanumeric. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -562,13 +615,15 @@ Accept wildcard characters: False ``` ### -ApprovedApplicationList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApprovedApplicationList parameter specifies a configured list of approved applications for the device. ```yaml Type: ApprovedApplicationCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -578,6 +633,9 @@ Accept wildcard characters: False ``` ### -AttachmentsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AttachmentsEnabled parameter specifies whether attachments can be downloaded on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. When set to $false, this parameter blocks the user from downloading attachments on the mobile device. @@ -586,7 +644,6 @@ When set to $false, this parameter blocks the user from downloading attachments Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -596,6 +653,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -605,7 +665,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -615,6 +674,9 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This setting is supported by Outlook for iOS and Android. The DeviceEncryptionEnabled parameter specifies whether encryption is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. @@ -625,7 +687,6 @@ When this parameter is set to $true, device encryption is enabled on the mobile Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -635,6 +696,9 @@ Accept wildcard characters: False ``` ### -DevicePolicyRefreshInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DevicePolicyRefreshInterval parameter specifies how often the policy is sent to the mobile device. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -645,7 +709,6 @@ The default value is Unlimited. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -655,6 +718,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -663,7 +729,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -673,13 +738,15 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mobile device. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -689,6 +756,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault parameter specifies whether this policy is the default mobile device mailbox policy. Valid input for this parameter is $true or $false. The default value for the built-in mobile device mailbox policy named Default is $true. The default value for new mobile device mailbox policies that you create is $false. There can be only one default policy. If another policy is currently set as the default, and you set this parameter to $true, this policy becomes the default policy. The value of this parameter on the other policy is automatically changed to $false, and that policy is no longer the default policy. @@ -697,7 +767,6 @@ There can be only one default policy. If another policy is currently set as the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -707,6 +776,9 @@ Accept wildcard characters: False ``` ### -MaxAttachmentSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile device. Valid input for this parameter is a size value between 0 and 2147482624 bytes (approximately 2 GB), or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4096 or 4KB. @@ -721,7 +793,6 @@ The maximum value is 1024 bytes (one kilobyte) less than two gigabytes (2\*1024^ Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -731,6 +802,9 @@ Accept wildcard characters: False ``` ### -MaxCalendarAgeFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the mobile device. Valid values for this parameter are: - All @@ -745,7 +819,6 @@ The default value is All. Type: CalendarAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -755,6 +828,9 @@ Accept wildcard characters: False ``` ### -MaxEmailAgeFilter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the mobile device. Valid values for this parameter are: - All @@ -770,7 +846,6 @@ The default value is All. Type: EmailAgeFilterType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -780,6 +855,9 @@ Accept wildcard characters: False ``` ### -MaxEmailBodyTruncationSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. @@ -788,7 +866,6 @@ Unqualified values are treated as bytes. You can qualify the value with KB (kilo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -798,6 +875,9 @@ Accept wildcard characters: False ``` ### -MaxEmailHTMLBodyTruncationSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. @@ -806,7 +886,6 @@ Unqualified values are treated as bytes. You can qualify the value with KB (kilo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -816,6 +895,9 @@ Accept wildcard characters: False ``` ### -MaxInactivityTimeLock + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxInactivityTimeLock parameter specifies the length of time that the mobile device can be inactive before the password is required to reactivate it. Valid values are: - A timespan: hh:mm:ss, where hh = hours, mm = minutes and ss= seconds. The valid input range is 00:01:00 to 01:00:00 (one minute to one hour). @@ -825,7 +907,6 @@ The MaxInactivityTimeLock parameter specifies the length of time that the mobile Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -835,6 +916,9 @@ Accept wildcard characters: False ``` ### -MaxPasswordFailedAttempts + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxPasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile device. You can enter any number from 4 through 16 or the value Unlimited. The default value is Unlimited. @@ -843,7 +927,6 @@ You can enter any number from 4 through 16 or the value Unlimited. The default v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -853,6 +936,9 @@ Accept wildcard characters: False ``` ### -MinPasswordComplexCharacters + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MinPasswordComplexCharacters parameter specifies the character sets that are required in the password of the mobile device. The character sets are: - Lower case letters. @@ -875,7 +961,6 @@ For Windows Phone 10 devices, the value specifies the following password complex Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -885,6 +970,9 @@ Accept wildcard characters: False ``` ### -MinPasswordLength + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This setting is supported by Outlook for Android. The MinPasswordLength parameter specifies the minimum number of characters in the mobile device password. @@ -895,7 +983,6 @@ You can enter any number from 1 through 16 or the value $null. The default value Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -905,13 +992,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the friendly name of the mobile device mailbox policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -921,6 +1010,9 @@ Accept wildcard characters: False ``` ### -PasswordEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PasswordEnabled parameter specifies whether a password is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. When set to $true, this parameter requires the user to set a password on the mobile device. @@ -929,7 +1021,6 @@ When set to $true, this parameter requires the user to set a password on the mob Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -939,6 +1030,9 @@ Accept wildcard characters: False ``` ### -PasswordExpiration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PasswordExpiration parameter specifies how long a password can be used on a mobile device before the user is forced to change the password. Valid values are: - A timespan: ddd.hh:mm:ss, where ddd = days, hh = hours, mm = minutes and ss= seconds. The valid input range is 1.00:00:00 to 730.00:00:00 (one day to two years). @@ -948,7 +1042,6 @@ The PasswordExpiration parameter specifies how long a password can be used on a Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -958,6 +1051,9 @@ Accept wildcard characters: False ``` ### -PasswordHistory + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PasswordHistory parameter specifies the number of unique new passwords that need to be created on the mobile device before an old password can be reused. You can enter any number from 0 through 50. The default value is 0. @@ -966,7 +1062,6 @@ You can enter any number from 0 through 50. The default value is 0. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -976,6 +1071,9 @@ Accept wildcard characters: False ``` ### -PasswordRecoveryEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile device is stored in Exchange. Valid input for this parameter is $true or $false. The default value is $false. When set to $true, this parameter enables you to store the recovery password for the mobile device in Exchange. The recovery password can be viewed in Outlook on the web or the Exchange admin center. @@ -984,7 +1082,6 @@ When set to $true, this parameter enables you to store the recovery password for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -994,13 +1091,15 @@ Accept wildcard characters: False ``` ### -RequireDeviceEncryption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireDeviceEncryption parameter specifies whether encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1010,13 +1109,15 @@ Accept wildcard characters: False ``` ### -RequireEncryptedSMIMEMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireEncryptedSMIMEMessages parameter specifies whether the mobile device must send encrypted S/MIME messages. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1026,6 +1127,9 @@ Accept wildcard characters: False ``` ### -RequireEncryptionSMIMEAlgorithm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireEncryptionSMIMEAlgorithm parameter specifies the algorithm that's required to encrypt S/MIME messages on a mobile device. The valid values for this parameter are: - DES @@ -1040,7 +1144,6 @@ The default value is TripleDES. Type: EncryptionSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1050,13 +1153,15 @@ Accept wildcard characters: False ``` ### -RequireManualSyncWhenRoaming + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireManualSyncWhenRoaming parameter specifies whether the mobile device must synchronize manually while roaming. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1066,6 +1171,9 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEAlgorithm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to sign S/MIME messages on the mobile device. Valid values for this parameter are SHA1 or MD5. The default value is SHA1. @@ -1074,7 +1182,6 @@ Valid values for this parameter are SHA1 or MD5. The default value is SHA1. Type: SignedSMIMEAlgorithmType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1084,13 +1191,15 @@ Accept wildcard characters: False ``` ### -RequireSignedSMIMEMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireSignedSMIMEMessages parameter specifies whether the mobile device must send signed S/MIME messages. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1100,6 +1209,9 @@ Accept wildcard characters: False ``` ### -RequireStorageCardEncryption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequireStorageCardEncryption parameter specifies whether storage card encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. @@ -1108,7 +1220,6 @@ Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1118,13 +1229,15 @@ Accept wildcard characters: False ``` ### -UnapprovedInROMApplicationList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM on the mobile device. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1134,13 +1247,15 @@ Accept wildcard characters: False ``` ### -UNCAccessEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled from the mobile device. In on-premises Exchange organizations, access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1150,13 +1265,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1166,13 +1283,15 @@ Accept wildcard characters: False ``` ### -WSSAccessEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled from the mobile device. In on-premises Exchange organizations, access to specific shares is configured on the Exchange ActiveSync virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-MoveRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MoveRequest.md index 1d1ecd41fb..1c119aad16 100644 --- a/exchange/exchange-ps/exchange/Set-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-MoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-moverequest +schema: 2.0.0 +title: Set-MoveRequest --- # Set-MoveRequest @@ -77,6 +78,9 @@ This example changes the move request for Sruthi to approve all skipped items en ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values: - GUID @@ -91,7 +95,6 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c Type: MoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. In Exchange 2013 or later or Exchange Online, you need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -111,7 +117,6 @@ In Exchange 2010, you need to use this switch if you set the BadItemLimit parame Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -ArchiveTargetDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ArchiveTargetDatabase parameter specifies the target mailbox database for the personal archive. You can use any value that uniquely identifies the database. For example: @@ -135,7 +143,6 @@ You can use this parameter to change the target database only if the move reques Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +152,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -157,7 +167,6 @@ In Exchange 2010, if you set this value to 51 or higher, you also need to use th Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,13 +176,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BatchName parameter specifies a different name for a batch. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -183,6 +194,9 @@ Accept wildcard characters: False ``` ### -CompleteAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CompleteAfter parameter specifies a delay before the request is completed. The request is started, but not completed until the date/time you specify with this parameter. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -198,7 +212,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,13 +221,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -224,6 +239,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -233,7 +251,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,6 +260,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -251,7 +271,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,13 +280,15 @@ Accept wildcard characters: False ``` ### -IgnoreRuleLimitErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013 + The IgnoreRuleLimitErrors parameter specifies that the command won't move the user's rules to the target server running Microsoft Exchange. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -277,6 +298,9 @@ Accept wildcard characters: False ``` ### -IncrementalSyncInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -287,7 +311,6 @@ Valid values are from 00:00:00 to 120.00:00:00 (120 days). The default value is Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -297,6 +320,9 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -305,7 +331,6 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -315,6 +340,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -332,7 +360,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -342,6 +369,9 @@ Accept wildcard characters: False ``` ### -MoveOptions + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The MoveOptions parameter specifies the stages of the move that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. Don't use this parameter with the SkipMoving parameter. @@ -350,7 +380,6 @@ Don't use this parameter with the SkipMoving parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -360,6 +389,9 @@ Accept wildcard characters: False ``` ### -PreventCompletion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PreventCompletion parameter specifies whether to run the move request, but not allow it to complete. Valid values are: - $true: The move request is run, but is not allowed to complete. Instead of this value, we recommend using the CompleteAfter parameter. @@ -369,7 +401,6 @@ The PreventCompletion parameter specifies whether to run the move request, but n Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -379,6 +410,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -396,7 +430,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,6 +439,9 @@ Accept wildcard characters: False ``` ### -Protect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -414,7 +450,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -424,6 +459,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter specifies the move destination by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -443,7 +481,6 @@ The ProxyToMailbox parameter specifies the move destination by the location of t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -453,6 +490,9 @@ Accept wildcard characters: False ``` ### -RemoteCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoteCredential parameter specifies the username and password an administrator who has permission to perform the mailbox move. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -461,7 +501,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -471,13 +510,15 @@ Accept wildcard characters: False ``` ### -RemoteGlobalCatalog + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoteGlobalCatalog parameter specifies the FQDN of the global catalog server for the remote forest. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -487,13 +528,15 @@ Accept wildcard characters: False ``` ### -RemoteHostName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -503,6 +546,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -516,7 +562,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -526,6 +571,9 @@ Accept wildcard characters: False ``` ### -SkipMoving + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -534,7 +582,6 @@ The SkipMoving parameter specifies the stages of the move that you want to skip Type: SkippableMoveComponent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -544,6 +591,9 @@ Accept wildcard characters: False ``` ### -SourceEndpoint + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SourceEndpoint Description }} @@ -552,7 +602,6 @@ This parameter is available only in the cloud-based service. Type: MigrationEndpointIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -562,6 +611,9 @@ Accept wildcard characters: False ``` ### -StartAfter + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StartAfter parameter specifies a delay before the request is started. The request isn't started until the date/time you specify with this parameter. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -577,7 +629,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -587,6 +638,9 @@ Accept wildcard characters: False ``` ### -SkippedItemApprovalTime + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SkippedItemApprovalTime parameter marks all of the skipped items discovered prior to the specified time as approved. If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. @@ -602,7 +656,6 @@ To specify a date/time value for this parameter, use either of the following opt Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -612,13 +665,15 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendWhenReadyToComplete parameter specifies whether to suspend the move request before it reaches the status of CompletionInProgress. Instead of this parameter, we recommend using CompleteAfter parameter. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -628,6 +683,9 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The TargetDatabase parameter specifies the target mailbox database for the mailbox. You can use any value that uniquely identifies the database. For example: @@ -642,7 +700,6 @@ You can use this parameter to change the target database only if the move reques Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -652,13 +709,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-MyAnalyticsFeatureConfig.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-MyAnalyticsFeatureConfig.md index 68c9290d33..e20c354134 100644 --- a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-MyAnalyticsFeatureConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-myanalyticsfeatureconfig applicable: Exchange Online -title: Set-MyAnalyticsFeatureConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-myanalyticsfeatureconfig +schema: 2.0.0 +title: Set-MyAnalyticsFeatureConfig --- # Set-MyAnalyticsFeatureConfig @@ -71,13 +72,15 @@ This example disables the digest email feature for Akshath. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user you want to view. You identify the user by their email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Feature + +> Applicable: Exchange Online + The Feature parameter specifies the MyAnalytics features to enable or disable for the user. Valid values are: - all (this is the default value) @@ -101,7 +107,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: dashboard, add-in, digest-email, all -Applicable: Exchange Online Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -IsEnabled + +> Applicable: Exchange Online + The IsEnabled parameter specifies whether to enable or disable the feature that's specified by the Feature parameter. Valid values are: - $true: The specified feature is enabled. @@ -120,7 +128,6 @@ The IsEnabled parameter specifies whether to enable or disable the feature that' Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -PrivacyMode + +> Applicable: Exchange Online + The PrivacyMode parameter specifies whether to enable or disable MyAnalytics for the specified user. Valid values are: -opt-in: MyAnalytics is enabled for the user. Use the Feature and IsEnabled parameters to enable or disable specific MyAnalytics features. @@ -140,7 +150,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: opt-in, opt-out -Applicable: Exchange Online Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Notification.md b/exchange/exchange-ps/ExchangePowerShell/Set-Notification.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-Notification.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Notification.md index 4d7ef423b7..a253128a9d 100644 --- a/exchange/exchange-ps/exchange/Set-Notification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Notification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-notification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-Notification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-notification +schema: 2.0.0 +title: Set-Notification --- # Set-Notification @@ -69,6 +70,9 @@ This example configures the specified notification event to send notification em ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the notification event that you want to modify. You identify the notification event by its AlternativeID property value (a GUID). You can find this value by running the command: `Get-Notification | Format-List DisplayName,AlternativeID,StartTime,Status,Type`. Typically, it only makes sense to modify notification recipients for events that haven't completed (if the event has completed, no more notification messages will be sent). @@ -79,7 +83,6 @@ You can't use this parameter with the ProcessType parameter. Type: EwsStoreObjectIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -NotificationEmails + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NotificationEmails parameter specifies the recipients for notification emails related to notification events. You can specify multiple recipients separated by commas. You need to use this parameter with either the ProcessType or Identity parameters: @@ -102,7 +108,6 @@ For Migration events, you can also use the NotificationEmails parameter on the N Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -ProcessType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ProcessType parameter specifies the notification event type that sends notification emails to users (specified by the required NotificationEmails parameter). The users receive email notification messages for all events of the specified type. The only valid value for this is parameter is CertExpiry. @@ -122,7 +130,6 @@ You can't use this parameter with the Identity parameter. Type: AsyncOperationType Parameter Sets: Settings Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -141,7 +151,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -151,6 +160,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -159,7 +171,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,13 +180,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OMEConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Set-OMEConfiguration.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-OMEConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OMEConfiguration.md index 5e1079d1bc..233c454fd2 100644 --- a/exchange/exchange-ps/exchange/Set-OMEConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OMEConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-omeconfiguration applicable: Exchange Online, Exchange Online Protection -title: Set-OMEConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-omeconfiguration +schema: 2.0.0 +title: Set-OMEConfiguration --- # Set-OMEConfiguration @@ -53,13 +54,15 @@ This example configures the specified values for the default OME configuration n ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the OME configuration that you want to modify. The default OME configuration has the Identity value "OME Configuration". ```yaml Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -BackgroundColor + +> Applicable: Exchange Online, Exchange Online Protection + The BackgroundColor parameter specifies the background color. Valid values are: - An HTML hexadecimal color code value (#RRGGBB) enclosed in quotation marks. For example, `"#FFFFFF"` is white. @@ -79,7 +85,6 @@ The BackgroundColor parameter specifies the background color. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DisclaimerText + +> Applicable: Exchange Online, Exchange Online Protection + The DisclaimerText parameter specifies the disclaimer text in the email that contains the encrypted message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). To remove existing text and use the default value, use the value $null for this parameter. @@ -116,7 +126,6 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -EmailText + +> Applicable: Exchange Online, Exchange Online Protection + The EmailText parameter specifies the default text that accompanies encrypted email messages. The default text appears above the instructions for viewing encrypted messages. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). To remove existing text and use the default value, use the value $null for this parameter. @@ -134,7 +146,6 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,6 +155,9 @@ Accept wildcard characters: False ``` ### -ExternalMailExpiryInDays + +> Applicable: Exchange Online + This parameter is available only with a Microsoft 365 Advanced Message Encryption subscription. The ExternalMailExpiryInDays parameter specifies the number of days that the encrypted message is available to external recipients in the Microsoft 365 portal. A valid value is an integer from 0 to 730. The value 0 means the messages will never expire. The default value is 0. @@ -156,7 +170,6 @@ In the output of the Get-OMEConfiguration cmdlet, the value of this parameter is Type: String Parameter Sets: Int32 Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -Image + +> Applicable: Exchange Online, Exchange Online Protection + The Image parameter identifies and uploads an image that will be displayed in the email message and in the Microsoft 365 admin center. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -180,7 +196,6 @@ To remove an existing image and use the default image, use the value $null for t Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -IntroductionText + +> Applicable: Exchange Online, Exchange Online Protection + The IntroductionText parameter specifies the text that appears next to the sender's name and email address. If the value contains spaces, enclose the value in quotation marks ("). To remove existing text and use the default value, use the value $null for this parameter. @@ -198,7 +216,6 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,6 +225,9 @@ Accept wildcard characters: False ``` ### -OTPEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The OTPEnabled parameter specifies whether to allow recipients to use a one-time passcode to view encrypted messages. Valid values are: - $true: Recipients can use a one-time passcode to view encrypted messages. This is the default value. @@ -217,7 +237,6 @@ The OTPEnabled parameter specifies whether to allow recipients to use a one-time Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -227,6 +246,9 @@ Accept wildcard characters: False ``` ### -PortalText + +> Applicable: Exchange Online, Exchange Online Protection + The PortalText parameter specifies the text that appears at the top of the encrypted mail viewing portal. The maximum length is 128 characters. If the value contains spaces, enclose the value in quotation marks ("). To remove existing text and use the default value, use the value $null for this parameter. @@ -235,7 +257,6 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -245,6 +266,9 @@ Accept wildcard characters: False ``` ### -PrivacyStatementUrl + +> Applicable: Exchange Online, Exchange Online Protection + The PrivacyStatementUrl parameter specifies the Privacy Statement link in the encrypted email notification message. If you don't use this parameter, the Privacy Statement link goes to the default Microsoft privacy statement. @@ -253,7 +277,6 @@ If you don't use this parameter, the Privacy Statement link goes to the default Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -263,6 +286,9 @@ Accept wildcard characters: False ``` ### -ReadButtonText + +> Applicable: Exchange Online, Exchange Online Protection + The ReadButtonText parameter specifies the text that appears on the "Read the message" button. If the value contains spaces, enclose the value in quotation marks ("). To remove existing text and use the default value, use the value $null for this parameter. @@ -271,7 +297,6 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -281,6 +306,9 @@ Accept wildcard characters: False ``` ### -SocialIdSignIn + +> Applicable: Exchange Online, Exchange Online Protection + The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Microsoft 365 admin center using their own social network id (Google, Yahoo, and Microsoft account). Valid values are: - $true: Social network ID sign in is allowed. This is the default value. @@ -290,7 +318,6 @@ The SocialIdSignIn parameter specifies whether a user is allowed to view an encr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -300,13 +327,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md b/exchange/exchange-ps/ExchangePowerShell/Set-OMEMessageRevocation.md similarity index 96% rename from exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OMEMessageRevocation.md index d08012a2ab..2372c45de6 100644 --- a/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OMEMessageRevocation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-omemessagerevocation applicable: Exchange Online -title: Set-OMEMessageRevocation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-omemessagerevocation +schema: 2.0.0 +title: Set-OMEMessageRevocation --- # Set-OMEMessageRevocation @@ -44,6 +45,9 @@ This example revokes encryption for the specified message. ## PARAMETERS ### -MessageId + +> Applicable: Exchange Online + The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft Purview compliance portal. @@ -52,7 +56,6 @@ You can find the Message ID for a message in Message Trace or the Message Encryp Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Revoke + +> Applicable: Exchange Online + The Revoke parameter specifies whether to revoke encryption for the message. Valid values are: - $true: Encryption for the specified message is revoked. The recipient will get an error when they try to view the encrypted message in the OME portal @@ -71,7 +77,6 @@ The Revoke parameter specifies whether to revoke encryption for the message. Val Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-OabVirtualDirectory.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OabVirtualDirectory.md index 23e45c17c1..5ec25ce2cb 100644 --- a/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OabVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-oabvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-OabVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-oabvirtualdirectory +schema: 2.0.0 +title: Set-OabVirtualDirectory --- # Set-OabVirtualDirectory @@ -53,6 +54,9 @@ This example changes the external URL of the OAB virtual directory OAB (Default ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the OAB virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -65,7 +69,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: - $true: Basic authentication is enabled. This is the default value. @@ -86,7 +92,6 @@ You can use this parameter with the WindowsAuthentication parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -105,7 +113,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -143,7 +155,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,6 +164,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -162,7 +176,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +185,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -184,7 +200,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,13 +209,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,13 +227,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -226,13 +245,15 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -242,6 +263,9 @@ Accept wildcard characters: False ``` ### -PollInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange 2010. The PollInterval parameter specifies the time interval in minutes that the distribution service should poll the offline address book generation server for updates. @@ -250,7 +274,6 @@ The PollInterval parameter specifies the time interval in minutes that the distr Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,6 +283,9 @@ Accept wildcard characters: False ``` ### -RequireSSL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireSSL parameter specifies whether the client connection to the virtual directory requires Secure Sockets Layer (SSL) encryption. Valid values are: - $true: SSL encryption is required to connect to the virtual directory. This is the default value. @@ -269,7 +295,6 @@ The RequireSSL parameter specifies whether the client connection to the virtual Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -279,13 +304,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -295,6 +322,9 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: - $true: Integrated Windows authentication is enabled. This is the default value. @@ -306,7 +336,6 @@ You can use this parameter with the BasicAuthentication parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/Set-OfflineAddressBook.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OfflineAddressBook.md index b6bd614d26..e7ba1533af 100644 --- a/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OfflineAddressBook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-OfflineAddressBook -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-offlineaddressbook +schema: 2.0.0 +title: Set-OfflineAddressBook --- # Set-OfflineAddressBook @@ -73,6 +74,9 @@ This example changes the organization mailbox that's responsible for generating ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the OAB that you want to modify. You can use any value that uniquely identifies the OAB. For example: - Name or \\Name @@ -83,7 +87,6 @@ The Identity parameter specifies the OAB that you want to modify. You can use an Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AddressLists + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AddressLists parameter specifies the address lists or global address lists that are included in the OAB. You can use any value that uniquely identifies the address list. For example: - Name @@ -107,7 +113,6 @@ You can find the identify values of address lists and global address lists by us Type: AddressBookBaseIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -ApplyMandatoryProperties + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApplyMandatoryProperties switch specifies whether to update the mandatory properties of a legacy OAB. You don't need to specify a value with this switch. This switch was used in coexistence environments when an OAB was migrated from Exchange 2003. @@ -125,7 +133,6 @@ This switch was used in coexistence environments when an OAB was migrated from E Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -ConfiguredAttributes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConfiguredAttributes parameter specifies the recipient MAPI properties that are available in the OAB. This parameter uses the syntax: `"Name1,Type1","Name2,Type2",..."NameN,TypeN"` where Name is the name of the MAPI property (for example, MobileTelephoneNumber), and Type is the value ANR (ambiguous name resolution), Value, or Indicator. To reset this parameter back to the default values, use the UseDefaultAttributes switch. @@ -143,7 +153,6 @@ To reset this parameter back to the default values, use the UseDefaultAttributes Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -162,7 +174,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -DiffRetentionPeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DiffRetentionPeriod parameter specifies the number of days that the OAB difference files are stored on the server. Valid values are integers from 7 to 1825, or the value unlimited. The default value is 30. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -196,7 +212,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -FullOabDownloadPreventionThreshold + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -222,6 +239,9 @@ Accept wildcard characters: False ``` ### -GeneratingMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The GeneratingMailbox parameter specifies the arbitration mailbox where the OAB is generated. Specifically, the arbitration mailbox must contain the OrganizationCapabilityOABGen value for the PersistedCapability property. An arbitration mailbox with this capability is also known as an organization mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -245,7 +265,6 @@ A single organization mailbox can generate multiple OABs (you can use the same v Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +274,9 @@ Accept wildcard characters: False ``` ### -GlobalWebDistributionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The GlobalWebDistributionEnabled parameter specifies whether all OAB virtual directories in the organization can accept requests to download the OAB. These locations are advertised by the Autodiscover service. Valid values are: @@ -268,7 +290,6 @@ In Exchange 2013 CU7 or later, we recommend that you use the value $true for thi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -278,6 +299,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault parameter specifies whether the OAB is used by all mailboxes and mailbox databases that don't have an OAB specified. Valid values are: - $true: The OAB is the default OAB. @@ -287,7 +311,6 @@ The IsDefault parameter specifies whether the OAB is used by all mailboxes and m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -297,6 +320,9 @@ Accept wildcard characters: False ``` ### -MaxBinaryPropertySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxBinaryPropertySize parameter specifies the maximum size in bytes for binary attributes in the OAB before they're truncated. Valid values are integers from 0 to 999999999. The default value is 65536. @@ -305,7 +331,6 @@ The MaxBinaryPropertySize parameter specifies the maximum size in bytes for bina Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -315,6 +340,9 @@ Accept wildcard characters: False ``` ### -MaxMultivaluedBinaryPropertySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxMultivaluedBinaryPropertySize parameter specifies the maximum size in bytes for multivalued binary attributes in the OAB before they're truncated. Valid values are integers from 0 to 999999999. The default value is 65536 (64 kilobytes). @@ -323,7 +351,6 @@ The MaxMultivaluedBinaryPropertySize parameter specifies the maximum size in byt Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -333,6 +360,9 @@ Accept wildcard characters: False ``` ### -MaxMultivaluedStringPropertySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxMultivaluedStringPropertySize parameter specifies the maximum size for multivalued string attributes in the OAB before they're truncated. Valid values are integers from 0 to 999999999. The default value is 65536 (64 kilobytes). @@ -341,7 +371,6 @@ The MaxMultivaluedStringPropertySize parameter specifies the maximum size for mu Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -351,6 +380,9 @@ Accept wildcard characters: False ``` ### -MaxStringPropertySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxStringPropertySize parameter specifies the maximum size in bytes for string attributes before they're truncated. Valid values are integers from 0 to 999999999. The default value is 3400. @@ -359,7 +391,6 @@ The MaxStringPropertySize parameter specifies the maximum size in bytes for stri Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -369,13 +400,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name of the OAB. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -385,6 +418,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDistributionEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The PublicFolderDistributionEnabled parameter specifies whether the OAB is to be distributed via public folders. Setting the PublicFolderDistributionEnabled parameter to a value of $true sets the OAB to be distributed via public folders. The default value is $true. @@ -393,7 +429,6 @@ The PublicFolderDistributionEnabled parameter specifies whether the OAB is to be Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -403,6 +438,9 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in Exchange 2010. In Exchange 2013 or later, this parameter is no longer responsible for the OAB generation schedule. For more information, see [Change the offline address book generation schedule in Exchange](https://learn.microsoft.com/Exchange/plan-and-deploy/post-installation-tasks/change-oab-generation-schedule). @@ -435,7 +473,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -445,6 +482,9 @@ Accept wildcard characters: False ``` ### -ShadowMailboxDistributionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ShadowMailboxDistributionEnabled parameter specifies whether a read only copy of the OAB (also known as a shadow copy) is distributed to all other OAB generation mailboxes (also known as organization mailboxes). This allows additional Mailbox servers to be endpoints for requests to download the OAB, which can help prevent users from downloading the OAB across slow WAN links. Valid values are: @@ -458,7 +498,6 @@ The value of this parameter is only meaningful if you have multiple organization Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,13 +507,15 @@ Accept wildcard characters: False ``` ### -UpgradeFromE14 + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -484,6 +525,9 @@ Accept wildcard characters: False ``` ### -UseDefaultAttributes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UseDefaultAttributes switch specifies whether to revert the recipient MAPI properties that are available in the OAB to the default list. You don't need to specify a value with this switch. You can use this switch to undo changes that you've made to the default list by using the ConfiguredAttributes parameter. @@ -492,7 +536,6 @@ You can use this switch to undo changes that you've made to the default list by Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -502,6 +545,9 @@ Accept wildcard characters: False ``` ### -Versions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Versions parameter specifies the OAB versions that are generated for client download. Valid values are: - Version2 (requires public folder distribution) @@ -512,7 +558,6 @@ The Versions parameter specifies the OAB versions that are generated for client Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -522,6 +567,9 @@ Accept wildcard characters: False ``` ### -VirtualDirectories + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The VirtualDirectories parameter specifies the OAB virtual directories that accept requests to download the OAB. These locations are advertised in the Autodiscover service. @@ -544,7 +592,6 @@ In Exchange 2013 CU7 or later, we recommend that you set this parameter to $null Type: VirtualDirectoryIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -554,13 +601,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -570,6 +619,9 @@ Accept wildcard characters: False ``` ### -ZipOabFilesBeforeUploading + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ZipOabFilesBeforeUploading specifies whether to use ZIP file compression on the OAB files before uploading them to the server. Valid values are: - $true: ZIP the OAB files. @@ -579,7 +631,6 @@ The ZipOabFilesBeforeUploading specifies whether to use ZIP file compression on Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md b/exchange/exchange-ps/ExchangePowerShell/Set-OnPremisesOrganization.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OnPremisesOrganization.md index 98e0bf8f30..aa0d233348 100644 --- a/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OnPremisesOrganization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-onpremisesorganization applicable: Exchange Online, Exchange Online Protection -title: Set-OnPremisesOrganization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-onpremisesorganization +schema: 2.0.0 +title: Set-OnPremisesOrganization --- # Set-OnPremisesOrganization @@ -50,6 +51,9 @@ This example adds a third domain legal.contoso.com to the ExchangeMail OnPremise ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - Canonical name @@ -60,7 +64,6 @@ The Identity parameter specifies the identity of the on-premises organization ob Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -HybridDomains + +> Applicable: Exchange Online + The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between a Microsoft 365 organization and an on-premises Exchange organization. The domains specified in this parameter must match the domains listed in the HybridConfiguration Active Directory object for the on-premises Exchange organization configured by the Hybrid Configuration wizard. Multiple domains may be listed and must be separated by a comma, for example, "contoso.com, sales.contoso.com". ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -InboundConnector + +> Applicable: Exchange Online + The InboundConnector parameter specifies the name of the inbound connector configured in Microsoft 365 for a hybrid deployment configured with an on-premises Exchange organization. ```yaml Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -137,13 +148,15 @@ Accept wildcard characters: False ``` ### -OrganizationName + +> Applicable: Exchange Online + The OrganizationName parameter specifies the Active Directory object name of the on-premises Exchange organization. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -153,13 +166,15 @@ Accept wildcard characters: False ``` ### -OrganizationRelationship + +> Applicable: Exchange Online + The OrganizationRelationship parameter specifies the organization relationship configured by the Hybrid Configuration wizard on the Microsoft 365 organization as part of a hybrid deployment with an on-premises Exchange organization. This organization relationship defines the federated sharing features enabled on the Microsoft 365 organization. ```yaml Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -169,13 +184,15 @@ Accept wildcard characters: False ``` ### -OutboundConnector + +> Applicable: Exchange Online + The OutboundConnector parameter specifies the name of the outbound connector configured on the EOP service for a hybrid deployment configured with an on-premises Exchange organization. ```yaml Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -185,13 +202,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-OrganizationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OrganizationConfig.md index 96e1fdf138..763ab36230 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-OrganizationConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-organizationconfig +schema: 2.0.0 +title: Set-OrganizationConfig --- # Set-OrganizationConfig @@ -559,6 +560,9 @@ In Exchange Online, this example results in meeting updates being auto-processed ## PARAMETERS ### -ShortenEventScopeDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ShortenEventScopeDefault parameter specifies whether calendar events start late or end early in the organization. Valid values are: @@ -571,7 +575,6 @@ The ShortenEventScopeDefault parameter specifies whether calendar events start l Type: ShortenEventScopeMode Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -581,6 +584,9 @@ Accept wildcard characters: False ``` ### -AcceptedDomainApprovedSendersEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AcceptedDomainApprovedSendersEnabled Description }} @@ -589,7 +595,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -599,6 +604,9 @@ Accept wildcard characters: False ``` ### -ACLableSyncedObjectEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ACLableSyncedObjectEnabled parameter specifies whether remote mailboxes in hybrid environments are stamped as ACLableSyncedMailboxUser. @@ -607,7 +615,6 @@ The ACLableSyncedObjectEnabled parameter specifies whether remote mailboxes in h Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -617,6 +624,9 @@ Accept wildcard characters: False ``` ### -ActionableMessagesExtenalAccessTokenEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ActionableMessagesExtenalAccessTokenEnabled Description }} @@ -625,7 +635,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -635,6 +644,9 @@ Accept wildcard characters: False ``` ### -ActivityBasedAuthenticationTimeoutEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActivityBasedAuthenticationTimeoutEnabled parameter enables or disables the inactivity interval for automatic logoff in Outlook on the web (formerly known as Outlook Web App). Valid values are: - $true: The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity that causes logoff in Outlook on the web. This is the default value. @@ -646,7 +658,6 @@ If you're using single sign-on, use the ActivityBasedAuthenticationTimeoutWithSi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -656,6 +667,9 @@ Accept wildcard characters: False ``` ### -ActivityBasedAuthenticationTimeoutInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity that causes an automatic logoff in Outlook on the web. You enter this value as a time span: hh:mm:ss where hh = hours, mm = minutes and ss = seconds. @@ -670,7 +684,6 @@ For more information about the activity-based timeout in Outlook on the web, see Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -680,6 +693,9 @@ Accept wildcard characters: False ``` ### -ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter enables or disables the inactivity interval for automatic logoff for single sign-on in Outlook on the Web. Valid values are: - $true: The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity in Outlook on the web that causes logoff for single sign-on. This is the default value. @@ -691,7 +707,6 @@ If you aren't using single sign-on, use the ActivityBasedAuthenticationTimeoutEn Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -701,6 +716,9 @@ Accept wildcard characters: False ``` ### -AdfsAudienceUris + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AdfsAudienceUris parameter specifies one or more external URLs that are used for Active Directory Federation Services (AD FS) claims-based authentication. For example, the external Outlook on the web and external Exchange admin center (EAC) URLs. @@ -715,7 +733,6 @@ For more information about configuring AD FS claims based authentication in Exch Type: MultiValuedProperty Parameter Sets: AdfsAuthenticationParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -725,6 +742,9 @@ Accept wildcard characters: False ``` ### -AdfsAuthenticationConfiguration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -733,7 +753,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -743,6 +762,9 @@ Accept wildcard characters: False ``` ### -AdfsEncryptCertificateThumbprint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -751,7 +773,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AdfsAuthenticationParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -761,6 +782,9 @@ Accept wildcard characters: False ``` ### -AdfsIssuer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AdfsIssuer parameter specifies URL of the AD FS server that's used for AD FS claims-based authentication. This is the URL where AD FS relying parties send users for authentication. @@ -771,7 +795,6 @@ To get this value, open Windows PowerShell on the AD FS server and run the comma Type: Uri Parameter Sets: AdfsAuthenticationParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -781,6 +804,9 @@ Accept wildcard characters: False ``` ### -AdfsSignCertificateThumbprints + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AdfsSignCertificateThumbprints parameter specifies one or more X.509 token-signing certificates that are used for AD FS claims-based authentication. This parameter uses certificate thumbprint values (GUIDs) to identify the certificates. @@ -795,7 +821,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: AdfsAuthenticationParameter Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -805,13 +830,15 @@ Accept wildcard characters: False ``` ### -AppsForOfficeEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AppsForOfficeEnabled parameter specifies whether to enable apps for Outlook features. By default, the parameter is set to $true. If the flag is set to $false, no new apps can be activated for any user in the organization. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -821,6 +848,9 @@ Accept wildcard characters: False ``` ### -AsyncSendEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AsyncSendEnabled parameter specifies whether to enable or disable async send in Outlook on the web. Valid values are: - $true: Async send is enabled. This is the default value. @@ -830,7 +860,6 @@ The AsyncSendEnabled parameter specifies whether to enable or disable async send Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -840,6 +869,9 @@ Accept wildcard characters: False ``` ### -AuditDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AuditDisabled parameter specifies whether to disable or enable mailbox auditing for the organization. Valid values are: @@ -851,7 +883,6 @@ The AuditDisabled parameter specifies whether to disable or enable mailbox audit Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -861,6 +892,9 @@ Accept wildcard characters: False ``` ### -AutodiscoverPartialDirSync + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AutodiscoverPartialDirSync parameter is for scenarios where tenants have Directory Synced some of their Active Directory users into the cloud, but still have on-premises Exchange users that are not Directory Synced. Setting this parameter to $true will cause unknown users to be redirected to the on-premises endpoint and will allow on-premises users to discover their mailbox automatically. Online email addresses will be susceptible to enumeration. We recommend full Directory Sync for all Active Directory users and leaving this parameter with the default $false. @@ -871,7 +905,6 @@ After you enable AutodiscoverPartialDirSync, it will take approximately 3 hours Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -881,6 +914,9 @@ Accept wildcard characters: False ``` ### -AutoEnableArchiveMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AutoEnableArchiveMailbox specifies whether an archive mailbox is automatically provisioned when the primary mailbox reaches 90% of the size quota (if licenses include archiving). Valid values are: @@ -892,7 +928,6 @@ The AutoEnableArchiveMailbox specifies whether an archive mailbox is automatical Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -902,6 +937,9 @@ Accept wildcard characters: False ``` ### -AutoExpandingArchive + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AutoExpandingArchive switch enables the auto-expanding archiving feature in an Exchange Online organization. You don't need to specify a value with this switch. @@ -912,7 +950,6 @@ After you enable auto-expanding archiving, additional storage space is automatic Type: SwitchParameter Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -922,6 +959,9 @@ Accept wildcard characters: False ``` ### -AutomaticForcedReadReceiptEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AutomaticForcedReadReceiptEnabled Description }} @@ -930,7 +970,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -940,6 +979,9 @@ Accept wildcard characters: False ``` ### -BlockMoveMessagesForGroupFolders + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The BlockMoveMessagesForGroupFolders parameter specifies whether to prevent group owners or group members from moving messages between folders in Microsoft 365 Groups. Valid values are: @@ -960,7 +1002,6 @@ For more information, see [Manage Folders and Rules feature in Microsoft 365 Gro Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -970,6 +1011,9 @@ Accept wildcard characters: False ``` ### -BookingsAddressEntryRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsAddressEntryRestricted parameter specifies whether addresses can be collected from Bookings customers. Valid values are: @@ -981,7 +1025,6 @@ The BookingsAddressEntryRestricted parameter specifies whether addresses can be Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -991,6 +1034,9 @@ Accept wildcard characters: False ``` ### -BookingsAuthEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsAuthEnabled parameter specifies whether to enforce authentication to access all published Bookings pages. Valid values are: @@ -1002,7 +1048,6 @@ The BookingsAuthEnabled parameter specifies whether to enforce authentication to Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1012,6 +1057,9 @@ Accept wildcard characters: False ``` ### -BookingsBlockedWordsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsBlockedWordsEnabled Description }} @@ -1020,7 +1068,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1030,6 +1077,9 @@ Accept wildcard characters: False ``` ### -BookingsCreationOfCustomQuestionsRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsCreationOfCustomQuestionsRestricted parameter specifies whether Bookings admins can add custom questions. Valid values are: @@ -1041,7 +1091,6 @@ The BookingsCreationOfCustomQuestionsRestricted parameter specifies whether Book Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1051,6 +1100,9 @@ Accept wildcard characters: False ``` ### -BookingsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsEnabled parameter specifies whether to enable Microsoft Bookings in an organization. Valid values are: @@ -1064,7 +1116,6 @@ Microsoft Bookings is an online and mobile app for small businesses who provide Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1074,6 +1125,9 @@ Accept wildcard characters: False ``` ### -BookingsExposureOfStaffDetailsRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsExposureOfStaffDetailsRestricted parameter specifies whether the attributes of internal Bookings staff members (for example, email addresses) are visible to external Bookings customers. Valid values are: @@ -1085,7 +1139,6 @@ The BookingsExposureOfStaffDetailsRestricted parameter specifies whether the att Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1095,6 +1148,9 @@ Accept wildcard characters: False ``` ### -BookingsMembershipApprovalRequired + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsMembershipApprovalRequired parameter enables a membership approval requirement when new staff members are added to Bookings calendars. Valid values are: @@ -1106,7 +1162,6 @@ The BookingsMembershipApprovalRequired parameter enables a membership approval r Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1116,6 +1171,9 @@ Accept wildcard characters: False ``` ### -BookingsNamingPolicyEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsNamingPolicyEnabled Description }} @@ -1124,7 +1182,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1134,6 +1191,9 @@ Accept wildcard characters: False ``` ### -BookingsNamingPolicyPrefix + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsNamingPolicyPrefix Description }} @@ -1142,7 +1202,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1152,6 +1211,9 @@ Accept wildcard characters: False ``` ### -BookingsNamingPolicyPrefixEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsNamingPolicyPrefixEnabled Description }} @@ -1160,7 +1222,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1170,6 +1231,9 @@ Accept wildcard characters: False ``` ### -BookingsNamingPolicySuffix + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsNamingPolicySuffix Description }} @@ -1178,7 +1242,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1188,6 +1251,9 @@ Accept wildcard characters: False ``` ### -BookingsNamingPolicySuffixEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsNamingPolicySuffixEnabled Description }} @@ -1196,7 +1262,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1206,6 +1271,9 @@ Accept wildcard characters: False ``` ### -BookingsNotesEntryRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsNotesEntryRestricted parameter specifies whether appointment notes can be collected from Bookings customers. Valid values are: @@ -1217,7 +1285,6 @@ The BookingsNotesEntryRestricted parameter specifies whether appointment notes c Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1227,6 +1294,9 @@ Accept wildcard characters: False ``` ### -BookingsPaymentsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsPaymentsEnabled parameter specifies whether to enable the online payment node inside Bookings. Valid values are: @@ -1238,7 +1308,6 @@ The BookingsPaymentsEnabled parameter specifies whether to enable the online pay Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1248,6 +1317,9 @@ Accept wildcard characters: False ``` ### -BookingsPhoneNumberEntryRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsPhoneNumberEntryRestricted parameter specifies whether phone numbers can be collected from Bookings customers. Valid values are: @@ -1259,7 +1331,6 @@ The BookingsPhoneNumberEntryRestricted parameter specifies whether phone numbers Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1269,6 +1340,9 @@ Accept wildcard characters: False ``` ### -BookingsSearchEngineIndexDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsSearchEngineIndexDisabled Description }} @@ -1277,7 +1351,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1287,6 +1360,9 @@ Accept wildcard characters: False ``` ### -BookingsSmsMicrosoftEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsSmsMicrosoftEnabled Description }} @@ -1295,7 +1371,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1305,6 +1380,9 @@ Accept wildcard characters: False ``` ### -BookingsSocialSharingRestricted + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsSocialSharingRestricted parameter specifies whether users can see the social sharing options inside Bookings. Valid values are: @@ -1316,7 +1394,6 @@ The BookingsSocialSharingRestricted parameter specifies whether users can see th Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1326,6 +1403,9 @@ Accept wildcard characters: False ``` ### -ByteEncoderTypeFor7BitCharsets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ByteEncoderTypeFor7BitCharsets parameter specifies the 7-bit transfer encoding method for MIME format for messages sent to this remote domain. The valid values for this parameter are: - 0: Always use default 7-bit transfer encoding for HTML and plain text. @@ -1342,7 +1422,6 @@ If no value is specified, Exchange always uses QP encoding for HTML and plain te Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1352,6 +1431,9 @@ Accept wildcard characters: False ``` ### -CalendarVersionStoreEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1360,7 +1442,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1370,6 +1451,9 @@ Accept wildcard characters: False ``` ### -ComplianceMLBgdCrawlEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ComplianceMLBgdCrawlEnabled Description }} @@ -1378,7 +1462,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1388,6 +1471,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -1397,7 +1483,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1407,6 +1492,9 @@ Accept wildcard characters: False ``` ### -ConnectorsActionableMessagesEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConnectorsActionableMessagesEnabled parameter specifies whether to enable or disable actionable buttons in messages (connector cards) from connected apps on Outlook on the web. Valid values are: - $true: Action buttons in connector cards are enabled, which allows you to take quick actions directly from Outlook on the web (for example, Like or Comment). This is the default value. @@ -1418,7 +1506,6 @@ For more information about actionable messages in connected apps, see [Connect a Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1428,6 +1515,9 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ConnectorsEnabled parameter specifies whether to enable or disable all connected apps in organization. Valid values are: - $true: Connectors are enabled. This is the default value. @@ -1439,7 +1529,6 @@ The workloads that are affected by this parameter are Outlook, SharePoint, Teams Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1449,6 +1538,9 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabledForOutlook + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ConnectorsEnabledForOutlook parameter specifies whether to enable or disable connected apps in Outlook on the web. Valid values are: @@ -1464,7 +1556,6 @@ For more information about connectors for Outlook on the web, see [Connect apps Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1474,6 +1565,9 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabledForSharepoint + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ConnectorsEnabledForSharepoint parameter specifies whether to enable or disable connected apps on SharePoint. Valid values are: @@ -1485,7 +1579,6 @@ The ConnectorsEnabledForSharepoint parameter specifies whether to enable or disa Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1495,6 +1588,9 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabledForTeams + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ConnectorsEnabledForTeams parameter specifies whether to enable or disable connected apps on Teams. Valid values are: @@ -1506,7 +1602,6 @@ The ConnectorsEnabledForTeams parameter specifies whether to enable or disable c Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1516,6 +1611,9 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabledForYammer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ConnectorsEnabledForYammer parameter specifies whether to enable or disable connected apps on Viva Engage. Valid values are: @@ -1527,7 +1625,6 @@ The ConnectorsEnabledForYammer parameter specifies whether to enable or disable Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1537,6 +1634,9 @@ Accept wildcard characters: False ``` ### -CustomerFeedbackEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CustomerFeedbackEnabled parameter specifies whether the Exchange server is enrolled in the Microsoft Customer Experience Improvement Program. @@ -1545,7 +1645,6 @@ The CustomerFeedbackEnabled parameter specifies whether the Exchange server is e Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1555,6 +1654,9 @@ Accept wildcard characters: False ``` ### -CustomerLockboxEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1563,7 +1665,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1573,6 +1674,9 @@ Accept wildcard characters: False ``` ### -DataClassifications + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1581,7 +1685,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1591,6 +1694,9 @@ Accept wildcard characters: False ``` ### -DefaultAuthenticationPolicy + +> Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The DefaultAuthenticationPolicy parameter specifies the authentication policy that's used for the whole organization. You can use any value that uniquely identifies the policy. For example: - Name @@ -1605,7 +1711,6 @@ You create authentication policies with the New-AuthenticationPolicy cmdlet to b Type: AuthPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1615,6 +1720,9 @@ Accept wildcard characters: False ``` ### -DefaultGroupAccessType + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DefaultGroupAccessType parameter specifies the default access type for Microsoft 365 Groups. Valid values are: @@ -1626,7 +1734,6 @@ The DefaultGroupAccessType parameter specifies the default access type for Micro Type: ModernGroupObjectType Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1636,6 +1743,9 @@ Accept wildcard characters: False ``` ### -DefaultMinutesToReduceLongEventsBy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DefaultMinutesToReduceLongEventsBy parameter specifies the number of minutes to reduce calendar events by if the events are 60 minutes or longer. A valid value is an integer from 0 to 29. The default value is 10. @@ -1648,7 +1758,6 @@ Whether long events start late or end early by the specified number of minutes d Type: Int32 Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named Default value: None @@ -1657,6 +1766,9 @@ Accept wildcard characters: False ``` ### -DefaultMinutesToReduceShortEventsBy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DefaultMinutesToReduceShortEventsBy parameter specifies the number of minutes to reduce calendar events by if the events are less than 60 minutes long. A valid value is an integer from 0 to 29. The default value is 5. @@ -1669,7 +1781,6 @@ Whether short events start late or end early by the specified number of minutes Type: Int32 Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named Default value: None @@ -1678,6 +1789,9 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultPublicFolderAgeLimit parameter specifies the default age limit for the contents of public folders across the entire organization. Content in a public folder is automatically deleted when this age limit is exceeded. This attribute applies to all public folders in the organization that don't have their own AgeLimit setting. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. Or, enter the value $null. The default value is blank ($null). @@ -1686,7 +1800,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hou Type: EnhancedTimeSpan Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1696,13 +1809,15 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderDeletedItemRetention + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultPublicFolderDeletedItemRetention parameter specifies the default value of the length of time to retain deleted items for public folders across the entire organization. This attribute applies to all public folders in the organization that don't have their own RetainDeletedItemsFor attribute set. ```yaml Type: EnhancedTimeSpan Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1712,6 +1827,9 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderIssueWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultPublicFolderIssueWarningQuota parameter specifies the default value across the entire organization for the public folder size at which a warning message is sent to this folder's owners, warning that the public folder is almost full. This attribute applies to all public folders within the organization that don't have their own warning quota attribute set. The default value of this attribute is unlimited. When you enter a value, qualify the value with one of the following units: @@ -1730,7 +1848,6 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes(2 Type: Unlimited Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1740,6 +1857,9 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderMaxItemSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultPublicFolderMaxItemSize parameter specifies the default maximum size for posted items within public folders across the entire organization. Items larger than the value of the DefaultPublicFolderMaxItemSize parameter are rejected. This attribute applies to all public folders within the organization that don't have their own MaxItemSize attribute set. The default value of this attribute is unlimited. When you enter a value, qualify the value with one of the following units: @@ -1758,7 +1878,6 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes ( Type: Unlimited Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1768,15 +1887,17 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderMovedItemRetention + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultPublicFolderMovedItemRetention parameter specifies how long items that have been moved between mailboxes are kept in the source mailbox for recovery purposes before being removed by the Public Folder Assistant. -When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see [Set-PublicFolder](https://learn.microsoft.com/powershell/module/exchange/set-publicfolder). +When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see [Set-PublicFolder](https://learn.microsoft.com/powershell/module/exchangepowershell/set-publicfolder). ```yaml Type: EnhancedTimeSpan Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1786,6 +1907,9 @@ Accept wildcard characters: False ``` ### -DefaultPublicFolderProhibitPostQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultPublicFolderProhibitPostQuota parameter specifies the size of a public folder at which users are notified that the public folder is full. Users can't post to a folder whose size is larger than the DefaultPublicFolderProhibitPostQuota parameter value. The default value of this attribute is unlimited. When you enter a value, qualify the value with one of the following units: @@ -1804,7 +1928,6 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes ( Type: Unlimited Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1814,6 +1937,9 @@ Accept wildcard characters: False ``` ### -DelayedDelicensingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The DelayedDelicensingEnabled parameter enables or disables a 30 day grace period for Exchange Online license removals from mailboxes. Valid values are: @@ -1837,7 +1963,6 @@ When you set the value of the DelayedDelicensingEnabled parameter to $false, the Type: Boolean Parameter Sets: DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1847,6 +1972,9 @@ Accept wildcard characters: False ``` ### -DirectReportsGroupAutoCreationEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DirectReportsGroupAutoCreationEnabled parameter specifies whether to enable or disable the automatic creation of direct report Microsoft 365 Groups. Valid values are: @@ -1858,7 +1986,6 @@ The DirectReportsGroupAutoCreationEnabled parameter specifies whether to enable Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1868,6 +1995,9 @@ Accept wildcard characters: False ``` ### -DisablePlusAddressInRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The DisablePlusAddressInRecipients parameter specifies whether to enable or disable plus addressing (also known as subaddressing) for Exchange Online mailboxes. Valid values are: @@ -1881,7 +2011,6 @@ For more information about plus addressing, see [Plus addressing in Exchange Onl Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1891,13 +2020,15 @@ Accept wildcard characters: False ``` ### -DistributionGroupDefaultOU + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DistributionGroupDefaultOU parameter specifies the container where distribution groups are created by default. ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1907,13 +2038,15 @@ Accept wildcard characters: False ``` ### -DistributionGroupNameBlockedWordsList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DistributionGroupNameBlockedWordsList parameter specifies words that can't be included in the Display Name values of distribution groups that are created by users. Separate multiple values with commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1923,6 +2056,9 @@ Accept wildcard characters: False ``` ### -DistributionGroupNamingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DistributionGroupNamingPolicy parameter specifies the additional text that's applied to the Display Name value of distribution groups created by users. You can require a prefix, a suffix, or both. The prefix and suffix can be text strings, user attribute values from the person who created the group, or a combination of text strings and attributes. The basic syntax for this parameter is `"prefixsuffix"`. The value `` is a literal value that you must always include. @@ -1946,7 +2082,6 @@ For example: `"DL__"`, `"-- Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -1966,7 +2104,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1976,6 +2113,9 @@ Accept wildcard characters: False ``` ### -ElcProcessingDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ElcProcessingDisabled parameter specifies whether to enable or disable the processing of mailboxes by the Managed Folder Assistant. Valid values are: @@ -1987,7 +2127,6 @@ The ElcProcessingDisabled parameter specifies whether to enable or disable the p Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1997,6 +2136,9 @@ Accept wildcard characters: False ``` ### -EmptyAddressBookForNonExchangeUsers + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. {{ Fill EmptyAddressBookForNonExchangeUsers Description }} @@ -2005,7 +2147,6 @@ This parameter is available only in on-premises Exchange. Type: SwitchParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2015,6 +2156,9 @@ Accept wildcard characters: False ``` ### -EnableAuthAdminReadSession + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EnableAuthAdminReadSession switch enables a recipient read session in Exchange 2016 CU17 or later, or in Exchange 2019 CU6 or later. You don't need to specify a value with this switch. @@ -2023,7 +2167,6 @@ The EnableAuthAdminReadSession switch enables a recipient read session in Exchan Type: SwitchParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2033,6 +2176,9 @@ Accept wildcard characters: False ``` ### -EnableDownloadDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The EnableDownloadDomains parameter specifies that Outlook on the web downloads inline images from a different domain than the rest of Outlook on the web. Valid values are: @@ -2046,7 +2192,6 @@ For more information about the security vulnerability that's addressed by this p Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2056,6 +2201,9 @@ Accept wildcard characters: False ``` ### -EnableForwardingAddressSyncForMailboxes + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2064,7 +2212,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2074,6 +2221,9 @@ Accept wildcard characters: False ``` ### -EnableOrgWidePermissionOnScopedRoles + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. {{ Fill EnableOrgWidePermissionOnScopedRoles Description }} @@ -2082,7 +2232,6 @@ This parameter is available only in on-premises Exchange. Type: SwitchParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2092,6 +2241,9 @@ Accept wildcard characters: False ``` ### -EnableOutlookEvents + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EnableOutlookEvents parameter specifies whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to user calendars. Valid values are: @@ -2103,7 +2255,6 @@ The EnableOutlookEvents parameter specifies whether Outlook or Outlook on the we Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2113,6 +2264,9 @@ Accept wildcard characters: False ``` ### -EndUserDLUpgradeFlowsDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The EndUserDLUpgradeFlowsDisabled parameter specifies whether to prevent users from upgrading their own distribution groups to Microsoft 365 Groups in an Exchange Online organization. Valid values are: @@ -2124,7 +2278,6 @@ The EndUserDLUpgradeFlowsDisabled parameter specifies whether to prevent users f Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2134,6 +2287,9 @@ Accept wildcard characters: False ``` ### -EndUserMailNotificationForDelayedDelicensingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The EndUserMailNotificationForDelayedDelicensingEnabled parameter enables or disables periodic email warnings to affected users that have pending Exchange Online license removal requests on their mailboxes. Valid values are: @@ -2149,7 +2305,6 @@ Use the TenantAdminNotificationForDelayedDelicensingEnabled parameter to turn on Type: Boolean Parameter Sets: DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2159,13 +2314,15 @@ Accept wildcard characters: False ``` ### -EwsAllowEntourage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsAllowEntourage parameter specifies whether to enable or disable Entourage 2008 to access Exchange Web Services (EWS) for the entire organization. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2175,6 +2332,9 @@ Accept wildcard characters: False ``` ### -EwsAllowList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsAllowList parameter specifies the applications that are allowed to access EWS or REST when the EwsApplicationAccessPolicy parameter is set to EwsAllowList. Other applications that aren't specified by this parameter aren't allowed to access EWS or REST. You identify the application by its user agent string value. Wildcard characters (\*) are supported. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -2187,7 +2347,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2197,13 +2356,15 @@ Accept wildcard characters: False ``` ### -EwsAllowMacOutlook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsAllowMacOutlook parameter enables or disables access to mailboxes by Outlook for Mac clients that use Exchange Web Services (for example, Outlook for Mac 2011 or later). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2213,13 +2374,15 @@ Accept wildcard characters: False ``` ### -EwsAllowOutlook + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsAllowOutlook parameter enables or disables access to mailboxes by Outlook clients that use Exchange Web Services. Outlook uses Exchange Web Services for free/busy, out-of-office settings, and calendar sharing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2229,6 +2392,9 @@ Accept wildcard characters: False ``` ### -EwsApplicationAccessPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsApplicationAccessPolicy parameter specifies the client applications that have access to EWS and REST. Valid values are: - EnforceAllowList: Only applications specified by the EwsAllowList parameter are allowed to access EWS and REST. Access by other applications is blocked. @@ -2240,7 +2406,6 @@ Note that if the EwsAllowEntourage, EwsAllowMacOutlook or EwsAllowOutlook parame Type: EwsApplicationAccessPolicy Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2250,6 +2415,9 @@ Accept wildcard characters: False ``` ### -EwsBlockList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsBlockList parameter specifies the applications that aren't allowed to access EWS or REST when the EwsApplicationAccessPolicy parameter is set to EnforceBlockList. All other applications that aren't specified by this parameter are allowed to access EWS or REST. You identify the application by its user agent string value. Wildcard characters (\*) are supported. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -2260,7 +2428,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2270,6 +2437,9 @@ Accept wildcard characters: False ``` ### -EwsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EwsEnabled parameter specifies whether to globally enable or disable EWS access for the entire organization, regardless of what application is making the request. Valid values are: - $true: All EWS access is enabled. @@ -2282,7 +2452,6 @@ This parameter has no affect on access to REST. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2292,6 +2461,9 @@ Accept wildcard characters: False ``` ### -ExchangeNotificationEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeNotificationEnabled parameter enables or disables Exchange notifications sent to administrators regarding their organizations. Valid input for this parameter is $true or $false. @@ -2300,7 +2472,6 @@ The ExchangeNotificationEnabled parameter enables or disables Exchange notificat Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2310,6 +2481,9 @@ Accept wildcard characters: False ``` ### -ExchangeNotificationRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeNotificationRecipients parameter specifies the recipients for Exchange notifications sent to administrators regarding their organizations. If the ExchangeNotificationEnabled parameter is set to $false, no notification messages are sent. Be sure to enclose values that contain spaces in quotation marks (") and separate multiple values with commas. If this parameter isn't set, Exchange notifications are sent to all administrators. @@ -2318,7 +2492,6 @@ The ExchangeNotificationRecipients parameter specifies the recipients for Exchan Type: MultiValuedProperty Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2328,6 +2501,9 @@ Accept wildcard characters: False ``` ### -FindTimeAttendeeAuthenticationEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FindTimeAttendeeAuthenticationEnabled parameter controls whether attendees are required to verify their identity in meeting polls using the FindTime Outlook add-in. Valid values are: @@ -2343,7 +2519,6 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2353,6 +2528,9 @@ Accept wildcard characters: False ``` ### -FindTimeAutoScheduleDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FindTimeAutoScheduleDisabled parameter controls automatically scheduling the meeting once a consensus is reached in meeting polls using the FindTime Outlook add-in. Valid values are: @@ -2368,7 +2546,6 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2378,6 +2555,9 @@ Accept wildcard characters: False ``` ### -FindTimeLockPollForAttendeesEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FindTimeLockPollForAttendeesEnabled controls whether the **Lock poll for attendees** setting is managed by the organization. Valid values are: @@ -2393,7 +2573,6 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2403,6 +2582,9 @@ Accept wildcard characters: False ``` ### -FindTimeOnlineMeetingOptionDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FindTimeOnlineMeetingOptionDisabled parameter controls the availability of the **Online meeting** checkbox for Teams or Skype in meeting polls using the FindTime Outlook add-in. Valid values are: @@ -2418,7 +2600,6 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2428,6 +2609,9 @@ Accept wildcard characters: False ``` ### -FocusedInboxOn + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FocusedInboxOn parameter enables or disables Focused Inbox for the organization. Valid values are: @@ -2443,7 +2627,6 @@ Focused Inbox is a replacement for Clutter that separates the Inbox into the Foc Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2453,6 +2636,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -2463,7 +2649,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2473,6 +2658,9 @@ Accept wildcard characters: False ``` ### -HierarchicalAddressBookRoot + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HierarchicalAddressBookRoot parameter specifies the user, contact, or group to be used as the root organization for a hierarchical address book in the Exchange organization. You can use any value that uniquely identifies the recipient. For example: - Name @@ -2488,7 +2676,6 @@ The default value is blank. To reset this parameter, use the value $null. Type: UserContactGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2498,6 +2685,9 @@ Accept wildcard characters: False ``` ### -HybridRSVPEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The HybridRSVPEnabled parameter enables or disables Hybrid RSVP for your organization. Hybrid RSVP allows users the option to indicate if they will attend a meeting in-person or virtually when responding to a meeting invitation on Outlook. Valid values are: @@ -2509,7 +2699,6 @@ The HybridRSVPEnabled parameter enables or disables Hybrid RSVP for your organiz Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2519,6 +2708,9 @@ Accept wildcard characters: False ``` ### -Industry + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Industry parameter specifies the industry that best represents your organization. @@ -2527,7 +2719,6 @@ The Industry parameter specifies the industry that best represents your organiza Type: IndustryType Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2537,6 +2728,9 @@ Accept wildcard characters: False ``` ### -IPListBlocked + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter only affects Basic authentication connections. @@ -2559,7 +2753,6 @@ Changes to this parameter might take up to 4 hours to fully propagate across the Type: MultiValuedProperty Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2569,13 +2762,15 @@ Accept wildcard characters: False ``` ### -IsAgendaMailEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2585,6 +2780,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromOffboardMigration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IsExcludedFromOffboardMigration parameter specifies that no new moves from the cloud to your on-premises organization are permitted. When this flag is set, no offboarding move requests are allowed. @@ -2593,7 +2791,6 @@ The IsExcludedFromOffboardMigration parameter specifies that no new moves from t Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2603,6 +2800,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromOnboardMigration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IsExcludedFromOnboardMigration parameter specifies that no new moves from your on-premises organization to the cloud are permitted. When this flag is set, no onboarding move requests are allowed. @@ -2611,7 +2811,6 @@ The IsExcludedFromOnboardMigration parameter specifies that no new moves from yo Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2621,6 +2820,9 @@ Accept wildcard characters: False ``` ### -IsFfoMigrationInProgress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -2629,7 +2831,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2639,6 +2840,9 @@ Accept wildcard characters: False ``` ### -IsGroupFoldersAndRulesEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The IsGroupFoldersAndRulesEnabled specifies whether group owners (by default) can create folders and move messages (manually or by using Inbox rules) in Microsoft 365 Groups. Valid values are: @@ -2654,7 +2858,6 @@ For more information, see [Manage Folders and Rules feature in Microsoft 365 Gro Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2664,6 +2867,9 @@ Accept wildcard characters: False ``` ### -IsGroupMemberAllowedToEditContent + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The IsGroupMemberAllowedToEditContent parameter specifies whether group owners can allow group members to manage folders and messages in Microsoft 365 Groups. Valid values are: @@ -2688,7 +2894,6 @@ For more information, see [Manage Folders and Rules feature in Microsoft 365 Gro Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2698,6 +2903,9 @@ Accept wildcard characters: False ``` ### -LeanPopoutEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The LeanPopoutEnabled parameter specifies whether to enable faster loading of pop-out messages in Outlook on the web for Internet Explorer and Microsoft Edge. Valid values are: - $true: Lean pop-outs are enabled. @@ -2712,7 +2920,6 @@ The LeanPopoutEnabled parameter specifies whether to enable faster loading of po Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2722,6 +2929,9 @@ Accept wildcard characters: False ``` ### -LinkPreviewEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The LinkPreviewEnabled parameter specifies whether link preview of URLs in email messages is allowed for the organization. Valid values are: - $true: Link preview of URLs in email messages is allowed. Users can enable or disable link preview in their Outlook on the web settings. This is the default value. @@ -2731,7 +2941,6 @@ The LinkPreviewEnabled parameter specifies whether link preview of URLs in email Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2741,6 +2950,9 @@ Accept wildcard characters: False ``` ### -MailboxDataEncryptionEnabled + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. {{ Fill MailboxDataEncryptionEnabled Description }} @@ -2749,7 +2961,6 @@ This parameter is available only in on-premises Exchange. Type: SwitchParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -2759,13 +2970,15 @@ Accept wildcard characters: False ``` ### -MailTipsAllTipsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailTipsAllTipsEnabled parameter specifies whether MailTips are enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2775,13 +2988,15 @@ Accept wildcard characters: False ``` ### -MailTipsExternalRecipientsTipsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailTipsExternalRecipientsTipsEnabled parameter specifies whether MailTips for external recipients are enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2791,13 +3006,15 @@ Accept wildcard characters: False ``` ### -MailTipsGroupMetricsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailTipsGroupMetricsEnabled parameter specifies whether MailTips that rely on group metrics data are enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2807,13 +3024,15 @@ Accept wildcard characters: False ``` ### -MailTipsLargeAudienceThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailTipsLargeAudienceThreshold parameter specifies what a large audience is. The default value is 25. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2823,13 +3042,15 @@ Accept wildcard characters: False ``` ### -MailTipsMailboxSourcedTipsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailTipsMailboxSourcedTipsEnabled parameter specifies whether MailTips that rely on mailbox data (out-of-office or full mailbox) are enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2839,6 +3060,9 @@ Accept wildcard characters: False ``` ### -ManagedFolderHomepage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ManagedFolderHomepage parameter specifies the URL of the web page that's displayed when users click the Managed Folders folder in Outlook. If a URL isn't specified, Outlook doesn't display a managed folders home page. @@ -2847,7 +3071,6 @@ The ManagedFolderHomepage parameter specifies the URL of the web page that's dis Type: String Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2857,6 +3080,9 @@ Accept wildcard characters: False ``` ### -MapiHttpEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MapiHttpEnabled parameter enables or disables access to mailboxes in Outlook by using MAPI over HTTP. Valid values are: @@ -2870,7 +3096,6 @@ You can use the MapiHttpEnabled parameter on the Set-CASMailbox cmdlet to overri Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2880,6 +3105,9 @@ Accept wildcard characters: False ``` ### -MaskClientIpInReceivedHeadersEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MaskClientIpInReceivedHeadersEnabled Description }} @@ -2888,7 +3116,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2898,6 +3125,9 @@ Accept wildcard characters: False ``` ### -MatchSenderOrganizerProperties + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MatchSenderOrganizerProperties Description }} @@ -2906,7 +3136,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2916,6 +3145,9 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMigrations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxConcurrentMigrations parameter specifies the maximum number of concurrent migrations that your organization can configure at any specific time. @@ -2924,7 +3156,6 @@ The MaxConcurrentMigrations parameter specifies the maximum number of concurrent Type: Unlimited Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2934,6 +3165,9 @@ Accept wildcard characters: False ``` ### -MessageHighlightsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MessageHighlightsEnabled Description }} @@ -2942,7 +3176,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2952,6 +3185,9 @@ Accept wildcard characters: False ``` ### -MessageRecallAlertRecipientsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MessageRecallAlertRecipientsEnabled Description }} @@ -2960,7 +3196,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2970,6 +3205,9 @@ Accept wildcard characters: False ``` ### -MessageRecallAlertRecipientsReadMessagesOnlyEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MessageRecallAlertRecipientsReadMessagesOnlyEnabled Description }} @@ -2978,7 +3216,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2988,6 +3225,9 @@ Accept wildcard characters: False ``` ### -MessageRecallEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MessageRecallEnabled Description }} @@ -2996,7 +3236,6 @@ This parameter is available only in the cloud-based service. Type: System.Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3006,13 +3245,15 @@ Accept wildcard characters: False ``` ### -MessageRecallMaxRecallableAge + +> Applicable: Exchange Online + {{ Fill MessageRecallMaxRecallableAge Description }} ```yaml Type: Microsoft.Exchange.Data.EnhancedTimeSpan Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3022,6 +3263,9 @@ Accept wildcard characters: False ``` ### -MessageRemindersEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MessageRemindersEnabled parameter enables or disables the message reminders feature in the organization. Valid values are: @@ -3033,7 +3277,6 @@ The MessageRemindersEnabled parameter enables or disables the message reminders Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3043,6 +3286,9 @@ Accept wildcard characters: False ``` ### -MicrosoftExchangeRecipientEmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MicrosoftExchangeRecipientEmailAddresses parameter specifies one or more email addresses for the recipient. All valid Microsoft Exchange email address types may be used. You can specify multiple values for this parameter as a comma-delimited list. If the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter is set to $true, the email addresses are automatically generated by the default email address policy. This means you can't use the MicrosoftExchangeRecipientEmailAddresses parameter. @@ -3053,7 +3299,6 @@ Email addresses that you specify by using the MicrosoftExchangeRecipientEmailAdd Type: ProxyAddressCollection Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3063,6 +3308,9 @@ Accept wildcard characters: False ``` ### -MicrosoftExchangeRecipientEmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter specifies whether the default email address policy is automatically applied to the Exchange recipient. The default value is $true. If this parameter is set to $true, Exchange automatically adds new email addresses to the Exchange recipient when email address policies are added or modified in the Exchange organization. If this parameter is set to $false, you must manually add new email addresses to the Exchange recipient when email address policies are added or modified. @@ -3073,7 +3321,6 @@ If you change the value of the MicrosoftExchangeRecipientEmailAddressPolicyEnabl Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3083,6 +3330,9 @@ Accept wildcard characters: False ``` ### -MicrosoftExchangeRecipientPrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MicrosoftExchangeRecipientPrimarySmtpAddress parameter specifies the primary return SMTP email address for the Exchange recipient. If the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter is set to $true, you can't use the MicrosoftExchangeRecipientPrimarySmtpAddress parameter. @@ -3095,7 +3345,6 @@ The MicrosoftExchangeRecipientPrimarySmtpAddress parameter is meaningful only if Type: SmtpAddress Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3105,6 +3354,9 @@ Accept wildcard characters: False ``` ### -MicrosoftExchangeRecipientReplyRecipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MicrosoftExchangeRecipientReplyRecipient parameter specifies the recipient that should receive messages sent to the Exchange recipient. Typically, you would configure a mailbox to receive the messages sent to the Exchange recipient. You can use any value that uniquely identifies the recipient: For example: @@ -3120,7 +3372,6 @@ The MicrosoftExchangeRecipientReplyRecipient parameter specifies the recipient t Type: RecipientIdParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3130,6 +3381,9 @@ Accept wildcard characters: False ``` ### -MitigationsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MitigationsEnabled parameter specifies whether the Exchange Emergency Mitigation service (EM service) is enabled in the organization. Valid values are: @@ -3143,7 +3397,6 @@ For more information, see [Exchange Emergency Mitigation (EM) service](https://l Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3153,6 +3406,9 @@ Accept wildcard characters: False ``` ### -MobileAppEducationEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MobileAppEducationEnabled specifies whether to show or hide the Outlook for iOS and Android education reminder in Outlook on the web (formerly known as Outlook Web App). Valid values are: @@ -3166,7 +3422,6 @@ This setting will affect Outlook desktop at some point in the future. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3176,6 +3431,9 @@ Accept wildcard characters: False ``` ### -OabShadowDistributionOldestFileAgeLimit + +> Applicable: Exchange Server 2019 + This parameter is available only in on-premises Exchange. {{ Fill OabShadowDistributionOldestFileAgeLimit Description }} @@ -3184,7 +3442,6 @@ This parameter is available only in on-premises Exchange. Type: EnhancedTimeSpan Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -3194,6 +3451,9 @@ Accept wildcard characters: False ``` ### -OAuth2ClientProfileEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OAuth2ClientProfileEnabled parameter enables or disables modern authentication in the Exchange organization. Valid values are: - $true: modern authentication is enabled. @@ -3207,7 +3467,6 @@ When you enable modern authentication in Exchange Online, we recommend that you Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3217,6 +3476,9 @@ Accept wildcard characters: False ``` ### -OnlineMeetingsByDefaultEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetings as Teams or Skype for Business by default during meeting creation. Valid values are: @@ -3231,7 +3493,6 @@ If a user has already directly interacted with this setting in Outlook or Outloo Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3241,6 +3502,9 @@ Accept wildcard characters: False ``` ### -OrganizationSummary + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The OrganizationSummary parameter specifies a summarized description that best represents your organization. @@ -3249,7 +3513,6 @@ The OrganizationSummary parameter specifies a summarized description that best r Type: MultiValuedProperty Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3259,6 +3522,9 @@ Accept wildcard characters: False ``` ### -OutlookGifPickerDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookGifPickerDisabled parameter disables the GIF Search (powered by Bing) feature that's built into the Compose page in Outlook on the web. Valid values are: @@ -3270,7 +3536,6 @@ The OutlookGifPickerDisabled parameter disables the GIF Search (powered by Bing) Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3280,6 +3545,9 @@ Accept wildcard characters: False ``` ### -OutlookMobileGCCRestrictionsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookMobileGCCRestrictionsEnabled parameter specifies whether to enable or disable features within Outlook for iOS and Android that are not FedRAMP compliant for Microsoft 365 US Government Community Cloud (GCC) customers. Valid values are: @@ -3300,7 +3568,6 @@ The Outlook for iOS and Android feature and services that are not FedRAMP compli Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3310,6 +3577,9 @@ Accept wildcard characters: False ``` ### -OutlookMobileHelpShiftEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -3318,7 +3588,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3328,6 +3597,9 @@ Accept wildcard characters: False ``` ### -OutlookMobileSingleAccountEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -3336,7 +3608,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3346,6 +3617,9 @@ Accept wildcard characters: False ``` ### -OutlookPayEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookPayEnabled parameter enables or disables Microsoft Pay in the Microsoft 365 organization. Valid values are: @@ -3357,7 +3631,6 @@ The OutlookPayEnabled parameter enables or disables Microsoft Pay in the Microso Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3367,6 +3640,9 @@ Accept wildcard characters: False ``` ### -OutlookTextPredictionDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill OutlookTextPredictionDisabled Description }} @@ -3375,7 +3651,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3385,6 +3660,9 @@ Accept wildcard characters: False ``` ### -PermanentlyDeleteDisabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The PermanentlyDeleteDisabled parameter specifies whether to disable the PermanentlyDelete retention action for messaging records management (MRM). Valid values are: @@ -3398,7 +3676,6 @@ A message that's permanently deleted can't be recovered by using the Recoverable Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -3408,6 +3685,9 @@ Accept wildcard characters: False ``` ### -PerTenantSwitchToESTSEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter has been deprecated and is no longer used. @@ -3416,7 +3696,6 @@ This parameter has been deprecated and is no longer used. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3426,6 +3705,9 @@ Accept wildcard characters: False ``` ### -PostponeRoamingSignaturesUntilLater + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PostponeRoamingSignaturesUntilLater parameter controls whether roaming signatures are enabled or disabled in Outlook on the web (formerly known as Outlook Web App or OWA) and the new Outlook for Windows. Valid values are: @@ -3445,7 +3727,6 @@ We have no plans to support roaming signature management in the Microsoft Graph Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3455,13 +3736,15 @@ Accept wildcard characters: False ``` ### -PreferredInternetCodePageForShiftJis + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3471,13 +3754,15 @@ Accept wildcard characters: False ``` ### -PublicComputersDetectionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublicComputersDetectionEnabled parameter specifies whether Outlook on the web will detect when a user signs from a public or private computer or network, and then enforces the attachment handling settings from public networks. The default is $false. However, if you set this parameter to $true, Outlook on the web will determine if the user is signing in from a public computer, and all public attachment handling rules will be applied and enforced. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3487,6 +3772,9 @@ Accept wildcard characters: False ``` ### -PublicFolderContentReplicationDisabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The PublicFolderContentReplicationDisabled parameter is used during public folder migration. When you set the PublicFolderContentReplicationDisabled parameter to $true, public folder content is not replicated to Exchange during the initial migration. The default value is $false. @@ -3495,7 +3783,6 @@ The PublicFolderContentReplicationDisabled parameter is used during public folde Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -3505,6 +3792,9 @@ Accept wildcard characters: False ``` ### -PublicFolderMailboxesLockedForNewConnections + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PublicFolderMailboxesLockedForNewConnections parameter specifies whether users are allowed to make new connections to public folder mailboxes. Valid values are: @@ -3516,7 +3806,6 @@ The PublicFolderMailboxesLockedForNewConnections parameter specifies whether use Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3526,6 +3815,9 @@ Accept wildcard characters: False ``` ### -PublicFolderMailboxesMigrationComplete + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PublicFolderMailboxesMigrationComplete parameter is used during public folder migration. @@ -3537,7 +3829,6 @@ The PublicFolderMailboxesMigrationComplete parameter is used during public folde Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3547,6 +3838,9 @@ Accept wildcard characters: False ``` ### -PublicFolderMigrationComplete + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PublicFolderMigrationComplete parameter is used during public folder migration. When you set the PublicFolderMigrationComplete parameter to $true, transport starts rerouting the queued messages to a new destination. The default value is $false. @@ -3555,7 +3849,6 @@ The PublicFolderMigrationComplete parameter is used during public folder migrati Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3565,6 +3858,9 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublicFoldersEnabled parameter specifies how public folders are deployed in your organization. Valid values are: - Local: The public folders are deployed locally in your organization. @@ -3575,7 +3871,6 @@ The PublicFoldersEnabled parameter specifies how public folders are deployed in Type: PublicFoldersDeployment Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3585,6 +3880,9 @@ Accept wildcard characters: False ``` ### -PublicFolderShowClientControl + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublicFolderShowClientControl parameter enables or disables the control access feature for public folders in Microsoft Outlook. Valid values are: - $true: User access to public folders in Outlook is controlled by the value of the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet (the default value is $false). @@ -3594,7 +3892,6 @@ The PublicFolderShowClientControl parameter enables or disables the control acce Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3604,6 +3901,9 @@ Accept wildcard characters: False ``` ### -PublicFoldersLockedForMigration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PublicFoldersLockedForMigration parameter specifies whether users are locked out from accessing down level public folder servers. When you set the PublicFoldersLockedForMigration parameter to $true, users are locked out from accessing down level public folder servers. This is used for public folder migration during final stages. The default value is $false, which means that the user is able to access public folder servers. @@ -3612,7 +3912,6 @@ The PublicFoldersLockedForMigration parameter specifies whether users are locked Type: Boolean Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3622,13 +3921,15 @@ Accept wildcard characters: False ``` ### -ReadTrackingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReadTrackingEnabled parameter specifies whether the tracking for read status for messages in an organization is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3638,6 +3939,9 @@ Accept wildcard characters: False ``` ### -RecallReadMessagesEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RecallReadMessagesEnabled Description }} @@ -3646,7 +3950,6 @@ This parameter is available only in the cloud-based service. Type: System.Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3656,13 +3959,15 @@ Accept wildcard characters: False ``` ### -RefreshSessionEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3672,6 +3977,9 @@ Accept wildcard characters: False ``` ### -RejectDirectSend + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill RejectDirectSend Description }} @@ -3680,7 +3988,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3690,13 +3997,15 @@ Accept wildcard characters: False ``` ### -RemotePublicFolderMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemotePublicFolderMailboxes parameter specifies the identities of the public folder objects (represented as mail user objects locally) corresponding to the public folder mailboxes created in the remote forest. The public folder values set here are used only if the public folder deployment is a remote deployment. ```yaml Type: MultiValuedProperty Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3706,13 +4015,15 @@ Accept wildcard characters: False ``` ### -RequiredCharsetCoverage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3722,6 +4033,9 @@ Accept wildcard characters: False ``` ### -SCLJunkThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SCLJunkThreshold parameter specifies the spam confidence level (SCL) threshold. Messages with an SCL greater than the value that you specify for the SCLJunkThreshold parameter are moved to the Junk Email folder. Valid values are integers from 0 through 9, inclusive. @@ -3730,7 +4044,6 @@ The SCLJunkThreshold parameter specifies the spam confidence level (SCL) thresho Type: Int32 Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3740,6 +4053,9 @@ Accept wildcard characters: False ``` ### -SendFromAliasEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SendFromAliasEnabled parameter allows mailbox users to send messages using aliases (proxy addresses). Valid values are: @@ -3753,7 +4069,6 @@ For more information about the availability of the feature in Outlook on the web Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3763,6 +4078,9 @@ Accept wildcard characters: False ``` ### -SharedDomainEmailAddressFlowEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill SharedDomainEmailAddressFlowEnabled Description }} @@ -3771,7 +4089,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3781,13 +4098,15 @@ Accept wildcard characters: False ``` ### -SiteMailboxCreationURL + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SiteMailboxCreationURL parameter specifies the URL that's used to create site mailboxes. Site mailboxes improve collaboration and user productivity by allowing access to both SharePoint documents and Exchange email in Outlook 2013 or later. ```yaml Type: Uri Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3797,6 +4116,9 @@ Accept wildcard characters: False ``` ### -SmtpActionableMessagesEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SmtpActionableMessagesEnabled parameter specifies whether to enable or disable action buttons in email messages in Outlook on the web. Valid values are: - $true: Action buttons in email messages are enabled. This is the default value. @@ -3806,7 +4128,6 @@ The SmtpActionableMessagesEnabled parameter specifies whether to enable or disab Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3816,6 +4137,9 @@ Accept wildcard characters: False ``` ### -TenantAdminNotificationForDelayedDelicensingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The TenantAdminNotificationForDelayedDelicensingEnabled parameter enables or disables weekly admin Service Health advisory notifications that are sent to admins. Valid values are: @@ -3833,7 +4157,6 @@ Use the EndUserMailNotificationForDelayedDelicensingEnabled to send affected use Type: Boolean Parameter Sets: DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3843,6 +4166,9 @@ Accept wildcard characters: False ``` ### -TwoClickMailPreviewEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill TwoClickMailPreviewEnabled Description }} @@ -3851,7 +4177,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3861,6 +4186,9 @@ Accept wildcard characters: False ``` ### -UMAvailableLanguages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter has been deprecated and is no longer used. @@ -3869,7 +4197,6 @@ This parameter has been deprecated and is no longer used. Type: MultiValuedProperty Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3879,13 +4206,15 @@ Accept wildcard characters: False ``` ### -UnblockUnsafeSenderPromptEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3895,6 +4224,9 @@ Accept wildcard characters: False ``` ### -UseIcsSyncStateStreaming + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. {{ Fill UseIcsSyncStateStreaming Description }} @@ -3903,7 +4235,6 @@ This parameter is available only in on-premises Exchange. Type: SwitchParameter Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3913,6 +4244,9 @@ Accept wildcard characters: False ``` ### -VisibleMeetingUpdateProperties + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The VisibleMeetingUpdateProperties parameter specifies whether meeting message updates will be auto-processed on behalf of attendees. Auto-processed updates are applied to the attendee's calendar item, and then the meeting message is moved to the deleted items. The attendee never sees the update in their inbox, but their calendar is updated. @@ -3948,7 +4282,6 @@ In the following scenarios, meeting update messages are not auto-processed, rega Type: String Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3958,6 +4291,9 @@ Accept wildcard characters: False ``` ### -WACDiscoveryEndpoint + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The WacDiscoveryEndpoint parameter specifies the discovery endpoint for Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server) for all mailboxes in the organization. For example, `https://oos.internal.contoso.com/hosting/discovery`. @@ -3968,7 +4304,6 @@ Office Online Server enables users to view supported file attachments in Outlook Type: String Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -3978,6 +4313,9 @@ Accept wildcard characters: False ``` ### -WebPushNotificationsDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WebPushNotificationsDisabled parameter specifies whether to enable or disable Web Push Notifications in Outlook on the Web. This feature provides web push notifications which appear on a user's desktop while the user is not using Outlook on the Web. This brings awareness of incoming messages while they are working elsewhere on their computer. Valid values are: @@ -3989,7 +4327,6 @@ The WebPushNotificationsDisabled parameter specifies whether to enable or disabl Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -3999,6 +4336,9 @@ Accept wildcard characters: False ``` ### -WebSuggestedRepliesDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WebSuggestedRepliesDisabled parameter specifies whether to enable or disable Suggested Replies in Outlook on the web. This feature provides suggested replies to emails so users can easily and quickly respond to messages. Valid values are: @@ -4010,7 +4350,6 @@ The WebSuggestedRepliesDisabled parameter specifies whether to enable or disable Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -4020,13 +4359,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4036,6 +4377,9 @@ Accept wildcard characters: False ``` ### -WorkspaceTenantEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WorkspaceTenantEnabled parameter enables or disables workspace booking in the organization. Valid values are: @@ -4047,7 +4391,6 @@ The WorkspaceTenantEnabled parameter enables or disables workspace booking in th Type: Boolean Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationRelationship.md similarity index 84% rename from exchange/exchange-ps/exchange/Set-OrganizationRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OrganizationRelationship.md index f21e2920e4..32e1291fcb 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationRelationship.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationrelationship applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-OrganizationRelationship -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-organizationrelationship +schema: 2.0.0 +title: Set-OrganizationRelationship --- # Set-OrganizationRelationship @@ -72,6 +73,9 @@ This example disables the organization relationship with Contoso ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the organization relationship that you want to modify. You can use any value that uniquely identifies the organization relationship. For example: - Name @@ -82,7 +86,6 @@ The Identity parameter specifies the organization relationship that you want to Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -ArchiveAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + 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. @@ -101,7 +107,6 @@ The ArchiveAccessEnabled parameter specifies whether the organization relationsh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -120,7 +128,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -DeliveryReportEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DeliveryReportEnabled parameter specifies whether Delivery Reports should be shared over the organization relationship. Valid values are: - $true: Delivery Reports should be shared over the organization relationship. This value means the organization has agreed to share all Delivery Reports with the external organization, and the organization relationship should be used to retrieve Delivery Report information from the external organization. @@ -141,7 +151,6 @@ For message tracking to work in a cross-premises Exchange scenario, this paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,6 +160,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -159,7 +171,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,13 +180,15 @@ Accept wildcard characters: False ``` ### -DomainNames + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DomainNames parameter specifies the SMTP domains of the external organization. You can specify multiple domains separated by commas (for example, "contoso.com","northamerica.contoso.com"). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -185,6 +198,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether to enable the organization relationship. Valid values are: - $true: The organization relationship is enabled. This is the default value. @@ -194,7 +210,6 @@ The Enabled parameter specifies whether to enable the organization relationship. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -204,6 +219,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -212,7 +230,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -222,6 +239,9 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FreeBusyAccessEnabled parameter specifies whether the organization relationship should be used to retrieve free/busy information from the external organization. Valid values are: - $true: Free/busy information is retrieved from the external organization. @@ -233,7 +253,6 @@ You control the free/busy access level and scope by using the FreeBusyAccessLeve Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -243,6 +262,9 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization. Valid values are: - None: No free/busy access. @@ -255,7 +277,6 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: FreeBusyAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -FreeBusyAccessScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FreeBusyAccessScope parameter specifies a mail-enabled security group in the internal organization that contains users whose free/busy information is accessible by an external organization. You can use any value that uniquely identifies the group. For example: - Name @@ -278,7 +302,6 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -288,6 +311,9 @@ Accept wildcard characters: False ``` ### -MailboxMoveCapability + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The MailboxMoveCapability parameter is used in cross-tenant mailbox migrations. Valid values are: @@ -303,7 +329,6 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MailboxMoveCapability Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,6 +338,9 @@ Accept wildcard characters: False ``` ### -MailboxMoveEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailboxMoveEnabled parameter specifies whether the organization relationship enables moving mailboxes to or from the external organization. Valid values are: - $true: Mailbox moves to or from the external organization are allowed. @@ -322,7 +350,6 @@ The MailboxMoveEnabled parameter specifies whether the organization relationship Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -332,6 +359,9 @@ Accept wildcard characters: False ``` ### -MailboxMovePublishedScopes + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The MailboxMovePublishedScopes parameter is used in cross-tenant mailbox migrations to specify the mail-enabled security groups whose members are allowed to migrate. You can use any value that uniquely identifies the group. For example: @@ -351,7 +381,6 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -361,6 +390,9 @@ Accept wildcard characters: False ``` ### -MailTipsAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTipsAccessEnabled parameter specifies whether MailTips for users in this organization are returned over this organization relationship. Valid values are: - $true: MailTips for users in this organization are returned over the organization relationship. @@ -372,7 +404,6 @@ You control the MailTips access level by using the MailTipsAccessLevel parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -382,6 +413,9 @@ Accept wildcard characters: False ``` ### -MailTipsAccessLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTipsAccessLevel parameter specifies the level of MailTips data externally shared over this organization relationship. This parameter can have the following values: - All: All MailTips are returned, but the recipients in the remote organization are considered external. For the Auto Reply MailTip, the external Auto Reply message is returned. @@ -394,7 +428,6 @@ This parameter is only meaningful when the MailTipsAccessEnabled parameter value Type: MailTipsAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -404,6 +437,9 @@ Accept wildcard characters: False ``` ### -MailTipsAccessScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MailTipsAccessScope parameter specifies a mail-enabled security group in the internal organization that contains users whose free/busy information is accessible by an external organization. You can use any value that uniquely identifies the group. For example: - Name @@ -427,7 +463,6 @@ This restriction only applies to mailboxes, mail users, and mail contacts. It do Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -437,13 +472,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the organization relationship. The maximum length is 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -453,6 +490,9 @@ Accept wildcard characters: False ``` ### -OAuthApplicationId + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the application ID of the mailbox migration app that you consented to. For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). @@ -461,7 +501,6 @@ The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -471,13 +510,15 @@ Accept wildcard characters: False ``` ### -OrganizationContact + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OrganizationContact parameter specifies the email address that can be used to contact the external organization (for example, administrator@fourthcoffee.com). ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -487,6 +528,9 @@ Accept wildcard characters: False ``` ### -PhotosEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PhotosEnabled parameter specifies whether photos for users in the internal organization are returned over the organization relationship. Valid values are: - $true: Photos for users in this organization are returned over the organization relationship. @@ -496,7 +540,6 @@ The PhotosEnabled parameter specifies whether photos for users in the internal o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -506,13 +549,15 @@ Accept wildcard characters: False ``` ### -TargetApplicationUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TargetApplicationUri parameter specifies the target Uniform Resource Identifier (URI) of the external organization. The TargetApplicationUri parameter is specified by Exchange when requesting a delegated token to retrieve free and busy information, for example, mail.contoso.com. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -522,13 +567,15 @@ Accept wildcard characters: False ``` ### -TargetAutodiscoverEpr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, `https://contoso.com/autodiscover/autodiscover.svc/wssecurity`. Exchange uses Autodiscover to automatically detect the correct Exchange server endpoint to use for external requests. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -538,13 +585,15 @@ Accept wildcard characters: False ``` ### -TargetOwaURL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TargetOwaURL parameter specifies the Outlook on the web (formerly Outlook Web App) URL of the external organization that's defined in the organization relationship. It is used for Outlook on the web redirection in a cross-premise Exchange scenario. Configuring this attribute enables users in the organization to use their current Outlook on the web URL to access Outlook on the web in the external organization. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -554,6 +603,9 @@ Accept wildcard characters: False ``` ### -TargetSharingEpr + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services for the external organization. If you use this parameter, this URL is always used to reach the external Exchange server. TheURL that's specified by the TargetAutoDiscoverEpr parameter isn't used to locate the external Exchange server. @@ -562,7 +614,6 @@ If you use this parameter, this URL is always used to reach the external Exchang Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -572,13 +623,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OrganizationSegment.md b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationSegment.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-OrganizationSegment.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OrganizationSegment.md index 49cf493921..89cb5abe15 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationSegment.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OrganizationSegment.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationsegment applicable: Security & Compliance -title: Set-OrganizationSegment -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-organizationsegment +schema: 2.0.0 +title: Set-OrganizationSegment --- # Set-OrganizationSegment @@ -43,6 +44,9 @@ In this example, for the segment that has the GUID c96e0837-c232-4a8a-841e-ef457 ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the organization segment that you want to modify. You can use any value that uniquely identifies the segment. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the organization segment that you want to modif Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -UserGroupFilter + +> Applicable: Security & Compliance + The UserGroupFilter parameter uses OPATH filter syntax to specify the members of the organization segment. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"MemberOf -eq 'Engineering Department'"` or `"ExtensionAttribute1 -eq 'DayTrader'"`). - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -76,7 +82,6 @@ Use the same property for all of your segments, and verify that your segments do Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -100,4 +105,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Set-OutboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-OutboundConnector.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-OutboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OutboundConnector.md index a73f8dfcd5..b270f10022 100644 --- a/exchange/exchange-ps/exchange/Set-OutboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OutboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-outboundconnector applicable: Exchange Online, Exchange Online Protection -title: Set-OutboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-outboundconnector +schema: 2.0.0 +title: Set-OutboundConnector --- # Set-OutboundConnector @@ -63,6 +64,9 @@ This example changes the settings of the existing Outbound connector named Conto ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the connector you want to modify. You can use any value that uniquely identifies the connector. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the connector you want to modify. You can use a Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -AllAcceptedDomains + +> Applicable: Exchange Online, Exchange Online Protection + The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: - $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. This setting requires OnPremises for the ConnectorType value. @@ -94,7 +100,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -117,7 +125,6 @@ Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -127,13 +134,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online, Exchange Online Protection + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -152,7 +164,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -ConnectorSource + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorSource parameter specifies how the connector is created. Valid values are: - Default: The connector is manually created. This is the default value for manually created connectors, and we recommend that you don't change this value. @@ -172,7 +186,6 @@ The ConnectorSource parameter specifies how the connector is created. Valid valu Type: TenantConnectorSource Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -182,6 +195,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid values are: - Partner: The connector services domains that are external to your organization. @@ -191,7 +207,6 @@ The ConnectorType parameter specifies a category for the domains that are servic Type: TenantConnectorType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -201,6 +216,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online, Exchange Online Protection + The Enabled parameter specifies whether to enable or disable the Outbound connector. Valid values are: - $true: The connector is enabled. This is the default value. @@ -210,7 +228,6 @@ The Enabled parameter specifies whether to enable or disable the Outbound connec Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -220,6 +237,9 @@ Accept wildcard characters: False ``` ### -IsTransportRuleScoped + +> Applicable: Exchange Online, Exchange Online Protection + The IsTransportRuleScoped parameter specifies whether the Outbound connector is associated with a transport rule (also known as a mail flow rule). Valid values are: - $true: The connector is associated with a transport rule. @@ -231,7 +251,6 @@ You scope a transport rule to an Outbound connector by using the RouteMessageOut Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -241,6 +260,9 @@ Accept wildcard characters: False ``` ### -IsValidated + +> Applicable: Exchange Online, Exchange Online Protection + The IsValidated parameter specifies whether the Outbound connector has been validated. Valid values are: - $true: The connector has been validated, @@ -252,7 +274,6 @@ Use the Validate-OutboundConnector cmdlet to validate the connector. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -262,6 +283,9 @@ Accept wildcard characters: False ``` ### -LastValidationTimestamp + +> Applicable: Exchange Online, Exchange Online Protection + The LastValidationTimestamp parameter specifies the date/time that the Outbound connector was validated. To specify a date/time value for this parameter, use either of the following options: @@ -275,7 +299,6 @@ Use the Validate-OutboundConnector cmdlet to validate the connector. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -285,13 +308,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name for the connector. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -301,6 +326,9 @@ Accept wildcard characters: False ``` ### -RecipientDomains + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientDomains parameter specifies the domain that the Outbound connector routes mail to. You can specify multiple domains separated by commas. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. @@ -309,7 +337,6 @@ You can use a wildcard character to specify all subdomains of a specified domain Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -319,6 +346,9 @@ Accept wildcard characters: False ``` ### -RouteAllMessagesViaOnPremises + +> Applicable: Exchange Online, Exchange Online Protection + The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises email system. Valid values are: - $true: Messages are routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. @@ -330,7 +360,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -340,6 +369,9 @@ Accept wildcard characters: False ``` ### -SenderRewritingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SenderRewritingEnabled parameter specifies that all messages that normally qualify for SRS rewriting are rewritten for routing through the on-premises email system. Valid values are: - $true: Messages are rewritten by SRS as needed before being routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. @@ -351,7 +383,6 @@ This parameter is effective only for OnPremises connectors. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -361,6 +392,9 @@ Accept wildcard characters: False ``` ### -SmartHosts + +> Applicable: Exchange Online, Exchange Online Protection + The SmartHosts parameter specifies the smart host that the Outbound connector uses to route mail. Valid values are: - FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record: For example, mail.contoso.com. @@ -375,7 +409,6 @@ This parameter is required if you use the value $false for the UseMxRecord param Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -385,6 +418,9 @@ Accept wildcard characters: False ``` ### -TestMode + +> Applicable: Exchange Online, Exchange Online Protection + The TestMode parameter specifies whether you want to enabled or disable test mode for the Outbound connector. Valid values are: - $true: Test mode is enabled. @@ -394,7 +430,6 @@ The TestMode parameter specifies whether you want to enabled or disable test mod Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -404,6 +439,9 @@ Accept wildcard characters: False ``` ### -TlsDomain + +> Applicable: Exchange Online, Exchange Online Protection + The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. A valid value for this parameter is an SMTP domain. Wildcards are supported to specify all subdomains of a domain (for example, \*.contoso.com), but you can't embed the wildcard character within the domain (for example, domain.\*.contoso.com). @@ -414,7 +452,6 @@ This parameter meaningful only when the TlsSettings value is DomainValidation. Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -424,6 +461,9 @@ Accept wildcard characters: False ``` ### -TlsSettings + +> Applicable: Exchange Online, Exchange Online Protection + The TlsSettings parameter specifies the TLS authentication level that's used for outbound TLS connections established by this Outbound connector. Valid values are: - EncryptionOnly: TLS is used only to encrypt the communication channel. No certificate authentication is performed. @@ -435,7 +475,6 @@ The TlsSettings parameter specifies the TLS authentication level that's used for Type: TlsAuthLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -445,6 +484,9 @@ Accept wildcard characters: False ``` ### -UseMXRecord + +> Applicable: Exchange Online, Exchange Online Protection + The UseMXRecord parameter enables or disables DNS routing for the connector. Valid values are: - $true: The connector uses DNS routing (MX records in DNS) to deliver email. This is the default value. @@ -454,7 +496,6 @@ The UseMXRecord parameter enables or disables DNS routing for the connector. Val Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -464,13 +505,15 @@ Accept wildcard characters: False ``` ### -ValidationRecipients + +> Applicable: Exchange Online, Exchange Online Protection + The ValidationRecipients parameter specifies the email addresses of the validation recipients for the Outbound connector. You can specify multiple email addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -480,13 +523,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookAnywhere.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-OutlookAnywhere.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OutlookAnywhere.md index bdc199f0c5..17d58eac0e 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookAnywhere.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-outlookanywhere applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-OutlookAnywhere -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-outlookanywhere +schema: 2.0.0 +title: Set-OutlookAnywhere --- # Set-OutlookAnywhere @@ -87,6 +88,9 @@ In Exchange 2010 and Exchange 2013, this example sets the available authenticati ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Outlook Anywhere virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -99,7 +103,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -ClientAuthenticationMethod + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The ClientAuthenticationMethod parameter specifies the authentication method that the Autodiscover service provides to the Outlook Anywhere clients to authenticate to the Client Access server. Valid values are: @@ -122,7 +128,6 @@ Although you can use this parameter to set only one authentication method, the c Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -132,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -141,7 +149,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,6 +158,9 @@ Accept wildcard characters: False ``` ### -DefaultAuthenticationMethod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DefaultAuthenticationMethod parameter specifies the default authentication method for Outlook Anywhere. This parameter replaces the existing ExternalClientAuthenticationMethod, InternalClientAuthenticationMethod and IISAuthenticationMethods property values with the value you specify. Valid values are: - Basic @@ -163,7 +173,6 @@ You can't use this parameter with the ExternalClientAuthenticationMethod, Intern Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,13 +182,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,6 +200,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -201,7 +215,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,6 +224,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -220,7 +236,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -230,6 +245,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -242,7 +260,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,6 +269,9 @@ Accept wildcard characters: False ``` ### -ExternalClientAuthenticationMethod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalClientAuthenticationMethod parameter specifies the authentication method that's used to authenticate external Outlook Anywhere clients. Valid values are: - Basic @@ -264,7 +284,6 @@ You can't use this parameter with the DefaultAuthenticationMethods parameter. Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -274,6 +293,9 @@ Accept wildcard characters: False ``` ### -ExternalClientsRequireSsl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalClientsRequireSsl parameter specifies whether external Outlook Anywhere clients are required to use Secure Sockets Layer (SSL). Valid values are: - $true: Clients connecting via Outlook Anywhere from outside the organization are required to use SSL. @@ -285,7 +307,6 @@ The value of this parameter is related to the value of the SSLOffloading paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -295,13 +316,15 @@ Accept wildcard characters: False ``` ### -ExternalHostname + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalHostname parameter specifies the external hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com. ```yaml Type: Hostname Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -311,6 +334,9 @@ Accept wildcard characters: False ``` ### -IISAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IISAuthenticationMethods parameter specifies the authentication method that's used on the Outlook Anywhere virtual directory in IIS. Valid values are: - Basic @@ -325,7 +351,6 @@ You can't use this parameter with the DefaultAuthenticationMethods parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -335,6 +360,9 @@ Accept wildcard characters: False ``` ### -InternalClientAuthenticationMethod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalClientAuthenticationMethod parameter specifies the authentication method that's used to authenticate internal Outlook Anywhere clients. Valid values are: - Basic @@ -347,7 +375,6 @@ You can't use this parameter with the DefaultAuthenticationMethods parameter. Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,6 +384,9 @@ Accept wildcard characters: False ``` ### -InternalClientsRequireSsl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalClientsRequireSsl parameter specifies whether internal Outlook Anywhere clients are required to use SSL. Valid values are: - $true: Clients connecting via Outlook Anywhere from inside the organization are required to use SSL. @@ -368,7 +398,6 @@ The value of this parameter is related to the value of the SSLOffloading paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -378,13 +407,15 @@ Accept wildcard characters: False ``` ### -InternalHostname + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalHostname parameter specifies the internal hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -394,13 +425,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the Outlook Anywhere virtual directory. The default value is Rpc (Default Web Site). If the value you specify contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -410,6 +443,9 @@ Accept wildcard characters: False ``` ### -SSLOffloading + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SSLOffloading parameter specifies whether a network device accepts SSL connections and decrypts them before proxying the connections to the Outlook Anywhere virtual directory on the Exchange server. Valid values are: - $true: Outlook Anywhere clients using SSL don't maintain an SSL connection along the entire network path to the Exchange server. A network device in front of the server decrypts the SSL connections and proxies the unencrypted (HTTP) client connections to the Outlook Anywhere virtual directory. The network segment where HTTP is used should be a secured network. This is the default value. @@ -425,7 +461,6 @@ The value of this parameter is related to the values of the ExternalClientsRequi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -435,13 +470,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookProtectionRule.md similarity index 85% rename from exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OutlookProtectionRule.md index 9e222994d5..595590c4a5 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookProtectionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-OutlookProtectionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-outlookprotectionrule +schema: 2.0.0 +title: Set-OutlookProtectionRule --- # Set-OutlookProtectionRule @@ -64,13 +65,15 @@ This example sets the priority of the Outlook protection rule OPR-DG-Finance to ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApplyRightsProtectionTemplate parameter specifies an RMS template to be applied to messages matching the conditions. ```yaml Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -105,7 +113,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -123,7 +133,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to suppress the confirmation prompt that appears when you modify a rule with no conditions (the rule applies to all messages). @@ -141,7 +153,6 @@ Use this switch to suppress the confirmation prompt that appears when you modify Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -FromDepartment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FromDepartment parameter specifies a department name. The rule is applied to messages where the sender's department attribute matches this value. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -167,13 +180,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a name for the rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -183,6 +198,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Priority parameter specifies a priority for the Outlook protection rule. Rule priority values can range from 0 through n-1, where n is the total number of existing Outlook protection rules. Any existing rules with priority equal to or higher than the priority being set have their priority incremented by 1. @@ -191,7 +209,6 @@ Any existing rules with priority equal to or higher than the priority being set Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -201,6 +218,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SentTo parameter specifies one or more recipients. External recipients can be specified using the SMTP address. Internal recipients can be specified using any of the following values: @@ -216,7 +236,6 @@ Internal recipients can be specified using any of the following values: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -226,6 +245,9 @@ Accept wildcard characters: False ``` ### -SentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SentToScope parameter specifies the scope of messages to which the rule applies. Valid values include: - All: Applies to all messages. @@ -237,7 +259,6 @@ If not specified, the parameter defaults to All. Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,6 +268,9 @@ Accept wildcard characters: False ``` ### -UserCanOverride + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UserCanOverride parameter specifies whether the Outlook user can override the rule behavior, either by using a different RMS template, or by removing rights protection before sending the message. Valid values include: - $true: User can override rule action. @@ -256,7 +280,6 @@ The UserCanOverride parameter specifies whether the Outlook user can override th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -266,13 +289,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OutlookProvider.md b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookProvider.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-OutlookProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OutlookProvider.md index 3d9413c338..aca9ccddb2 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OutlookProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-outlookprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-OutlookProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-outlookprovider +schema: 2.0.0 +title: Set-OutlookProvider --- # Set-OutlookProvider @@ -51,13 +52,15 @@ This example changes the duration that the Autodiscover service settings are val ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the ADIDParameter value of the MAPI protocol for which you want to set global settings. ```yaml Type: OutlookProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -CertPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CertPrincipalName parameter specifies the Secure Sockets Layer (SSL) certificate principal name required for connecting to Exchange from an external location. This parameter is only used for Outlook Anywhere clients. @@ -75,7 +81,6 @@ This parameter is only used for Outlook Anywhere clients. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -94,7 +102,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a common name for the Outlook Provider Configuration object. This can be a user-friendly name for identification. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +147,15 @@ Accept wildcard characters: False ``` ### -OutlookProviderFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OutlookProviderFlags parameter specifies how Outlook clients should connect to the Exchange server. The value can be set to ServerExclusiveConnect, ExternalClientsRequireSSL, InternalClientsRequireSSL or to None to clear the flags. The recommended value is None, which is also the default setting. ```yaml Type: OutlookProviderFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +165,9 @@ Accept wildcard characters: False ``` ### -RequiredClientVersions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequiredClientVersions parameter specifies the minimum version of Microsoft Outlook that's allowed to connect to the Exchange server. This information is in the Autodiscover response to the client connection request. This parameter uses the syntax `"MinimumVersion, ExpirationDate"`. MinimumVersion is the version of Outlook in the format xx.x.xxxx.xxxx. For example, to specify Outlook 2010 Service Pack 2 (SP2), use the value 14.0.7012.1000. @@ -164,7 +180,6 @@ An example of a valid value for this parameter is `"14.0.7012.1000, 2020-01-01T1 Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Mailbox server to use for Outlook Anywhere clients. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,6 +207,9 @@ Accept wildcard characters: False ``` ### -TTL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TTL parameter specifies the duration (in hours) that the specified settings are valid. If a value is specified, the settings are rediscovered via the Autodiscover service after the duration specified with this parameter. A value of 0 indicates that no rediscovery is required. The default value is 1 hour. @@ -198,7 +218,6 @@ If a value is specified, the settings are rediscovered via the Autodiscover serv Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,13 +227,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-OwaMailboxPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OwaMailboxPolicy.md index c0190ec10f..4379af8950 100644 --- a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OwaMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-owamailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-OwaMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-owamailboxpolicy +schema: 2.0.0 +title: Set-OwaMailboxPolicy --- # Set-OwaMailboxPolicy @@ -199,6 +200,9 @@ This example disables Outlook UserVoice for the default mailbox policy in Micros ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Outlook on the web mailbox policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -209,7 +213,6 @@ The Identity parameter specifies the Outlook on the web mailbox policy that you Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -219,6 +222,9 @@ Accept wildcard characters: False ``` ### -AccountTransferEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -227,7 +233,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -237,6 +242,9 @@ Accept wildcard characters: False ``` ### -ActionForUnknownFileAndMIMETypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActionForUnknownFileAndMIMETypes parameter specifies how to handle file types that aren't specified in the Allow, Block, and Force Save lists for file types and MIME types. Valid values are: - Allow (This is the default value.) @@ -247,7 +255,6 @@ The ActionForUnknownFileAndMIMETypes parameter specifies how to handle file type Type: AttachmentBlockingActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -257,6 +264,9 @@ Accept wildcard characters: False ``` ### -AdditionalStorageProvidersAvailable + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AdditionalStorageProvidersAvailable parameter specifies whether to allow additional storage providers (for example, Box, Dropbox, Facebook, Google Drive, Egnyte, personal OneDrive) attachments in Outlook on the web. Valid values are: @@ -268,7 +278,6 @@ The AdditionalStorageProvidersAvailable parameter specifies whether to allow add Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -278,6 +287,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncIntegrationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActiveSyncIntegrationEnabled parameter specifies whether to enable or disable Exchange ActiveSync settings in Outlook on the web. Valid values are: - $true: ActiveSync is available in Outlook on the web. This is the default value. @@ -287,7 +299,6 @@ The ActiveSyncIntegrationEnabled parameter specifies whether to enable or disabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -297,6 +308,9 @@ Accept wildcard characters: False ``` ### -AdditionalAccountsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter has been deprecated and is no longer used. @@ -307,7 +321,6 @@ To enable or disable personal accounts in the new Outlook for Windows, use the P Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -317,6 +330,9 @@ Accept wildcard characters: False ``` ### -AllAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllAddressListsEnabled parameter specifies which address lists are available in Outlook on the web. Valid values are: - $true: All address lists are visible in Outlook on the web. This is the default value. @@ -326,7 +342,6 @@ The AllAddressListsEnabled parameter specifies which address lists are available Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -336,6 +351,9 @@ Accept wildcard characters: False ``` ### -AllowCopyContactsToDeviceAddressBook + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowCopyContactsToDeviceAddressBook parameter specifies whether users can copy the contents of their Contacts folder to a mobile device's native address book when using Outlook on the web for devices. Valid values are: - $true: Contacts can be copied to the device's address book in Outlook on the web for devices. This is the default value. @@ -345,7 +363,6 @@ The AllowCopyContactsToDeviceAddressBook parameter specifies whether users can c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -355,6 +372,9 @@ Accept wildcard characters: False ``` ### -AllowedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowedFileTypes parameter specifies the attachment file types (file extensions) that can be saved locally or viewed from Outlook on the web. The default values are: .avi, .bmp, .doc, .docm, .docx, .gif, .jpg, .mp3, .one, .pdf, .png, .ppsm, .ppsx, .ppt, .pptm, .pptx, .pub, .rpmsg, .rtf, .tif, .tiff, .txt, .vsd, .wav, .wma, .wmv, .xls, .xlsb, .xlsm, .xlsx, .zip @@ -372,7 +392,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -382,6 +401,9 @@ Accept wildcard characters: False ``` ### -AllowedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowedMimeTypes parameter specifies the MIME extensions of attachments that allow the attachments to be saved locally or viewed from Outlook on the web. The default values are: - image/bmp @@ -402,7 +424,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -412,6 +433,9 @@ Accept wildcard characters: False ``` ### -AllowedOrganizationAccountDomains + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The AllowedOrganizationAccountDomains parameter specifies domains where users can add work or school email accounts in the new Outlook for Windows. The default value is blank ($null), which allows work or school accounts from any domain. Setting this parameter to an empty list ([]) prevents any work or school accounts from being added. @@ -420,7 +444,6 @@ The AllowedOrganizationAccountDomains parameter specifies domains where users ca Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -430,6 +453,9 @@ Accept wildcard characters: False ``` ### -AllowOfflineOn + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The AllowOfflineOn parameter specifies when Outlook Web App in offline mode is available for supported web browsers. Valid values are: @@ -444,7 +470,6 @@ When offline mode is available, users can turn offline mode on or off themselves Type: AllowOfflineOnEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -454,6 +479,9 @@ Accept wildcard characters: False ``` ### -BizBarEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BizBarEnabled Description }} @@ -462,7 +490,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -472,6 +499,9 @@ Accept wildcard characters: False ``` ### -BlockedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BlockedFileTypes parameter specifies a list of attachment file types (file extensions) that can't be saved locally or viewed from Outlook on the web. The default values are: .ade, .adp, .apk, .app, .appcontent-ms, .application, .appref-ms, .appx, .asp, .aspx, .asx, .bas, .bat, .bgi, .cab, .cdxml, .cer, .chm, .cmd, .cnt, .com, .cpl, .crt, .csh, .der, .diagcab, .exe, .fxp, .gadget, .grp, .hlp, .hpj, .hta, .htc, .img, .inf, .ins, .iso, .isp, .its, .jar, .jnlp, .js, .jse, .ksh, .library-ms, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mcf, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .mht, .mhtml, .msc, .msh, .msh1, .msh1xml, .msh2, .msh2xml, .mshxml, .msi, .msp, .mst, .msu, .ops, .osd, .pcd, .pif, .pl, .plg, .prf, .prg, .printerexport, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .psd1, .psdm1, .pssc, .pst, .py, .pyc, .pyo, .pyw, .pyz, .pyzw, .reg, .scf, .scr, .sct, .search-ms, .settingcontent-ms, .shb, .shs, .theme, .tmp, .udl, .url, .vb, .vbe, .vbp, .vbs, .vhd, .vhdx, .vsmacros, .vsw, .webpnp, .website, .ws, .wsb, .wsc, .wsf, .wsh, .xbap, .xll, .xnk @@ -489,7 +519,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -499,6 +528,9 @@ Accept wildcard characters: False ``` ### -BlockedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The BlockedMimeTypes parameter specifies MIME extensions in attachments that prevent the attachments from being saved locally or viewed from Outlook on the web. The default values are: - application/hta @@ -523,7 +555,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -533,6 +564,9 @@ Accept wildcard characters: False ``` ### -BookingsMailboxCreationEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The BookingsMailboxCreationEnabled parameter allows you disable Microsoft Bookings. @@ -541,7 +575,6 @@ The BookingsMailboxCreationEnabled parameter allows you disable Microsoft Bookin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -551,6 +584,9 @@ Accept wildcard characters: False ``` ### -BookingsMailboxDomain + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill BookingsMailboxDomain Description }} @@ -559,7 +595,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -569,6 +604,9 @@ Accept wildcard characters: False ``` ### -BoxAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -577,7 +615,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -587,6 +624,9 @@ Accept wildcard characters: False ``` ### -CalendarEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The CalendarEnabled parameter specifies whether to enable or disable the calendar in Outlook Web App. Valid values are: @@ -598,7 +638,6 @@ The CalendarEnabled parameter specifies whether to enable or disable the calenda Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -608,6 +647,9 @@ Accept wildcard characters: False ``` ### -ChangePasswordEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The ChangePasswordEnabled parameter specifies whether users can change their passwords from inside Outlook on the web. Valid values are: @@ -619,7 +661,6 @@ The ChangePasswordEnabled parameter specifies whether users can change their pas Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -629,6 +670,9 @@ Accept wildcard characters: False ``` ### -ChangeSettingsAccountEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ChangeSettingsAccountEnabled parameter specifies whether users can change the email account where app-wide settings (for example, theme and privacy settings) are associated in the new Outlook for Windows. Valid values are: @@ -642,7 +686,6 @@ The ChangeSettingsAccountEnabled parameter specifies whether users can change th Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -652,6 +695,9 @@ Accept wildcard characters: False ``` ### -ClassicAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ClassicAttachmentsEnabled parameter specifies whether users can attach local files as regular email attachments in Outlook on the web. Valid values are: - $true: Users can attach local files to email messages in Outlook on the web. This is the default value. @@ -661,7 +707,6 @@ The ClassicAttachmentsEnabled parameter specifies whether users can attach local Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -671,6 +716,9 @@ Accept wildcard characters: False ``` ### -ConditionalAccessPolicy + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ConditionalAccessPolicy parameter specifies the Outlook on the Web Policy for limited access. For this feature to work properly, you also need to configure a Conditional Access policy in the Microsoft Entra admin center. @@ -687,7 +735,6 @@ Valid values are: Type: PolicyEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -697,6 +744,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -706,7 +756,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -716,6 +765,9 @@ Accept wildcard characters: False ``` ### -ContactsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The ContactsEnabled parameter specifies whether to enable or disable Contacts in Outlook Web App. Valid values are: @@ -727,7 +779,6 @@ The ContactsEnabled parameter specifies whether to enable or disable Contacts in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -737,13 +788,15 @@ Accept wildcard characters: False ``` ### -DefaultClientLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter has been deprecated and is no longer used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -753,6 +806,9 @@ Accept wildcard characters: False ``` ### -DefaultTheme + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://learn.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). Note that this parameter is a text string, and the value you specify isn't validated against the list of available themes. @@ -761,7 +817,6 @@ Note that this parameter is a text string, and the value you specify isn't valid Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -771,6 +826,9 @@ Accept wildcard characters: False ``` ### -DelegateAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The DelegateAccessEnabled parameter specifies whether delegates can use Outlook on the web or Outlook Web App to open folders that they have delegate access to. Valid values are: @@ -782,7 +840,6 @@ The DelegateAccessEnabled parameter specifies whether delegates can use Outlook Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -792,6 +849,9 @@ Accept wildcard characters: False ``` ### -DirectFileAccessOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DirectFileAccessOnPrivateComputersEnabled parameter specifies the left-click options for attachments in Outlook on the web for private computer sessions. Valid values are: - $true: Open is available for attachments in Outlook on the web for private computer sessions. This is the default value. @@ -803,7 +863,6 @@ By default in Exchange 2013 or later and Exchange Online, all Outlook on the web Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -813,6 +872,9 @@ Accept wildcard characters: False ``` ### -DirectFileAccessOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DirectFileAccessOnPublicComputersEnabled parameter specifies the left-click options for attachments in Outlook on the web for public computer sessions. Valid values are: - $true: Open is available for attachments in Outlook on the web for public computer sessions. This is the default value. @@ -824,7 +886,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -834,6 +895,9 @@ Accept wildcard characters: False ``` ### -DisableFacebook + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. **Note**: Facebook integration is no longer available. For more information, see [Facebook Connect is no longer available](https://support.microsoft.com/office/facebook-connect-is-no-longer-available-f31c8107-7b5a-4e3d-8a22-e506dacb6db6). @@ -849,7 +913,6 @@ The value of this switch is stored in the FacebookEnabled property in the output Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -859,6 +922,9 @@ Accept wildcard characters: False ``` ### -DisplayPhotosEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DisplayPhotosEnabled parameter specifies whether users see sender photos in Outlook on the web. Valid values are: - $true: Users see sender photos in Outlook on the web. This is the default value. @@ -868,7 +934,6 @@ The DisplayPhotosEnabled parameter specifies whether users see sender photos in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -878,6 +943,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -886,7 +954,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -896,6 +963,9 @@ Accept wildcard characters: False ``` ### -DropboxAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -904,7 +974,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -914,6 +983,9 @@ Accept wildcard characters: False ``` ### -EmptyStateEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill EmptyStateEnabled Description }} @@ -922,7 +994,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -932,6 +1003,9 @@ Accept wildcard characters: False ``` ### -ExplicitLogonEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The ExplicitLogonEnabled parameter specifies whether to allow a user to open someone else's mailbox in Outlook on the web (provided that user has permissions to the mailbox). Valid values are: @@ -943,7 +1017,6 @@ The ExplicitLogonEnabled parameter specifies whether to allow a user to open som Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -953,6 +1026,9 @@ Accept wildcard characters: False ``` ### -ExternalImageProxyEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExternalImageProxyEnabled parameter specifies whether to load all external images through the Outlook external image proxy. Valid values are: @@ -964,7 +1040,6 @@ The ExternalImageProxyEnabled parameter specifies whether to load all external i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -974,6 +1049,9 @@ Accept wildcard characters: False ``` ### -ExternalSPMySiteHostURL + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalSPMySiteHostURL specifies the My Site Host URL for external users (for example, `https://sp01.contoso.com`). This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. @@ -982,7 +1060,6 @@ This parameter is part of rich document collaboration that allows links to docum Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -992,6 +1069,9 @@ Accept wildcard characters: False ``` ### -FeedbackEnabled + +> Applicable: Exchange Online + This cmdlet is available only in the cloud-based service. The FeedbackEnabled parameter specifies whether to enable or disable inline feedback surveys in Outlook on the web. Valid values are: @@ -1005,7 +1085,6 @@ The FeedbackEnabled parameter specifies whether to enable or disable inline feed Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1015,6 +1094,9 @@ Accept wildcard characters: False ``` ### -ForceSaveAttachmentFilteringEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForceSaveAttachmentFilteringEnabled parameter specifies whether files are filtered before they can be saved from Outlook on the web. Valid values are: - $true: The attachments specified by the ForceSaveFileTypes parameter are filtered before they can be saved from Outlook on the web. @@ -1024,7 +1106,6 @@ The ForceSaveAttachmentFilteringEnabled parameter specifies whether files are fi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1034,6 +1115,9 @@ Accept wildcard characters: False ``` ### -ForceSaveFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForceSaveFileTypes parameter specifies the attachment file types (file extensions) that can only be saved from Outlook on the web (not opened). The default values are: .ade, .adp, .app, .asp, .aspx, .asx, .bas, .bat, .cer, .chm, .cmd, .com, .cpl, .crt, .csh, .dcr, .dir, .exe, .fxp, .gadget, .hlp, .hta, .htm, .html, .inf, .ins, .isp, .its, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .msc, .msh, .mshxml, .msi, .msp, .mst, .ops, .pcd, .pif, .plg, .prf, .prg, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .pst, .reg, .scf, .scr, .sct, .shb, .shs, .spl, .swf, .tmp, .url, .vb, .vbe, .vbs, .vsmacro, .vss, .vst, .vsw, .ws, .wsc, .wsf, .wsh @@ -1051,7 +1135,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1061,6 +1144,9 @@ Accept wildcard characters: False ``` ### -ForceSaveMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForceSaveMimeTypes parameter specifies the MIME extensions in attachments that only allow the attachments to be saved locally (not opened). The default values are: - Application/futuresplash @@ -1082,7 +1168,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1092,6 +1177,9 @@ Accept wildcard characters: False ``` ### -ForceWacViewingFirstOnPrivateComputers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForceWacViewingFirstOnPrivateComputers parameter specifies whether private computers must first preview an Office file as a web page in Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server) before opening the file in the local application. Valid values are: - $true: Private computers must first preview an Office file as a web page in Office Online Server before opening the file. @@ -1103,7 +1191,6 @@ By default in Exchange 2013 or later and Exchange Online, all Outlook on the web Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1113,6 +1200,9 @@ Accept wildcard characters: False ``` ### -ForceWacViewingFirstOnPublicComputers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForceWacViewingFirstOnPublicComputers parameter specifies whether public computers must first preview an Office file as a web page in Office Online Server before opening the file in the local application. Valid values are: - $true: Public computers must first preview an Office file as a web page in Office Online Server before opening the file. @@ -1124,7 +1214,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1134,6 +1223,9 @@ Accept wildcard characters: False ``` ### -ForceWebReadyDocumentViewingFirstOnPrivateComputers + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The ForceWebReadyDocumentViewingFirstOnPrivateComputers parameter specifies whether private computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file from Outlook Web App. Valid values are: @@ -1147,7 +1239,6 @@ By default in Exchange 2013 or later and Exchange Online, all Outlook on the web Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1157,6 +1248,9 @@ Accept wildcard characters: False ``` ### -ForceWebReadyDocumentViewingFirstOnPublicComputers + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The ForceWebReadyDocumentViewingFirstOnPublicComputers parameter specifies whether Public computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file from Outlook Web App. Valid values are: @@ -1170,7 +1264,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1180,6 +1273,9 @@ Accept wildcard characters: False ``` ### -FreCardsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1188,7 +1284,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1198,6 +1293,9 @@ Accept wildcard characters: False ``` ### -GlobalAddressListEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The GlobalAddressListEnabled parameter specifies whether the global address list is available in Outlook on the web. Valid values are: - $true: The global address list is visible in Outlook on the web. This is the default value. @@ -1207,7 +1305,6 @@ The GlobalAddressListEnabled parameter specifies whether the global address list Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1217,6 +1314,9 @@ Accept wildcard characters: False ``` ### -GoogleDriveAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1225,7 +1325,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1235,6 +1334,9 @@ Accept wildcard characters: False ``` ### -GroupCreationEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The GroupCreationEnabled parameter specifies whether Microsoft 365 Group creation is available in Outlook and Outlook on the web. Valid values are: @@ -1246,7 +1348,6 @@ The GroupCreationEnabled parameter specifies whether Microsoft 365 Group creatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1256,6 +1357,9 @@ Accept wildcard characters: False ``` ### -HideClassicOutlookToggleOut + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The HideClassicOutlookToggleOut parameter specifies whether to enable or disable hiding the toggle in new Outlook that allows users to switch back to classic Outlook. Valid values are: @@ -1267,7 +1371,6 @@ The HideClassicOutlookToggleOut parameter specifies whether to enable or disable Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1277,6 +1380,9 @@ Accept wildcard characters: False ``` ### -InstantMessagingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InstantMessagingEnabled parameter specifies whether instant messaging is available in Outlook on the web. This does not affect chat capabilities provided by Skype for Business or Teams. Valid values are: - $true: Instant messaging is available in Outlook on the web. This is the default value. @@ -1286,7 +1392,6 @@ The InstantMessagingEnabled parameter specifies whether instant messaging is ava Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1296,6 +1401,9 @@ Accept wildcard characters: False ``` ### -InstantMessagingType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InstantMessagingType parameter specifies the type of instant messaging provider in Outlook on the web. Valid values are: - None: This is the default value in on-premises Exchange. @@ -1305,7 +1413,6 @@ The InstantMessagingType parameter specifies the type of instant messaging provi Type: InstantMessagingTypeOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1315,6 +1422,9 @@ Accept wildcard characters: False ``` ### -InterestingCalendarsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The InterestingCalendarsEnabled parameter specifies whether interesting calendars are available in Outlook on the web. Valid values are: @@ -1326,7 +1436,6 @@ The InterestingCalendarsEnabled parameter specifies whether interesting calendar Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1336,6 +1445,9 @@ Accept wildcard characters: False ``` ### -InternalSPMySiteHostURL + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The InternalSPMySiteHostURL specifies the My Site Host URL for internal users (for example, `https://sp01.contoso.com`). This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. @@ -1344,7 +1456,6 @@ This parameter is part of rich document collaboration that allows links to docum Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1354,6 +1465,9 @@ Accept wildcard characters: False ``` ### -IRMEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IRMEnabled parameter specifies whether Information Rights Management (IRM) features are available in Outlook on the web. Valid values are: - $true: IRM is available in Outlook on the web. This is the default value. @@ -1363,7 +1477,6 @@ The IRMEnabled parameter specifies whether Information Rights Management (IRM) f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1373,17 +1486,19 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault switch specifies whether the Outlook on the web policy is the default policy that's used to configure the Outlook on the web settings for new mailboxes. You don't need to specify a value with this switch. If another policy is currently set as the default, this switch replaces the old default policy with this policy. -**Note**: In Exchange Online - and excluding resource mailboxes - this value will be superseded by the **OwaMailboxPolicy** parameter in each organization's [CASMailboxPlan](https://learn.microsoft.com/powershell/module/exchange/set-casmailboxplan). That value will instead be applied per each mailbox's SKU. +**Note**: In Exchange Online - and excluding resource mailboxes - this value will be superseded by the **OwaMailboxPolicy** parameter in each organization's [CASMailboxPlan](https://learn.microsoft.com/powershell/module/exchangepowershell/set-casmailboxplan). That value will instead be applied per each mailbox's SKU. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1393,6 +1508,9 @@ Accept wildcard characters: False ``` ### -ItemsToOtherAccountsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ItemsToOtherAccountsEnabled parameter specifies whether users can move or copy email messages between accounts. Valid values are: @@ -1406,7 +1524,6 @@ The ItemsToOtherAccountsEnabled parameter specifies whether users can move or co Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1416,6 +1533,9 @@ Accept wildcard characters: False ``` ### -JournalEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The JournalEnabled parameter specifies whether the Journal folder is available in Outlook on the web. Valid values are: - $true: The Journal folder is visible in Outlook on the web. This is the default value. @@ -1425,7 +1545,6 @@ The JournalEnabled parameter specifies whether the Journal folder is available i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1435,6 +1554,9 @@ Accept wildcard characters: False ``` ### -JunkEmailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The JunkEmailEnabled parameter specifies whether the Junk Email folder and junk email management are available in Outlook on the web. Valid values are: @@ -1446,7 +1568,6 @@ The JunkEmailEnabled parameter specifies whether the Junk Email folder and junk Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1456,6 +1577,9 @@ Accept wildcard characters: False ``` ### -LinkedInEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. LinkedIn integration is no longer supported. @@ -1464,7 +1588,6 @@ LinkedIn integration is no longer supported. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1474,6 +1597,9 @@ Accept wildcard characters: False ``` ### -LocalEventsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The LocalEventsEnabled parameter specifies whether local events calendars are available in Outlook on the web. Valid values are: @@ -1485,7 +1611,6 @@ The LocalEventsEnabled parameter specifies whether local events calendars are av Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1495,6 +1620,9 @@ Accept wildcard characters: False ``` ### -LogonAndErrorLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LogonAndErrorLanguage parameter specifies the language that used in Outlook on the web for forms-based authentication and for error messages when a user's current language setting can't be read. A valid value is a supported Microsoft Windows Language Code Identifier (LCID). For example, 1033 is US English. @@ -1505,7 +1633,6 @@ The default value is 0, which means the logon and error language selection is un Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1515,6 +1642,9 @@ Accept wildcard characters: False ``` ### -MessagePreviewsDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MessagePreviewsDisabled Description }} @@ -1523,7 +1653,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1533,6 +1662,9 @@ Accept wildcard characters: False ``` ### -MonthlyUpdatesEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MonthlyUpdatesEnabled Description }} @@ -1541,7 +1673,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1551,13 +1682,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name for the policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1567,6 +1700,9 @@ Accept wildcard characters: False ``` ### -NotesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NotesEnabled parameter specifies whether the Notes folder is available in Outlook on the web. Valid values are: - $true: The Notes folder is visible in Outlook on the web. This is the default value. @@ -1576,7 +1712,6 @@ The NotesEnabled parameter specifies whether the Notes folder is available in Ou Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1586,6 +1721,9 @@ Accept wildcard characters: False ``` ### -NpsSurveysEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The NpsSurveysEnabled parameter specifies whether to enable or disable the Net Promoter Score (NPS) survey in Outlook on the web. The survey allows users to rate Outlook on the web on a scale of 1 to 5, and to provide feedback and suggested improvements in free text. Valid values are: @@ -1597,7 +1735,6 @@ The NpsSurveysEnabled parameter specifies whether to enable or disable the Net P Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1607,6 +1744,9 @@ Accept wildcard characters: False ``` ### -OfflineEnabledWeb + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OfflineEnabledWeb parameter specifies whether offline capabilities are available in Outlook on the web, including saving items to the local device (view items without an internet connection). Valid values are: @@ -1620,7 +1760,6 @@ When offline capabilities are available, users can turn offline capabilities on Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1630,6 +1769,9 @@ Accept wildcard characters: False ``` ### -OfflineEnabledWin + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OfflineEnabledWin parameter specifies whether offline capabilities are available in the new Outlook for Windows, including saving items to the local device (view items without an internet connection). Valid values are: @@ -1643,7 +1785,6 @@ When offline capabilities are available, users can turn offline capabilities on Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1653,6 +1794,9 @@ Accept wildcard characters: False ``` ### -OneDriveAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -1661,7 +1805,6 @@ To enable or disable personal OneDrive in Outlook on the web, use the Additional Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1671,6 +1814,9 @@ Accept wildcard characters: False ``` ### -OneWinNativeOutlookEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OneWinNativeOutlookEnabled parameter controls the availability of the new Outlook for Windows App. Valid values are: @@ -1682,7 +1828,6 @@ The OneWinNativeOutlookEnabled parameter controls the availability of the new Ou Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named Default value: None @@ -1703,7 +1848,6 @@ The OnSendAddinsEnabled parameter specifies whether a mail item can be edited wh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1713,13 +1857,15 @@ Accept wildcard characters: False ``` ### -OrganizationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + When the OrganizationEnabled parameter is set to $false, the Automatic Reply option doesn't include external and internal options, the address book doesn't show the organization hierarchy, and the Resources tab in Calendar forms is disabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1729,6 +1875,9 @@ Accept wildcard characters: False ``` ### -OutboundCharset + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OutboundCharset parameter specifies the character set that's used for outgoing messages in Outlook on the web. Valid values are: - AutoDetect: Examine the first 2 kilobytes (KB) of text in the message to determine the character set that's used in outgoing messages. This is the default value. @@ -1739,7 +1888,6 @@ The OutboundCharset parameter specifies the character set that's used for outgoi Type: OutboundCharsetOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1749,6 +1897,9 @@ Accept wildcard characters: False ``` ### -OutlookBetaToggleEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookBetaToggleEnabled parameter specifies whether to enable or disable the Outlook on the web Preview toggle. The Preview toggle allows users to try the new Outlook on the web experience. Valid values are: @@ -1760,7 +1911,6 @@ The OutlookBetaToggleEnabled parameter specifies whether to enable or disable th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1770,6 +1920,9 @@ Accept wildcard characters: False ``` ### -OutlookNewslettersAccessLevel + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookNewslettersAccessLevelAccess parameter specifies the access level in Outlook Newsletters. Valid values are: @@ -1783,7 +1936,6 @@ The OutlookNewslettersAccessLevelAccess parameter specifies the access level in Type: OutlookNewslettersAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1793,6 +1945,9 @@ Accept wildcard characters: False ``` ### -OutlookDataFile + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookDataFile parameter specifies what users can do with .pst files in the new Outlook for Windows. Valid values are: @@ -1808,7 +1963,6 @@ The OutlookDataFile parameter specifies what users can do with .pst files in the Type: OutlookDataFileFeatureState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1818,6 +1972,9 @@ Accept wildcard characters: False ``` ### -OutlookNewslettersReactions + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookNewslettersReactions parameter specifies whether reactions are enabled in Outlook Newsletters. Readers can react to individual sections or the entire newsletter. They can also comment using integrated controls at the end of the newsletter. Valid values are: @@ -1831,7 +1988,6 @@ The OutlookNewslettersReactions parameter specifies whether reactions are enable Type: OutlookNewslettersFeatureState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1841,6 +1997,9 @@ Accept wildcard characters: False ``` ### -OutlookNewslettersShowMore + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The OutlookNewslettersShowMore parameter specifies whether recommendations to other Outlook Newsletters are included in the footer of published newsletter editions. Valid values are: @@ -1856,7 +2015,6 @@ Authors can disable these recommendations for each individual newsletter edition Type: OutlookNewslettersFeatureState Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1866,6 +2024,9 @@ Accept wildcard characters: False ``` ### -OWALightEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWALightEnabled parameter controls the availability of the light version of Outlook on the web. Valid values are: - $true: The light version of Outlook on the web is available. This is the default value. @@ -1875,7 +2036,6 @@ The OWALightEnabled parameter controls the availability of the light version of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1885,6 +2045,9 @@ Accept wildcard characters: False ``` ### -OWAMiniEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAMiniEnabled parameter controls the availability of the mini version of Outlook Web App. Valid values are: @@ -1896,7 +2059,6 @@ The OWAMiniEnabled parameter controls the availability of the mini version of Ou Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1906,6 +2068,9 @@ Accept wildcard characters: False ``` ### -PersonalAccountCalendarsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PersonalAccountCalendarsEnabled parameter specifies whether to allow users to connect to their personal Outlook.com or Google Calendar in Outlook on the web. Valid values are: @@ -1917,7 +2082,6 @@ The PersonalAccountCalendarsEnabled parameter specifies whether to allow users t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1927,6 +2091,9 @@ Accept wildcard characters: False ``` ### -PersonalAccountsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PersonalAccountsEnabled parameter specifies whether to allow users to add their personal accounts (for example, Outlook.com, Gmail, or Yahoo!) in the new Outlook for Windows. Valid values are: @@ -1938,7 +2105,6 @@ The PersonalAccountsEnabled parameter specifies whether to allow users to add th Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1948,13 +2114,15 @@ Accept wildcard characters: False ``` ### -PhoneticSupportEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PhoneticSupportEnabled parameter specifies phonetically spelled entries in the address book. This parameter is available for use in Japan. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1964,6 +2132,9 @@ Accept wildcard characters: False ``` ### -PlacesEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PlacesEnabled parameter specifies whether to enable or disable Places in Outlook on the web. Places lets users search, share, and map location details by using Bing. Valid values are: @@ -1975,7 +2146,6 @@ The PlacesEnabled parameter specifies whether to enable or disable Places in Out Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1985,6 +2155,9 @@ Accept wildcard characters: False ``` ### -PremiumClientEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PremiumClientEnabled parameter controls the availability of the full version of Outlook Web App. Valid values are: - $true: The full version of Outlook Web App is available for supported browsers. This is the default value. @@ -1994,7 +2167,6 @@ The PremiumClientEnabled parameter controls the availability of the full version Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2004,6 +2176,9 @@ Accept wildcard characters: False ``` ### -PrintWithoutDownloadEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PrintWithoutDownloadEnabled specifies whether to allow printing of supported files without downloading the attachment in Outlook on the web. Valid values are: @@ -2015,7 +2190,6 @@ The PrintWithoutDownloadEnabled specifies whether to allow printing of supported Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2025,6 +2199,9 @@ Accept wildcard characters: False ``` ### -ProjectMocaEnabled + +> Applicable: Exchange Online + **Note**: The feature that's associated with this parameter is currently in Preview, is not available to all organizations, and is subject to change. This parameter is available only in the cloud-based service. @@ -2038,7 +2215,6 @@ The ProjectMocaEnabled parameter enables or disables access to Project Moca in O Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2048,6 +2224,9 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in Exchange Server 2010. The PublicFoldersEnabled parameter specifies whether a user can browse or read items in public folders in Outlook Web App. Valid values are: @@ -2059,7 +2238,6 @@ The PublicFoldersEnabled parameter specifies whether a user can browse or read i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2069,6 +2247,9 @@ Accept wildcard characters: False ``` ### -RecoverDeletedItemsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in Exchange Server 2010. The RecoverDeletedItemsEnabled parameter specifies whether a user can use Outlook Web App to view, recover, or delete permanently items that have been deleted from the Deleted Items folder. Valid values are: @@ -2080,7 +2261,6 @@ The RecoverDeletedItemsEnabled parameter specifies whether a user can use Outloo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2090,6 +2270,9 @@ Accept wildcard characters: False ``` ### -ReferenceAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReferenceAttachmentsEnabled parameter specifies whether users can attach files from the cloud as linked attachments in Outlook on the web. Valid values are: - $true: Users can attach files that are stored in the cloud as linked attachments. If the file hasn't been uploaded to the cloud yet, the users can attach and upload the file in the same step. This is the default value. @@ -2099,7 +2282,6 @@ The ReferenceAttachmentsEnabled parameter specifies whether users can attach fil Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2109,6 +2291,9 @@ Accept wildcard characters: False ``` ### -RemindersAndNotificationsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemindersAndNotificationsEnabled parameter specifies whether notifications and reminders are enabled in Outlook on the web. Valid values are: - $true: Notifications and reminders are enabled in Outlook on the web. This is the default value. @@ -2120,7 +2305,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2130,6 +2314,9 @@ Accept wildcard characters: False ``` ### -ReportJunkEmailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: In Exchange Online, this parameter does not affect the ability of users to report messages. Whether a user is able to report messages and where is controlled in the Microsoft Defender portal as described in [User reported message settings](https://learn.microsoft.com/defender-office-365/submissions-user-reported-messages-custom-mailbox). The ReportJunkEmailEnabled parameter specifies whether users can report messages as junk or not junk to Microsoft in Outlook on the web. Valid values are: @@ -2143,7 +2330,6 @@ This parameter is meaningful only when the JunkEmailEnabled parameter is set to Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2153,6 +2339,9 @@ Accept wildcard characters: False ``` ### -RulesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RulesEnabled parameter specifies whether a user can view, create, or modify server-side rules in Outlook on the web. Valid values are: - $true: Users can view, create, or modify server-side rules in Outlook on the web. This is the default value. @@ -2162,7 +2351,6 @@ The RulesEnabled parameter specifies whether a user can view, create, or modify Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2172,6 +2360,9 @@ Accept wildcard characters: False ``` ### -SatisfactionEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SatisfactionEnabled parameter specifies whether to enable or disable the satisfaction survey. Valid values are: - $true: The satisfaction survey is enabled. This is the default value. @@ -2181,7 +2372,6 @@ The SatisfactionEnabled parameter specifies whether to enable or disable the sat Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2191,6 +2381,9 @@ Accept wildcard characters: False ``` ### -SaveAttachmentsToCloudEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SaveAttachmentsToCloudEnabled parameter specifies whether users can save regular email attachments to the cloud. Valid values are: - $true: Users can save regular email attachments to the cloud. This is the default value. @@ -2200,7 +2393,6 @@ The SaveAttachmentsToCloudEnabled parameter specifies whether users can save reg Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2210,6 +2402,9 @@ Accept wildcard characters: False ``` ### -SearchFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SearchFoldersEnabled parameter specifies whether Search Folders are available in Outlook on the web. Valid values are: - $true: Search Folders are visible in Outlook on the Web. This is the default value. @@ -2219,7 +2414,6 @@ The SearchFoldersEnabled parameter specifies whether Search Folders are availabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2229,6 +2423,9 @@ Accept wildcard characters: False ``` ### -SetPhotoEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SetPhotoEnabled parameter specifies whether users can add, change, and remove their sender photo in Outlook on the web. Valid values are: - $true: Users can manage their photos in Outlook on the web. This is the default value. @@ -2240,7 +2437,6 @@ The SetPhotoEnabled parameter specifies whether users can add, change, and remov Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2250,13 +2446,15 @@ Accept wildcard characters: False ``` ### -SetPhotoURL + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SetPhotoURL parameter controls where users go to select their photo. Note that you can't specify a URL that contains one or more picture files, as there is no mechanism to copy a URL photo to the properties of the users' Exchange Online mailboxes. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2266,6 +2464,9 @@ Accept wildcard characters: False ``` ### -ShowOnlineArchiveEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ShowOnlineArchiveEnabled Description }} @@ -2274,7 +2475,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2284,6 +2484,9 @@ Accept wildcard characters: False ``` ### -SignaturesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SignaturesEnabled parameter specifies whether to enable or disable the use of signatures in Outlook on the web. Valid values are: - $true: Signatures are available in Outlook on the web. This is the default value. @@ -2293,7 +2496,6 @@ The SignaturesEnabled parameter specifies whether to enable or disable the use o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2303,6 +2505,9 @@ Accept wildcard characters: False ``` ### -SilverlightEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in Exchange Server 2010. The SilverlightEnabled parameter specifies whether a user can use Microsoft Silverlight features in Outlook Web App. Valid values are: @@ -2314,7 +2519,6 @@ The SilverlightEnabled parameter specifies whether a user can use Microsoft Silv Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2324,6 +2528,9 @@ Accept wildcard characters: False ``` ### -SkipCreateUnifiedGroupCustomSharepointClassification + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The SkipCreateUnifiedGroupCustomSharepointClassification parameter specifies whether to skip a custom SharePoint page during the creation of Microsoft 365 Groups in Outlook on the web. Valid values are: @@ -2335,7 +2542,6 @@ The SkipCreateUnifiedGroupCustomSharepointClassification parameter specifies whe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2345,6 +2551,9 @@ Accept wildcard characters: False ``` ### -SMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The SMimeEnabled parameter specifies whether users can download the S/MIME control for Outlook Web App and use it to read and compose signed and encrypted messages. Valid values are: @@ -2358,7 +2567,6 @@ The SMimeEnabled parameter specifies whether users can download the S/MIME contr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2368,6 +2576,9 @@ Accept wildcard characters: False ``` ### -SMimeSuppressNameChecksEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SMimeSuppressNameChecksEnabled switch specifies whether to suppress name check in S/MIME messages. You don't need to specify a value with this switch. @@ -2376,7 +2587,6 @@ The SMimeSuppressNameChecksEnabled switch specifies whether to suppress name che Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2386,6 +2596,9 @@ Accept wildcard characters: False ``` ### -SpellCheckerEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in Exchange Server 2010. The SpellCheckerEnabled parameter specifies whether to enable or disable the built-in Outlook Web App spell checker in the full version of Outlook Web App. Valid values are: @@ -2399,7 +2612,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2409,6 +2621,9 @@ Accept wildcard characters: False ``` ### -TasksEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The TasksEnabled parameter specifies whether Tasks folder is available in Outlook Web App. Valid values are: @@ -2422,7 +2637,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2432,6 +2646,9 @@ Accept wildcard characters: False ``` ### -TeamSnapCalendarsEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The TeamSnapCalendarsEnabled parameter specifies whether to allow users to connect to their personal TeamSnap calendars in Outlook on the web. Valid values are: @@ -2443,7 +2660,6 @@ The TeamSnapCalendarsEnabled parameter specifies whether to allow users to conne Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2453,6 +2669,9 @@ Accept wildcard characters: False ``` ### -TextMessagingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TextMessagingEnabled parameter specifies whether users can send and receive text messages in Outlook on the web. Valid values are: - $true: Text messaging is available in Outlook on the web. This is the default value. @@ -2464,7 +2683,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2474,6 +2692,9 @@ Accept wildcard characters: False ``` ### -ThemeSelectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ThemeSelectionEnabled parameter specifies whether users can change the theme in Outlook on the web. Valid values are: - $true: Users can specify the theme in Outlook on the web. This is the default value. @@ -2483,7 +2704,6 @@ The ThemeSelectionEnabled parameter specifies whether users can change the theme Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2493,6 +2713,9 @@ Accept wildcard characters: False ``` ### -ThirdPartyAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -2501,7 +2724,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2511,6 +2733,9 @@ Accept wildcard characters: False ``` ### -UMIntegrationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UMIntegrationEnabled parameter specifies whether Unified Messaging (UM) integration is enabled in Outlook on the web. Valid values are: - $true: UM integration is enabled in Outlook on the web. This is the default value. @@ -2524,7 +2749,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2534,6 +2758,9 @@ Accept wildcard characters: False ``` ### -UNCAccessOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter has been deprecated and is no longer used. @@ -2542,7 +2769,6 @@ This parameter has been deprecated and is no longer used. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2552,6 +2778,9 @@ Accept wildcard characters: False ``` ### -UNCAccessOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter has been deprecated and is no longer used. @@ -2560,7 +2789,6 @@ This parameter has been deprecated and is no longer used. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2570,6 +2798,9 @@ Accept wildcard characters: False ``` ### -UseGB18030 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UseGB18030 parameter specifies whether to use the GB18030 character set instead of GB2312 in Outlook on the web. Valid values are: - $true: GB18030 is used wherever GB2312 would have been used in Outlook on the web. @@ -2579,7 +2810,6 @@ The UseGB18030 parameter specifies whether to use the GB18030 character set inst Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2589,6 +2819,9 @@ Accept wildcard characters: False ``` ### -UseISO885915 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UseISO885915 parameter specifies whether to use the character set ISO8859-15 instead of ISO8859-1 in Outlook on the web. Valid values are: - $true: ISO8859-15 is used wherever ISO8859-1 would have been used in Outlook on the web. @@ -2598,7 +2831,6 @@ The UseISO885915 parameter specifies whether to use the character set ISO8859-15 Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2608,6 +2840,9 @@ Accept wildcard characters: False ``` ### -UserVoiceEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The UserVoiceEnabled parameter specifies whether to enable or disable Outlook UserVoice in Outlook on the web. Outlook UserVoice is a customer feedback area that's available in Microsoft 365. Valid values are: @@ -2619,7 +2854,6 @@ The UserVoiceEnabled parameter specifies whether to enable or disable Outlook Us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2629,6 +2863,9 @@ Accept wildcard characters: False ``` ### -WacEditingEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WacEditingEnabled parameter specifies whether to enable or disable editing documents in Outlook on the web by using Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server). Valid values are: - $true: Users can edit supported documents in Outlook on the web. This is the default value. @@ -2638,7 +2875,6 @@ The WacEditingEnabled parameter specifies whether to enable or disable editing d Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2648,6 +2884,9 @@ Accept wildcard characters: False ``` ### -WacExternalServicesEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WacExternalServicesEnabled parameter specifies whether to enable or disable external services when viewing documents in Outlook on the web (for example, machine translation) by using Office Online Server. Valid values are: - $true: External services are enabled when viewing supported documents in Outlook on the web. This is the default value. @@ -2657,7 +2896,6 @@ The WacExternalServicesEnabled parameter specifies whether to enable or disable Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2667,6 +2905,9 @@ Accept wildcard characters: False ``` ### -WacOMEXEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WacOMEXEnabled parameter specifies whether to enable or disable apps for Outlook in Outlook on the web in Office Online Server. Valid values are: - $true: apps for Outlook are enabled in Outlook on the web. @@ -2676,7 +2917,6 @@ The WacOMEXEnabled parameter specifies whether to enable or disable apps for Out Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2686,6 +2926,9 @@ Accept wildcard characters: False ``` ### -WacViewingOnPrivateComputersEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WacViewingOnPrivateComputersEnabled parameter specifies whether to enable or disable web viewing of supported Office documents private computer sessions in Office Online Server (formerly known as Office Web Apps Server and Web Access Companion Server). By default, all Outlook on the web sessions are considered to be on private computers. Valid values are: - $true: In private computer sessions, users can view supported Office documents in the web browser. This is the default value. @@ -2697,7 +2940,6 @@ By default in Exchange 2013 or later and Exchange Online, all Outlook on the web Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2707,6 +2949,9 @@ Accept wildcard characters: False ``` ### -WacViewingOnPublicComputersEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WacViewingOnPublicComputersEnabled parameter specifies whether to enable or disable web viewing of supported Office documents in public computer sessions in Office Online Server. Valid values are: - $true: In public computer sessions, users can view supported Office documents in the web browser. This is the default value. @@ -2718,7 +2963,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2728,6 +2972,9 @@ Accept wildcard characters: False ``` ### -WeatherEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The WeatherEnabled parameter specifies whether to enable or disable weather information in the calendar in Outlook on the web. Valid values are: @@ -2739,7 +2986,6 @@ The WeatherEnabled parameter specifies whether to enable or disable weather info Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -2749,6 +2995,9 @@ Accept wildcard characters: False ``` ### -WebPartsFrameOptionsType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WebPartsFrameOptionsType parameter specifies what sources can access web parts in IFRAME or FRAME elements in Outlook on the web. Valid values are: - None: There are no restrictions on displaying Outlook on the web content in a frame. @@ -2759,7 +3008,6 @@ The WebPartsFrameOptionsType parameter specifies what sources can access web par Type: WebPartsFrameOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2769,6 +3017,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingForAllSupportedTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingForAllSupportedTypes parameter specifies whether to enable WebReady Document Viewing for all supported file and MIME types. Valid values are: @@ -2780,7 +3031,6 @@ The WebReadyDocumentViewingForAllSupportedTypes parameter specifies whether to e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2790,6 +3040,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingOnPrivateComputersEnabled parameter specifies whether WebReady Document Viewing is available in private computer sessions. Valid values are: @@ -2803,7 +3056,6 @@ By default in Exchange 2013, all Outlook on the web sessions are considered to b Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2813,6 +3065,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingOnPublicComputersEnabled parameter specifies whether WebReady Document Viewing is in public computer sessions. Valid values are: @@ -2826,7 +3081,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2836,6 +3090,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingSupportedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. This is a read-only parameter that can't be modified; use the WebReadyFileTypes parameter instead. @@ -2844,7 +3101,6 @@ This is a read-only parameter that can't be modified; use the WebReadyFileTypes Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2854,6 +3110,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingSupportedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. This is a read-only parameter that can't be modified; use the WebReadyMimeTypes parameter instead. @@ -2862,7 +3121,6 @@ This is a read-only parameter that can't be modified; use the WebReadyMimeTypes Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2872,6 +3130,9 @@ Accept wildcard characters: False ``` ### -WebReadyFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyFileTypes parameter specifies the attachment file types (file extensions) that can be viewed by WebReady Document Viewing in Outlook on the web. The default value is all supported file types: @@ -2899,7 +3160,6 @@ This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parame Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2909,6 +3169,9 @@ Accept wildcard characters: False ``` ### -WebReadyMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyMimeTypes parameter specifies the MIME extensions of attachments that allow the attachments to be viewed by WebReady Document Viewing in Outlook on the web. The default value is all supported MIME types: @@ -2935,7 +3198,6 @@ This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parame Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2945,13 +3207,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2961,13 +3225,15 @@ Accept wildcard characters: False ``` ### -WSSAccessOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter has been deprecated and is no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2977,13 +3243,15 @@ Accept wildcard characters: False ``` ### -WSSAccessOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter has been deprecated and is no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3009,10 +3277,10 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[New-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchange/new-owamailboxpolicy) +[New-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-owamailboxpolicy) -[Get-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchange/get-owamailboxpolicy) +[Get-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/get-owamailboxpolicy) -[Set-CASMailbox](https://learn.microsoft.com/powershell/module/exchange/set-casmailbox) +[Set-CASMailbox](https://learn.microsoft.com/powershell/module/exchangepowershell/set-casmailbox) [Outlook on the web mailbox policy procedures in Exchange Online](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-on-the-web/outlook-web-app-mailbox-policy-procedures) diff --git a/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-OwaVirtualDirectory.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-OwaVirtualDirectory.md index 14358aa512..bb19fab87e 100644 --- a/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-OwaVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-owavirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-OwaVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-owavirtualdirectory +schema: 2.0.0 +title: Set-OwaVirtualDirectory --- # Set-OwaVirtualDirectory @@ -182,6 +183,9 @@ This example sets the ActionForUnknownFileAndMIMETypes parameter to Block on the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the OWA virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -194,7 +198,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -204,6 +207,9 @@ Accept wildcard characters: False ``` ### -ActionForUnknownFileAndMIMETypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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.) @@ -214,7 +220,6 @@ The ActionForUnknownFileAndMIMETypes parameter specifies how to handle file type Type: AttachmentBlockingActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,6 +229,9 @@ Accept wildcard characters: False ``` ### -ActiveSyncIntegrationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -233,7 +241,6 @@ The ActiveSyncIntegrationEnabled parameter specifies whether to enable or disabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,6 +250,9 @@ Accept wildcard characters: False ``` ### -AdfsAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AdfsAuthentication parameter enables or disables Active Directory Federation Services (ADFS) authentication on the Outlook on the web virtual directory. Valid values are: - $true: ADFS authentication is enabled. You need to set the AdfsAuthentication parameter on Set-EcpVirtualDirectory to $true before you can use this value. @@ -252,7 +262,6 @@ The AdfsAuthentication parameter enables or disables Active Directory Federation Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,6 +271,9 @@ Accept wildcard characters: False ``` ### -AllAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -271,7 +283,6 @@ The AllAddressListsEnabled parameter specifies which address lists are available Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -281,6 +292,9 @@ Accept wildcard characters: False ``` ### -AllowCopyContactsToDeviceAddressBook + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -290,7 +304,6 @@ The AllowCopyContactsToDeviceAddressBook parameter specifies whether users can c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,6 +313,9 @@ Accept wildcard characters: False ``` ### -AllowedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AllowedFileTypes parameter specifies the attachment file types (file extensions) that can be saved locally or viewed from Outlook on the web. The default values are: .avi, .bmp, .doc, .docm, .docx, .gif, .jpg, .mp3, .one, .pdf, .png, .ppsm, .ppsx, .ppt, .pptm, .pptx, .pub, .rpmsg, .rtf, .tif, .tiff, .txt, .vsd, .wav, .wma, .wmv, .xls, .xlsb, .xlsm, .xlsx, .zip @@ -317,7 +333,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -327,6 +342,9 @@ Accept wildcard characters: False ``` ### -AllowedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AllowedMimeTypes parameter specifies the MIME extensions of attachments that allow the attachments to be saved locally or viewed from Outlook on the web. The default values are: - image/bmp @@ -347,7 +365,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,6 +374,9 @@ Accept wildcard characters: False ``` ### -AllowOfflineOn + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AllowOfflineOn parameter specifies when Outlook on the web in offline mode is available for supported web browsers. Valid values are: - PrivateComputersOnly: Offline mode is available in private computer sessions. By default in Exchange 2013 or later, all Outlook on the web sessions are considered to be on private computers. In Exchange 2013 or later, users can only specify public computer sessions if you've enabled the private/public selection on the sign in page (the LogonPagePublicPrivateSelectionEnabled parameter value is $true). @@ -369,7 +389,6 @@ When offline mode is available, users can turn offline mode on or off themselves Type: AllowOfflineOnEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -379,6 +398,9 @@ Accept wildcard characters: False ``` ### -AnonymousFeaturesEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnonymousFeaturesEnabled parameter specifies whether you want to allow Outlook on the web users that are logged on anonymously to access specific features. Valid values are: - $true: Features are enabled for anonymous users. For example, anonymous users can view and change meeting content. This is the default value. @@ -388,7 +410,6 @@ The AnonymousFeaturesEnabled parameter specifies whether you want to allow Outlo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -398,6 +419,9 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: - $true: Basic authentication is enabled. This is the default value. @@ -409,7 +433,6 @@ This parameter can be used with the FormsAuthentication parameter or with the Di Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -419,6 +442,9 @@ Accept wildcard characters: False ``` ### -BlockedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BlockedFileTypes parameter specifies a list of attachment file types (file extensions) that can't be saved locally or viewed from Outlook on the web. The default values are: .ade, .adp, .app, .appcontent-ms, .asp, .aspx, .asx, .bas, .bat, .cer, .chm, .cmd, .cnt, .com, .cpl, .crt, .csh, .der, .diagcab, .exe, .fxp, .gadget, .grp, .hlp, .hpj, .hta, .htc, .inf, .ins, .isp, .its, .jar, .jnlp, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mcf, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .mht, .mhtml, .msc, .msh, .msh1, .msh1xml, .msh2, .msh2xml, .mshxml, .msi, .msp, .mst, .msu, .ops, .osd, .pcd, .pif, .pl, .plg, .prf, .prg, .printerexport, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .psd1, .psdm1, .pst, .reg, .scf, .scr, .sct, .settingcontent-ms, .shb, .shs, .theme, .tmp, .url, .vb, .vbe, .vbp, .vbs, .vsmacros, .vsw, .webpnp, .website, .ws, .wsc, .wsf, .wsh, .xbap, .xll, .xnk @@ -436,7 +462,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -446,6 +471,9 @@ Accept wildcard characters: False ``` ### -BlockedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BlockedMimeTypes parameter specifies MIME extensions in attachments that prevent the attachments from being saved locally or viewed from Outlook on the web. The default values are: - application/hta @@ -470,7 +498,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -480,13 +507,15 @@ Accept wildcard characters: False ``` ### -BoxAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -496,6 +525,9 @@ Accept wildcard characters: False ``` ### -CalendarEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarEnabled parameter specifies whether to enable or disable the calendar in Outlook on the web. Valid values are: - $true: The Calendar is available in Outlook on the web. This is the default value. @@ -505,7 +537,6 @@ The CalendarEnabled parameter specifies whether to enable or disable the calenda Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -515,6 +546,9 @@ Accept wildcard characters: False ``` ### -CalendarPublishingEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CalendarPublishingEnabled parameter specifies whether users can publish their calendar from Outlook Web App. Valid values are: @@ -526,7 +560,6 @@ The CalendarPublishingEnabled parameter specifies whether users can publish thei Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -536,6 +569,9 @@ Accept wildcard characters: False ``` ### -ChangePasswordEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ChangePasswordEnabled parameter specifies whether users can change their passwords from inside Outlook on the web. Valid values are: - $true: The Change password option is available in Outlook on the web. This is the default value in on-premises Exchange. @@ -545,7 +581,6 @@ The ChangePasswordEnabled parameter specifies whether users can change their pas Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -555,6 +590,9 @@ Accept wildcard characters: False ``` ### -ClassicAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + 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. @@ -564,7 +602,6 @@ The ClassicAttachmentsEnabled parameter specifies whether users can attach local Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -574,6 +611,9 @@ Accept wildcard characters: False ``` ### -ClientAuthCleanupLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ClientAuthCleanupLevel parameter specifies how much of the cache is cleared when the user logs off from Outlook on the web. Valid values are: - Low @@ -585,7 +625,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: ClientAuthCleanupLevels Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -595,6 +634,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -604,7 +646,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -614,6 +655,9 @@ Accept wildcard characters: False ``` ### -ContactsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ContactsEnabled parameter specifies whether to enable or disable Contacts in Outlook on the web. Valid values are: - $true: Contacts are available in Outlook on the web. This is the default value. @@ -623,7 +667,6 @@ The ContactsEnabled parameter specifies whether to enable or disable Contacts in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -633,6 +676,9 @@ Accept wildcard characters: False ``` ### -CrossSiteRedirectType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CrossSiteRedirectType parameter controls how a Client Access server redirects Outlook Web App to the Client Access server infrastructure in another Active Directory site. Valid values are: @@ -646,7 +692,6 @@ The default value is Manual. Type: LegacyRedirectTypeOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -656,13 +701,15 @@ Accept wildcard characters: False ``` ### -DefaultClientLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -672,13 +719,15 @@ Accept wildcard characters: False ``` ### -DefaultDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DefaultDomain parameter specifies which domain to use when the LogonFormat parameter is set to UserName (for example, contoso.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -688,6 +737,9 @@ Accept wildcard characters: False ``` ### -DefaultTheme + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://learn.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). Note that this parameter is a text string, and the value you specify isn't validated against the list of available themes. @@ -696,7 +748,6 @@ Note that this parameter is a text string, and the value you specify isn't valid Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -706,6 +757,9 @@ Accept wildcard characters: False ``` ### -DelegateAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The DelegateAccessEnabled parameter specifies whether delegates can use Outlook Web App to open folders that they have delegate access to. Valid values are: @@ -717,7 +771,6 @@ The DelegateAccessEnabled parameter specifies whether delegates can use Outlook Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -727,6 +780,9 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. @@ -738,7 +794,6 @@ You can use this parameter with the FormsAuthentication parameter. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -748,6 +803,9 @@ Accept wildcard characters: False ``` ### -DirectFileAccessOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -759,7 +817,6 @@ By default in Exchange 2013 or later, all Outlook on the web sessions are consid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -769,6 +826,9 @@ Accept wildcard characters: False ``` ### -DirectFileAccessOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -780,7 +840,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -790,6 +849,9 @@ Accept wildcard characters: False ``` ### -DisplayPhotosEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -799,7 +861,6 @@ The DisplayPhotosEnabled parameter specifies whether users see sender photos in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -809,13 +870,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -825,13 +888,15 @@ Accept wildcard characters: False ``` ### -DropboxAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -841,6 +906,9 @@ Accept wildcard characters: False ``` ### -Exchange2003Url + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The Exchange2003Url parameter specifies the Outlook Web App URL for Exchange Server 2003 mailboxes. The URL must include the Outlook Web App virtual directory name, even if you're using a redirect to simplify the URL specified by the Exchange2003Url parameter. @@ -849,7 +917,6 @@ The Exchange2003Url parameter specifies the Outlook Web App URL for Exchange Ser Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -859,13 +926,15 @@ Accept wildcard characters: False ``` ### -ExchwebProxyDestination + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: ExchwebProxyDestinations Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -875,6 +944,9 @@ Accept wildcard characters: False ``` ### -ExplicitLogonEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExplicitLogonEnabled parameter specifies whether to allow a user to open someone else's mailbox in Outlook on the web (provided that user has permissions to the mailbox). Valid values are: - $true: A user with the required permissions is able to open someone else's mailbox in Outlook on the web. This is the default value. @@ -884,7 +956,6 @@ The ExplicitLogonEnabled parameter specifies whether to allow a user to open som Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -894,6 +965,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -910,7 +984,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -920,6 +993,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null (blank): This is the default value. @@ -933,7 +1009,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -943,6 +1018,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -955,7 +1033,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -965,6 +1042,9 @@ Accept wildcard characters: False ``` ### -ExternalAuthenticationMethods + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalAuthenticationMethods parameter restricts the authentication methods that can be used to connect to the virtual directory from outside the firewall. Valid values are: - Adfs @@ -994,7 +1074,6 @@ Although you can specify any of these values, whether or not the authentication Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1004,13 +1083,15 @@ Accept wildcard characters: False ``` ### -ExternalDownloadHostName + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ExternalDownloadHostName parameter specifies the download location for files in Outlook on the web for external users (for example, in-line image files). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1020,6 +1101,9 @@ Accept wildcard characters: False ``` ### -ExternalSPMySiteHostURL + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ExternalSPMySiteHostURL specifies the My Site Host URL for external users (for example, `https://sp01.contoso.com`). This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. @@ -1028,7 +1112,6 @@ This parameter is part of rich document collaboration that allows links to docum Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1038,6 +1121,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. @@ -1046,7 +1132,6 @@ This setting is important when Secure Sockets Layer (SSL) is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1056,6 +1141,9 @@ Accept wildcard characters: False ``` ### -FailbackUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FailbackUrl parameter specifies the URL that Outlook on the web uses to connect to the server after failback in a site resilience process and requires a separate DNS entry pointing to the original server's IP address. This parameter value must be different from the ExternalUrl parameter. @@ -1064,7 +1152,6 @@ This parameter value must be different from the ExternalUrl parameter. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1074,6 +1161,9 @@ Accept wildcard characters: False ``` ### -FilterWebBeaconsAndHtmlForms + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FilterWebBeaconsAndHtmlForms parameter specifies how web beacons are handled in Outlook on the web. Valid values are: - UserFilterChoice (This is the default value) @@ -1084,7 +1174,6 @@ The FilterWebBeaconsAndHtmlForms parameter specifies how web beacons are handled Type: WebBeaconFilterLevels Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1094,6 +1183,9 @@ Accept wildcard characters: False ``` ### -ForceSaveAttachmentFilteringEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1103,7 +1195,6 @@ The ForceSaveAttachmentFilteringEnabled parameter specifies whether files are fi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1113,6 +1204,9 @@ Accept wildcard characters: False ``` ### -ForceSaveFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ForceSaveFileTypes parameter specifies the attachment file types (file extensions) that can only be saved from Outlook on the web (not opened). The default values are: .ade, .adp, .app, .asp, .aspx, .asx, .bas, .bat, .cer, .chm, .cmd, .com, .cpl, .crt, .csh, .dcr, .dir, .exe, .fxp, .gadget, .hlp, .hta, .htm, .html, .inf, .ins, .isp, .its, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .msc, .msh, .mshxml, .msi, .msp, .mst, .ops, .pcd, .pif, .plg, .prf, .prg, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .pst, .reg, .scf, .scr, .sct, .shb, .shs, .spl, .swf, .tmp, .url, .vb, .vbe, .vbs, .vsmacro, .vss, .vst, .vsw, .ws, .wsc, .wsf, .wsh @@ -1130,7 +1224,6 @@ If the same file types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1140,6 +1233,9 @@ Accept wildcard characters: False ``` ### -ForceSaveMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ForceSaveMimeTypes parameter specifies the MIME extensions in attachments that only allow the attachments to be saved locally (not opened). The default values are: - Application/futuresplash @@ -1161,7 +1257,6 @@ If the same MIME types are specified in multiple lists: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1171,6 +1266,9 @@ Accept wildcard characters: False ``` ### -ForceWacViewingFirstOnPrivateComputers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1182,7 +1280,6 @@ By default in Exchange 2013 or later, all Outlook on the web sessions are consid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1192,6 +1289,9 @@ Accept wildcard characters: False ``` ### -ForceWacViewingFirstOnPublicComputers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1203,7 +1303,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1213,6 +1312,9 @@ Accept wildcard characters: False ``` ### -ForceWebReadyDocumentViewingFirstOnPrivateComputers + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The ForceWebReadyDocumentViewingFirstOnPrivateComputers parameter specifies whether private computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file from Outlook Web App. Valid values are: @@ -1226,7 +1328,6 @@ By default in Exchange 2013 or later, all Outlook on the web sessions are consid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1236,6 +1337,9 @@ Accept wildcard characters: False ``` ### -ForceWebReadyDocumentViewingFirstOnPublicComputers + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 or Exchange Server 2013. The ForceWebReadyDocumentViewingFirstOnPublicComputers parameter specifies whether Public computers must first preview an Office file as a web page in WebReady Document Viewing before opening the file from Outlook Web App. Valid values are: @@ -1249,7 +1353,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -1259,6 +1362,9 @@ Accept wildcard characters: False ``` ### -FormsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FormsAuthentication parameter enables or disables forms-based authentication on the Outlook on the web virtual directory. Valid values are: - $true: Forms-based authentication is enabled in Outlook on the web. This is the default value. The BasicAuthentication parameter is also set to $true, and the DigestAuthentication and WindowsAuthentication parameters are set to $false. @@ -1268,7 +1374,6 @@ The FormsAuthentication parameter enables or disables forms-based authentication Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1278,13 +1383,15 @@ Accept wildcard characters: False ``` ### -FreCardsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1294,6 +1401,9 @@ Accept wildcard characters: False ``` ### -GlobalAddressListEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1303,7 +1413,6 @@ The GlobalAddressListEnabled parameter specifies whether the global address list Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1313,13 +1422,15 @@ Accept wildcard characters: False ``` ### -GoogleDriveAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1329,6 +1440,9 @@ Accept wildcard characters: False ``` ### -GzipLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GzipLevel parameter sets Gzip configuration information for the Outlook on the web virtual directory. Valid values are: - Off @@ -1340,7 +1454,6 @@ The GzipLevel parameter sets Gzip configuration information for the Outlook on t Type: GzipLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1350,13 +1463,15 @@ Accept wildcard characters: False ``` ### -InstantMessagingCertificateThumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InstantMessagingCertificateThumbprint parameter specifies the trusted certificate used to communicate between the instant messaging server and the Mailbox server. Use the Get-ExchangeCertificate cmdlet to find the thumbprint of the certificate. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1366,6 +1481,9 @@ Accept wildcard characters: False ``` ### -InstantMessagingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InstantMessagingEnabled parameter specifies whether instant messaging is available in Outlook on the web. This does not affect chat capabilities provided by Skype for Business or Teams. Valid values are: - $true: Instant messaging is available in Outlook on the web. This is the default value. @@ -1375,7 +1493,6 @@ The InstantMessagingEnabled parameter specifies whether instant messaging is ava Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1385,13 +1502,15 @@ Accept wildcard characters: False ``` ### -InstantMessagingServerName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InstantMessagingServerName parameter specifies the fully qualified domain name (FQDN) of the instant messaging server or set of servers behind a load balancing device. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1401,6 +1520,9 @@ Accept wildcard characters: False ``` ### -InstantMessagingType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InstantMessagingType parameter specifies the type of instant messaging provider in Outlook on the web. Valid values are: - None: This is the default value. @@ -1410,7 +1532,6 @@ The InstantMessagingType parameter specifies the type of instant messaging provi Type: InstantMessagingTypeOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1420,6 +1541,9 @@ Accept wildcard characters: False ``` ### -IntegratedFeaturesEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IntegratedFeaturesEnabled parameter specifies whether to allow Outlook on the web users who are logged on using Integrated Windows authentication to access specific features. Valid values are: - $true: Integrated features are enabled. For example, users logged on using Integrated Windows authentication can view and change meeting content. This is the default value. @@ -1429,7 +1553,6 @@ The IntegratedFeaturesEnabled parameter specifies whether to allow Outlook on th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1439,13 +1562,15 @@ Accept wildcard characters: False ``` ### -InternalDownloadHostName + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The InternalDownloadHostName parameter specifies the download location for files in Outlook on the web for internal users (for example, in-line image files). The default value is blank ($null). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1455,6 +1580,9 @@ Accept wildcard characters: False ``` ### -InternalSPMySiteHostURL + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The InternalSPMySiteHostURL specifies the My Site Host URL for internal users (for example, `https://sp01.contoso.com`). This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. @@ -1463,7 +1591,6 @@ This parameter is part of rich document collaboration that allows links to docum Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1473,6 +1600,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is important when SSL is used. @@ -1481,7 +1611,6 @@ This setting is important when SSL is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1491,6 +1620,9 @@ Accept wildcard characters: False ``` ### -IRMEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1500,7 +1632,6 @@ The IRMEnabled parameter specifies whether Information Rights Management (IRM) f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1510,6 +1641,9 @@ Accept wildcard characters: False ``` ### -IsPublic + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsPublic parameter specifies whether external users use the virtual directory for Outlook on the web in multiple virtual directory environments (you've configured separate virtual directories on the same server for internal vs. external Outlook on the web connections). Valid values are: - $true: External users use the virtual directory for Outlook on the web. @@ -1519,7 +1653,6 @@ The IsPublic parameter specifies whether external users use the virtual director Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1529,6 +1662,9 @@ Accept wildcard characters: False ``` ### -JournalEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1538,7 +1674,6 @@ The JournalEnabled parameter specifies whether the Journal folder is available i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1548,6 +1683,9 @@ Accept wildcard characters: False ``` ### -JunkEmailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The JunkEmailEnabled parameter specifies whether the Junk Email folder and junk email management are available in Outlook on the web. Valid values are: - $true: The Junk Email folder and junk email management are available in Outlook on the web. This is the default value. @@ -1557,7 +1695,6 @@ The JunkEmailEnabled parameter specifies whether the Junk Email folder and junk Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1567,6 +1704,9 @@ Accept wildcard characters: False ``` ### -LegacyRedirectType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The LegacyRedirectType parameter specifies the type of redirect that Outlook Web App uses to a legacy Client Access server or Front End server when forms-based authentication isn't used on the Exchange 2010 Outlook Web App virtual directory. Valid values are: @@ -1578,7 +1718,6 @@ The LegacyRedirectType parameter specifies the type of redirect that Outlook Web Type: LegacyRedirectTypeOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1588,6 +1727,9 @@ Accept wildcard characters: False ``` ### -LogonAndErrorLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogonAndErrorLanguage parameter specifies the language that used in Outlook on the web for forms-based authentication and for error messages when a user's current language setting can't be read. A valid value is a supported Microsoft Windows Language Code Identifier (LCID). For example, 1033 is US English. @@ -1598,7 +1740,6 @@ The default value is 0, which means the logon and error language selection is un Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1608,6 +1749,9 @@ Accept wildcard characters: False ``` ### -LogonFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogonFormat parameter specifies the type of logon format that's required for forms-based authentication on the Outlook on the web sign-in page. Valid values are: - FullDomain: Requires the format domain\\username. This is the default value. @@ -1618,7 +1762,6 @@ The LogonFormat parameter specifies the type of logon format that's required for Type: LogonFormats Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1628,6 +1771,9 @@ Accept wildcard characters: False ``` ### -LogonPageLightSelectionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogonPageLightSelectionEnabled parameter specifies whether the Outlook on the web sign-in page includes the option to sign in to the light version of Outlook on the web. Valid values are: - $true: The option to use the light version of Outlook on the web is available on the sign-in page. This is the default value. @@ -1639,7 +1785,6 @@ This parameter is meaningful only for browsers that support the full version of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1649,6 +1794,9 @@ Accept wildcard characters: False ``` ### -LogonPagePublicPrivateSelectionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogonPagePublicPrivateSelectionEnabled parameter specifies whether the Outlook on the web sign-in page includes the public/private computer session option at sign-in. Valid values are: - $true: The public/private computer session selection is available on the Outlook on the web sign-in page. @@ -1662,7 +1810,6 @@ When you change the value of this parameter, restart IIS (Stop-Service WAS -Forc Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1672,6 +1819,9 @@ Accept wildcard characters: False ``` ### -NotesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1681,7 +1831,6 @@ The NotesEnabled parameter specifies whether the Notes folder is available in Ou Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1691,6 +1840,9 @@ Accept wildcard characters: False ``` ### -NotificationInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The NotificationInterval parameter specifies the polling frequency in seconds that the client polls the server for new item notifications, reminder updates, and session time-out information in Outlook Web App. @@ -1703,7 +1855,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1713,13 +1864,15 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1729,13 +1882,15 @@ Accept wildcard characters: False ``` ### -OneDriveAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1745,13 +1900,15 @@ Accept wildcard characters: False ``` ### -OrganizationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + When the OrganizationEnabled parameter is set to $false, the Automatic Reply option doesn't include external and internal options, the address book doesn't show the organization hierarchy, and the Resources tab in Calendar forms is disabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1761,6 +1918,9 @@ Accept wildcard characters: False ``` ### -OutboundCharset + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1771,7 +1931,6 @@ The OutboundCharset parameter specifies the character set that's used for outgoi Type: OutboundCharsetOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1781,6 +1940,9 @@ Accept wildcard characters: False ``` ### -OWALightEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1790,7 +1952,6 @@ The OWALightEnabled parameter controls the availability of the light version of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1800,6 +1961,9 @@ Accept wildcard characters: False ``` ### -OWAMiniEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAMiniEnabled parameter controls the availability of the mini version of Outlook Web App. Valid values are: @@ -1811,7 +1975,6 @@ The OWAMiniEnabled parameter controls the availability of the mini version of Ou Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1821,6 +1984,9 @@ Accept wildcard characters: False ``` ### -PremiumClientEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1830,7 +1996,6 @@ The PremiumClientEnabled parameter controls the availability of the full version Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1840,6 +2005,9 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The PublicFoldersEnabled parameter specifies whether a user can browse or read items in public folders in Outlook Web App. Valid values are: @@ -1851,7 +2019,6 @@ The PublicFoldersEnabled parameter specifies whether a user can browse or read i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1861,6 +2028,9 @@ Accept wildcard characters: False ``` ### -RecoverDeletedItemsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The RecoverDeletedItemsEnabled parameter specifies whether a user can use Outlook Web App to view, recover, or delete permanently items that have been deleted from the Deleted Items folder. Valid values are: @@ -1872,7 +2042,6 @@ The RecoverDeletedItemsEnabled parameter specifies whether a user can use Outloo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1882,6 +2051,9 @@ Accept wildcard characters: False ``` ### -RedirectToOptimalOWAServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RedirectToOptimalOWAServer parameter specifies whether to find the optimal server for Outlook on the web. Valid values are: - $true: Outlook on the web uses service discovery to find the best Mailbox server to use after a user authenticates. This is the default value. @@ -1891,7 +2063,6 @@ The RedirectToOptimalOWAServer parameter specifies whether to find the optimal s Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1901,6 +2072,9 @@ Accept wildcard characters: False ``` ### -ReferenceAttachmentsEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + 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. @@ -1910,7 +2084,6 @@ The ReferenceAttachmentsEnabled parameter specifies whether users can attach fil Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1920,6 +2093,9 @@ Accept wildcard characters: False ``` ### -RemindersAndNotificationsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1931,7 +2107,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1941,6 +2116,9 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsActionForUnknownServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -1949,7 +2127,6 @@ This parameter has been deprecated and is no longer used. Type: RemoteDocumentsActions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1959,6 +2136,9 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsAllowedServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -1967,7 +2147,6 @@ This parameter has been deprecated and is no longer used. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1977,6 +2156,9 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsBlockedServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -1985,7 +2167,6 @@ This parameter has been deprecated and is no longer used. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1995,6 +2176,9 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsInternalDomainSuffixList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -2003,7 +2187,6 @@ This parameter has been deprecated and is no longer used. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2013,6 +2196,9 @@ Accept wildcard characters: False ``` ### -ReportJunkEmailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2024,7 +2210,6 @@ This parameter is meaningful only when the JunkEmailEnabled parameter is set to Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2034,6 +2219,9 @@ Accept wildcard characters: False ``` ### -RulesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2043,7 +2231,6 @@ The RulesEnabled parameter specifies whether a user can view, create, or modify Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2053,6 +2240,9 @@ Accept wildcard characters: False ``` ### -SaveAttachmentsToCloudEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + 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. @@ -2062,7 +2252,6 @@ The SaveAttachmentsToCloudEnabled parameter specifies whether users can save reg Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2072,6 +2261,9 @@ Accept wildcard characters: False ``` ### -SearchFoldersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The SearchFoldersEnabled parameter specifies whether Search Folders are available in Outlook on the web. Valid values are: @@ -2083,7 +2275,6 @@ The SearchFoldersEnabled parameter specifies whether Search Folders are availabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2093,6 +2284,9 @@ Accept wildcard characters: False ``` ### -SetPhotoEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2102,7 +2296,6 @@ The SetPhotoEnabled parameter specifies whether users can add, change, and remov Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2112,13 +2305,15 @@ Accept wildcard characters: False ``` ### -SetPhotoURL + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SetPhotoURL parameter specifies the location (URL) of user photos. The default value of this parameter is blank ($null). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2128,6 +2323,9 @@ Accept wildcard characters: False ``` ### -SignaturesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2137,7 +2335,6 @@ The SignaturesEnabled parameter specifies whether to enable or disable the use o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2147,6 +2344,9 @@ Accept wildcard characters: False ``` ### -SilverlightEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The SilverlightEnabled parameter specifies whether a user can use Microsoft Silverlight features in Outlook Web App. Valid values are: @@ -2158,7 +2358,6 @@ The SilverlightEnabled parameter specifies whether a user can use Microsoft Silv Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2168,6 +2367,9 @@ Accept wildcard characters: False ``` ### -SMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The SMimeEnabled parameter specifies whether users can download the S/MIME control for Outlook Web App and use it to read and compose signed and encrypted messages. Valid values are: @@ -2181,7 +2383,6 @@ The SMimeEnabled parameter specifies whether users can download the S/MIME contr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2191,6 +2392,9 @@ Accept wildcard characters: False ``` ### -SpellCheckerEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The SpellCheckerEnabled parameter specifies whether to enable or disable the built-in Outlook Web App spell checker in the full version of Outlook Web App. Valid values are: @@ -2204,7 +2408,6 @@ This parameter doesn't apply to the light version of Outlook Web App. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2214,6 +2417,9 @@ Accept wildcard characters: False ``` ### -TasksEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TasksEnabled parameter specifies whether Tasks folder is available in Outlook on the web. Valid values are: - $true: The Tasks folder is available in Outlook on the web. This is the default value. @@ -2225,7 +2431,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2235,6 +2440,9 @@ Accept wildcard characters: False ``` ### -TextMessagingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2246,7 +2454,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2256,6 +2463,9 @@ Accept wildcard characters: False ``` ### -ThemeSelectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2265,7 +2475,6 @@ The ThemeSelectionEnabled parameter specifies whether users can change the theme Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2275,6 +2484,9 @@ Accept wildcard characters: False ``` ### -UMIntegrationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2288,7 +2500,6 @@ This parameter doesn't apply to the light version of Outlook on the web. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2298,13 +2509,15 @@ Accept wildcard characters: False ``` ### -UNCAccessOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2314,13 +2527,15 @@ Accept wildcard characters: False ``` ### -UNCAccessOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2330,6 +2545,9 @@ Accept wildcard characters: False ``` ### -UseGB18030 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2339,7 +2557,6 @@ The UseGB18030 parameter specifies whether to use the GB18030 character set inst Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2349,6 +2566,9 @@ Accept wildcard characters: False ``` ### -UseISO885915 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2358,7 +2578,6 @@ The UseISO885915 parameter specifies whether to use the character set ISO8859-15 Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2368,6 +2587,9 @@ Accept wildcard characters: False ``` ### -UserContextTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UserContextTimeout parameter specifies the time-out setting in minutes for a user context object. This parameter doesn't limit public and private forms-based authentication time-out settings. The default value is 60. @@ -2376,7 +2598,6 @@ The default value is 60. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2386,13 +2607,15 @@ Accept wildcard characters: False ``` ### -VirtualDirectoryType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: VirtualDirectoryTypes Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2402,6 +2625,9 @@ Accept wildcard characters: False ``` ### -WacEditingEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + 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. @@ -2411,7 +2637,6 @@ The WacEditingEnabled parameter specifies whether to enable or disable editing d Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2421,6 +2646,9 @@ Accept wildcard characters: False ``` ### -WacViewingOnPrivateComputersEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2432,7 +2660,6 @@ By default in Exchange 2013 or later, all Outlook on the web sessions are consid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2442,6 +2669,9 @@ Accept wildcard characters: False ``` ### -WacViewingOnPublicComputersEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2453,7 +2683,6 @@ In Exchange 2013 or later, users can only specify public computer sessions if yo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2463,6 +2692,9 @@ Accept wildcard characters: False ``` ### -WebPartsFrameOptionsType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -2473,7 +2705,6 @@ The WebPartsFrameOptionsType parameter specifies what sources can access web par Type: WebPartsFrameOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2483,6 +2714,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingForAllSupportedTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingForAllSupportedTypes parameter specifies whether to enable WebReady Document Viewing for all supported file and MIME types. Valid values are: @@ -2494,7 +2728,6 @@ The WebReadyDocumentViewingForAllSupportedTypes parameter specifies whether to e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2504,6 +2737,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingOnPrivateComputersEnabled parameter specifies whether WebReady Document Viewing is available in private computer sessions. Valid values are: @@ -2517,7 +2753,6 @@ By default in Exchange 2013, all Outlook on the web sessions are considered to b Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2527,6 +2762,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyDocumentViewingOnPublicComputersEnabled parameter specifies whether WebReady Document Viewing is in public computer sessions. Valid values are: @@ -2540,7 +2778,6 @@ In Exchange 2013, users can only specify public computer sessions if you've enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2550,6 +2787,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingSupportedFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. This is a read-only parameter that can't be modified; use the WebReadyFileTypes parameter instead. @@ -2558,7 +2798,6 @@ This is a read-only parameter that can't be modified; use the WebReadyFileTypes Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2568,6 +2807,9 @@ Accept wildcard characters: False ``` ### -WebReadyDocumentViewingSupportedMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. This is a read-only parameter that can't be modified; use the WebReadyMimeTypes parameter instead. @@ -2576,7 +2818,6 @@ This is a read-only parameter that can't be modified; use the WebReadyMimeTypes Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2586,6 +2827,9 @@ Accept wildcard characters: False ``` ### -WebReadyFileTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyFileTypes parameter specifies the attachment file types (file extensions) that can be viewed by WebReady Document Viewing in Outlook on the web. The default value is all supported file types: @@ -2613,7 +2857,6 @@ This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parame Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2623,6 +2866,9 @@ Accept wildcard characters: False ``` ### -WebReadyMimeTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013 + This parameter is available only in Exchange Server 2010 and Exchange Server 2013. The WebReadyMimeTypes parameter specifies the MIME extensions of attachments that allow the attachments to be viewed by WebReady Document Viewing in Outlook on the web. The default value is all supported MIME types: @@ -2649,7 +2895,6 @@ This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parame Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -2659,13 +2904,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2675,6 +2922,9 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsAuthentication parameter enables or disables Integrated Windows authentication on the virtual directory. Valid values are: - $true: Integrated Windows authentication is enabled on the Outlook on the web virtual directory. @@ -2684,7 +2934,6 @@ The WindowsAuthentication parameter enables or disables Integrated Windows authe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2694,13 +2943,15 @@ Accept wildcard characters: False ``` ### -WSSAccessOnPrivateComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2710,13 +2961,15 @@ Accept wildcard characters: False ``` ### -WSSAccessOnPublicComputersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter has been deprecated and is no longer used. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PartnerApplication.md b/exchange/exchange-ps/ExchangePowerShell/Set-PartnerApplication.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-PartnerApplication.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PartnerApplication.md index 157ce52607..7d756ac636 100644 --- a/exchange/exchange-ps/exchange/Set-PartnerApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PartnerApplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-partnerapplication applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-PartnerApplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-partnerapplication +schema: 2.0.0 +title: Set-PartnerApplication --- # Set-PartnerApplication @@ -93,6 +94,9 @@ This example refreshes the auth metadata for the HRApp partner application. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the partner application you want to modify. You can use any value that uniquely identifies the partner application. For example: - Name @@ -104,7 +108,6 @@ The Identity parameter specifies the partner application you want to modify. You Type: PartnerApplicationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -114,13 +117,15 @@ Accept wildcard characters: False ``` ### -AcceptSecurityIdentifierInformation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AcceptSecurityIdentifierInformation parameter specifies whether Exchange should accept security identifiers (SIDs) from another trusted Active Directory forest for the partner application. By default, new partner applications are configured to not accept SIDs from another forest. If you're in deployment with a trusted forest, set the parameter to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -AccountType + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AccountType parameter specifies the type of Microsoft account that's required for the partner application. Valid values are: - OrganizationalAccount: This is the default value @@ -139,7 +147,6 @@ The AccountType parameter specifies the type of Microsoft account that's require Type: SupportedAccountType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -149,13 +156,15 @@ Accept wildcard characters: False ``` ### -ActAsPermissions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ActAsPermissions parameter specifies the delegate permissions that are allowed for the partner application. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -ApplicationIdentifier + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ApplicationIdentifier parameter specifies a unique application identifier for the partner application that uses an authorization server. ```yaml Type: String Parameter Sets: ACSTrustApplication Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -AppOnlyPermissions + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -189,7 +203,6 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -199,6 +212,9 @@ Accept wildcard characters: False ``` ### -AuthMetadataUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AuthMetadataUrl parameter specifies the URL that Exchange can retrieve the AuthMetadata document from for a partner application that doesn't use an authorization server. @@ -207,7 +223,6 @@ The AuthMetadataUrl parameter specifies the URL that Exchange can retrieve the A Type: String Parameter Sets: AuthMetadataUrl Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,6 +232,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -226,7 +244,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -244,7 +264,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,13 +273,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter specifies whether the partner application is enabled. By default, new partner applications are enabled. Set the parameter to $false to create the application configuration in a disabled state. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -270,6 +291,9 @@ Accept wildcard characters: False ``` ### -IssuerIdentifier + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter is reserved for internal Microsoft use. @@ -278,7 +302,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -288,13 +311,15 @@ Accept wildcard characters: False ``` ### -LinkedAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LinkedAccount parameter specifies a linked Active Directory user account for the application. Exchange evaluates Role Based Access Control (RBAC) permissions for the linked account when authorizing a token used to perform a task. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -304,13 +329,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a new name for the partner application. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -320,6 +347,9 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Realm parameter specifies a security realm for the partner application. If the token is from a domain that's not an accepted domain, Exchange checks the realm specified in the token. In such a scenario, only tokens with the same realm specified in the partner application can access Exchange resources. @@ -328,7 +358,6 @@ The Realm parameter specifies a security realm for the partner application. If t Type: String Parameter Sets: ACSTrustApplication Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -338,6 +367,9 @@ Accept wildcard characters: False ``` ### -RefreshAuthMetadata + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RefreshAuthMetadata switch refreshes the auth metadata from the authorization server. You don't need to specify a value with this switch. @@ -346,7 +378,6 @@ The RefreshAuthMetadata switch refreshes the auth metadata from the authorizatio Type: SwitchParameter Parameter Sets: RefreshAuthMetadata Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,6 +387,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. @@ -366,7 +400,6 @@ We don't recommend using this switch in a production environment. Type: SwitchParameter Parameter Sets: AuthMetadataUrl Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -376,13 +409,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md b/exchange/exchange-ps/ExchangePowerShell/Set-PendingFederatedDomain.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PendingFederatedDomain.md index a823ef0913..406c4a2b4c 100644 --- a/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PendingFederatedDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-pendingfederateddomain applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PendingFederatedDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-pendingfederateddomain +schema: 2.0.0 +title: Set-PendingFederatedDomain --- # Set-PendingFederatedDomain @@ -49,13 +50,15 @@ This example adds the pending domains contoso.com and sales.contoso.com to the e ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -PendingAccountNamespace + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PendingAccountNamespace parameter specifies the pending domain that's used as the account namespace for the federation trust. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -PendingDomains + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PendingDomains parameter specifies the pending federated domains that are configured for the federation trust. ```yaml Type: SmtpDomain[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,13 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-PerimeterConfig.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-PerimeterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PerimeterConfig.md index d104c470f0..1611b85ea0 100644 --- a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PerimeterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-perimeterconfig applicable: Exchange Online, Exchange Online Protection -title: Set-PerimeterConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-perimeterconfig +schema: 2.0.0 +title: Set-PerimeterConfig --- # Set-PerimeterConfig @@ -43,13 +44,15 @@ This example shows how to add an IP address to cloud-based safelists where the g ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -68,7 +74,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -GatewayIPAddresses + +> Applicable: Exchange Online + Use the GatewayIPAddresses parameter to create or modify a list of gateway server IP addresses to add to IP safelists. IP addresses are specified in IPv4 format, for example, 10.1.1.1. If you list more than one IP address, separate each entry with a comma. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-PhishSimOverridePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PhishSimOverridePolicy.md index 2e52b3a0fd..49519a0178 100644 --- a/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PhishSimOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-phishsimoverridepolicy applicable: Exchange Online -title: Set-PhishSimOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-phishsimoverridepolicy +schema: 2.0.0 +title: Set-PhishSimOverridePolicy --- # Set-PhishSimOverridePolicy @@ -46,6 +47,9 @@ This example disables the phishing simulation override policy. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the phishing simulation override policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -57,7 +61,6 @@ The Identity parameter specifies the phishing simulation override policy that yo Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -67,13 +70,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -83,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -92,7 +100,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -127,7 +139,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -137,6 +148,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -145,7 +159,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Place.md b/exchange/exchange-ps/ExchangePowerShell/Set-Place.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-Place.md rename to exchange/exchange-ps/ExchangePowerShell/Set-Place.md index aeffd3882a..0fdf11de3f 100644 --- a/exchange/exchange-ps/exchange/Set-Place.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-Place.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-place applicable: Exchange Online -title: Set-Place -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-place +schema: 2.0.0 +title: Set-Place --- # Set-Place @@ -73,6 +74,9 @@ The example adds the specified metadata to the room mailbox named Conference Roo ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the room mailbox that you want to modify. You can use any value that uniquely identifies the room. For example: - Name @@ -86,7 +90,6 @@ The Identity parameter specifies the room mailbox that you want to modify. You c Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -AudioDeviceName + +> Applicable: Exchange Online + The AudioDeviceName parameter specifies the name of the audio device in the room. If the value contains spaces, enclose the value in quotation marks ("). The default value is blank ($null). To indicate that this room has no audio device, use the value $null for this parameter. @@ -104,7 +110,6 @@ The default value is blank ($null). To indicate that this room has no audio devi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -Building + +> Applicable: Exchange Online + The Building parameter specifies the building name or building number that the room is in. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -Capacity + +> Applicable: Exchange Online + The Capacity parameter specifies the capacity of the room. A valid value is an integer. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Exchange Online + The City parameter specifies the room's city. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -162,13 +173,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Exchange Online + The CountryOrRegion parameter specifies the room's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name). A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). @@ -188,7 +204,6 @@ The friendly name is returned in the CountryOrRegion property value by the Get-P Type: CountryInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -DisplayDeviceName + +> Applicable: Exchange Online + The DisplayDeviceName parameter specifies the name of the display device in the room. If the value contains spaces, enclose the value in quotation marks ("). The default value is blank ($null). To indicate that this room has no display device, use the value $null for this parameter. @@ -206,7 +224,6 @@ The default value is blank ($null). To indicate that this room has no display de Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,13 +233,15 @@ Accept wildcard characters: False ``` ### -Floor + +> Applicable: Exchange Online + The Floor parameter specifies the floor number that the room is on. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -232,13 +251,15 @@ Accept wildcard characters: False ``` ### -FloorLabel + +> Applicable: Exchange Online + The FloorLabel parameter specifies a descriptive label for the floor that the room is on. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,6 +269,9 @@ Accept wildcard characters: False ``` ### -GeoCoordinates + +> Applicable: Exchange Online + The GeoCoordinates parameter specifies the room's location in latitude, longitude and (optionally) altitude coordinates. A valid value for this parameter uses one of the following formats: - Latitude and longitude: For example, "47.644125;-122.122411" @@ -259,7 +283,6 @@ The GeoCoordinates parameter specifies the room's location in latitude, longitud Type: GeoCoordinates Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -269,6 +292,9 @@ Accept wildcard characters: False ``` ### -IsWheelChairAccessible + +> Applicable: Exchange Online + The IsWheelChairAccessible parameter specifies whether the room is wheelchair accessible. Valid values are: - $true: The room is wheelchair accessible. @@ -278,7 +304,6 @@ The IsWheelChairAccessible parameter specifies whether the room is wheelchair ac Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -288,13 +313,15 @@ Accept wildcard characters: False ``` ### -Label + +> Applicable: Exchange Online + The Label parameter specifies a descriptive label for the room (for example, a number or name). If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -304,6 +331,9 @@ Accept wildcard characters: False ``` ### -MTREnabled + +> Applicable: Exchange Online + **Note**: Currently, this parameter is informational only and results in no additional functionality. The MTREnabled parameter identifies the room as configured with a Microsoft Teams room system. You can add Teams room systems as audio sources in Teams meetings that involve the room. Valid values are: @@ -317,7 +347,6 @@ For more information about Microsoft Teams Rooms, see [Microsoft Teams Rooms](ht Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -327,6 +356,9 @@ Accept wildcard characters: False ``` ### -ParentId + +> Applicable: Exchange Online + **Note**: This feature is experimental and is available only for organizations using Microsoft Places. The ParentId parameter specifies the ID of a Place in the parent location hierarchy in Microsoft Places. @@ -337,7 +369,6 @@ Organizations that are onboarding Rooms and Workspaces to Microsoft Places need Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -347,6 +378,9 @@ Accept wildcard characters: False ``` ### -ParentType + +> Applicable: Exchange Online + **Note**: This feature is experimental and is available only for organizations using Microsoft Places. The ParentType parameter specifies the parent type of the ParentId in Microsoft Places. Valid values are: @@ -360,7 +394,6 @@ Organizations that are onboarding Rooms and Workspaces to Microsoft Places need Type: Microsoft.Exchange.Management.RecipientTasks.SetPlaceParentType Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -370,13 +403,15 @@ Accept wildcard characters: False ``` ### -Phone + +> Applicable: Exchange Online + The Phone parameter specifies the room's telephone number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -386,13 +421,15 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Exchange Online + The PostalCode parameter specifies the room's postal code. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -402,13 +439,15 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Online + The State parameter specifies the room's state or province. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -418,13 +457,15 @@ Accept wildcard characters: False ``` ### -Street + +> Applicable: Exchange Online + The Street parameter specifies the room's physical address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -434,6 +475,9 @@ Accept wildcard characters: False ``` ### -Tags + +> Applicable: Exchange Online + The Tags parameter specifies additional features of the room (for example, details like the type of view or furniture type). You can specify multiple labels separated by commas. If the labels contains spaces, enclose the values in quotation marks: `"Label 1","Label 2",..."Label N"`. @@ -442,7 +486,6 @@ You can specify multiple labels separated by commas. If the labels contains spac Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -452,6 +495,9 @@ Accept wildcard characters: False ``` ### -VideoDeviceName + +> Applicable: Exchange Online + The VideoDeviceName parameter specifies the name of the video device in the room. If the value contains spaces, enclose the value in quotation marks ("). The default value is blank ($null). To indicate that this room has no video device, use the value $null for this parameter. @@ -460,7 +506,6 @@ The default value is blank ($null). To indicate that this room has no video devi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -470,13 +515,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PolicyConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-PolicyConfig.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-PolicyConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PolicyConfig.md index 6455c497f6..6fac58c159 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PolicyConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-policyconfig applicable: Security & Compliance -title: Set-PolicyConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-policyconfig +schema: 2.0.0 +title: Set-PolicyConfig --- # Set-PolicyConfig @@ -70,13 +71,15 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -86,13 +89,15 @@ Accept wildcard characters: False ``` ### -CaseHoldPolicyLimit + +> Applicable: Security & Compliance + {{ Fill CaseHoldPolicyLimit Description }} ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -ClassificationScheme + +> Applicable: Security & Compliance + {{ Fill ClassificationScheme Description }} ```yaml @@ -109,7 +117,6 @@ Type: ClassificationScheme Parameter Sets: (All) Aliases: Accepted values: Default, V0_AggregatedOnly, V1_DetailedResults -Applicable: Security & Compliance Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -ComplianceUrl + +> Applicable: Security & Compliance + {{ Fill ComplianceUrl Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -144,7 +156,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -DlpAppGroups + +> Applicable: Security & Compliance + {{ Fill DlpAppGroups Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -DlpAppGroupsPsws + +> Applicable: Security & Compliance + {{ Fill DlpAppGroupsPsws Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -DlpExtensionGroups + +> Applicable: Security & Compliance + {{ Fill DlpExtensionGroups Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -202,13 +219,15 @@ Accept wildcard characters: False ``` ### -DlpNetworkShareGroups + +> Applicable: Security & Compliance + {{ Fill DlpNetworkShareGroups Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -218,13 +237,15 @@ Accept wildcard characters: False ``` ### -DlpPrinterGroups + +> Applicable: Security & Compliance + {{ Fill DlpPrinterGroups Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -234,13 +255,15 @@ Accept wildcard characters: False ``` ### -DlpRemovableMediaGroups + +> Applicable: Security & Compliance + {{ Fill DlpRemovableMediaGroups Description }} ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -250,6 +273,9 @@ Accept wildcard characters: False ``` ### -DocumentIsUnsupportedSeverity + +> Applicable: Security & Compliance + {{ Fill DocumentIsUnsupportedSeverity Description }} ```yaml @@ -257,7 +283,6 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Required: False Position: Named @@ -267,13 +292,15 @@ Accept wildcard characters: False ``` ### -EnableAdvancedRuleBuilder + +> Applicable: Security & Compliance + {{ Fill EnableAdvancedRuleBuilder Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -283,6 +310,9 @@ Accept wildcard characters: False ``` ### -EnableLabelCoauth + +> Applicable: Security & Compliance + The EnableLabelCoauth parameter enables or disables co-authoring support in Office desktop apps for the entire organization. Valid value are: - $true: Co-authoring support in Office desktop apps is enabled. When documents are labeled and encrypted by sensitivity labels, multiple users can edit these documents at the same time. Labeling information for unencrypted files is no longer saved in custom properties. Don't enable co-authoring if you use any apps, services, scripts, or tools that read or write labeling metadata to the old location. @@ -299,7 +329,6 @@ Disabling co-authoring support in Office desktop apps in the organization has th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -309,6 +338,9 @@ Accept wildcard characters: False ``` ### -EnableSpoAipMigration + +> Applicable: Security & Compliance + The EnableSpoAipMigration parameter enables or disables built-in labeling for supported Office files in SharePoint and OneDrive. Valid values are: - $true: Users can apply your sensitivity labels in Office for the web. Users will see the Sensitivity button on the ribbon so they can apply labels, and see any applied label name on the status bar. @@ -318,7 +350,6 @@ The EnableSpoAipMigration parameter enables or disables built-in labeling for su Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -328,6 +359,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpGlobalSettings + +> Applicable: Security & Compliance + The EndpointDlpGlobalSettings parameter specifies the global endpoints. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. The value of `` is one of the supported values. @@ -350,7 +384,6 @@ Example values: Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -360,13 +393,15 @@ Accept wildcard characters: False ``` ### -EndpointDlpGlobalSettingsPsws + +> Applicable: Security & Compliance + {{ Fill EndpointDlpGlobalSettingsPsws Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -376,6 +411,9 @@ Accept wildcard characters: False ``` ### -ExtendTeamsDlpPoliciesToSharePointOneDrive + +> Applicable: Security & Compliance + The ExtendTeamsDlpPoliciesToSharePointOneDrive parameter enables the Teams DLP Policy to automatically extend protection to the content stored in OneDrive shared in 1:1 chats and content stored in SharePoint associated with Teams teams shared through channel chats. Valid values are: - $true @@ -385,7 +423,6 @@ The ExtendTeamsDlpPoliciesToSharePointOneDrive parameter enables the Teams DLP P Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -395,6 +432,9 @@ Accept wildcard characters: False ``` ### -InformationBarrierMode + +> Applicable: Security & Compliance + The InformationBarrierMode parameter specifies the mode that controls the total number of segments and how many segments a user can be part of. Valid values are: - SingleSegment: Users in the organization can have 5000 segments but can only be assigned to one segment. @@ -405,7 +445,6 @@ Type: InformationBarrierMode Parameter Sets: (All) Aliases: Accepted values: SingleSegment, MultiSegment -Applicable: Security & Compliance Required: False Position: Named @@ -415,6 +454,9 @@ Accept wildcard characters: False ``` ### -InformationBarrierPeopleSearchRestriction + +> Applicable: Security & Compliance + {{ Fill InformationBarrierPeopleSearchRestriction Description }} ```yaml @@ -422,7 +464,6 @@ Type: InformationBarrierPeopleSearchRestriction Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Security & Compliance Required: False Position: Named @@ -432,13 +473,15 @@ Accept wildcard characters: False ``` ### -IsDlpSimulationOptedIn + +> Applicable: Security & Compliance + {{ Fill IsDlpSimulationOptedIn Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -448,6 +491,9 @@ Accept wildcard characters: False ``` ### -OnPremisesWorkload + +> Applicable: Security & Compliance + {{ Fill OnPremisesWorkload Description }} ```yaml @@ -455,7 +501,6 @@ Type: Workload Parameter Sets: (All) Aliases: Accepted values: None, Exchange, SharePoint, Intune, OneDriveForBusiness, PublicFolder, SharePointOnPremises, ExchangeOnPremises, AuditAlerting, Skype, ModernGroup, DynamicScope, Teams, UnifiedAuditAzure, EndpointDevices, ThirdPartyApps, OnPremisesScanner -Applicable: Security & Compliance Required: False Position: Named @@ -465,6 +510,9 @@ Accept wildcard characters: False ``` ### -ProcessingLimitExceededSeverity + +> Applicable: Security & Compliance + {{ Fill ProcessingLimitExceededSeverity Description }} ```yaml @@ -472,7 +520,6 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Required: False Position: Named @@ -482,13 +529,15 @@ Accept wildcard characters: False ``` ### -PurviewLabelConsent + +> Applicable: Security & Compliance + {{ Fill PurviewLabelConsent Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -498,13 +547,15 @@ Accept wildcard characters: False ``` ### -ReservedForFutureUse + +> Applicable: Security & Compliance + {{ Fill ReservedForFutureUse Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -514,13 +565,15 @@ Accept wildcard characters: False ``` ### -RetentionForwardCrawl + +> Applicable: Security & Compliance + {{ Fill RetentionForwardCrawl Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -530,6 +583,9 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Security & Compliance + The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - Ignore @@ -540,7 +596,6 @@ Type: PolicyRuleErrorAction Parameter Sets: (All) Aliases: Accepted values: Ignore, RetryThenBlock -Applicable: Security & Compliance Required: False Position: Named @@ -550,6 +605,9 @@ Accept wildcard characters: False ``` ### -SenderAddressLocation + +> Applicable: Security & Compliance + The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: - Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. @@ -561,7 +619,6 @@ Type: PolicySenderAddressLocation Parameter Sets: (All) Aliases: Accepted values: Header, Envelope, HeaderOrEnvelope -Applicable: Security & Compliance Required: False Position: Named @@ -571,13 +628,15 @@ Accept wildcard characters: False ``` ### -SiteGroups + +> Applicable: Security & Compliance + {{ Fill SiteGroups Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -587,13 +646,15 @@ Accept wildcard characters: False ``` ### -SiteGroupsPsws + +> Applicable: Security & Compliance + {{ Fill SiteGroupsPsws Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -603,13 +664,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-PolicyTipConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-PolicyTipConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PolicyTipConfig.md index 16cd681d3b..3cd1fde963 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PolicyTipConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-policytipconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-PolicyTipConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-policytipconfig +schema: 2.0.0 +title: Set-PolicyTipConfig --- # Set-PolicyTipConfig @@ -51,6 +52,9 @@ This example replaces the text of all custom Spanish Policy Tips with the value, ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the custom Policy Tip you want to modify. You can use any value that uniquely identifies the custom Policy Tip. For example: - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. @@ -62,7 +66,6 @@ The Identity parameter specifies the custom Policy Tip you want to modify. You c Type: PolicyTipConfigIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -Value + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Value parameter specifies the text that's displayed by the Policy Tip. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PopSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-PopSettings.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-PopSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PopSettings.md index a6e5d017f8..47d9968636 100644 --- a/exchange/exchange-ps/exchange/Set-PopSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PopSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-popsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PopSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-popsettings +schema: 2.0.0 +title: Set-PopSettings --- # Set-PopSettings @@ -100,6 +101,9 @@ This example specifies the certificate that contains mail.contoso.com is used to ## PARAMETERS ### -AuthenticatedConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AuthenticatedConnectionTimeout parameter specifies the time to wait before closing an idle authenticated connection. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -110,7 +114,6 @@ Valid values are 00:00:30 to 1:00:00. The default value is 00:30:00 (30 minutes) Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +123,15 @@ Accept wildcard characters: False ``` ### -Banner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Banner parameter specifies the text string that's displayed to connecting POP3 clients. The default value is: The Microsoft Exchange POP3 service is ready. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -CalendarItemRetrievalOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CalendarItemRetrievalOption parameter specifies how calendar items are presented to POP3 clients. Valid values are: - 0 or iCalendar. This is the default value. @@ -149,7 +157,6 @@ If you specify 3 or Custom, you need to specify a value for the OwaServerUrl par Type: CalendarItemRetrievalOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +166,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -168,7 +178,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,13 +187,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +205,9 @@ Accept wildcard characters: False ``` ### -EnableExactRFC822Size + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnableExactRFC822Size parameter specifies how message sizes are presented to POP3 clients. Valid values are: - $true: Calculate the exact message size. Because this setting can negatively affect performance, you should configure it only if it's required by your POP3 clients. @@ -203,7 +217,6 @@ The EnableExactRFC822Size parameter specifies how message sizes are presented to Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -213,6 +226,9 @@ Accept wildcard characters: False ``` ### -EnableGSSAPIAndNTLMAuth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnableGSSAPIAndNTLMAuth parameter specifies whether connections can use Integrated Windows authentication (NTLM) by using the Generic Security Services application programming interface (GSSAPI). This setting applies to connections where Transport Layer Security (TLS) is disabled. Valid values are: - $true: NTLM for POP3 connections is enabled. This is the default value. @@ -222,7 +238,6 @@ The EnableGSSAPIAndNTLMAuth parameter specifies whether connections can use Inte Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -232,6 +247,9 @@ Accept wildcard characters: False ``` ### -EnforceCertificateErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnforceCertificateErrors parameter specifies whether to enforce Secure Sockets Layer (SSL) certificate validation failures. Valid values are: - $true: If the certificate isn't valid or doesn't match the target POP3 server's FQDN, the connection attempt fails. @@ -241,7 +259,6 @@ The EnforceCertificateErrors parameter specifies whether to enforce Secure Socke Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionPolicy parameter specifies how Extended Protection for Authentication is used for POP3 connections. Valid values are: - None: Extended Protection for Authentication isn't used. This is the default value. @@ -263,7 +283,6 @@ Extended Protection for Authentication enhances the protection and handling of c Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,6 +292,9 @@ Accept wildcard characters: False ``` ### -ExternalConnectionSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by external POP3 clients (POP3 connections from outside your corporate network). This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). @@ -289,7 +311,6 @@ The combination of encryption methods and ports that are specified for this para Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -299,6 +320,9 @@ Accept wildcard characters: False ``` ### -InternalConnectionSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by internal POP3 clients (POP3 connections from inside your corporate network). This setting is also used when a POP3 connection is forwarded to another Exchange server that's running the Microsoft Exchange POP3 service. This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). @@ -315,7 +339,6 @@ The combination of encryption methods and ports that are specified for this para Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,6 +348,9 @@ Accept wildcard characters: False ``` ### -LogFileLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogFileLocation parameter specifies the location for the POP3 protocol log files. The default location is%ExchangeInstallPath%Logging\\Pop3. This parameter is only meaningful when the ProtocolLogEnabled parameter value is $true. @@ -333,7 +359,6 @@ This parameter is only meaningful when the ProtocolLogEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -343,6 +368,9 @@ Accept wildcard characters: False ``` ### -LogFileRollOverSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogFileRollOverSettings parameter defines how frequently POP3 protocol logging creates a new log file. Valid values are: - 1 or Hourly. This is the default value in Exchange 2019 and Exchange 2016. @@ -356,7 +384,6 @@ This parameter is only meaningful when the LogPerFileSizeQuota parameter value i Type: LogFileRollOver Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -366,6 +393,9 @@ Accept wildcard characters: False ``` ### -LoginType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LoginType parameter specifies the authentication method for POP3 connections. Valid values are: - 1 or PlainTextLogin. @@ -376,7 +406,6 @@ The LoginType parameter specifies the authentication method for POP3 connections Type: LoginOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -386,6 +415,9 @@ Accept wildcard characters: False ``` ### -LogPerFileSizeQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LogPerFileSizeQuota parameter specifies the maximum size of a POP3 protocol log file. When you enter a value, qualify the value with one of the following units: @@ -406,7 +438,6 @@ This parameter is only meaningful when the ProtocolLogEnabled parameter value is Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -416,13 +447,15 @@ Accept wildcard characters: False ``` ### -MaxCommandSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxCommandSize parameter specifies the maximum size in bytes of a single POP3 command. Valid values are from 40 through 1024. The default value is 512. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -432,13 +465,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionFromSingleIP + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConnectionFromSingleIP parameter specifies the maximum number of POP3 connections that are accepted by the Exchange server from a single IP address. Valid values are from 1 through 2147483647. The default value is 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -448,13 +483,15 @@ Accept wildcard characters: False ``` ### -MaxConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConnections parameter specifies the maximum number of POP3 connections that are accepted by the Exchange server. Valid values are from 1 through 2147483647. The default value is 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -464,13 +501,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionsPerUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConnectionsPerUser parameter specifies the maximum number of POP3 connections that are allowed for each user. Valid values are from 1 through 2147483647. The default value is 16. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -480,6 +519,9 @@ Accept wildcard characters: False ``` ### -MessageRetrievalMimeFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages. Valid values are: - 0 or TextOnly. @@ -494,7 +536,6 @@ The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages Type: MimeTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -504,6 +545,9 @@ Accept wildcard characters: False ``` ### -MessageRetrievalSortOrder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRetrievalSortOrder parameter specifies how retrieved messages are sorted. Valid values are: - 0 or Ascending. This is the default value. @@ -513,7 +557,6 @@ The MessageRetrievalSortOrder parameter specifies how retrieved messages are sor Type: SortOrder Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -523,13 +566,15 @@ Accept wildcard characters: False ``` ### -OwaServerUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaServerUrl parameter specifies the URL that's used to retrieve calendar information for instances of custom Outlook on the web calendar items. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -539,6 +584,9 @@ Accept wildcard characters: False ``` ### -PreAuthenticatedConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PreAuthenticatedConnectionTimeout parameter specifies the time to wait before closing an idle POP3 connection that isn't authenticated. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -549,7 +597,6 @@ Valid values are from00:00:30 to 1:00:00. The default value is 00:01:00 (one min Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -559,6 +606,9 @@ Accept wildcard characters: False ``` ### -ProtocolLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProtocolLogEnabled parameter specifies whether to enable protocol logging for POP3. Valid values are: - $true: POP3 protocol logging is enabled. @@ -568,7 +618,6 @@ The ProtocolLogEnabled parameter specifies whether to enable protocol logging fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -578,13 +627,15 @@ Accept wildcard characters: False ``` ### -ProxyTargetPort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProxyTargetPort parameter specifies the port on the Microsoft Exchange POP3 Backend service that listens for client connections that are proxied from the Microsoft Exchange POP3 service. The default value is 1995. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -594,6 +645,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -607,7 +661,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -617,6 +670,9 @@ Accept wildcard characters: False ``` ### -SSLBindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SSLBindings parameter specifies the IP address and TCP port that's used for an POP3 connection that's always encrypted by SSL/TLS. This parameter uses the syntax `IPv4OrIPv6Address:Port`. The default value is `[::]:995,0.0.0.0:995`. @@ -629,7 +685,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -639,6 +694,9 @@ Accept wildcard characters: False ``` ### -SuppressReadReceipt + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuppressReadReceipt parameter specifies whether to stop duplicate read receipts from being sent to POP3 clients that have the Send read receipts for messages I send setting configured in their POP3 email program. Valid values are: - $true: The sender receives a read receipt only when the recipient opens the message. @@ -648,7 +706,6 @@ The SuppressReadReceipt parameter specifies whether to stop duplicate read recei Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -658,6 +715,9 @@ Accept wildcard characters: False ``` ### -UnencryptedOrTLSBindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UnencryptedOrTLSBindings parameter specifies the IP address and TCP port that's used for unencrypted POP3 connections, or POP3 connections that are encrypted by using opportunistic TLS (STARTTLS) after the initial unencrypted protocol handshake. This parameter uses the syntax `IPv4OrIPv6Address:Port`. The default value is `[::]:110, 0.0.0.0:110`. @@ -670,7 +730,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -680,13 +739,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -696,6 +757,9 @@ Accept wildcard characters: False ``` ### -X509CertificateName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The X509CertificateName parameter specifies the certificate that's used for encrypting POP3 client connections. A valid value for this parameter is the FQDN from the ExternalConnectionSettings or InternalConnectionSettings parameters (for example, mail.contoso.com or mailbox01.contoso.com). @@ -708,7 +772,6 @@ If you use a wildcard certificate, you don't need to assign the certificate to t Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-PowerShellVirtualDirectory.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PowerShellVirtualDirectory.md index 16c3da7808..552dbc3950 100644 --- a/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PowerShellVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-powershellvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PowerShellVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-powershellvirtualdirectory +schema: 2.0.0 +title: Set-PowerShellVirtualDirectory --- # Set-PowerShellVirtualDirectory @@ -54,6 +55,9 @@ This example modifies the external URL of the Contoso Windows PowerShell virtual ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the PowerShell virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -66,7 +70,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: - $true: Basic authentication is enabled. This is the default value. @@ -85,7 +91,6 @@ The BasicAuthentication parameter specifies whether Basic authentication is enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -CertificateAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CertificateAuthentication parameter specifies whether certificate authentication is enabled on the Windows PowerShell virtual directory. The valid values are $true and $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -120,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -158,7 +172,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,6 +181,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -177,7 +193,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -199,7 +217,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +244,15 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,13 +262,15 @@ Accept wildcard characters: False ``` ### -RequireSSL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireSSL parameter specifies whether the Windows PowerShell virtual directory should require that the client connection be made using Secure Sockets Layer (SSL). The valid values are $true and $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -257,13 +280,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,6 +298,9 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: - $true: Integrated Windows authentication is enabled. This is the default value. @@ -282,7 +310,6 @@ The WindowsAuthentication parameter specifies whether Integrated Windows authent Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md b/exchange/exchange-ps/ExchangePowerShell/Set-ProtectionAlert.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-ProtectionAlert.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ProtectionAlert.md index 39c461d99d..5ed5a8d14e 100644 --- a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ProtectionAlert.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-protectionalert applicable: Security & Compliance -title: Set-ProtectionAlert -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-protectionalert +schema: 2.0.0 +title: Set-ProtectionAlert --- # Set-ProtectionAlert @@ -74,6 +75,9 @@ This example modifies an alert so that even though it's configured for aggregate ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the alert policy that you want to modify. You can use any value that uniquely identifies the alert policy. For example: - Name @@ -84,7 +88,6 @@ The Identity parameter specifies the alert policy that you want to modify. You c Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AggregationType + +> Applicable: Security & Compliance + The AggregationType parameter specifies the how the alert policy triggers alerts for multiple occurrences of monitored activity. Valid values are: - None: Alerts are triggered for every occurrence of the activity. @@ -104,7 +110,6 @@ The AggregationType parameter specifies the how the alert policy triggers alerts Type: AlertAggregationType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -AlertBy + +> Applicable: Security & Compliance + The AlertBy parameter specifies the scope for aggregated alert policies. Valid values are determined by the ThreatType parameter value: - Activity: Valid values are User or $null (blank, which is the default value). If you don't use the value User, the scope of the alert policy is the entire organization. @@ -127,7 +135,6 @@ You can't use this parameter when the AggregationType parameter value is None (a Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -137,13 +144,15 @@ Accept wildcard characters: False ``` ### -AlertFor + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: Security & Compliance + The Category parameter specifies a category for the alert policy. Valid values are: - AccessGovernance @@ -170,7 +182,6 @@ When an activity occurs that matches the conditions of the alert policy, the ale Type: AlertRuleCategory Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -180,13 +191,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -205,7 +221,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -215,13 +230,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies descriptive text for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -231,6 +248,9 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Security & Compliance + The Disabled parameter enables or disables the alert policy. Valid values are: - $true: The alert policy is disabled. @@ -240,7 +260,6 @@ The Disabled parameter enables or disables the alert policy. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -250,6 +269,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Security & Compliance + The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. - Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. @@ -310,7 +332,6 @@ You can specify multiple criteria by using the -and comparison operator. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -320,6 +341,9 @@ Accept wildcard characters: False ``` ### -NotificationCulture + +> Applicable: Security & Compliance + The NotificationCulture parameter specifies the language or locale that's used for notifications. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -328,7 +352,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -338,13 +361,15 @@ Accept wildcard characters: False ``` ### -NotificationEnabled + +> Applicable: Security & Compliance + {{ Fill NotificationEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -354,13 +379,15 @@ Accept wildcard characters: False ``` ### -NotifyUser + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -370,6 +397,9 @@ Accept wildcard characters: False ``` ### -NotifyUserOnFilterMatch + +> Applicable: Security & Compliance + The NotifyUserOnFilterMatch parameter specifies whether to trigger an alert for a single event when the alert policy is configured for aggregated activity. Valid values are: - $true: Even though the alert is configured for aggregated activity, a notification is triggered during a match for the activity (basically, an early warning). @@ -381,7 +411,6 @@ You can't use this parameter when the AggregationType parameter value is None (a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -391,6 +420,9 @@ Accept wildcard characters: False ``` ### -NotifyUserSuppressionExpiryDate + +> Applicable: Security & Compliance + The NotifyUserSuppressionExpiryDate parameter specifies whether to temporarily suspend notifications for the alert policy. Until the specified date-time, no notifications are sent for detected activities. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -399,7 +431,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -409,6 +440,9 @@ Accept wildcard characters: False ``` ### -NotifyUserThrottleThreshold + +> Applicable: Security & Compliance + The NotifyUserThrottleThreshold parameter specifies the maximum number of notifications for the alert policy within the time period specified by the NotifyUserThrottleWindow parameter. Once the maximum number of notifications has been reached in the time period, no more notifications are sent for the alert. Valid values are: - An integer. @@ -418,7 +452,6 @@ The NotifyUserThrottleThreshold parameter specifies the maximum number of notifi Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -428,6 +461,9 @@ Accept wildcard characters: False ``` ### -NotifyUserThrottleWindow + +> Applicable: Security & Compliance + The NotifyUserThrottleWindow parameter specifies the time interval in minutes that's used by the NotifyUserThrottleThreshold parameter. Valid values are: - An integer. @@ -437,7 +473,6 @@ The NotifyUserThrottleWindow parameter specifies the time interval in minutes th Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -447,6 +482,9 @@ Accept wildcard characters: False ``` ### -Operation + +> Applicable: Security & Compliance + The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. @@ -457,7 +495,6 @@ You can only use this parameter when the ThreatType parameter has the value Acti Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -467,13 +504,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypes + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -483,13 +522,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypesForCounting + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypesForCounting Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -499,13 +540,15 @@ Accept wildcard characters: False ``` ### -PrivacyManagementScopedSensitiveInformationTypesThreshold + +> Applicable: Security & Compliance + {{ Fill PrivacyManagementScopedSensitiveInformationTypesThreshold Description }} ```yaml Type: System.UInt64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -515,6 +558,9 @@ Accept wildcard characters: False ``` ### -Severity + +> Applicable: Security & Compliance + The Severity parameter specifies the severity of the detection. Valid values are: - Low (This is the default value) @@ -525,7 +571,6 @@ The Severity parameter specifies the severity of the detection. Valid values are Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -535,6 +580,9 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: Security & Compliance + The Threshold parameter specifies the number of detections that trigger the alert policy (within the time period specified by the TimeWindow parameter). A valid value is an integer that's greater than or equal to 3. You can only use this parameter when the AggregationType parameter value is SimpleAggregation. @@ -543,7 +591,6 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -553,6 +600,9 @@ Accept wildcard characters: False ``` ### -TimeWindow + +> Applicable: Security & Compliance + The TimeWindow parameter specifies the time interval in minutes for number of detections specified by the Threshold parameter. A valid value is an integer that's greater than 60 (one hour). You can only use this parameter when the AggregationType parameter value is SimpleAggregation. @@ -561,7 +611,6 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -571,13 +620,15 @@ Accept wildcard characters: False ``` ### -VolumeThreshold + +> Applicable: Security & Compliance + {{ Fill VolumeThreshold Description }} ```yaml Type: System.UInt64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -587,13 +638,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolder.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-PublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PublicFolder.md index 089d38d7be..1e20ef8860 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-PublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-publicfolder +schema: 2.0.0 +title: Set-PublicFolder --- # Set-PublicFolder @@ -79,13 +80,15 @@ In Exchange 2010, this example sets the folder to replicate only on weekends. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name and path of the public folder you want to modify. A valid value uses the format: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. ```yaml Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -AgeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AgeLimit parameter specifies the overall age limit on the folder. Items that reach the age limit are deleted from the public folder. Replicas of this public folder are automatically deleted when the age limit is exceeded. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -103,7 +109,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -122,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -140,7 +150,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -EformsLocaleId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -174,7 +188,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -184,6 +197,9 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The HiddenFromAddressListsEnabled parameter specifies whether to hide the public folder from address lists. @@ -192,7 +208,6 @@ The HiddenFromAddressListsEnabled parameter specifies whether to hide the public Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IssueWarningQuota parameter specifies the public folder size that triggers a warning to public folder owners stating that the folder is almost full. The default value is unlimited, which is 2 terabytes. @@ -222,7 +240,6 @@ The valid input range for this parameter is from 1 through 2TB. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -232,6 +249,9 @@ Accept wildcard characters: False ``` ### -LocalReplicaAgeLimit + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The LocalReplicaAgeLimit parameter specifies the age limit of the replica on the connected server, if there is a replica on it. @@ -240,7 +260,6 @@ The LocalReplicaAgeLimit parameter specifies the age limit of the replica on the Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -250,6 +269,9 @@ Accept wildcard characters: False ``` ### -MailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailEnabled parameter specifies that the public folder is mail-enabled. To do this, you use the value $true. You use this parameter to correct a mail-enabled public folder that lost its mail-enabled status. If you attempt to use this parameter to mail-enable a public folder that was never mail-enabled, the command will fail. @@ -258,7 +280,6 @@ You use this parameter to correct a mail-enabled public folder that lost its mai Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -268,6 +289,9 @@ Accept wildcard characters: False ``` ### -MailRecipientGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MailRecipientGuid parameter specifies the MailRecipientGuid value of the public folder. You use this parameter to correct a mail-enabled public folder that lost its MailRecipientGuid value. The value that you specify for this parameter must match the MailRecipientGuid value of an existing mail-enabled public folder. Otherwise, the command will fail. @@ -276,7 +300,6 @@ The value that you specify for this parameter must match the MailRecipientGuid v Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -286,6 +309,9 @@ Accept wildcard characters: False ``` ### -MaxItemSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxItemSize parameter specifies the maximum size for posted items. Items larger than the value of the MaxItemSize parameter are rejected. The default value is unlimited, which is 2 gigabytes. When you enter a value, qualify the value with one of the following units: When you enter a value, qualify the value with one of the following units: @@ -304,7 +330,6 @@ The valid input range for this parameter is from 1 through 2GB. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -314,13 +339,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name for the public folder. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -330,6 +357,9 @@ Accept wildcard characters: False ``` ### -OverrideContentMailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The OverrideContentMailbox parameter specifies the target public folder mailbox whereyou want to move this public folder's content to. You can use any value that uniquely identifies the mailbox. For example: @@ -349,7 +379,6 @@ The OverrideContentMailbox parameter specifies the target public folder mailbox Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -359,13 +388,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Path parameter specifies the path of the public folder, for example, \\TopLevelPublicFolder\\PublicFolder. ```yaml Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -375,13 +406,15 @@ Accept wildcard characters: False ``` ### -PerUserReadStateEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PerUserReadStateEnabled parameter specifies whether to maintain read and unread data on a per-user basis. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -391,6 +424,9 @@ Accept wildcard characters: False ``` ### -ProhibitPostQuota + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ProhibitPostQuota parameter specifies the size of a public folder at which users are notified that the public folder is full. Users can't post to a folder whose size is larger than the ProhibitPostQuota parameter value. The default value is unlimited, which is 2 terabytes. When you enter a value, qualify the value with one of the following units: @@ -409,7 +445,6 @@ The valid input range for this parameter is from 1 through 2TB. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -419,6 +454,9 @@ Accept wildcard characters: False ``` ### -Replicas + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The Replicas parameter specifies a list of public folder databases with which to replicate this public folder. You can use any value that uniquely identifies the database. For example: @@ -433,7 +471,6 @@ You can specify multiple values separated by commas. If the values contain space Type: DatabaseIdParameter[] Parameter Sets: Set2 Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -443,6 +480,9 @@ Accept wildcard characters: False ``` ### -ReplicationSchedule + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The ReplicationSchedule parameter specifies the replication schedule for the folder. @@ -471,7 +511,6 @@ Here are some examples: Type: Schedule Parameter Sets: Set2 Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -481,6 +520,9 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsFor + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetainDeletedItemsFor parameter specifies the retention time for deleted items. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -489,7 +531,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -499,6 +540,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -514,7 +558,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -524,6 +567,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseAgeDefaults + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The UseDatabaseAgeDefaults parameter specifies whether to use the database age limit. @@ -532,7 +578,6 @@ The UseDatabaseAgeDefaults parameter specifies whether to use the database age l Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -542,6 +587,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseQuotaDefaults + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The UseDatabaseQuotaDefaults parameter specifies whether to use the public store quota limits. @@ -550,7 +598,6 @@ The UseDatabaseQuotaDefaults parameter specifies whether to use the public store Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -560,6 +607,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseReplicationSchedule + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The UseDatabaseReplicationSchedule parameter specifies whether to use the public folder replication schedule. @@ -568,7 +618,6 @@ The UseDatabaseReplicationSchedule parameter specifies whether to use the public Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -578,6 +627,9 @@ Accept wildcard characters: False ``` ### -UseDatabaseRetentionDefaults + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The UseDatabaseRetentionDefaults parameter specifies whether to use the database retention defaults. @@ -586,7 +638,6 @@ The UseDatabaseRetentionDefaults parameter specifies whether to use the database Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -596,13 +647,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderDatabase.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderDatabase.md index 85ad17feda..fd89adf4ff 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderDatabase.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfolderdatabase applicable: Exchange Server 2010 -title: Set-PublicFolderDatabase -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-publicfolderdatabase +schema: 2.0.0 +title: Set-PublicFolderDatabase --- # Set-PublicFolderDatabase @@ -76,6 +77,9 @@ This example prevents the deleted items in the public folder database PFDB01 fro ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the public folder database that you want to modify. You can use any value that uniquely identifies the database. For example: - Name @@ -86,7 +90,6 @@ The Identity parameter specifies the public folder database that you want to mod Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -AllowFileRestore + +> Applicable: Exchange Server 2010 + The AllowFileRestore parameter specifies that the public folder database can be overwritten if the public folder database is restored. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -112,13 +117,15 @@ Accept wildcard characters: False ``` ### -BackgroundDatabaseMaintenance + +> Applicable: Exchange Server 2010 + The BackgroundDatabaseMaintenance parameter specifies whether the Extensible Storage Engine (ESE) performs database maintenance. The two possible values are $true or $false. If you specify $true, the public folder database reads the object during database mount and initializes the database to perform the background database maintenance. If you specify $false, the public folder database reads the object during database mount and initializes the database without the option to perform the background database maintenance. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -CircularLoggingEnabled + +> Applicable: Exchange Server 2010 + The CircularLoggingEnabled parameter specifies whether to enable circular logging. If you specify a value of $true, circular logging is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -153,7 +165,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -CustomReferralServerList + +> Applicable: Exchange Server 2010 + The CustomReferralServerList parameter specifies public folder referral costs to individual servers manually. Costs can be any positive number. Servers not included on the list aren't included for referrals. If this parameter is set with no servers in the list, there are no public folder referrals. The CustomReferralServerList parameter accepts an array in the following format: "serverID:cost". Use a comma to separate multiple servers, for example, "MBXSERVER01:1","MBXSERVER02:5". @@ -171,7 +185,6 @@ The CustomReferralServerList parameter accepts an array in the following format: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -DeletedItemRetention + +> Applicable: Exchange Server 2010 + The DeletedItemRetention parameter specifies the time that deleted items are kept in the dumpster before being permanently deleted during store maintenance. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -197,13 +212,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -213,13 +230,15 @@ Accept wildcard characters: False ``` ### -EventHistoryRetentionPeriod + +> Applicable: Exchange Server 2010 + The EventHistoryRetentionPeriod parameter specifies the length of time that events are retained in the event history table. Events can be retained for up to one week. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -229,13 +248,15 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2010 + The IssueWarningQuota parameter specifies the public folder size at which a warning is issued to public folder owners stating that the folder is almost full. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -245,13 +266,15 @@ Accept wildcard characters: False ``` ### -ItemRetentionPeriod + +> Applicable: Exchange Server 2010 + The ItemRetentionPeriod parameter specifies the length of time that items are retained in a folder before they're deleted during store maintenance. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -261,6 +284,9 @@ Accept wildcard characters: False ``` ### -MaintenanceSchedule + +> Applicable: Exchange Server 2010 + The MaintenanceSchedule parameter specifies the store maintenance schedule. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. @@ -286,7 +312,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -296,13 +321,15 @@ Accept wildcard characters: False ``` ### -MaxItemSize + +> Applicable: Exchange Server 2010 + The MaxItemSize parameter specifies the maximum size of an item that can be posted to or received by a public folder. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -312,13 +339,15 @@ Accept wildcard characters: False ``` ### -MountAtStartup + +> Applicable: Exchange Server 2010 + The MountAtStartup parameter specifies whether the database should be mounted when the store starts. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -328,13 +357,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the name of the public folder database. Use this parameter to change the name of the public folder database. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -344,13 +375,15 @@ Accept wildcard characters: False ``` ### -ProhibitPostQuota + +> Applicable: Exchange Server 2010 + The ProhibitPostQuota parameter specifies the size of a public folder at which users are notified that the public folder is full. Users can't post to a folder larger than the ProhibitPostQuota parameter value. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -360,6 +393,9 @@ Accept wildcard characters: False ``` ### -QuotaNotificationSchedule + +> Applicable: Exchange Server 2010 + The QuotaNotificationSchedule parameter specifies the interval at which warning messages are sent when public folders exceed their specified size limit. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. @@ -385,7 +421,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -395,6 +430,9 @@ Accept wildcard characters: False ``` ### -ReplicationMessageSize + +> Applicable: Exchange Server 2010 + The ReplicationMessageSize parameter specifies the size of replication messages. Small items may be aggregated into a single replication message that can be as large as this setting, but items larger than this setting are replicated with messages larger than this size. A valid value is a number up to 2 gigabytes (2147482624 bytes). The default value is 300 kilobytes (307200 bytes). @@ -412,7 +450,6 @@ Unqualified values are typically treated as bytes, but small values may be round Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -422,13 +459,15 @@ Accept wildcard characters: False ``` ### -ReplicationPeriod + +> Applicable: Exchange Server 2010 + The ReplicationPeriod parameter specifies the interval at which replication of public folders or content updates may occur. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -438,6 +477,9 @@ Accept wildcard characters: False ``` ### -ReplicationSchedule + +> Applicable: Exchange Server 2010 + The ReplicationSchedule parameter specifies the time intervals during which replication of public folders or contents may occur. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. @@ -464,7 +506,6 @@ Here are some examples: Type: Schedule Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -474,13 +515,15 @@ Accept wildcard characters: False ``` ### -RetainDeletedItemsUntilBackup + +> Applicable: Exchange Server 2010 + The RetainDeletedItemsUntilBackup parameter specifies that deleted items aren't removed until a backup of the public folder database is performed. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -490,6 +533,9 @@ Accept wildcard characters: False ``` ### -UseCustomReferralServerList + +> Applicable: Exchange Server 2010 + The UseCustomReferralServerList parameter specifies whether to use the server costs specified by the PublicFolderReferralServerList parameter. If set to $true, the server uses the PublicFolderReferralServerList parameter costs to make public folder referrals. If set to $false, the server uses Active Directory inter-site costs to make public folder referrals. Setting this parameter to $false also clears the PublicFolderReferralServerList parameter. @@ -498,7 +544,6 @@ Setting this parameter to $false also clears the PublicFolderReferralServerList Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -508,13 +553,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMigrationRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMigrationRequest.md index 7c4de5b3bf..d90b6c55ed 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfoldermigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PublicFolderMigrationRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-publicfoldermigrationrequest +schema: 2.0.0 +title: Set-PublicFolderMigrationRequest --- # Set-PublicFolderMigrationRequest @@ -69,6 +70,9 @@ This example changes the setting of the PublicFolderMigration migration request ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the migration request that you want to modify. You can use the following values: - Name @@ -78,7 +82,6 @@ The Identity parameter specifies the migration request that you want to modify. Type: PublicFolderMigrationRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -RehomeRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RehomeRequest switch tells the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the public folder that's being migrated. You don't need to specify a value with this switch. This switch is used primarily for debugging purposes. @@ -96,7 +102,6 @@ This switch is used primarily for debugging purposes. Type: SwitchParameter Parameter Sets: Rehome Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -114,7 +122,6 @@ You need to use this switch if you set the LargeItemLimit parameter to a value o Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -132,7 +142,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -BatchName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BatchName parameter specifies a descriptive name for the public folder batch migration. You can use the BatchName parameter as a search string when you use the Get-PublicFolderMigrationRequest cmdlet. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -158,13 +169,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -174,6 +187,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -183,7 +199,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,13 +208,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All)) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +244,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -240,7 +262,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -250,6 +271,9 @@ Accept wildcard characters: False ``` ### -PreventCompletion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PreventCompletion parameter specifies whether to run the migration request, but not allow it to complete. Valid values are: - $true: The migration request is run, but is not allowed to complete. To complete the migration request, set this parameter to $false before you run the Resume-PublicFolderMigrationRequest cmdlet. @@ -259,7 +283,6 @@ The PreventCompletion parameter specifies whether to run the migration request, Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -269,6 +292,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: - Lowest @@ -284,7 +310,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -294,6 +319,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -307,7 +335,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -317,13 +344,15 @@ Accept wildcard characters: False ``` ### -SkipMerging + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SkipMerging parameter specifies whether certain stages of a migration are to be skipped for debugging purposes. Don't use this parameter unless directed to do so by Microsoft Customer Service and Support or specific documentation. ```yaml Type: SkippableMergeComponent[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -333,13 +362,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMoveRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMoveRequest.md index f63c7353d0..9926e55de1 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-PublicFolderMoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfoldermoverequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-PublicFolderMoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-publicfoldermoverequest +schema: 2.0.0 +title: Set-PublicFolderMoveRequest --- # Set-PublicFolderMoveRequest @@ -53,13 +54,15 @@ This example changes the public folder move request \\PublicFolderMove to accept ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the public folder move request. The default identity of a public folder move request is \\PublicFolderMove. ```yaml Type: PublicFolderMoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -77,7 +83,6 @@ You need to use this switch if you set the LargeItemLimit parameter to a value o Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -BadItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. @@ -95,7 +103,6 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -130,7 +142,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +169,15 @@ Accept wildcard characters: False ``` ### -InternalFlags + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. ```yaml Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +187,9 @@ Accept wildcard characters: False ``` ### -LargeItemLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. For more information about maximum message size values, see the following topics: @@ -187,7 +205,6 @@ If you set this value to 51 or higher, you also need to use the AcceptLargeDataL Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,6 +214,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: - Lowest @@ -212,7 +232,6 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +241,9 @@ Accept wildcard characters: False ``` ### -RequestExpiryInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter: - The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value. @@ -235,7 +257,6 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -245,13 +266,15 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuspendWhenReadyToComplete parameter specifies whether to suspend the request before it reaches the status of CompletionInProgress. After the move is suspended, it has a status of AutoSuspended. You can then manually complete the move by using the Resume-PublicFolderMoveRequest command. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -261,13 +284,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md b/exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePermissions.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-QuarantinePermissions.md rename to exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePermissions.md index 124bd14378..3a2ffa3548 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePermissions.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-quarantinepermissions applicable: Exchange Online, Exchange Online Protection -title: Set-QuarantinePermissions -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-quarantinepermissions +schema: 2.0.0 +title: Set-QuarantinePermissions --- # Set-QuarantinePermissions @@ -54,13 +55,15 @@ In the same PowerShell session, you can use `$Perms` for the _EndUserQuarantineP ## PARAMETERS ### -QuarantinePermissionsObject + +> Applicable: Exchange Online, Exchange Online Protection + The QuarantinePermissionsObject parameter specifies the existing variable that contains quarantine permissions that you want to modify. For example if you previously ran the command `$Perms = New-QuarantinePermissions `, use the value `$Perms` for this parameter. ```yaml Type: QuarantinePermissions Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 9 @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -PermissionToAllowSender + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are: - $true: Allow sender is available for affected messages in quarantine. @@ -79,7 +85,6 @@ The PermissionToBlockSender parameter specifies whether users are allowed to add Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -PermissionToBlockSender + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are: - $true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine. @@ -98,7 +106,6 @@ The PermissionToBlockSender parameter specifies whether users are allowed to add Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 2 @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -PermissionToDelete + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are: - $true: Delete messages and Delete from quarantine are available for affected messages in quarantine. @@ -117,7 +127,6 @@ The PermissionToDelete parameter specifies whether users are allowed to delete m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 3 @@ -127,6 +136,9 @@ Accept wildcard characters: False ``` ### -PermissionToDownload + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToDownload parameter specifies whether users are allowed to download messages from quarantine. Valid values are: - $true: The permission is enabled. @@ -138,7 +150,6 @@ Currently, this value has no effect on the available actions in quarantine notif Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 4 @@ -148,6 +159,9 @@ Accept wildcard characters: False ``` ### -PermissionToPreview + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are: - $true: Preview message is available for affected messages in quarantine. @@ -157,7 +171,6 @@ The PermissionToPreview parameter specifies whether users are allowed to preview Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 5 @@ -167,6 +180,9 @@ Accept wildcard characters: False ``` ### -PermissionToRelease + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are: - $true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine. @@ -178,7 +194,6 @@ Don't set this parameter and the _PermissionToRequestRelease_ parameter to $true Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 6 @@ -188,6 +203,9 @@ Accept wildcard characters: False ``` ### -PermissionToRequestRelease + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are: - $true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine. @@ -199,7 +217,6 @@ Don't set this parameter and the _PermissionRelease_ parameter to $true. Set one Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 7 @@ -209,6 +226,9 @@ Accept wildcard characters: False ``` ### -PermissionToViewHeader + +> Applicable: Exchange Online, Exchange Online Protection + The PermissionToViewHeader parameter specifies whether users are allowed to view the message headers of quarantined messages. Valid values are: - $true: The permission is enabled. @@ -220,7 +240,6 @@ Currently, this value has no effect on available actions in quarantine notificat Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 8 diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-QuarantinePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePolicy.md index 796d65b9a1..20659f9134 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-QuarantinePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-quarantinepolicy applicable: Exchange Online, Exchange Online Protection -title: Set-QuarantinePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-quarantinepolicy +schema: 2.0.0 +title: Set-QuarantinePolicy --- # Set-QuarantinePolicy @@ -77,6 +78,9 @@ This example modifies the global settings for quarantine notifications (formerly ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the quarantine policy you want to modify. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -87,7 +91,6 @@ The Identity parameter specifies the quarantine policy you want to modify. You c Type: QuarantineTagIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -AdminNotificationFrequencyInDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,13 +118,15 @@ Accept wildcard characters: False ``` ### -AdminNotificationLanguage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: EsnLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese Required: False @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -AdminNotificationsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -AdminQuarantinePermissionsList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -162,6 +173,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -171,7 +185,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -CustomDisclaimer + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -197,13 +212,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -213,6 +230,9 @@ Accept wildcard characters: False ``` ### -EndUserQuarantinePermissions + +> Applicable: Exchange Online, Exchange Online Protection + **Note**: To set permissions in quarantine policies, we recommend using the EndUserQuarantinePermissionsValue parameter. The EndUserQuarantinePermissions specifies the end-user permissions for the quarantine policy by using a variable from the output of a New-QuarantinePermissions or Set-QuarantinePermissions command. @@ -223,7 +243,6 @@ For example, run the following command to store the required permissions in a va Type: QuarantinePermissions Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,6 +252,9 @@ Accept wildcard characters: False ``` ### -EndUserQuarantinePermissionsValue + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy. This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1): @@ -260,7 +282,6 @@ For custom permissions, get the binary value that corresponds to the permissions Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -270,13 +291,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. To set this parameter back to the default email address quarantine@messaging.microsoft.com, use the value $null. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -286,6 +309,9 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency + +> Applicable: Exchange Online, Exchange Online Protection + The EndUserSpamNotificationFrequency parameter species how often quarantine notifications are sent to users. Valid values are: - 04:00:00 (4 hours) @@ -296,7 +322,6 @@ The EndUserSpamNotificationFrequency parameter species how often quarantine noti Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -306,13 +331,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequencyInDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -322,13 +349,15 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLanguage + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: EsnLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese Required: False @@ -339,6 +368,9 @@ Accept wildcard characters: False ``` ### -EsnCustomSubject + +> Applicable: Exchange Online, Exchange Online Protection + The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications. You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. @@ -351,7 +383,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: MultiValuedProperty Parameter Sets: (All) Aliases: MultiValuedProperty -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -361,6 +392,9 @@ Accept wildcard characters: False ``` ### -ESNEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: - $true: Quarantine notifications are enabled. @@ -372,7 +406,6 @@ The ESNEnabled parameter specifies whether to enable quarantine notifications (f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -382,13 +415,15 @@ Accept wildcard characters: False ``` ### -IgnoreDehydratedFlag + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -398,6 +433,9 @@ Accept wildcard characters: False ``` ### -IncludeMessagesFromBlockedSenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send quarantine notifications for quarantined messages from blocked sender addresses. Valid values are: - $true: Recipients get quarantine notifications for affected messages from blocked senders. @@ -407,7 +445,6 @@ The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -417,6 +454,9 @@ Accept wildcard characters: False ``` ### -MultiLanguageCustomDisclaimer + +> Applicable: Exchange Online, Exchange Online Protection + The MultiLanguageCustomDisclaimer parameter specifies the custom disclaimer text to use near the bottom of quarantine notifications. The localized text, **A disclaimer from your organization:** is always included first, followed by the text you specify for this parameter. You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique custom disclaimer text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. @@ -429,7 +469,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -439,6 +478,9 @@ Accept wildcard characters: False ``` ### -MultiLanguageSenderName + +> Applicable: Exchange Online, Exchange Online Protection + The MultiLanguageSenderName parameter specifies the email sender's display name to use in quarantine notifications. You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you can specify a unique sender name. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, and MultiLanguageSenderName parameter values in the same order. @@ -451,7 +493,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -461,6 +502,9 @@ Accept wildcard characters: False ``` ### -MultiLanguageSetting + +> Applicable: Exchange Online, Exchange Online Protection + The MultiLanguageSetting parameter specifies the language of quarantine notifications. Valid values are: Default, Amharic, Arabic, Basque, BengaliIndia, Bulgarian, Catalan, ChineseSimplified, ChineseTraditional, Croatian, Cyrillic, Czech, Danish, Dutch, English, Estonian, Filipino, Finnish, French, Galician, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Malay, Malayalam, Marathi, Norwegian, NorwegianNynorsk, Odia, Persian, Polish, Portuguese, PortuguesePortugal, Romanian, Russian, Serbian, SerbianCyrillic, Slovak, Slovenian, Spanish, Swahili, Swedish, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, and Vietnamese. @@ -477,7 +521,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -487,6 +530,9 @@ Accept wildcard characters: False ``` ### -OrganizationBrandingEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The OrganizationBrandingEnabled parameter enables or disables organization branding in the end-user quarantine notification messages. Valid values are: - $true: Organization branding is enabled. The default Microsoft logo that's used in quarantine notifications is replaced by your custom logo. Before you do this, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your custom logo. @@ -498,7 +544,6 @@ This setting is available only in the built-in quarantine policy named DefaultGl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,13 +553,15 @@ Accept wildcard characters: False ``` ### -QuarantineRetentionDays + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -524,13 +571,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RMSTemplate.md b/exchange/exchange-ps/ExchangePowerShell/Set-RMSTemplate.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-RMSTemplate.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RMSTemplate.md index 807ec202d5..26d5d4ef44 100644 --- a/exchange/exchange-ps/exchange/Set-RMSTemplate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RMSTemplate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-rmstemplate applicable: Exchange Online, Exchange Online Protection -title: Set-RMSTemplate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-rmstemplate +schema: 2.0.0 +title: Set-RMSTemplate --- # Set-RMSTemplate @@ -45,6 +46,9 @@ This example changes the RMS template Contoso Confidential from Distributed to A ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the RMS template. You can use any value that uniquely identifies the RMS template, for example: - Name @@ -56,7 +60,6 @@ You can use the Get-RMSTemplate cmdlet to view the RMS templates in your organiz Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Online, Exchange Online Protection + The Type parameter specifies the type of RMS template. You can specify one of the following values: - Archived @@ -78,7 +84,6 @@ The default type for imported RMS templates is Archived. Type: RmsTemplateType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ReceiveConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-ReceiveConnector.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-ReceiveConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ReceiveConnector.md index 0243479192..4e14c8daab 100644 --- a/exchange/exchange-ps/exchange/Set-ReceiveConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ReceiveConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-receiveconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ReceiveConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-receiveconnector +schema: 2.0.0 +title: Set-ReceiveConnector --- # Set-ReceiveConnector @@ -100,6 +101,9 @@ Configures the Receive connector to time out connections after 15 minutes. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Receive connector that you want to modify. You can use any value that uniquely identifies the Receive connector. For example: - Name @@ -111,7 +115,6 @@ The Identity parameter specifies the Receive connector that you want to modify. Type: ReceiveConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -121,6 +124,9 @@ Accept wildcard characters: False ``` ### -AdvertiseClientSettings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AdvertiseClientSettings parameter specifies whether the SMTP server name, port number, and authentication settings for the Receive connector are displayed to users in the options of Outlook on the web. Valid values are: - $true: The SMTP values are displayed in Outlook on the web. Typically, you would only use this setting for a Receive connector with the usage type Client (authenticated SMTP connections on TCP port 587 for POP3 and IMAP4 clients). @@ -130,7 +136,6 @@ The AdvertiseClientSettings parameter specifies whether the SMTP server name, po Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,6 +145,9 @@ Accept wildcard characters: False ``` ### -AuthMechanism + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AuthMechanism parameter specifies the advertised and accepted authentication mechanisms for the Receive connector. Valid values are: - None @@ -162,7 +170,6 @@ You can specify multiple values separated by commas, but some values have depend Type: AuthMechanisms Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +179,9 @@ Accept wildcard characters: False ``` ### -AuthTarpitInterval + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The AuthTarpitInterval parameter specifies the period of time to delay responses to failed authentication attempts from remote servers that may be abusing the connection. The default value is 5 seconds. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -184,7 +194,6 @@ You can configure the delay for other SMTP failure responses by using the Tarpit Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +203,9 @@ Accept wildcard characters: False ``` ### -Banner + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Banner parameter specifies a custom SMTP 220 banner that's displayed to remote messaging servers that connect to the Receive connector. When you specify a value, enclose the value in quotation marks, and start the value with 220 (the default "Service ready" SMTP response code). The default value of this parameter is blank ($null), which uses the following SMTP banner: @@ -204,7 +216,6 @@ The default value of this parameter is blank ($null), which uses the following S Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -214,6 +225,9 @@ Accept wildcard characters: False ``` ### -BareLinefeedRejectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BareLinefeedRejectionEnabled parameter specifies whether this Receive connector rejects messages that contain line feed (LF) characters without immediately preceding carriage return characters (CR) in the SMTP DATA stream. This condition is known as bare line feeds. Valid values are: - $true: Messages that contain bare line feeds are rejected. @@ -225,7 +239,6 @@ Although message that contain bare line feeds might be delivered successfully, t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -235,6 +248,9 @@ Accept wildcard characters: False ``` ### -BinaryMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BinaryMimeEnabled parameter specifies whether the BINARYMIME Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: BINARYMIME is enabled and is advertised in the EHLO response. This setting requires that the ChunkingEnabled parameter is also set to the value $true. This is the default value. @@ -246,7 +262,6 @@ The binary MIME extension is defined in RFC 3030. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -256,6 +271,9 @@ Accept wildcard characters: False ``` ### -Bindings + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax `"IPv4Address:TCPPort","IPv6Address:TCPPort"`. You can specify an IPv4 address and port, an IPv6 address and port, or both. The IP address values 0.0.0.0 or `[::]` indicate that the Receive connector uses all available local IPv4 or all IPv6 addresses. You need to specify a valid local IP address from the network adapters of the Exchange server. If you specify an invalid local IP address, the Microsoft Exchange Transport service might fail to start when the service is restarted. @@ -269,7 +287,6 @@ The values for this parameter must satisfy one of the following uniqueness requi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -279,6 +296,9 @@ Accept wildcard characters: False ``` ### -ChunkingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ChunkingEnabled parameter specifies whether the CHUNKING Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: CHUNKING is enabled and is advertised in the EHLO response. This is the default value. @@ -290,7 +310,6 @@ Chunking is defined in RFC 3030. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -300,13 +319,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,6 +337,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -325,7 +349,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -335,6 +358,9 @@ Accept wildcard characters: False ``` ### -ConnectionInactivityTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectionInactivityTimeout parameter specifies the maximum amount of idle time before a connection to the Receive connector is closed. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -349,7 +375,6 @@ The value of this parameter must be less than the value of the ConnectionTimeout Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -359,6 +384,9 @@ Accept wildcard characters: False ``` ### -ConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectionTimeout parameter specifies the maximum time that the connection to the Receive connector can remain open, even if the connection is actively transmitting data. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -373,7 +401,6 @@ The value of this parameter must be greater than the value of the ConnectionInac Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -383,6 +410,9 @@ Accept wildcard characters: False ``` ### -DefaultDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DefaultDomain parameter specifies the default accepted domain to use for the Exchange organization. You can use any value that uniquely identifies the accepted domain. For example: - Name @@ -399,7 +429,6 @@ Although you can configure any accepted domain as the default domain, you typica Type: AcceptedDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -409,6 +438,9 @@ Accept wildcard characters: False ``` ### -DeliveryStatusNotificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeliveryStatusNotificationEnabled parameter specifies whether the DSN (delivery status notification) Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: DSN is enabled and is advertised in the EHLO response. This is the default value. @@ -420,7 +452,6 @@ Delivery status notifications are defined in RFC 3461. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -430,6 +461,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -438,7 +472,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -448,6 +481,9 @@ Accept wildcard characters: False ``` ### -DomainSecureEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainSecureEnabled parameter specifies whether to enable or disable mutual Transport Layer Security (TLS) authentication (also known as Domain Secure) for the domains that are serviced by the Receive connector. Valid values are: - $true: Mutual TLS authentication is enabled. @@ -465,7 +501,6 @@ Note that setting this parameter to the value $true is only part of the requirem Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -475,6 +510,9 @@ Accept wildcard characters: False ``` ### -EightBitMimeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EightBitMimeEnabled parameter specifies whether the 8BITMIME Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: 8BITMIME is enabled and is advertised in the EHLO response. This is the default value. @@ -486,7 +524,6 @@ The EightBitMimeEnabled parameter specifies whether the 8BITMIME Extended SMTP e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -496,6 +533,9 @@ Accept wildcard characters: False ``` ### -EnableAuthGSSAPI + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnableAuthGSSAPI parameter enables or disables Kerberos when Integrated Windows authentication is available on the Receive connector (the AuthMechanism parameter contains the value Integrated). Valid values are: - $true: Kerberos is enabled. The Extended SMTP keyword AUTH GSSAPI NTLM is advertised in the EHLO response. Clients can use Kerberos or NTLM for Integrated Windows authentication. @@ -507,7 +547,6 @@ The Generic Security Services application programming interface (GSSAPI) is an I Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -517,6 +556,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether to enable or disable the Receive connector. Valid values are: - $true: The Receive connector is enabled. This is the default value. @@ -526,7 +568,6 @@ The Enabled parameter specifies whether to enable or disable the Receive connect Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -536,6 +577,9 @@ Accept wildcard characters: False ``` ### -EnhancedStatusCodesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnhancedStatusCodesEnabled parameter specifies whether the ENHANCEDSTATUSCODES Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: ENHANCEDSTATUSCODES is enabled and is advertised in the EHLO response. This is the default value. @@ -547,7 +591,6 @@ Enhanced status codes are defined in RFC 2034. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -557,6 +600,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionPolicy parameter specifies how you want to use Extended Protection for Authentication on the Receive connector.Valid values are: - None: Extended Protection for Authentication won't be used. This is the default value. @@ -569,7 +615,6 @@ Extended Protection for Authentication enhances the protection and handling of c Type: ExtendedProtectionPolicySetting Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -579,6 +624,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Fqdn parameter specifies the destination FQDN that's shown to connected messaging servers. This value is used in the following locations: - In the default SMTP banner of the Receive connector @@ -594,7 +642,6 @@ Don't modify this value on the default Receive connector named `Default Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LongAddressesEnabled parameter specifies whether the Receive connector accepts long X.400 email addresses. The X.400 email addresses are encapsulated in SMTP email addresses by using the Internet Mail Connector Encapsulated Address (IMCEA) encapsulation method. Valid values are: - $true: X.400 email addresses can be up to 1,860 characters long after IMCEA encapsulation. @@ -621,7 +671,6 @@ You can only configure this parameter on Receive connectors in the Transport ser Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -631,6 +680,9 @@ Accept wildcard characters: False ``` ### -MaxAcknowledgementDelay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The MaxAcknowledgementDelay parameter specifies the period the transport server delays acknowledgement when receiving messages from a host that doesn't support shadow redundancy. When receiving messages from a host that doesn't support shadow redundancy, a Microsoft Exchange Server 2010 transport server delays issuing an acknowledgement until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server times out and issues an acknowledgement anyway. The default value is 30 seconds. @@ -641,7 +693,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -651,6 +702,9 @@ Accept wildcard characters: False ``` ### -MaxHeaderSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxHeaderSize parameter specifies the maximum size of the SMTP message header before the Receive connector closes the connection. The default value is 256 kilobytes (262144 bytes). When you enter a value, qualify the value with one of the following units: @@ -668,7 +722,6 @@ A valid value is from 1 to 2147483647 bytes. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -678,6 +731,9 @@ Accept wildcard characters: False ``` ### -MaxHopCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxHopCount parameter specifies the maximum number of hops that a message can take before the message is rejected by the Receive connector. The maximum number of hops is determined by the number of Received header fields that exist in a submitted message. A valid value is from 1 to 500. The default value is 30. @@ -686,7 +742,6 @@ A valid value is from 1 to 500. The default value is 30. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -696,6 +751,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxInboundConnection parameter specifies the maximum number of inbound connections that this Receive connector serves at the same time. A valid value is from 1 to 2147483647, or the value unlimited. The default value is 5000. @@ -706,7 +764,6 @@ To disable the inbound connection limit on a Receive connector, enter a value of Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -716,6 +773,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnectionPercentagePerSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxInboundConnectionPercentagePerSource parameter specifies the maximum number of connections that a Receive connector serves at the same time from a single IP address, expressed as the percentage of available remaining connections on a Receive connector. A valid value is from 1 to 100 without the percent sign (%). The default value is 2 percent. @@ -724,7 +784,6 @@ A valid value is from 1 to 100 without the percent sign (%). The default value i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -734,6 +793,9 @@ Accept wildcard characters: False ``` ### -MaxInboundConnectionPerSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxInboundConnectionPerSource parameter specifies the maximum number of connections that this Receive connector serves at the same time from a single IP address. A valid value is from 1 to 10000, or the value unlimited. The default value is 20. @@ -744,7 +806,6 @@ To disable the inbound connection per source limit on a Receive connector, enter Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -754,6 +815,9 @@ Accept wildcard characters: False ``` ### -MaxLocalHopCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxLocalHopCount parameter specifies the maximum number of local hops that a message can take before the message is rejected by the Receive connector. The maximum number of local hops is determined by the number of Received headers with local server addresses in a submitted message. A valid value is from 0 to 50. The default value is 8. @@ -764,7 +828,6 @@ When you specify the value 0, the message is never rejected based on the number Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -774,6 +837,9 @@ Accept wildcard characters: False ``` ### -MaxLogonFailures + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxLogonFailures parameter specifies the number of logon failures that the Receive connector retries before it closes the connection. A valid value is from 0 to 10. The default value is 3. @@ -784,7 +850,6 @@ When you specify the value 0, the connection is never closed because of logon fa Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -794,6 +859,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxMessageSize parameter specifies the maximum size of a message that's allowed through the Receive connector. The default value is 36 MB, which results in a realistic maximum message size of 25 MB. When you enter a value, qualify the value with one of the following units: @@ -814,7 +882,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -824,6 +891,9 @@ Accept wildcard characters: False ``` ### -MaxProtocolErrors + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxProtocolErrors parameter specifies the maximum number of SMTP protocol errors that the Receive connector accepts before closing the connection. A valid value is from 0 to 2147483647, or the value unlimited. The default value is 5. @@ -834,7 +904,6 @@ When you specify the value unlimited, a connection is never closed because of pr Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -844,6 +913,9 @@ Accept wildcard characters: False ``` ### -MaxRecipientsPerMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxRecipientsPerMessage parameter specifies the maximum number of recipients per message that the Receive connector accepts before closing the connection. A valid value is from 1 to 512000. The default value is 200. @@ -852,7 +924,6 @@ A valid value is from 1 to 512000. The default value is 200. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -862,6 +933,9 @@ Accept wildcard characters: False ``` ### -MessageRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRateLimit parameter specifies the maximum number of messages that can be sent by a single client IP address per minute. A valid value is from 1 to 2147483647, or the value unlimited. @@ -874,7 +948,6 @@ The default value for Receive connectors on Mailbox servers is unlimited. The de Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -884,6 +957,9 @@ Accept wildcard characters: False ``` ### -MessageRateSource + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRateSource parameter specifies how the message submission rate is calculated. Valid values are: - None: No message submission rate is calculated. @@ -895,7 +971,6 @@ The MessageRateSource parameter specifies how the message submission rate is cal Type: MessageRateSourceFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -905,13 +980,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name for the Receive connector. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -921,6 +998,9 @@ Accept wildcard characters: False ``` ### -OrarEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OrarEnabled parameter enables or disables Originator Requested Alternate Recipient (ORAR) on the Receive connector. Valid values are: - $true: ORAR is enabled and is advertised in the XORAR keyword in the EHLO response. The actual ORAR information is transmitted in the RCPT TO SMTP command. @@ -932,7 +1012,6 @@ If the email address specified in the ORAR information is a long X.400 email add Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -942,6 +1021,9 @@ Accept wildcard characters: False ``` ### -PermissionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PermissionGroups parameter specifies the well-known security principals who are authorized to use the Receive connector and the permissions that are assigned to them. Valid values are: - None @@ -962,7 +1044,6 @@ For more information about the default permissions and security principals for p Type: PermissionGroups Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -972,6 +1053,9 @@ Accept wildcard characters: False ``` ### -PipeliningEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipeliningEnabled parameter specifies whether the PIPELINING Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: PIPELINING is enabled and is advertised in the EHLO response. This is the default value. @@ -983,7 +1067,6 @@ Pipelining is defined in RFC 2920. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -993,6 +1076,9 @@ Accept wildcard characters: False ``` ### -ProtocolLoggingLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProtocolLoggingLevel parameter specifies whether to enable or disable protocol logging for the Receive connector. Valid values are: - None: Protocol logging is disabled on the Receive connector. This is the default value. @@ -1004,7 +1090,6 @@ For more information about protocol logging, see [Protocol logging](https://lear Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1014,6 +1099,9 @@ Accept wildcard characters: False ``` ### -RejectReservedSecondLevelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RejectReservedSecondLevelRecipientDomains parameter specifies whether to reject connections that contain recipients in reserved second-level domains as specified in RFC 2606 (example.com, example.net, or example.org). Valid value are: - $true: RCPT TO commands that contain reserved second-level domains are rejected. @@ -1023,7 +1111,6 @@ The RejectReservedSecondLevelRecipientDomains parameter specifies whether to rej Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1033,6 +1120,9 @@ Accept wildcard characters: False ``` ### -RejectReservedTopLevelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RejectReservedTopLevelRecipientDomains parameter specifies whether to reject connections that contain recipients in reserved top-level domains (TLDs) as specified in RFC 2606 (.test, .example, .invalid, or .localhost). Valid value are: - $true: RCPT TO commands that contain reserved TLDs are rejected. @@ -1042,7 +1132,6 @@ The RejectReservedTopLevelRecipientDomains parameter specifies whether to reject Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1052,6 +1141,9 @@ Accept wildcard characters: False ``` ### -RejectSingleLabelRecipientDomains + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RejectSingleLabelRecipientDomains parameter specifies whether to reject connections that contain recipients in single-label domains (for example, chris@contoso instead of chris@contoso.com). Valid values are: - $true: RCPT TO commands that contain single-label domains are rejected. @@ -1061,7 +1153,6 @@ The RejectSingleLabelRecipientDomains parameter specifies whether to reject conn Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1071,6 +1162,9 @@ Accept wildcard characters: False ``` ### -RemoteIPRanges + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoteIPRanges parameter specifies the remote IP addresses that the Receive connector accepts messages from. Valid values are: - Single IP address: For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11. @@ -1091,7 +1185,6 @@ When remote IP address ranges overlap, the Receive connector with the most speci Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1101,6 +1194,9 @@ Accept wildcard characters: False ``` ### -RequireEHLODomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireEHLODomain parameter specifies whether the client must provide a domain name in the EHLO handshake after the SMTP connection is established. Valid values are: - $true: The client must provide a domain name in the EHLO handshake. If it doesn't, the SMTP connection is closed. @@ -1110,7 +1206,6 @@ The RequireEHLODomain parameter specifies whether the client must provide a doma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1120,6 +1215,9 @@ Accept wildcard characters: False ``` ### -RequireTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireTLS parameter specifies whether to require TLS transmission for inbound messages on the Receive connector. Valid values are: - $true: Inbound messages on the Receive connector require TLS transmission. @@ -1129,7 +1227,6 @@ The RequireTLS parameter specifies whether to require TLS transmission for inbou Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1139,13 +1236,15 @@ Accept wildcard characters: False ``` ### -ServiceDiscoveryFqdn + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ServiceDiscoveryFqdn parameter specifies the service discovery fully-qualified domain name (FQDN). for the Receive connector. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1155,6 +1254,9 @@ Accept wildcard characters: False ``` ### -SizeEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SizeEnabled parameter specifies how the SIZE Extended SMTP extension is used on the Receive connector. Valid values are: - Enabled: SIZE is enabled and is advertised in the EHLO response along with the value of the MaxMessageSize parameter. If the size of the inbound message exceeds the specified value, the Receive connector closes the connection with an error code. This is the default value. @@ -1167,7 +1269,6 @@ SIZE is defined in RFC 1870. Type: SizeMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1177,13 +1278,15 @@ Accept wildcard characters: False ``` ### -SmtpUtf8Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1193,6 +1296,9 @@ Accept wildcard characters: False ``` ### -SuppressXAnonymousTls + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuppressXAnonymousTls parameter specifies whether the X-ANONYMOUSTLS Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: - $true: X-ANONYMOUSTLS is disabled and isn't advertised in the EHLO response. This setting also requires that you set the UseDownGradedExchangeServerAuth parameter to the value $true on the Set-TransportService cmdlet on the server. @@ -1204,7 +1310,6 @@ The X-ANONYMOUSTLS extension is important when the AuthMechanism parameter conta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1214,6 +1319,9 @@ Accept wildcard characters: False ``` ### -TarpitInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TarpitInterval parameter specifies the period of time to delay an SMTP response to a remote server that may be abusing the connection. The default value is 00:00:05 (5 seconds). To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1226,7 +1334,6 @@ You can configure the delay for authentication failure responses by using the Au Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1236,13 +1343,15 @@ Accept wildcard characters: False ``` ### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"` and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1252,6 +1361,9 @@ Accept wildcard characters: False ``` ### -TlsDomainCapabilities + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsDomainCapabilities parameter specifies the capabilities that the Receive connector makes available to specific hosts outside of the organization. Remote hosts are authenticated with TLS with certificate validation before these capabilities are offered. This parameter uses the following syntax: @@ -1273,7 +1385,6 @@ For example, `"contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptCloudServices Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1283,6 +1394,9 @@ Accept wildcard characters: False ``` ### -TransportRole + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransportRole parameter specifies the transport service on the Mailbox server where the Receive connector is created. Valid values are: - FrontendTransport: The Front End Transport service where client or external SMTP connections occur. @@ -1294,7 +1408,6 @@ You can't use this parameter on Edge Transport servers. Type: ServerRole Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1304,13 +1417,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-RecipientFilterConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RecipientFilterConfig.md index d1543894e3..74a5aae2c5 100644 --- a/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RecipientFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-recipientfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-RecipientFilterConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-recipientfilterconfig +schema: 2.0.0 +title: Set-RecipientFilterConfig --- # Set-RecipientFilterConfig @@ -58,13 +59,15 @@ This example makes the following changes to the Recipient Filter agent configura ## PARAMETERS ### -BlockedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BlockedRecipients parameter specifies one or more SMTP addresses. To enter multiple SMTP addresses, separate the addresses by using a comma. The maximum number of individual SMTP addresses that you can input is 800. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -BlockListEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BlockListEnabled parameter specifies whether the Recipient Filter agent blocks messages sent to recipients listed in the BlockedRecipients parameter. Valid input for the BlockListEnabled parameter is $true or $false. The default setting is $false. When the BlockListEnabled parameter is set to $true, the Recipient Filter agent blocks messages sent to recipients listed in the BlockedRecipients parameter. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -99,7 +107,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -117,7 +127,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the Recipient Filter agent is enabled on the computer on which you're running the command. Valid input for the Enabled parameter is $true or $false. The default setting is $true. When the Enabled parameter is set to $true, the Recipient Filter agent is enabled on the computer on which you're running the command. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalMailEnabled parameter specifies whether all messages received from unauthenticated connections by servers external to your organization are passed through the Recipient Filter agent for processing. Valid input for the ExternalMailEnabled parameter is $true or $false. The default setting is $true. When the ExternalMailEnabled parameter is set to $true, all messages received from unauthenticated connections by servers external to your organization are passed through the Recipient Filter agent for processing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,13 +172,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalMailEnabled parameter specifies whether all messages from authenticated sender domains that belong to authoritative domains in the enterprise are passed through the Recipient Filter agent for processing. Valid input for the InternalMailEnabled parameter is $true or $false. The default setting is $false. When the InternalMailEnabled parameter is set to $true, all messages from authenticated sender domains that belong to authoritative domains in the enterprise are passed through the Recipient Filter agent for processing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,13 +190,15 @@ Accept wildcard characters: False ``` ### -RecipientValidationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecipientValidationEnabled parameter specifies whether the Recipient Filter agent blocks messages addressed to recipients that don't exist in the organization. Valid input for the RecipientValidationEnabled parameter is $true or $false. The default setting is $false. When the RecipientValidationEnabled parameter is set to $true, the Recipient Filter agent blocks messages addressed to recipients that don't exist in the organization. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +208,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-RecordReviewNotificationTemplateConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RecordReviewNotificationTemplateConfig.md index b3552f8231..862f6a7ab6 100644 --- a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RecordReviewNotificationTemplateConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-recordreviewnotificationtemplateconfig applicable: Security & Compliance -title: Set-RecordReviewNotificationTemplateConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-recordreviewnotificationtemplateconfig +schema: 2.0.0 +title: Set-RecordReviewNotificationTemplateConfig --- # Set-RecordReviewNotificationTemplateConfig @@ -42,6 +43,9 @@ This example configures customized review notification text and review reminder ## PARAMETERS ### -IsCustomizedNotificationTemplate + +> Applicable: Security & Compliance + The IsCustomizedNotificationTemplate switch specifies whether to use a customized review notification instead of the system default notification. Valid values are: - $true: Use a customized review notification. You specify the notification text using the CustomizedNotificationDataString parameter. @@ -51,7 +55,6 @@ The IsCustomizedNotificationTemplate switch specifies whether to use a customize Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -IsCustomizedReminderTemplate + +> Applicable: Security & Compliance + The IsCustomizedReminderTemplate switch specifies whether to use a customized review reminder instead of the system default reminder: - $true: Use a customized review reminder. You specify the reminder text using the CustomizedReminderDataString parameter. @@ -70,7 +76,6 @@ The IsCustomizedReminderTemplate switch specifies whether to use a customized re Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -CustomizedNotificationDataString + +> Applicable: Security & Compliance + The CustomizedNotificationDataString parameter specifies the customized review notification text to use. If the value contains spaces, enclose the value in quotation marks ("). The value of this parameter is meaningful only when the value of the IsCustomizedNotificationTemplate parameter is $true. @@ -88,7 +96,6 @@ The value of this parameter is meaningful only when the value of the IsCustomize Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -CustomizedReminderDataString + +> Applicable: Security & Compliance + The CustomizedReminderDataString parameter specifies the customized review reminder text to use. If the value contains spaces, enclose the value in quotation marks ("). The value of this parameter is meaningful only when the value of the IsCustomizedReminderTemplate parameter is $true. @@ -106,7 +116,6 @@ The value of this parameter is meaningful only when the value of the IsCustomize Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RegulatoryComplianceUI.md b/exchange/exchange-ps/ExchangePowerShell/Set-RegulatoryComplianceUI.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-RegulatoryComplianceUI.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RegulatoryComplianceUI.md index 8f4caf3d77..4379121dc8 100644 --- a/exchange/exchange-ps/exchange/Set-RegulatoryComplianceUI.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RegulatoryComplianceUI.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-regulatorycomplianceui applicable: Security & Compliance -title: Set-RegulatoryComplianceUI +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-regulatorycomplianceui schema: 2.0.0 +title: Set-RegulatoryComplianceUI --- # Set-RegulatoryComplianceUI @@ -38,6 +40,9 @@ This example displays the UI option in retention label settings to mark content ## PARAMETERS ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether to show or hide the UI option in retention label settings to mark content as a regulatory record. Valid values are: $true: The option to mark content as a regulatory record is visible in the UI for retention label settings. @@ -48,7 +53,6 @@ $false: The option to mark content as a regulatory record is not visible in the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RemoteDomain.md b/exchange/exchange-ps/ExchangePowerShell/Set-RemoteDomain.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-RemoteDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RemoteDomain.md index 8f7c3965a5..278351fb3b 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RemoteDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-remotedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-RemoteDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-remotedomain +schema: 2.0.0 +title: Set-RemoteDomain --- # Set-RemoteDomain @@ -81,6 +82,9 @@ This example queries Active Directory for all remote domains for which auto repl ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the remote domain that you want to modify. You can use any value that uniquely identifies the remote domain. For example: - Name @@ -91,7 +95,6 @@ The Identity parameter specifies the remote domain that you want to modify. You Type: RemoteDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -AllowedOOFType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AllowedOOFType parameter specifies the type of automatic replies or out-of-office (also known as OOF) notifications than can be sent to recipients in the remote domain. Valid values are: - External: Only automatic replies that are designated as external are sent to recipients in the remote domain. This is the default value. @@ -117,7 +123,6 @@ The value of this parameter is affected by the value of the IsInternal parameter Type: AllowedOOFType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -AutoForwardEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AutoForwardEnabled parameter specifies whether to allow messages that are auto-forwarded by client email programs in your organization. Valid values are: - $true: Auto-forwarded messages are delivered to recipients in the remote domain. This is the default value for new remote domains that you create and the built-in remote domain named Default in Exchange Online. @@ -136,7 +144,6 @@ The AutoForwardEnabled parameter specifies whether to allow messages that are au Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,6 +153,9 @@ Accept wildcard characters: False ``` ### -AutoReplyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AutoReplyEnabled parameter specifies whether to allow messages that are automatic replies from client email programs in your organization (for example, automatic reply messages that are generated by rules in Outlook). Valid values are: - $true: Automatic replies are delivered to recipients in the remote domain. This is the default value for new remote domains that you create and the built-in remote domain named Default in Exchange Online. @@ -155,7 +165,6 @@ The AutoReplyEnabled parameter specifies whether to allow messages that are auto Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,6 +174,9 @@ Accept wildcard characters: False ``` ### -ByteEncoderTypeFor7BitCharsets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ByteEncoderTypeFor7BitCharsets parameter specifies the 7-bit transfer encoding method for MIME format for messages sent to this remote domain. Valid values are: - Use7Bit: Always use default 7-bit transfer encoding for HTML and plain text. @@ -180,7 +192,6 @@ The ByteEncoderTypeFor7BitCharsets parameter specifies the 7-bit transfer encodi Type: ByteEncoderTypeFor7BitCharsetsEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -190,6 +201,9 @@ Accept wildcard characters: False ``` ### -CharacterSet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CharacterSet parameter specifies a character set for MIME messages without defined character sets that are sent from your organization to recipients in the remote domain. Valid values are: big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874, or the value $null. @@ -202,7 +216,6 @@ This setting doesn't overwrite character sets that are already specified in outb Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -221,7 +237,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -ContentType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ContentType parameter specifies the outbound message content type and formatting. Valid values are: - MimeHtmlText: Converts messages to MIME messages that use HTML formatting, unless the original message is a text message. If the original message is a text message, the outbound message is a MIME message that uses text formatting. This is the default value. @@ -241,7 +259,6 @@ The ContentType parameter specifies the outbound message content type and format Type: ContentType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -251,6 +268,9 @@ Accept wildcard characters: False ``` ### -DeliveryReportEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DeliveryReportEnabled parameter specifies whether to allow delivery reports from client software in your organization to recipients in the remote domain. Valid values are: - $true: Delivery reports are delivered to recipients in the remote domain. This is the default value. @@ -260,7 +280,6 @@ The DeliveryReportEnabled parameter specifies whether to allow delivery reports Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -270,6 +289,9 @@ Accept wildcard characters: False ``` ### -DisplaySenderName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: You should only modify this parameter under the direction of Microsoft Customer Service and Support. The DisplaySenderName parameter specifies whether to show the sender's Display Name in the From email address for messages sent to recipients in the remote domain. Valid values are: @@ -281,7 +303,6 @@ The DisplaySenderName parameter specifies whether to show the sender's Display N Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -291,6 +312,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -301,7 +325,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -311,6 +334,9 @@ Accept wildcard characters: False ``` ### -IsCoexistenceDomain + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IsCoexistenceDomain parameter specifies whether this remote domain is used to represent your Exchange Online organization. Valid values are: @@ -322,7 +348,6 @@ The IsCoexistenceDomain parameter specifies whether this remote domain is used t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -332,6 +357,9 @@ Accept wildcard characters: False ``` ### -IsInternal + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsInternal parameter specifies whether the recipients in the remote domain are considered to be internal recipients. Valid values are: - $true: All transport components (for example, transport rules) treat recipients in the remote domain as internal recipients. Typically, you use this value in cross-forest deployments. @@ -346,7 +374,6 @@ The value of this parameter is affected by the value of the AllowedOOFType param Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -356,13 +383,15 @@ Accept wildcard characters: False ``` ### -LineWrapSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LineWrapSize parameter specifies the line-wrap size for messages to recipients in the remote domain. Valid values are an integer from 0 through 132 or the value to unlimited. The default value is unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -372,6 +401,9 @@ Accept wildcard characters: False ``` ### -MeetingForwardNotificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MeetingForwardNotificationEnabled parameter specifies whether to enable meeting forward notifications for recipients in the remote domain. Valid values are: - $true: Meeting requests forwarded to recipients in the remote domain generate a meeting forward notification to the meeting organizer. This is the default value. @@ -381,7 +413,6 @@ The MeetingForwardNotificationEnabled parameter specifies whether to enable meet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -391,6 +422,9 @@ Accept wildcard characters: False ``` ### -MessageCountThreshold + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MessageCountThreshold parameter specifies the acceptable message count for the remote domain. If the message count exceeds this value, an event is generated that's visible using the Get-ServerHealth and Get-HealthReport cmdlets. @@ -401,7 +435,6 @@ Valid input for this parameter is an integer. The default value is Int32 (214748 Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -411,13 +444,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a unique name for the remote domain object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -427,6 +462,9 @@ Accept wildcard characters: False ``` ### -NDRDiagnosticInfoEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The NDRDiagnosticInfoEnabled parameter specifies whether diagnostic information is included in non-delivery reports (also known NDRs or bounce messages) that are sent to recipients the remote domain. Valid values are: @@ -440,7 +478,6 @@ This parameter is meaningful only when the value of the NDREnabled parameter is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -450,6 +487,9 @@ Accept wildcard characters: False ``` ### -NDREnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NDREnabled parameter specifies whether to allow non-delivery reports (also known NDRs or bounce messages) from your organization to recipients in the remote domain. Valid values are: - $true: NDRs from your organization are sent to recipients in the remote domain. This is the default value. @@ -459,7 +499,6 @@ The NDREnabled parameter specifies whether to allow non-delivery reports (also k Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -469,6 +508,9 @@ Accept wildcard characters: False ``` ### -NonMimeCharacterSet + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NonMimeCharacterSet parameter specifies a character set for plain text messages without defined character sets that are sent from your organization to recipients in the remote domain. Valid values are: big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874, or the value $null. @@ -481,7 +523,6 @@ This setting doesn't overwrite character sets that are already specified in outb Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -491,6 +532,9 @@ Accept wildcard characters: False ``` ### -PreferredInternetCodePageForShiftJis + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The PreferredInternetCodePageForShiftJis parameter specifies the specific code page to use for Shift JIS character encoding in messages that are sent to recipients in the remote domain. Valid values are: - 50220: Use ISO-2022-JP codepage. @@ -502,7 +546,6 @@ The PreferredInternetCodePageForShiftJis parameter specifies the specific code p Type: PreferredInternetCodePageForShiftJisEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -512,6 +555,9 @@ Accept wildcard characters: False ``` ### -RequiredCharsetCoverage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RequiredCharsetCoverage parameter specifies a percentage threshold for characters in a message that must match to apply your organization's preferred character set before switching to automatic character set detection. For example, if you set this parameter to 60, the preferred character sets will still be used during content conversion for messages that contain characters from non-preferred character sets as long as the percentage of those characters is 40 percent or less. If the percentage of characters in a message doesn't belong to preferred character sets, Exchange analyzes the Unicode characters and automatically determines the best matching character set to use. @@ -522,7 +568,6 @@ If recipients in the remote domain use characters that span character sets, you Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -532,6 +577,9 @@ Accept wildcard characters: False ``` ### -SmtpDaneMandatoryModeEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -540,7 +588,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -550,6 +597,9 @@ Accept wildcard characters: False ``` ### -TargetDeliveryDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetDeliveryDomain parameter specifies whether the remote domain is used in cross-forest deployments to generate target email addresses for new mail users that represent users in the other organization (for example, all mailboxes hosted on Exchange Online are represented as mail users in your on-premises organization). Valid values are: - $true: The remote domain is used for the target email address of mail users that represent the users in the other forest. @@ -559,7 +609,6 @@ The TargetDeliveryDomain parameter specifies whether the remote domain is used i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -569,6 +618,9 @@ Accept wildcard characters: False ``` ### -TNEFEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TNEFEnabled parameter specifies whether Transport Neutral Encapsulation Format (TNEF) message encoding is used on messages sent to the remote domain. Valid values are: - $true: TNEF encoding is used on all messages sent to the remote domain. @@ -579,7 +631,6 @@ The TNEFEnabled parameter specifies whether Transport Neutral Encapsulation Form Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -589,6 +640,9 @@ Accept wildcard characters: False ``` ### -TrustedMailInboundEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TrustedMailInboundEnabled parameter specifies whether messages from senders in the remote domain are treated as trusted messages. Valid values are: - $true: Inbound messages from senders in the remote domain are considered safe and will bypass content filtering and recipient filtering. @@ -598,7 +652,6 @@ The TrustedMailInboundEnabled parameter specifies whether messages from senders Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -608,6 +661,9 @@ Accept wildcard characters: False ``` ### -TrustedMailOutboundEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TrustedMailOutboundEnabled parameter specifies whether messages sent to recipients in the remote domain are treated as trusted messages. Valid values are: - $true: Outbound messages to recipients in the remote domain are considered safe and will bypass content filtering and recipient filtering. We recommend that you use this value in cross-forest deployments. @@ -617,7 +673,6 @@ The TrustedMailOutboundEnabled parameter specifies whether messages sent to reci Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -627,6 +682,9 @@ Accept wildcard characters: False ``` ### -UseSimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UseSimpleDisplayName parameter specifies whether the sender's simple display name is used for the From email address in messages sent to recipients in the remote domain. Valid values are: - $true: Simple display names are used in messages sent to recipients in the remote domain. If the sender doesn't have a simple display name configured, the From email address is `EmailAddress `. @@ -636,7 +694,6 @@ The UseSimpleDisplayName parameter specifies whether the sender's simple display Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -646,13 +703,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-RemoteMailbox.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-RemoteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RemoteMailbox.md index 6850e91830..9ddb71e508 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RemoteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-RemoteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-remotemailbox +schema: 2.0.0 +title: Set-RemoteMailbox --- # Set-RemoteMailbox @@ -113,6 +114,9 @@ This example configures delivery restrictions for the mailbox in the service tha ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the remote mailbox (mail user) that you want to modify. You can use any value that uniquely identifies the mail user. For example: - ADObjectID @@ -128,7 +132,6 @@ The Identity parameter specifies the remote mailbox (mail user) that you want to Type: RemoteMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -138,6 +141,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -161,7 +167,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +176,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -194,7 +202,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -204,6 +211,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -229,7 +239,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,6 +248,9 @@ Accept wildcard characters: False ``` ### -ACLableSyncedObjectEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. - To enable this feature, use this switch without a value. @@ -248,7 +260,6 @@ The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -258,6 +269,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -282,7 +296,6 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -292,13 +305,15 @@ Accept wildcard characters: False ``` ### -ArchiveGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -308,6 +323,9 @@ Accept wildcard characters: False ``` ### -ArchiveName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). The following default values are used based on the version of Exchange: @@ -322,7 +340,6 @@ In Outlook, the value of this parameter is ignored. The name of the archive mail Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,6 +349,9 @@ Accept wildcard characters: False ``` ### -BypassModerationFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator. To specify senders for this parameter, you can use any value that uniquely identifies the sender. For example: @@ -353,7 +373,6 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -363,6 +382,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -372,7 +394,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -382,13 +403,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -398,13 +421,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -414,13 +439,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -430,13 +457,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -446,13 +475,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -462,13 +493,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -478,13 +511,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -494,13 +529,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -510,13 +547,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -526,13 +565,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -542,13 +583,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -558,13 +601,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -574,13 +619,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -590,13 +637,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -606,13 +655,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -622,13 +673,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DisplayName parameter specifies the display name for the mail user. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -638,13 +691,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -654,6 +709,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -681,7 +739,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -691,6 +748,9 @@ Accept wildcard characters: False ``` ### -EmailAddressPolicyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -700,7 +760,6 @@ The EmailAddressPolicyEnabled parameter specifies whether to apply email address Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -710,6 +769,9 @@ Accept wildcard characters: False ``` ### -ExchangeGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExchangeGuid parameter specifies the ExchangeGuid property value of the mail user, which should match the ExchangeGuid value of the corresponding cloud mailbox. The ExchangeGuid property is a unique Exchange mailbox identifier, and corresponds to the msExchMailboxGuid attribute in Active Directory. An example value is d5a0bd9b-4e95-49b5-9736-14fde1eec1e3. Although the syntax is the same, this value is different than the GUID property value, which corresponds to the objectGUID attribute in Active Directory. @@ -718,7 +780,6 @@ The ExchangeGuid property is a unique Exchange mailbox identifier, and correspon Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -728,6 +789,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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"`. @@ -740,7 +804,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -750,6 +813,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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"`. @@ -762,7 +828,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -772,6 +837,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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"`. @@ -784,7 +852,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -794,6 +861,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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"`. @@ -806,7 +876,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -816,6 +885,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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"`. @@ -828,7 +900,6 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -838,13 +909,15 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Server 2010, Exchange Server 2013 + The GrantSendOnBehalfTo parameter specifies the DN of recipients that can send messages on behalf of this mail-enabled user. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013 Required: False Position: Named @@ -854,6 +927,9 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - $true: The recipient isn't visible in address lists. @@ -863,7 +939,6 @@ The HiddenFromAddressListsEnabled parameter specifies whether this recipient is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -873,6 +948,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -884,7 +962,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -894,6 +971,9 @@ Accept wildcard characters: False ``` ### -ImmutableId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario. @@ -902,7 +982,6 @@ You need to set the ImmutableId parameter if Active Directory Federation Service Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -912,6 +991,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -923,7 +1005,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -933,6 +1014,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -947,7 +1031,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -957,6 +1040,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -976,7 +1062,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -986,6 +1071,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -997,7 +1085,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1007,13 +1094,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name of the mail user. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1023,6 +1112,9 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the mail user are no longer automatically updated by email address policies. @@ -1033,7 +1125,6 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1043,6 +1134,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder of the mailbox. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 30 gigabytes (32212254720 bytes). @@ -1063,7 +1157,6 @@ The RecoverableItemsQuota value must be greater than or equal to the Recoverable Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1073,6 +1166,9 @@ Accept wildcard characters: False ``` ### -RecoverableItemsWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for the mailbox. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 20 gigabytes (21474836480 bytes). @@ -1093,7 +1189,6 @@ The RecoverableItemsWarningQuota value must be less than or equal to the Recover Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1103,6 +1198,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example: @@ -1126,7 +1224,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1136,6 +1233,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromDLMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example: @@ -1159,7 +1259,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1169,6 +1268,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1194,7 +1296,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1204,6 +1305,9 @@ Accept wildcard characters: False ``` ### -RemoteRoutingAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoteRoutingAddress parameter specifies the SMTP address of the mailbox in the service that's associated with this mail user. You shouldn't have to change the remote routing address if the address was automatically configured by Exchange when the mail user and its associated mailbox in the service were created. @@ -1212,7 +1316,6 @@ You shouldn't have to change the remote routing address if the address was autom Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1222,6 +1325,9 @@ Accept wildcard characters: False ``` ### -RemovePicture + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemovePicture switch removes the picture from the mail user. You don't need to specify a value with this switch. You can add a picture to a mail user by using the Import-RecipientDataProperty cmdlet. @@ -1230,7 +1336,6 @@ You can add a picture to a mail user by using the Import-RecipientDataProperty c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1240,6 +1345,9 @@ Accept wildcard characters: False ``` ### -RemoveSpokenName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoveSpokenName switch removes the spoken name from the mail user. You don't need to specify a value with this switch. You can add a picture to a mail user by using the Import-RecipientDataProperty cmdlet. @@ -1248,7 +1356,6 @@ You can add a picture to a mail user by using the Import-RecipientDataProperty c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1258,6 +1365,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1269,7 +1379,6 @@ The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1279,6 +1388,9 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1288,7 +1400,6 @@ The ResetPasswordOnNextLogon parameter specifies whether the user must change th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1298,13 +1409,15 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1314,6 +1427,9 @@ Accept wildcard characters: False ``` ### -SendModerationNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -1328,7 +1444,6 @@ The default value is Never. Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1338,6 +1453,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Type parameter specifies the type for the mailbox in the service. Valid values are: - Regular @@ -1355,7 +1473,6 @@ Notes on the value Shared: Type: ConvertibleRemoteMailboxSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1365,13 +1482,15 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1381,13 +1500,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1397,6 +1518,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -1408,7 +1532,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionPolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionPolicy.md index 5aaeb7f9dd..6b3d62ea2d 100644 --- a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-reportsubmissionpolicy applicable: Exchange Online -title: Set-ReportSubmissionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-reportsubmissionpolicy +schema: 2.0.0 +title: Set-ReportSubmissionPolicy --- # Set-ReportSubmissionPolicy @@ -166,13 +167,15 @@ If the report submission rule doesn't already exist (the Get-ReportSubmissionRul ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission policy that you want to modify. The only available policy is named DefaultReportSubmissionPolicy. ```yaml Type: ReportSubmissionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -182,6 +185,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. @@ -191,7 +197,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -201,6 +206,9 @@ Accept wildcard characters: False ``` ### -DisableQuarantineReportingOption + +> Applicable: Exchange Online + The DisableQuarantineReportingOption parameter allows or prevents users from reporting messages in quarantine. Valid values are: - $true: Users can't report quarantined messages from quarantine. @@ -212,7 +220,6 @@ This parameter is meaningful only reporting in Outlook is enabled as described i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -222,13 +229,15 @@ Accept wildcard characters: False ``` ### -DisableUserSubmissionOptions + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -238,13 +247,15 @@ Accept wildcard characters: False ``` ### -EnableCustomizedMsg + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -254,6 +265,9 @@ Accept wildcard characters: False ``` ### -EnableCustomNotificationSender + +> Applicable: Exchange Online + The EnableCustomNotificationSender parameter specifies whether a custom sender email address is used for result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Use a custom Microsoft 365 sender email address. @@ -265,7 +279,6 @@ You specify the sender email address using the NotificationSenderAddress paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -275,6 +288,9 @@ Accept wildcard characters: False ``` ### -EnableOrganizationBranding + +> Applicable: Exchange Online + The EnableOrganizationBranding parameter specifies whether to show the company logo in the footer of result messages that users receive after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Use the company logo in the footer text instead of the Microsoft logo. @@ -286,7 +302,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -296,6 +311,9 @@ Accept wildcard characters: False ``` ### -EnableReportToMicrosoft + +> Applicable: Exchange Online + The EnableReportToMicrosoft parameter specifies whether Microsoft integrated reporting experience is enabled or disabled. Valid values are $true or $false. The value $true for this parameter enables reporting in Outlook. The following configurations are possible: @@ -313,7 +331,6 @@ The value $false for this parameter disables reporting in Outlook. The following Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -323,6 +340,9 @@ Accept wildcard characters: False ``` ### -EnableThirdPartyAddress + +> Applicable: Exchange Online + The EnableThirdPartyAddress parameter specifies whether you're using non-Microsoft reporting tools in Outlook instead of Microsoft tools to send messages to the reporting mailbox in Exchange Online. Valid values are $true or $false. The value $true enables Microsoft to capture information about email sent to the non-Microsoft reporting mailbox. The following configurations are possible: @@ -336,7 +356,6 @@ The value $false means non-Microsoft reporting tools in Outlook aren't used. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -346,6 +365,9 @@ Accept wildcard characters: False ``` ### -EnableUserEmailNotification + +> Applicable: Exchange Online + The EnableUserEmailNotification parameter species whether users receive result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: - $true: Customized admin review result messages are sent. This value is required when user reported messages go only to the reporting mailbox (the value of the EnableReportToMicrosoft parameter is $false). @@ -361,7 +383,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -371,6 +392,9 @@ Accept wildcard characters: False ``` ### -JunkReviewResultMessage + +> Applicable: Exchange Online + The JunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as junk. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -383,7 +407,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -393,6 +416,9 @@ Accept wildcard characters: False ``` ### -NotJunkReviewResultMessage + +> Applicable: Exchange Online + The NotJunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as not junk. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -405,7 +431,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -415,6 +440,9 @@ Accept wildcard characters: False ``` ### -NotificationFooterMessage + +> Applicable: Exchange Online + The NotificationFooterMessage parameter specifies the custom footer text to use in email notifications after an admin reviews and marks the reported messages as junk, not junk, or phishing. If the value contains spaces, enclose the value in quotation marks. You can use the EnableOrganizationBranding parameter to include your company logo in the message footer. @@ -425,7 +453,6 @@ This parameter is meaningful only when the value of the EnableUserEmailNotificat Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -435,6 +462,9 @@ Accept wildcard characters: False ``` ### -NotificationSenderAddress + +> Applicable: Exchange Online + The NotificationSenderAddress parameter specifies the sender email address to use in result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. The email address must be in Exchange Online. This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -443,7 +473,6 @@ This parameter is meaningful only when reporting in Outlook is enabled for Micro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -453,13 +482,15 @@ Accept wildcard characters: False ``` ### -NotificationsForCleanSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -469,13 +500,15 @@ Accept wildcard characters: False ``` ### -NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -485,13 +518,15 @@ Accept wildcard characters: False ``` ### -NotificationsForSpamSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -501,13 +536,15 @@ Accept wildcard characters: False ``` ### -NotificationsForSubmissionAirInvestigationsEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -517,13 +554,15 @@ Accept wildcard characters: False ``` ### -OnlyShowPhishingDisclaimer + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -533,6 +572,9 @@ Accept wildcard characters: False ``` ### -PhishingReviewResultMessage + +> Applicable: Exchange Online + The PhishingReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as phishing. If the value contains spaces, enclose the value in quotation marks ("). This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. @@ -545,7 +587,6 @@ Use the NotificationSenderAddress parameter to customize the sender email addres Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -555,6 +596,9 @@ Accept wildcard characters: False ``` ### -PostSubmitMessage + +> Applicable: Exchange Online + The PostSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message title using the PostSubmitMessageTitle parameter. @@ -565,7 +609,6 @@ This parameter is meaningful only when the value of the PostSubmitMessageEnabled Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -575,6 +618,9 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageEnabled + +> Applicable: Exchange Online + The PostSubmitMessageEnabled parameter enables or disables the pop-up Outlook notifications that users see after they report messages using Microsoft reporting tools. Valid values are: - $true: Users receive pop-up notifications in Outlook after they report messages. This is the default value. @@ -584,7 +630,6 @@ The PostSubmitMessageEnabled parameter enables or disables the pop-up Outlook no Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -594,13 +639,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -610,13 +657,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -626,13 +675,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -642,6 +693,9 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitle + +> Applicable: Exchange Online + The PostSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message text using the PostSubmitMessage parameter. @@ -652,7 +706,6 @@ This parameter is meaningful only when the value of the PostSubmitMessageEnabled Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -662,13 +715,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -678,13 +733,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -694,13 +751,15 @@ Accept wildcard characters: False ``` ### -PostSubmitMessageTitleForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -710,6 +769,9 @@ Accept wildcard characters: False ``` ### -PreSubmitMessage + +> Applicable: Exchange Online + The PreSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the custom pop-up message title using the PreSubmitMessageTitle parameter. @@ -720,7 +782,6 @@ This parameter is meaningful only when the value of the PreSubmitMessageEnabled Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -730,6 +791,9 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageEnabled + +> Applicable: Exchange Online + The PreSubmitMessageEnabled parameter enables or disables the pop-up Outlook notifications that users see before they report messages using Microsoft reporting tools. Valid values are: - $true: Users receive pop-up notifications in Outlook before they report messages. This is the default value. @@ -739,7 +803,6 @@ The PreSubmitMessageEnabled parameter enables or disables the pop-up Outlook not Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -749,13 +812,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -765,13 +830,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -781,13 +848,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessage parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -797,6 +866,9 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitle + +> Applicable: Exchange Online + The PreSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). You specify the pop-up message text using the PreSubmitMessage parameter. @@ -807,7 +879,6 @@ This parameter is meaningful only when the value of the PreSubmitMessageEnabled Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -817,13 +888,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -833,13 +906,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForNotJunk + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -849,13 +924,15 @@ Accept wildcard characters: False ``` ### -PreSubmitMessageTitleForPhishing + +> Applicable: Exchange Online + Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -865,13 +942,15 @@ Accept wildcard characters: False ``` ### -ReportChatMessageEnabled + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -881,13 +960,15 @@ Accept wildcard characters: False ``` ### -ReportChatMessageToCustomizedAddressEnabled + +> Applicable: Exchange Online + {{ Fill ReportChatMessageToCustomizedAddressEnabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -897,6 +978,9 @@ Accept wildcard characters: False ``` ### -ReportJunkAddresses + +> Applicable: Exchange Online + **Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. @@ -909,7 +993,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -919,6 +1002,9 @@ Accept wildcard characters: False ``` ### -ReportJunkToCustomizedAddress + +> Applicable: Exchange Online + The ReportJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. @@ -930,7 +1016,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -940,6 +1025,9 @@ Accept wildcard characters: False ``` ### -ReportNotJunkAddresses + +> Applicable: Exchange Online + **Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. The ReportNotJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. @@ -952,7 +1040,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -962,6 +1049,9 @@ Accept wildcard characters: False ``` ### -ReportNotJunkToCustomizedAddress + +> Applicable: Exchange Online + The ReportNotJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. @@ -973,7 +1063,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -983,6 +1072,9 @@ Accept wildcard characters: False ``` ### -ReportPhishAddresses + +> Applicable: Exchange Online + **Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. The ReportPhishAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or non-Microsoft reporting tools in Outlook. @@ -995,7 +1087,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1005,6 +1096,9 @@ Accept wildcard characters: False ``` ### -ReportPhishToCustomizedAddress + +> Applicable: Exchange Online + The ReportPhishToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or non-Microsoft reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: - $true: User reported messages are sent to the reporting mailbox. @@ -1016,7 +1110,6 @@ You can't use this parameter by itself. You need to specify the same value for t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1026,6 +1119,9 @@ Accept wildcard characters: False ``` ### -ThirdPartyReportAddresses + +> Applicable: Exchange Online + **Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. Use the ThirdPartyReportAddresses parameter to specify the email address of the reporting mailbox when you're using a non-Microsoft product for user submissions instead of reporting in Outlook. @@ -1038,7 +1134,6 @@ For more information about using non-Microsoft reporting tools with or without r Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1048,13 +1143,15 @@ Accept wildcard characters: False ``` ### -UserSubmissionOptions + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1064,13 +1161,15 @@ Accept wildcard characters: False ``` ### -UserSubmissionOptionsMessage + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1080,13 +1179,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionRule.md similarity index 96% rename from exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionRule.md index c4e6300e20..68ff5bd5f9 100644 --- a/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ReportSubmissionRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-reportsubmissionrule applicable: Exchange Online -title: Set-ReportSubmissionRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-reportsubmissionrule +schema: 2.0.0 +title: Set-ReportSubmissionRule --- # Set-ReportSubmissionRule @@ -55,13 +56,15 @@ This example changes the reporting mailbox to userreportedmessages@contoso.onmic ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the report submission rule that you want to modify. The default rule is named DefaultReportSubmissionRule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -96,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the name of the report submission rule. When the rule is automatically created, the name of the rule is DefaultReportSubmissionRule. We recommend using this value to avoid confusion. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -ReportSubmissionPolicy + +> Applicable: Exchange Online + The ReportSubmissionPolicy parameter specifies the report submission policy that's associated with this rule. The only available policy is named DefaultReportSubmissionPolicy. ```yaml Type: ReportSubmissionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies the email address of the reporting mailbox in Exchange Online where user reported messages are sent. The value of this parameter is meaningful only if reporting in Outlook is enabled, and user reported messages are sent to a reporting mailbox as configured in the \*-ReportSubmissionPolicy cmdlets (either of the following scenarios): @@ -156,7 +170,6 @@ When you use this cmdlet to set the email address of the reporting mailbox, the Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ResourceConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-ResourceConfig.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-ResourceConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ResourceConfig.md index 19453e4a45..2dd5ae09c4 100644 --- a/exchange/exchange-ps/exchange/Set-ResourceConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ResourceConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-resourceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-ResourceConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-resourceconfig +schema: 2.0.0 +title: Set-ResourceConfig --- # Set-ResourceConfig @@ -52,6 +53,9 @@ This example adds the custom resource property Room/TV and removes Equipment/Lap ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -61,7 +65,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -79,7 +85,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -ResourcePropertySchema + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ResourcePropertySchema parameter specifies the custom resource property that you want to make available to room or equipment mailboxes. This parameter uses the syntax `Room/` or `Equipment/` where the `` value doesn't contain spaces. For example, `Room/Whiteboard` or `Equipment/Van`. You can specify multiple values separated by commas. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -99,7 +107,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ResubmitRequest.md b/exchange/exchange-ps/ExchangePowerShell/Set-ResubmitRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-ResubmitRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ResubmitRequest.md index 222f007a7c..1f7c69fdab 100644 --- a/exchange/exchange-ps/exchange/Set-ResubmitRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ResubmitRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-resubmitrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ResubmitRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-resubmitrequest +schema: 2.0.0 +title: Set-ResubmitRequest --- # Set-ResubmitRequest @@ -43,13 +44,15 @@ This example disables the resubmit request with the identity 8. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the resubmit request you want to modify. Each resubmit request is identified by an incremented integer value. ```yaml Type: ResubmitRequestIdentityParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter enables or disables an active resubmit request. Valid input for this parameter is $true or $false. Setting the value to $false disables the resubmit request. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -75,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -84,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,6 +101,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -107,7 +117,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionCompliancePolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RetentionCompliancePolicy.md index b953c9c959..2ec06971fb 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionCompliancePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-retentioncompliancepolicy applicable: Security & Compliance -title: Set-RetentionCompliancePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-retentioncompliancepolicy +schema: 2.0.0 +title: Set-RetentionCompliancePolicy --- # Set-RetentionCompliancePolicy @@ -16,7 +17,7 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Set-RetentionCompliancePolicy cmdlet to modify existing retention policies in the Microsoft Purview compliance portal. -**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. For information about the distribution status, see [Get-RetentionCompliancePolicy](https://learn.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy). +**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. For information about the distribution status, see [Get-RetentionCompliancePolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/get-retentioncompliancepolicy). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -224,6 +225,9 @@ Policy exclusions must remain within the supported limits for retention policies ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -234,7 +238,6 @@ The Identity parameter specifies the retention policy that you want to modify. Y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -244,6 +247,9 @@ Accept wildcard characters: False ``` ### -RetryDistribution + +> Applicable: Security & Compliance + The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -252,7 +258,6 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -262,6 +267,9 @@ Accept wildcard characters: False ``` ### -AddAdaptiveScopeLocation + +> Applicable: Security & Compliance + The AddAdaptiveScopeLocation parameter specifies the adaptive scope location to add to the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -274,7 +282,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -284,6 +291,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation + +> Applicable: Security & Compliance + The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -302,7 +312,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -312,6 +321,9 @@ Accept wildcard characters: False ``` ### -AddExchangeLocationException + +> Applicable: Security & Compliance + This parameter specifies the mailboxes to add to the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: - A mailbox @@ -330,7 +342,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -340,6 +351,9 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocation + +> Applicable: Security & Compliance + The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups when you aren't using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -355,7 +369,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -365,6 +378,9 @@ Accept wildcard characters: False ``` ### -AddModernGroupLocationException + +> Applicable: Security & Compliance + The AddModernGroupLocationException parameter specifies the Microsoft 365 Groups to add to the list of excluded Microsoft 365 Groups when you're using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -380,7 +396,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -390,6 +405,9 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation + +> Applicable: Security & Compliance + The AddOneDriveLocation parameter specifies the OneDrive sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -398,7 +416,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -408,6 +425,9 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocationException + +> Applicable: Security & Compliance + This parameter specifies the OneDrive sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -416,7 +436,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -426,13 +445,15 @@ Accept wildcard characters: False ``` ### -AddPublicFolderLocation + +> Applicable: Security & Compliance + The AddPublicFolderLocation parameter specifies that you want to add all public folders to the retention policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -442,6 +463,9 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation + +> Applicable: Security & Compliance + The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -452,7 +476,6 @@ SharePoint sites can't be added to the policy until they have been indexed. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -462,6 +485,9 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationException + +> Applicable: Security & Compliance + This parameter specifies the SharePoint sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -470,7 +496,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -480,6 +505,9 @@ Accept wildcard characters: False ``` ### -AddSkypeLocation + +> Applicable: Security & Compliance + The AddSkypeLocation parameter specifies the Skype for Business Online users to add from the list of included Skype for Business Online users. You can use any value that uniquely identifies the user. For example: @@ -495,7 +523,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -505,13 +532,15 @@ Accept wildcard characters: False ``` ### -AddSkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -521,6 +550,9 @@ Accept wildcard characters: False ``` ### -AddTeamsChannelLocation + +> Applicable: Security & Compliance + The AddTeamsChannelLocation parameter specifies the Teams to add to the policy. You can use any value that uniquely identifies the team. For example: @@ -535,7 +567,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -545,6 +576,9 @@ Accept wildcard characters: False ``` ### -AddTeamsChannelLocationException + +> Applicable: Security & Compliance + The AddTeamsChannelLocationException parameter specifies the Teams to add to the exclusion list when you use the value All for the TeamsChannelLocation parameter. You can use any value that uniquely identifies the team. For example: - Name @@ -557,7 +591,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -567,6 +600,9 @@ Accept wildcard characters: False ``` ### -AddTeamsChatLocation + +> Applicable: Security & Compliance + The AddTeamsChatLocation parameter specifies the Teams users to add to the policy. You can use any value that uniquely identifies the user. For example: @@ -582,7 +618,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -592,6 +627,9 @@ Accept wildcard characters: False ``` ### -AddTeamsChatLocationException + +> Applicable: Security & Compliance + The AddTeamsChatLocationException parameter specifies the Teams users to add to the exclusion list when you use the value All for the TeamsChatLocation parameter. You can use any value that uniquely identifies the user. For example: - Name @@ -604,7 +642,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -614,6 +651,9 @@ Accept wildcard characters: False ``` ### -Applications + +> Applicable: Security & Compliance + The Applications parameter specifies the target when Microsoft 365 Groups are included in the policy (the ModernGroups parameter is set). Valid values are: - `Group:Exchange` for the mailbox that's connected to the Microsoft 365 Group. @@ -625,7 +665,6 @@ The Applications parameter specifies the target when Microsoft 365 Groups are in Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -635,13 +674,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -651,6 +692,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -660,7 +704,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -670,6 +713,9 @@ Accept wildcard characters: False ``` ### -DeletedResources + +> Applicable: Security & Compliance + The DeletedResources parameter specifies the deleted Microsoft 365 Group, mailbox, or mail user to be removed or added as an exclusion to the respective location list. Use this parameter with the AddModernGroupLocationException and RemoveModernGroupLocation parameters for deleted Microsoft 365 Groups, or with the AddTeamsChatLocationException parameter for deleted mailboxes or mail users. A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter. @@ -686,7 +732,6 @@ For more information about the inactive mailbox scenario, see [Learn about inact Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -696,6 +741,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -705,7 +753,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -715,6 +762,9 @@ Accept wildcard characters: False ``` ### -EnforceSimulationPolicy + +> Applicable: Security & Compliance + The EnforceSimulationPolicy parameter specifies whether to enforce a simulation policy as an active policy. Valid values are: - $true: Enforce the simulation policy as an active policy. @@ -726,7 +776,6 @@ For more information about simulation mode, see [Learn about simulation mode](ht Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -736,6 +785,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -744,7 +796,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -754,6 +805,9 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + **Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. @@ -764,7 +818,6 @@ Administrative units are available only in Microsoft Entra ID P1 or P2. You crea Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -774,13 +827,15 @@ Accept wildcard characters: False ``` ### -PolicyTemplateInfo + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -790,6 +845,9 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + The PriorityCleanup switch specifies whether to update a Priority cleanup policy. You don't need to specify a value with this switch. Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). @@ -798,7 +856,6 @@ Priority cleanup policies expedite the deletion of sensitive content by overridi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -808,6 +865,9 @@ Accept wildcard characters: False ``` ### -RemoveAdaptiveScopeLocation + +> Applicable: Security & Compliance + The RemoveAdaptiveScopeLocation parameter specifies the adaptive scope location to remove from the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: - Name @@ -820,7 +880,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -830,6 +889,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation + +> Applicable: Security & Compliance + The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. You can use any value that uniquely identifies the mailbox. For example: @@ -845,7 +907,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -855,6 +916,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocationException + +> Applicable: Security & Compliance + The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. You can use any value that uniquely identifies the mailbox. For example: @@ -870,7 +934,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -880,6 +943,9 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocation + +> Applicable: Security & Compliance + The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups when you aren't using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -895,7 +961,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -905,6 +970,9 @@ Accept wildcard characters: False ``` ### -RemoveModernGroupLocationException + +> Applicable: Security & Compliance + The RemoveModernGroupLocationException parameter specifies the Microsoft 365 Groups to remove from the list of excluded groups when you're using the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -920,7 +988,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -930,6 +997,9 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation + +> Applicable: Security & Compliance + The RemoveOneDriveLocation parameter specifies the OneDrive sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -938,7 +1008,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -948,6 +1017,9 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocationException + +> Applicable: Security & Compliance + This parameter specifies the OneDrive sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -956,7 +1028,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -966,13 +1037,15 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation + +> Applicable: Security & Compliance + The RemovePublicFolderLocation parameter specifies that you want to remove all public folders from the retention policy. You use the value All for this parameter. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -982,6 +1055,9 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation + +> Applicable: Security & Compliance + The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -990,7 +1066,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1000,6 +1075,9 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationException + +> Applicable: Security & Compliance + This parameter specifies the SharePoint sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -1008,7 +1086,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1018,6 +1095,9 @@ Accept wildcard characters: False ``` ### -RemoveSkypeLocation + +> Applicable: Security & Compliance + The RemoveSkypeLocation parameter specifies the Skype for Business Online users to remove from the list of included Skype for Business Online users. You can use any value that uniquely identifies the user. For example: @@ -1033,7 +1113,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1043,13 +1122,15 @@ Accept wildcard characters: False ``` ### -RemoveSkypeLocationException + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1059,6 +1140,9 @@ Accept wildcard characters: False ``` ### -RestrictiveRetention + +> Applicable: Security & Compliance + The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for a retention policy or retention label policy. Valid values are: - $true: Preservation Lock is enabled for the policy. No one (including an administrator) can turn off the policy or make it less restrictive. @@ -1072,7 +1156,6 @@ Therefore, before you lock a policy for retention, it's critical that you unders Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1082,6 +1165,9 @@ Accept wildcard characters: False ``` ### -RemoveTeamsChannelLocation + +> Applicable: Security & Compliance + The RemoveTeamsChannelLocation parameter specifies the Teams to remove from the policy. You can use any value that uniquely identifies the team. For example: @@ -1096,7 +1182,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1106,6 +1191,9 @@ Accept wildcard characters: False ``` ### -RemoveTeamsChannelLocationException + +> Applicable: Security & Compliance + The RemoveTeamsChannelLocationException parameter specifies the Teams to remove from the exclusion list when you use the value All for the TeamsChannelLocation parameter. You can use any value that uniquely identifies the team. For example: - Name @@ -1118,7 +1206,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1128,6 +1215,9 @@ Accept wildcard characters: False ``` ### -RemoveTeamsChatLocation + +> Applicable: Security & Compliance + The RemoveTeamsChatLocation parameter specifies the Teams users to remove from the policy. You can use any value that uniquely identifies the user. For example: @@ -1143,7 +1233,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1153,6 +1242,9 @@ Accept wildcard characters: False ``` ### -RemoveTeamsChatLocationException + +> Applicable: Security & Compliance + The RemoveTeamsChatLocationException parameter specifies the Teams users to remove from the exclusion list when you use the value All for the TeamsChatLocation parameter. You can use any value that uniquely identifies the user. For example: - Name @@ -1165,7 +1257,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1175,6 +1266,9 @@ Accept wildcard characters: False ``` ### -StartSimulation + +> Applicable: Security & Compliance + The StartSimulation parameter specifies whether to start the simulation for a policy that was created in simulation mode. Valid values are: - $true: Start the simulation. @@ -1186,7 +1280,6 @@ For more information about simulation mode, see [Learn about simulation mode](ht Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -1196,13 +1289,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionComplianceRule.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RetentionComplianceRule.md index b34336842e..64bb9f4c85 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionComplianceRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-retentioncompliancerule applicable: Security & Compliance -title: Set-RetentionComplianceRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-retentioncompliancerule +schema: 2.0.0 +title: Set-RetentionComplianceRule --- # Set-RetentionComplianceRule @@ -55,6 +56,9 @@ This example changes the hold duration for the existing retention rule named "In ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the retention rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the retention rule that you want to modify. You Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -ApplyComplianceTag + +> Applicable: Security & Compliance + The ApplyComplianceTag parameter specifies the label that's applied to email messages or documents by the rule (which affects how long the content is retained). A valid value for this parameter is the name of an existing label. If the value contains spaces, enclose the value in quotation marks. You view and create labels by using the Get-ComplianceTag and New-ComplianceTag cmdlets. @@ -87,7 +93,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -122,7 +132,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. @@ -144,7 +156,6 @@ You can't use this parameter for Teams retention rules. Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -ContentDateFrom + +> Applicable: Security & Compliance + The ContentDateFrom parameter specifies the start date of the date range for content to include. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -162,7 +176,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -172,6 +185,9 @@ Accept wildcard characters: False ``` ### -ContentDateTo + +> Applicable: Security & Compliance + The ContentDateTo parameter specifies the end date of the date range for content to include. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -180,7 +196,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -ContentMatchQuery + +> Applicable: Security & Compliance + The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -200,7 +218,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -210,6 +227,9 @@ Accept wildcard characters: False ``` ### -ExcludedItemClasses + +> Applicable: Security & Compliance + The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter 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 @@ -231,7 +251,6 @@ You can't use this parameter for Teams retention rules. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -241,6 +260,9 @@ Accept wildcard characters: False ``` ### -ExpirationDateOption + +> Applicable: Security & Compliance + The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: - CreationAgeInDays @@ -252,7 +274,6 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -262,13 +283,15 @@ Accept wildcard characters: False ``` ### -IRMRiskyUserProfiles + +> Applicable: Security & Compliance + {{ Fill IRMRiskyUserProfiles Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -278,6 +301,9 @@ Accept wildcard characters: False ``` ### -PriorityCleanup + +> Applicable: Security & Compliance + The PriorityCleanup switch specifies whether to update the rule associated with a Priority cleanup policy. You don't need to specify a value with this switch. Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup). @@ -286,7 +312,6 @@ Priority cleanup policies expedite the deletion of sensitive content by overridi Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -296,6 +321,9 @@ Accept wildcard characters: False ``` ### -RetentionComplianceAction + +> Applicable: Security & Compliance + The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - Delete @@ -306,7 +334,6 @@ The RetentionComplianceAction parameter specifies the retention action for the r Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -316,6 +343,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: - An integer: The hold duration in days. @@ -325,7 +355,6 @@ The RetentionDuration parameter specifies the hold duration for the retention ru Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -335,6 +364,9 @@ Accept wildcard characters: False ``` ### -RetentionDurationDisplayHint + +> Applicable: Security & Compliance + The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. - Days @@ -349,7 +381,6 @@ You can't use this parameter for Teams retention rules. Type: HoldDurationHint Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -359,13 +390,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-RetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicy.md index 14102c1ff4..161fa3536c 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-retentionpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-RetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-retentionpolicy +schema: 2.0.0 +title: Set-RetentionPolicy --- # Set-RetentionPolicy @@ -51,13 +52,15 @@ The Identity parameter is a positional parameter. Positional parameters can be u ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the name, distinguished name (DN), or GUID of the retention policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you use the RetentionId parameter. @@ -112,7 +122,6 @@ Use this switch to hide the confirmation prompt when you use the RetentionId par Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IsDefault switch specifies that this retention policy is the default retention policy. You don't need to specify a value with this switch. @@ -141,7 +153,6 @@ Changes to the default retention policy that affect existing mailboxes can poten Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -IsDefaultArbitrationMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. You don't need to specify a value with this switch. @@ -161,7 +175,6 @@ This parameter isn't available in on-premises deployments. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies a unique name for the retention policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -RetentionId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionId parameter specifies the identity of the retention policy to make sure mailboxes moved between two Exchange organizations continue to have the same retention policy applied to them. For example, in a cross-forest deployment or in a cross-premises deployment, when a mailbox is moved from an on-premises Exchange server to the cloud, or a cloud-based mailbox is moved to an on-premises Exchange server, this parameter is used to make sure the same retention policy is applied to the mailbox. It's not normally required to specify or modify the RetentionId parameter for a retention tag. The parameter is populated automatically when importing retention tags using the Import-RetentionTags.ps1 script. @@ -195,7 +213,6 @@ It's not normally required to specify or modify the RetentionId parameter for a Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -205,13 +222,15 @@ Accept wildcard characters: False ``` ### -RetentionPolicyTagLinks + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionPolicyTagLinks parameter specifies the identity of retention policy tags to associate with the retention policy. Mailboxes that get a retention policy applied have retention tags linked with that retention policy. ```yaml Type: RetentionPolicyTagIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -221,13 +240,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicyTag.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicyTag.md index f4d7334536..5ded99737c 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RetentionPolicyTag.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-retentionpolicytag applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-RetentionPolicyTag -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-retentionpolicytag +schema: 2.0.0 +title: Set-RetentionPolicyTag --- # Set-RetentionPolicyTag @@ -91,13 +92,15 @@ This example makes optional retention tags available to user Terry Adams using t ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name, distinguished name (DN), or GUID of the retention policy tag to be modified. ```yaml Type: RetentionPolicyTagIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies a mailbox for assigning opt-in tags. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -126,7 +132,6 @@ You must use this parameter with the OptionalInMailbox parameter. Type: MailboxIdParameter Parameter Sets: MailboxTask Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -AddressForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -144,7 +152,6 @@ This parameter is reserved for internal Microsoft use. Type: RecipientIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -154,13 +161,15 @@ Accept wildcard characters: False ``` ### -AgeLimitForRetention + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. ```yaml Type: EnhancedTimeSpan Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,13 +179,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Comment parameter specifies a comment for the retention policy tag. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -195,7 +209,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -205,6 +218,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -213,7 +229,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -223,6 +238,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. Use this switch to hide the confirmation prompt when you use the RetentionId parameter. @@ -231,7 +249,6 @@ Use this switch to hide the confirmation prompt when you use the RetentionId par Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -241,6 +258,9 @@ Accept wildcard characters: False ``` ### -JournalingEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -249,7 +269,6 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -259,6 +278,9 @@ Accept wildcard characters: False ``` ### -LabelForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -267,7 +289,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -277,13 +298,15 @@ Accept wildcard characters: False ``` ### -LegacyManagedFolder + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LegacyManagedFolder parameter specifies the name of a managed folder. The retention tag is created by using retention settings from the managed folder and its managed content settings. You can use this parameter to create retention tags based on existing managed folders to migrate users from managed folder mailbox policies to retention policies. ```yaml Type: ELCFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -293,13 +316,15 @@ Accept wildcard characters: False ``` ### -LocalizedComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LocalizedComment parameter specifies the localized comment and language for the retention policy tag. This comment is displayed in Microsoft Outlook based on the user's locale. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -309,13 +334,15 @@ Accept wildcard characters: False ``` ### -LocalizedRetentionPolicyTagName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The LocalizedRetentionPolicyTagName parameter specifies a localized name for the retention policy tag. This name is displayed in Outlook based on the user's locale. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -325,6 +352,9 @@ Accept wildcard characters: False ``` ### -MessageClass + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MessageClass parameter specifies the message type to which the tag applies. If not specified, the default value is set to \*. With the exception of a default policy tag (DPT) for voicemail, Exchange doesn't support retention tags for different message types. Only tags with a MessageClass of \* are supported and they apply to all message types. @@ -337,7 +367,6 @@ A DPT for voice mail messages applies only to Microsoft Exchange Unified Messagi Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -347,6 +376,9 @@ Accept wildcard characters: False ``` ### -MessageFormatForJournaling + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. @@ -355,7 +387,6 @@ This parameter is reserved for internal Microsoft use. Type: JournalingFormat Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -365,13 +396,15 @@ Accept wildcard characters: False ``` ### -MustDisplayCommentEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -381,13 +414,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the retention policy tag. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -397,13 +432,15 @@ Accept wildcard characters: False ``` ### -OptionalInMailbox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OptionalInMailbox parameter is used with the Mailbox parameter to assign personal tags to the mailbox. You can use this parameter to make available to a user a personal tag that isn't assigned to the retention policy applied to the specified mailbox. You can specify multiple personal tags separated by commas. ```yaml Type: RetentionPolicyTagIdParameter[] Parameter Sets: MailboxTask Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -413,6 +450,9 @@ Accept wildcard characters: False ``` ### -RetentionAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionAction parameter specifies the action for the retention policy. Valid values are: - DeleteAndAllowRecovery: Deletes a message and allows recovery from the Recoverable Items folder. @@ -428,7 +468,6 @@ If this parameter isn't present and the RetentionEnabled parameter is set to $tr Type: RetentionAction Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -438,6 +477,9 @@ Accept wildcard characters: False ``` ### -RetentionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionEnabled parameter specifies whether the tag is enabled. When set to $false, the tag is disabled and no retention action is taken on messages that have the tag applied. Messages with a disabled tag are still considered tagged, so any default policy tags in the user's retention policy aren't applied to such messages. @@ -448,7 +490,6 @@ When you set the RetentionEnabled parameter to $false, the retention period for Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -458,6 +499,9 @@ Accept wildcard characters: False ``` ### -RetentionId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RetentionId parameter specifies an alternate tag ID to ensure the retention tag found on mailbox items tagged in one Exchange organization matches the tag when the mailbox is moved to another Exchange organization (for example, in a cross-forest deployment or in a cross-premises deployment, when a mailbox is moved from an on-premises Exchange server to the cloud, or a cloud-based mailbox is moved to an on-premises Exchange server). Typically, you don't need to specify or modify the RetentionId parameter for a retention tag. This parameter is populated automatically when importing retention tags in a cross-forest or cross-premises deployment. @@ -466,7 +510,6 @@ Typically, you don't need to specify or modify the RetentionId parameter for a r Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -476,13 +519,15 @@ Accept wildcard characters: False ``` ### -SystemTag + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SystemTag parameter specifies whether the retention policy tag is created for internal Exchange functionality. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -492,13 +537,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-RoleAssignmentPolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RoleAssignmentPolicy.md index eca66e5008..a21a561bda 100644 --- a/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RoleAssignmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-roleassignmentpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-RoleAssignmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-roleassignmentpolicy +schema: 2.0.0 +title: Set-RoleAssignmentPolicy --- # Set-RoleAssignmentPolicy @@ -50,13 +51,15 @@ This example changes the default assignment policy. New mailboxes or mailboxes m ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the assignment policy to modify. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Description parameter specifies the description that's displayed when the role assignment policy is viewed using the Get-RoleAssignmentPolicy cmdlet. Enclose the description in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -111,7 +121,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IsDefault switch makes the assignment policy the default assignment policy. You don't need to specify a value with this switch. New mailboxes or mailboxes moved from previous versions of Exchange are assigned the default assignment policy when an explicit assignment policy isn't provided. @@ -129,7 +141,6 @@ New mailboxes or mailboxes moved from previous versions of Exchange are assigned Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -139,13 +150,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the new name of the assignment policy. If the assignment policy name contains spaces, enclose the name in quotation marks ("). The maximum length of the name is 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RoleGroup.md b/exchange/exchange-ps/ExchangePowerShell/Set-RoleGroup.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-RoleGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RoleGroup.md index b0c9fd04a3..8f7420c130 100644 --- a/exchange/exchange-ps/exchange/Set-RoleGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RoleGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-rolegroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Set-RoleGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-rolegroup +schema: 2.0.0 +title: Set-RoleGroup --- # Set-RoleGroup @@ -89,13 +90,15 @@ The first command retrieves the credentials using the Get-Credential cmdlet and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the name of the role group to modify. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the fully qualified domain name (FQDN) or IP address of the domain controller in the forest where the foreign USG resides. The domain controller you specify is used to get security information for the foreign USG specified by the LinkedForeignGroup parameter. @@ -115,7 +121,6 @@ You can only use the LinkedDomainController parameter with a linked role group. Type: String Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -125,6 +130,9 @@ Accept wildcard characters: False ``` ### -LinkedForeignGroup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedForeignGroup parameter specifies the name of the foreign USG you want to link this role group to. If the foreign USG name contains spaces, enclose the name in quotation marks ("). @@ -137,7 +145,6 @@ If you use the LinkedForeignGroup parameter, you must specify a domain controlle Type: UniversalSecurityGroupIdParameter Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -158,7 +168,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,6 +177,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -177,7 +189,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -187,13 +198,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Description parameter specifies the description displayed when the role group is viewed using the Get-RoleGroup cmdlet. Enclose the description in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -203,13 +216,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter has a maximum length of 256 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -227,7 +245,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -237,6 +254,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -247,7 +267,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -257,6 +276,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. @@ -269,7 +291,6 @@ You can only use the LinkedCredential parameter with a linked role group. Type: PSCredential Parameter Sets: CrossForest Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Position: Named Default value: None Accept pipeline input: False @@ -277,6 +298,9 @@ Accept wildcard characters: False ``` ### -ManagedBy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ManagedBy parameter specifies the users or USG who can modify the configuration of a role group or add or remove members to or from a role group. The list you specify with this parameter overwrites the existing ManagedBy list. To add or remove individual role group managers, and for more information about modifying multivalued properties, see [Modifying multivalued properties](https://learn.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). You can use the name, distinguished name (DN), or primary SMTP address of the user or USG you want to add. If the name of the user or USG contains spaces, enclose the name in quotation marks ("). @@ -287,7 +311,6 @@ If you want to add more than one user or USG, separate them using commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -297,13 +320,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Name parameter specifies the name of the role group. The name can contain up to 64 characters. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -313,6 +338,9 @@ Accept wildcard characters: False ``` ### -WellKnownObject + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill WellKnownObject Description }} @@ -321,7 +349,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -331,6 +358,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -339,7 +369,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-RoutingGroupConnector.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RoutingGroupConnector.md index d17b041270..51433e0ed4 100644 --- a/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RoutingGroupConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-routinggroupconnector applicable: Exchange Server 2010 -title: Set-RoutingGroupConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-routinggroupconnector +schema: 2.0.0 +title: Set-RoutingGroupConnector --- # Set-RoutingGroupConnector @@ -57,13 +58,15 @@ This example makes the following configuration changes to the routing group conn ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the name or GUID of the routing group connector. The name is expressed as [[Administrative Group Name\\]Routing Group Name]\\Routing Group Connector Name. ```yaml Type: RoutingGroupConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -Cost + +> Applicable: Exchange Server 2010 + The Cost parameter specifies a cost to the connector. Transport servers use the connector cost to determine the least cost routing path from a source server to the destination server for message delivery. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010 + The MaxMessageSize parameter specifies the maximum size of a message that can pass through a routing group connector. The default value is unlimited. When you enter a value, qualify the value with one of the following units: - B (bytes) @@ -137,7 +149,6 @@ Unqualified values are treated as bytes. The valid input range for this paramete Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010 + The Name parameter specifies the name of the routing group connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -PublicFolderReferralsEnabled + +> Applicable: Exchange Server 2010 + The PublicFolderReferralsEnabled parameter specifies whether users can use this routing group connector to access a public folder replica located in the routing group of the target servers when an instance of that public folder isn't available in the same routing group as the user's mailbox. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010 + The SourceTransportServers parameter specifies the host name or FQDN of the transport servers that are used to send messages to the target transport servers. You can specify more than one server by separating each entry with a comma. For more information about how to add or remove values from multivalued properties, see [Modifying Multivalued Properties](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb684908(v=exchg.141)). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -195,13 +212,15 @@ Accept wildcard characters: False ``` ### -TargetTransportServers + +> Applicable: Exchange Server 2010 + The TargetTransportServers parameter specifies the host name or FQDN of the transport servers that receive messages from the source transport servers. You can specify more than one server by separating each entry with a comma. For more information about how to add or remove values from multivalued properties, see [Modifying Multivalued Properties](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb684908(v=exchg.141)). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -211,13 +230,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-RpcClientAccess.md b/exchange/exchange-ps/ExchangePowerShell/Set-RpcClientAccess.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-RpcClientAccess.md rename to exchange/exchange-ps/ExchangePowerShell/Set-RpcClientAccess.md index 970b171e11..e421b16986 100644 --- a/exchange/exchange-ps/exchange/Set-RpcClientAccess.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-RpcClientAccess.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-rpcclientaccess applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-RpcClientAccess -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-rpcclientaccess +schema: 2.0.0 +title: Set-RpcClientAccess --- # Set-RpcClientAccess @@ -60,6 +61,9 @@ This example prevents Outlook Anywhere connections by Outlook 2013 clients that ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Client Access server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -71,7 +75,6 @@ The Server parameter specifies the Client Access server where you want to run th Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -BlockedClientVersions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BlockedClientVersions parameter specifies the RPC client versions that aren't allowed to connect to the specified Exchange server. For example, the Microsoft Exchange RPC Client Access service rejects an Outlook Anywhere connection if the version of Outlook is the specified value, or is in the specified range. Valid version values are in the format X.Y.Z. RPC client versions are typically reported in format X.0.Y.Z format, but for this parameter, you need to specify the value as X.Y.Z. @@ -99,7 +105,6 @@ Be careful when you restrict client access, because Exchange server components m Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -118,7 +126,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -EncryptionRequired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EncryptionRequired parameter specifies whether encryption is required for RPC client connections. Valid values are: - $true: Unencrypted RPC client connections are rejected. This is the default value. @@ -153,7 +165,6 @@ The EncryptionRequired parameter specifies whether encryption is required for RP Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -MaximumConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaximumConnections parameter specifies the maximum number of concurrent client connections that are allowed by the Microsoft Exchange RPC Client Access service. The default value is 65536. **Note**: Although you can configure a non-default value for this parameter, changes to this setting aren't enforced. @@ -171,7 +185,6 @@ The MaximumConnections parameter specifies the maximum number of concurrent clie Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the configuration object in Active Directory. By default, this parameter is set to RpcClientAccess. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentPolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentPolicy.md index fbaa17c621..8ad4ecd46d 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-safeattachmentpolicy applicable: Exchange Online -title: Set-SafeAttachmentPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-safeattachmentpolicy +schema: 2.0.0 +title: Set-SafeAttachmentPolicy --- # Set-SafeAttachmentPolicy @@ -52,6 +53,9 @@ This example modifies the existing safe attachment policy named Engineering Bloc ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment policy that you want to modify. You can use any value that uniquely identifies the policy. For example: @@ -64,7 +68,6 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online + The Action parameter specifies the action for the safe attachment policy. Valid values are: - Allow: Deliver the message if malware is detected in the attachment and track scanning results. This value corresponds to **Monitor** for the **Safe Attachments unknown malware response** property of the policy in the Microsoft Defender portal. @@ -90,7 +96,6 @@ The results of all actions are available in message trace. Type: SafeAttachmentAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -125,7 +135,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: Exchange Online + The Enable parameter works with the Action parameter to specify the action for the safe attachment policy. Valid values are: - $true: The Action parameter specifies the action for the safe attachment policy. @@ -146,7 +158,6 @@ To enable or disable an existing Safe Attachments policy, use the Enable-SafeAtt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -QuarantineTag + +> Applicable: Exchange Online + The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware by Safe Attachments. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -172,7 +186,6 @@ To view the list of available quarantine policies, run the following command: `G Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -182,6 +195,9 @@ Accept wildcard characters: False ``` ### -Redirect + +> Applicable: Exchange Online + The Redirect parameter specifies whether to deliver messages to an alternate email address if malware is detected in an attachment. Valid values are: - $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is meaningful only when the value of the Action parameter is Allow. @@ -191,7 +207,6 @@ The Redirect parameter specifies whether to deliver messages to an alternate ema Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -201,6 +216,9 @@ Accept wildcard characters: False ``` ### -RedirectAddress + +> Applicable: Exchange Online + The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. The value of this parameter is meaningful only when value of the Redirect parameter is $true and the value of the Action parameter is Allow. @@ -209,7 +227,6 @@ The value of this parameter is meaningful only when value of the Redirect parame Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -219,13 +236,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentRule.md index 985e31a012..20758a7322 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SafeAttachmentRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-safeattachmentrule applicable: Exchange Online -title: Set-SafeAttachmentRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-safeattachmentrule +schema: 2.0.0 +title: Set-SafeAttachmentRule --- # Set-SafeAttachmentRule @@ -59,6 +60,9 @@ This example modifies the existing safe attachment rule named Engineering Depart ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the safe attachment rule that you want to modify. You can use any value that uniquely identifies the rule. For example: @@ -71,7 +75,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -106,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -147,7 +159,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -174,7 +188,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -184,13 +197,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the safe attachment rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -214,7 +232,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -224,13 +241,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -240,6 +259,9 @@ Accept wildcard characters: False ``` ### -SafeAttachmentPolicy + +> Applicable: Exchange Online + The SafeAttachmentPolicy parameter specifies the safe attachment policy that's associated with this safe attachment rule. The rule defines the conditions, and the policy defines the actions. You can use any value that uniquely identifies the policy. For example: @@ -254,7 +276,6 @@ You can't specify a safe attachment policy that's already associated with anothe Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -264,6 +285,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -279,7 +303,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -289,6 +312,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -306,7 +332,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -316,13 +341,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksPolicy.md index 4587cee20b..da0d2e61a6 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-safelinkspolicy applicable: Exchange Online -title: Set-SafeLinksPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-safelinkspolicy +schema: 2.0.0 +title: Set-SafeLinksPolicy --- # Set-SafeLinksPolicy @@ -58,6 +59,9 @@ This example modifies the existing Safe Links policy named Engineering Block URL ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -68,7 +72,6 @@ The Identity parameter specifies the Safe Links policy that you want to modify. Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -AllowClickThrough + +> Applicable: Exchange Online + The AllowClickThrough parameter specifies whether to allow users to click through to the original URL on warning pages. Valid values are: $true: The user is allowed to click through to the original URL. @@ -105,7 +113,6 @@ In PowerShell, the default value is $false. In new Safe Links policies created i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -124,7 +134,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -CustomNotificationText + +> Applicable: Exchange Online + The custom notification text specifies the customized notification text to show to users. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -DeliverMessageAfterScan + +> Applicable: Exchange Online + The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: - $true: Wait until Safe Links scanning is complete before delivering the message. This is the default value. Messages that contain malicious links are not delivered. @@ -159,7 +173,6 @@ The DeliverMessageAfterScan parameter specifies whether to deliver email message Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -DisableUrlRewrite + +> Applicable: Exchange Online + The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: - $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). @@ -180,7 +196,6 @@ In PowerShell, the default value is $false. In new Safe Links policies created i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -DoNotRewriteUrls + +> Applicable: Exchange Online + The DoNotRewriteUrls parameter specifies the URLs that are not rewritten by Safe Links scanning. The list of entries allows users who are included in the policy to access the specified URLs that would otherwise be blocked by Safe Links. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -200,7 +218,6 @@ For details about the entry syntax, see [Entry syntax for the "Do not rewrite th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -210,6 +227,9 @@ Accept wildcard characters: False ``` ### -EnableForInternalSenders + +> Applicable: Exchange Online + The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: - $true: The policy is applied to internal and external senders. This is the default value. @@ -219,7 +239,6 @@ The EnableForInternalSenders parameter specifies whether the Safe Links policy i Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -229,6 +248,9 @@ Accept wildcard characters: False ``` ### -EnableOrganizationBranding + +> Applicable: Exchange Online + The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: - $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. @@ -238,7 +260,6 @@ The EnableOrganizationBranding parameter specifies whether your organization's l Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,6 +269,9 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForEmail + +> Applicable: Exchange Online + The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: - $true: Safe Links is enabled for email. This is the default value. When a user clicks a link in an email, the link will be checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. @@ -257,7 +281,6 @@ The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links pro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -267,6 +290,9 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForOffice + +> Applicable: Exchange Online + The EnableSafeLinksForOffice parameter specifies whether to enable Safe Links protection for supported Office desktop, mobile, or web apps. Valid values are: - $true: Safe Links scanning is enabled in Office apps. This is the default value. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. @@ -278,7 +304,6 @@ Note that this protection applies to links in Office documents, not links in ema Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -288,6 +313,9 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForTeams + +> Applicable: Exchange Online + The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: - $true: Safe Links is enabled for Teams. This is the default value. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. @@ -297,7 +325,6 @@ The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -307,6 +334,9 @@ Accept wildcard characters: False ``` ### -ScanUrls + +> Applicable: Exchange Online + The ScanUrls parameter specifies whether to enable or disable real-time scanning of clicked links in email messages. Valid values are: - $true: Real-time scanning of clicked links, including links that point to files, is enabled. This is the default value. @@ -316,7 +346,6 @@ The ScanUrls parameter specifies whether to enable or disable real-time scanning Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -326,6 +355,9 @@ Accept wildcard characters: False ``` ### -TrackClicks + +> Applicable: Exchange Online + The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links. Valid values are: - $true: User clicks are tracked. This is the default value. @@ -335,7 +367,6 @@ The TrackClicks parameter specifies whether to track user clicks related to Safe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -345,6 +376,9 @@ Accept wildcard characters: False ``` ### -UseTranslatedNotificationText + +> Applicable: Exchange Online + The UseTranslatedNotificationText specifies whether to use Microsoft Translator to automatically localize the custom notification text that you specified with the CustomNotificationText parameter. Valid values are: - $true: Translate custom notification text to the user's language. @@ -354,7 +388,6 @@ The UseTranslatedNotificationText specifies whether to use Microsoft Translator Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -364,13 +397,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksRule.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-SafeLinksRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksRule.md index 6db4b01eeb..44a150694c 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SafeLinksRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-safelinksrule applicable: Exchange Online -title: Set-SafeLinksRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-safelinksrule +schema: 2.0.0 +title: Set-SafeLinksRule --- # Set-SafeLinksRule @@ -75,6 +76,9 @@ This example is similar to Example 2, but in this example, the Safe Links rule i ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Safe Links rule that you want to modify. You can use any value that uniquely identifies the rule. For example: @@ -87,7 +91,6 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -122,7 +130,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -163,7 +175,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -190,7 +204,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -200,13 +213,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a unique name for the Safe Links rule. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -216,6 +231,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Online + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -230,7 +248,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -240,13 +257,15 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Online + The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -256,6 +275,9 @@ Accept wildcard characters: False ``` ### -SafeLinksPolicy + +> Applicable: Exchange Online + The SafeLinksPolicy parameter specifies the Safe Links policy that's associated with this Safe Links rule. The rule defines the conditions and the policy defines the actions. You can use any value that uniquely identifies the policy. For example: @@ -270,7 +292,6 @@ You can't specify a Safe Attachments policy that's already associated with anoth Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Online + The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -295,7 +319,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -305,6 +328,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Online + The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name @@ -322,7 +348,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -332,13 +357,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md b/exchange/exchange-ps/ExchangePowerShell/Set-SearchDocumentFormat.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SearchDocumentFormat.md index 4288a07794..66cb53e178 100644 --- a/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SearchDocumentFormat.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-searchdocumentformat applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SearchDocumentFormat -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-searchdocumentformat +schema: 2.0.0 +title: Set-SearchDocumentFormat --- # Set-SearchDocumentFormat @@ -47,13 +48,15 @@ This command disables the Zip file format for indexing by Exchange Search. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the file format. ```yaml Type: SearchDocumentFormatId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the file format is enabled. Set the parameter to $false to disable the format for content indexing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -111,7 +121,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-SecOpsOverridePolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SecOpsOverridePolicy.md index d1f54d8ff0..8757a73749 100644 --- a/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SecOpsOverridePolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-secopsoverridepolicy applicable: Exchange Online -title: Set-SecOpsOverridePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-secopsoverridepolicy +schema: 2.0.0 +title: Set-SecOpsOverridePolicy --- # Set-SecOpsOverridePolicy @@ -48,6 +49,9 @@ This example modifies the SecOPs mailbox override policy with the specified sett ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the SecOps override policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the SecOps override policy that you want to mod Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 0 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AddSentTo + +> Applicable: Exchange Online + The AddSentTo parameter specifies an entry to add to the existing list of SecOps mailbox email addresses. Groups are not allowed. You can specify multiple values separated by commas. @@ -77,7 +83,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Online + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -112,7 +122,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,6 +149,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether the policy is enabled. Valid values are: - $true: The policy is enabled. This is the default value. @@ -147,7 +161,6 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -157,6 +170,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -165,7 +181,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -175,6 +190,9 @@ Accept wildcard characters: False ``` ### -RemoveSentTo + +> Applicable: Exchange Online + The RemoveSentTo parameter specifies an entry to remove from the existing list of SecOps mailbox email addresses. Groups are not allowed. You can specify multiple values separated by commas. @@ -183,7 +201,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -193,6 +210,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. The WhatIf switch doesn't work in Security & Compliance PowerShell. @@ -201,7 +221,6 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SendConnector.md b/exchange/exchange-ps/ExchangePowerShell/Set-SendConnector.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-SendConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SendConnector.md index 481f2bf0c3..e368fba06a 100644 --- a/exchange/exchange-ps/exchange/Set-SendConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SendConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-sendconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SendConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-sendconnector +schema: 2.0.0 +title: Set-SendConnector --- # Set-SendConnector @@ -79,13 +80,15 @@ This example makes the following configuration changes to the Send connector nam ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GUID or connector name that represents the Send connector you want to modify. ```yaml Type: SendConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -AddressSpaces + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. - AddressSpaceType: On an Edge server, the address space type must be SMTP. In the Transport service on a Mailbox server, the address space type may be SMTP, X400, or any other text string. If you omit the address space type, SMTP is assumed. @@ -121,7 +127,6 @@ Although you can configure non-SMTP address spaces on a Send connector in the Tr Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +136,9 @@ Accept wildcard characters: False ``` ### -AuthenticationCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AuthenticationCredential parameter specifies the username and password that's required to use the connector. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -139,7 +147,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,6 +156,9 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + **Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -162,7 +172,6 @@ Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +181,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + TheComment parameter specifies an optional comment. You must enclose the Comment parameter in quotation marks ("), for example: "this is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +199,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -197,7 +211,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +220,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The ConnectorType parameter specifies whether the connector is used in hybrid deployments to send messages to Microsoft 365. Valid values are: - Default: The connector isn't used to send messages to Microsoft 365. This is the default value. @@ -216,7 +232,6 @@ The ConnectorType parameter specifies whether the connector is used in hybrid de Type: TenantConnectorType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -226,6 +241,9 @@ Accept wildcard characters: False ``` ### -ConnectionInactivityTimeOut + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectionInactivityTimeOut parameter specifies the maximum time an idle connection can remain open. The default value is ten minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -236,7 +254,6 @@ For example, to specify fifteen minutes, set it to 00:15:00. The valid input ran Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,13 +263,15 @@ Accept wildcard characters: False ``` ### -DNSRoutingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DNSRoutingEnabled parameter specifies whether the Send connector uses Domain Name System (DNS) to route mail. Valid values for this parameter are $true or $false. The default value is $true. If you specify a SmartHosts parameter, the DNSRoutingEnabled parameter must be $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,6 +281,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -270,7 +292,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -DomainSecureEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainSecureEnabled parameter is part of the process to enable mutual Transport Layer Security (TLS) authentication for the domains serviced by this Send connector. Mutual TLS authentication functions correctly only when the following conditions are met: - The value of the DomainSecureEnabled parameter must be $true. @@ -299,7 +323,6 @@ The default value for the DomainSecureEnabled parameter is $true for default Sen Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,13 +332,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether to enable the Send connector to process email messages. Valid values are $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -325,6 +350,9 @@ Accept wildcard characters: False ``` ### -ErrorPolicies + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ErrorPolicies parameter specifies how communication errors are treated. Possible values are the following: - Default: A non-delivery report (NDR) is generated for communication errors. @@ -340,7 +368,6 @@ Specify a value other than Default for this parameter only if this Send connecto Type: ErrorPolicies Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -350,6 +377,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -358,7 +388,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -368,13 +397,15 @@ Accept wildcard characters: False ``` ### -ForceHELO + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ForceHELO parameter specifies whether HELO is sent instead of the default EHLO. Valid values are $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -384,6 +415,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Fqdn parameter specifies the FQDN used as the source server for connected messaging servers that use the Send connector to receive outgoing messages. The value of this parameter is displayed to connected messaging servers whenever a source server name is required, as in the following examples: - In the EHLO/HELO command when the Send connector communicates with the next hop messaging server @@ -396,7 +430,6 @@ The default value of the Fqdn parameter is $null. This means the default FQDN va Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -406,13 +439,15 @@ Accept wildcard characters: False ``` ### -FrontendProxyEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FrontendProxyEnabled parameter routes outbound messages through the CAS server, where destination specific routing, such as DNS or IP address, is set, when the parameter is set to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -422,13 +457,15 @@ Accept wildcard characters: False ``` ### -IgnoreSTARTTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreSTARTTLS parameter specifies whether to ignore the StartTLS option offered by a remote sending server. This parameter is used with remote domains. This parameter must be set to $false if the RequireTLS parameter is set to $true. Valid values for this parameter are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -438,6 +475,9 @@ Accept wildcard characters: False ``` ### -IsCoexistenceConnector + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IsCoexistenceConnector parameter specifies whether this Send connector is used for secure mail flow between your on-premises deployment and your Microsoft 365 organization. The default value is $false. @@ -446,7 +486,6 @@ The IsCoexistenceConnector parameter specifies whether this Send connector is us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -456,13 +495,15 @@ Accept wildcard characters: False ``` ### -IsScopedConnector + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers with the Transport service. When the value of this parameter is $false, the connector can be used by all Mailbox servers in the Exchange organization. When the value of this parameter is $true, the connector can only be used by Transport service on Mailbox servers in the same Active Directory site. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -472,6 +513,9 @@ Accept wildcard characters: False ``` ### -LinkedReceiveConnector + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The LinkedReceiveConnector parameter forces all messages received by the specified Receive connector out through this Send connector. The value of the LinkedReceiveConnector parameter can use any of the following identifiers to specify the Receive connector: @@ -492,7 +536,6 @@ When you use the LinkedReceiveConnector parameter with this command, you must al Type: ReceiveConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -502,6 +545,9 @@ Accept wildcard characters: False ``` ### -MaxMessageSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxMessageSize parameter specifies the maximum size of a message that can pass through a connector. The default value is 25 MB. When you enter a value, qualify the value with one of the following units: @@ -520,7 +566,6 @@ The valid input range for this parameter is 0 to 2147483647 bytes. To remove the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -530,13 +575,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the administrator-supplied name of the connector. You must enclose the Name parameter in quotation marks (") if the name contains spaces. For example, "New Send Connector". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -546,13 +593,15 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Port parameter specifies the port number for smart host forwarding, if you specify a value in the SmartHosts parameter. The valid input range is an integer from 0 through 65535. The default value is 25. In most organizations, the port number is set to 25. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -562,13 +611,15 @@ Accept wildcard characters: False ``` ### -ProtocolLoggingLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProtocolLoggingLevel parameter specifies whether to enable protocol logging. Verbose enables protocol logging. None disables protocol logging. The location of the Send connector protocol logs for all Send connectors configured in the Transport service on a Mailbox server or on an Edge server is specified with the SendProtocolLogPath parameter of the Set-TransportService cmdlet. ```yaml Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -578,13 +629,15 @@ Accept wildcard characters: False ``` ### -RequireOorg + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -594,13 +647,15 @@ Accept wildcard characters: False ``` ### -RequireTLS + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequireTLS parameter specifies whether all messages sent through this connector must be transmitted using TLS. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -610,13 +665,15 @@ Accept wildcard characters: False ``` ### -SmartHostAuthMechanism + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SmartHostAuthMechanism parameter specifies the smart host authentication mechanism to use for authentication with a remote server. Use this parameter only when a smart host is configured and the DNSRoutingEnabled parameter is set to $false. Valid values are None, BasicAuth, BasicAuthRequireTLS, ExchangeServer, and ExternalAuthoritative. All values are mutually exclusive. If you select BasicAuth or BasicAuthRequireTLS, you must use the AuthenticationCredential parameter to specify the authentication credential. ```yaml Type: AuthMechanisms Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -626,6 +683,9 @@ Accept wildcard characters: False ``` ### -SmartHosts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameter is required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart-host server. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -636,7 +696,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -646,13 +705,15 @@ Accept wildcard characters: False ``` ### -SmtpMaxMessagesPerConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SmtpMaxMessagesPerConnection parameter specifies the maximum number of messages the server can send per connection. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -662,13 +723,15 @@ Accept wildcard characters: False ``` ### -SourceIPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceIPAddress parameter specifies the local IP address to use as the endpoint for an SMTP connection to a remote messaging server. The default IP address is 0.0.0.0. This value means that the server can use any available local IP address. This parameter is valid only for Send connectors configured on an Edge server. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -678,6 +741,9 @@ Accept wildcard characters: False ``` ### -SourceTransportServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceTransportServers parameter specifies the names of the Mailbox servers that can use this Send connector. This parameter isn't valid for Send connectors configured on an Edge server. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -688,7 +754,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -698,6 +763,9 @@ Accept wildcard characters: False ``` ### -TlsAuthLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsAuthLevel parameter specifies the TLS authentication level that is used for outbound TLS connections established by this Send connector. Valid values are: - EncryptionOnly: TLS is used only to encrypt the communication channel. No certificate authentication is performed. @@ -710,7 +778,6 @@ You can't specify a value for this parameter if the IgnoreSTARTTLS parameter is Type: TlsAuthLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -720,13 +787,15 @@ Accept wildcard characters: False ``` ### -TlsCertificateName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -736,6 +805,9 @@ Accept wildcard characters: False ``` ### -TlsDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TlsDomain parameter specifies the domain name that the Send connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is used only if the TlsAuthLevel parameter is set to DomainValidation. @@ -749,7 +821,6 @@ A value for this parameter is required if: Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -759,13 +830,15 @@ Accept wildcard characters: False ``` ### -UseExternalDNSServersEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UseExternalDNSServersEnabled parameter specifies whether this Send connector uses the external DNS list specified by the ExternalDNSServers parameter of the Set-TransportService cmdlet. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -775,13 +848,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-SenderFilterConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-SenderFilterConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SenderFilterConfig.md index 1b634750be..01304c3b59 100644 --- a/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SenderFilterConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-senderfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SenderFilterConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-senderfilterconfig +schema: 2.0.0 +title: Set-SenderFilterConfig --- # Set-SenderFilterConfig @@ -57,13 +58,15 @@ It adds user1@contoso.com and user2@contoso.com to the blocked senders list with ## PARAMETERS ### -Action + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Action parameter specifies the action that the Sender Filter agent takes on messages from blocked senders or domains. Valid input for this parameter is StampStatus or Reject. The default value is Reject. ```yaml Type: BlockedSenderAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -BlankSenderBlockingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BlankSenderBlockingEnabled parameter blocks or allows messages that don't contain a sender value in the SMTP command MAIL FROM. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -BlockedDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BlockedDomains parameter specifies the domain names to block. When the Sender Filter agent encounters a message from a domain on this list, the Sender Filter agent takes the action specified by the Action parameter. Valid input for this parameter is one or more domains or subdomains. Wildcard characters aren't permitted. For example, if you specify the values contoso.com and marketing.contoso.com, only messages from those domains are blocked by the Sender Filter agent. Messages from sales.contoso.com aren't blocked by the Sender Filter agent. @@ -103,7 +111,6 @@ The maximum number of entries for this parameter is 800. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -BlockedDomainsAndSubdomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BlockedDomainsAndSubdomains parameter specifies the domain names to block. When the Sender Filter agent encounters a message from a domain on this list, or from any of the domain's subdomains, the Sender Filter agent takes the action specified by the Action parameter. Valid input for this parameter is one or more domains. Wildcard characters aren't permitted. For example, if you specify the value contoso.com, messages from contoso.com, sales.contoso.com, and all other subdomains of contoso.com are blocked by the Sender Filter agent. @@ -127,7 +137,6 @@ The maximum number of entries for this parameter is 800. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -BlockedSenders + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BlockedSenders parameter specifies one or more SMTP email addresses to block. When the Sender Filter agent encounters a message from a sender on this list, the Sender Filter agent takes the action specified by the Action parameter. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -149,7 +161,6 @@ The maximum number of entries for this parameter is 800. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +170,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -168,7 +182,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -186,7 +202,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,13 +211,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter enables or disables sender filtering on your Exchange server. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -212,13 +229,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalMailEnabled parameter enables or disables sender filtering on unauthenticated connections from external messaging servers. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,13 +247,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalMailEnabled parameter enables or disables sender filtering on authenticated connections from authoritative domains in your organization. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -244,6 +265,9 @@ Accept wildcard characters: False ``` ### -RecipientBlockedSenderAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecipientBlockedSenderAction parameter specifies the action that the Sender Filter agent takes on messages received from blocked senders that are defined by SafeList aggregation. SafeList aggregation adds blocked senders that are defined by your users in Microsoft Outlook or Outlook on the web to the Blocked Senders list that's used by the Sender Filter agent. Valid input for this parameter is Delete or Reject. The default value is Reject. @@ -252,7 +276,6 @@ Valid input for this parameter is Delete or Reject. The default value is Reject. Type: RecipientBlockedSenderAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,13 +285,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SenderIdConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-SenderIdConfig.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-SenderIdConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SenderIdConfig.md index eaeddca576..21ea80d26a 100644 --- a/exchange/exchange-ps/exchange/Set-SenderIdConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SenderIdConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-senderidconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SenderIdConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-senderidconfig +schema: 2.0.0 +title: Set-SenderIdConfig --- # Set-SenderIdConfig @@ -53,13 +54,15 @@ This example makes the following modifications to the Sender ID configuration: ## PARAMETERS ### -BypassedRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassedRecipients parameter specifies one or more SMTP email addresses. Messages bound for the email addresses listed in this parameter are excluded from processing by the Sender ID agent. You can specify multiple values separated by commas. You can enter a maximum of 100 email addresses. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -BypassedSenderDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassedSenderDomains parameter specifies one or more domain names. Messages that originate from the domains listed in this parameter are excluded from processing by the Sender ID agent. You can specify multiple values separated by commas. You can enter a maximum of 100 domain names. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -94,7 +102,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -112,7 +122,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter specifies whether the Sender ID agent is enabled on the computer on which you're running the command. Valid input for the Enabled parameter is $true or $false. The default setting is $true. When the Enabled parameter is set to $true, the Sender ID agent is enabled on the computer on which you're running the command. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,13 +149,15 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalMailEnabled parameter specifies whether all messages from unauthenticated connections external to your organization are passed through the Sender ID agent for processing. Valid input for the ExternalMailEnabled parameter is $true or $false. The default setting is $true. When the ExternalMailEnabled parameter is set to $true, all messages from unauthenticated connections external to your organization are passed through the Sender ID agent for processing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,13 +167,15 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalMailEnabled parameter specifies whether all messages from authenticated sender domains that belong to authoritative domains in your enterprise are passed through the Sender ID agent for processing. Valid input for the InternalMailEnabled parameter is $true or $false. The default setting is $false. When the InternalMailEnabled parameter is set to $true, all messages from authenticated sender domains that belong to authoritative domains in your enterprise are passed through the Sender ID agent for processing. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,13 +185,15 @@ Accept wildcard characters: False ``` ### -SpoofedDomainAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SpoofedDomainAction parameter specifies the action that the Sender ID agent takes on the message when the sender domain shows evidence of being spoofed. The SpoofedDomainAction parameter takes the following values: StampStatus, Reject or Delete. The default value is StampStatus. ```yaml Type: SenderIdAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -186,13 +203,15 @@ Accept wildcard characters: False ``` ### -TempErrorAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TempErrorAction parameter specifies the action that the Sender ID agent takes on the message when a Sender ID status of TempError is returned. The TempErrorAction parameter takes the following values: StampStatus, Reject or Delete. The default value is StampStatus. ```yaml Type: SenderIdAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,13 +221,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-SenderReputationConfig.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-SenderReputationConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SenderReputationConfig.md index 610a9441ff..5497aa6189 100644 --- a/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SenderReputationConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-senderreputationconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SenderReputationConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-senderreputationconfig +schema: 2.0.0 +title: Set-SenderReputationConfig --- # Set-SenderReputationConfig @@ -56,6 +57,9 @@ It sets the number of hours that senders are put on the blocked senders list to ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -65,7 +69,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -83,7 +89,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Enabled parameter enables or disables sender reputation on the Exchange server. Valid values are: - $true: Sender reputation is enabled. This is the default value. @@ -102,7 +110,6 @@ The Enabled parameter enables or disables sender reputation on the Exchange serv Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalMailEnabled parameter allows or prevents sender reputation from processing messages from unauthenticated connections that are external to your Exchange organization. Valid values are: - $true: Sender reputation is enabled on mail from external sources. This is the default value. @@ -121,7 +131,6 @@ The ExternalMailEnabled parameter allows or prevents sender reputation from proc Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalMailEnabled parameter allows or prevents sender reputation from processing messages from authenticated sender domains that are authoritative domains in your Exchange organization. Valid values are: - $true: Sender reputation is enabled on mail from internal sources. @@ -140,7 +152,6 @@ The InternalMailEnabled parameter allows or prevents sender reputation from proc Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,6 +161,9 @@ Accept wildcard characters: False ``` ### -OpenProxyDetectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OpenProxyDetectionEnabled parameter allows or prevents sender reputation from attempting to connect to the message's source IP address to send a test message back to the Exchange server. This test determines if the sender is an open proxy server. Valid values are: - $true: Open proxy server detection is enabled. This is the default value. @@ -165,7 +179,6 @@ The values of the OpenProxyDetectionEnabled and SenderBlockingEnabled parameters Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,6 +188,9 @@ Accept wildcard characters: False ``` ### -ProxyServerName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProxyServerName parameter specifies the name or IP address of your organization's proxy server. Sender reputation uses this value to connect to the Internet for open proxy server detection. The default value is blank ($null). To clear this value, use the value $null. @@ -183,7 +199,6 @@ The default value is blank ($null). To clear this value, use the value $null. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +208,9 @@ Accept wildcard characters: False ``` ### -ProxyServerPort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProxyServerPort parameter specifies the port number that's used by your organization's proxy server. Sender reputation uses this value to connect to the Internet for open proxy server detection. The default value is 0. @@ -201,7 +219,6 @@ The default value is 0. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,6 +228,9 @@ Accept wildcard characters: False ``` ### -ProxyServerType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProxyServerType parameter specifies the type of your organization's proxy server. Sender reputation uses this value to connect to the Internet for open proxy server detection. Valid values are: - None: This is the default value. @@ -226,7 +246,6 @@ The ProxyServerType parameter specifies the type of your organization's proxy se Type: ProxyType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +255,9 @@ Accept wildcard characters: False ``` ### -SenderBlockingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SenderBlockingEnabled parameter allows or prevents sender reputation from blocking senders when their sender reputation level (SRL) meets or exceeds the value of the SrlBlockThreshold parameter. Valid values are: - $true: Sender blocking is enabled. This is the default value. @@ -249,7 +271,6 @@ The values of the OpenProxyDetectionEnabled and SenderBlockingEnabled parameters Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,13 +280,15 @@ Accept wildcard characters: False ``` ### -SenderBlockingPeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SenderBlockingPeriod parameter specifies the number of hours that a sender remains on the blocked senders list when their SRL meets or exceeds the value of the SrlBlockThreshold parameter. Valid input for this parameter is an integer from 0 through 48. The default value is 24. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -275,6 +298,9 @@ Accept wildcard characters: False ``` ### -SrlBlockThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SrlBlockThreshold specifies the SRL rating that must be met or exceeded for sender reputation to block a sender. Valid input for this parameter is an integer from 0 through 9. The default value is 7. Messages are blocked only when the SenderBlockingEnabled parameter is set to $true. @@ -283,7 +309,6 @@ Messages are blocked only when the SenderBlockingEnabled parameter is set to $tr Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -293,13 +318,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ServerComponentState.md b/exchange/exchange-ps/ExchangePowerShell/Set-ServerComponentState.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-ServerComponentState.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ServerComponentState.md index 11c76cf3c6..cfda020fc9 100644 --- a/exchange/exchange-ps/exchange/Set-ServerComponentState.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ServerComponentState.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-servercomponentstate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ServerComponentState -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-servercomponentstate +schema: 2.0.0 +title: Set-ServerComponentState --- # Set-ServerComponentState @@ -61,6 +62,9 @@ The second command changes the state to Active after the maintenance is over (re ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -72,7 +76,6 @@ The Identity parameter specifies the Exchange server where you want to run this Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -Component + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Component parameter specifies the component or endpoint for which you want to set the state. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Requester + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Requester parameter specifies the system requesting this state change. Valid values are: - HealthAPI @@ -110,7 +118,6 @@ The Requester parameter specifies the system requesting this state change. Valid Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The State parameter specifies the state that you want for the component. Valid values are: - Active @@ -130,7 +140,6 @@ The State parameter specifies the state that you want for the component. Valid v Type: ServiceState Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -149,7 +161,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +170,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -167,7 +181,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -LocalOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LocalOnly switch specifies that the changes are written to the registry of the Exchange server only and not to Active Directory. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,13 +208,15 @@ Accept wildcard characters: False ``` ### -RemoteOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoteOnly switch specifies that the changes are written to Active Directory only and not to the registry of the Exchange server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -TimeoutInSeconds + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,13 +244,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ServerMonitor.md b/exchange/exchange-ps/ExchangePowerShell/Set-ServerMonitor.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-ServerMonitor.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ServerMonitor.md index 42b0c4a810..b5498bb8a4 100644 --- a/exchange/exchange-ps/exchange/Set-ServerMonitor.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ServerMonitor.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-servermonitor applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ServerMonitor -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-servermonitor +schema: 2.0.0 +title: Set-ServerMonitor --- # Set-ServerMonitor @@ -43,6 +44,9 @@ This example sets the maintenance monitor on the Exch01 server. ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -54,7 +58,6 @@ The Server parameter specifies the Exchange server where you want to run this co Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the monitor identity. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Repairing + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Repairing parameter specifies whether to set or clear the repairing property on a monitor. The default value is $true. @@ -88,7 +96,6 @@ The default value is $true. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -107,7 +117,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -TargetResource + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetResource parameter specifies the target resource that you want to set the monitor on. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -133,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ServicePrincipal.md b/exchange/exchange-ps/ExchangePowerShell/Set-ServicePrincipal.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-ServicePrincipal.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ServicePrincipal.md index 78b5a30bc0..cbd2bddb7e 100644 --- a/exchange/exchange-ps/exchange/Set-ServicePrincipal.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ServicePrincipal.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-serviceprincipal applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Set-ServicePrincipal -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda ms.reviewer: bili1 +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-serviceprincipal +schema: 2.0.0 +title: Set-ServicePrincipal --- # Set-ServicePrincipal @@ -45,6 +47,9 @@ This example sets the service principal in Exchange Online with the specified di ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the service principal that you want to modify. You can use any value that uniquely identifies the service principal. For example: - Name @@ -57,7 +62,6 @@ The Identity parameter specifies the service principal that you want to modify. Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -67,6 +71,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +83,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -86,13 +92,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The DisplayName parameter specifies the friendly name of the service principal. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -102,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SettingOverride.md b/exchange/exchange-ps/ExchangePowerShell/Set-SettingOverride.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-SettingOverride.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SettingOverride.md index f038384c37..7c0e64848e 100644 --- a/exchange/exchange-ps/exchange/Set-SettingOverride.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SettingOverride.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-settingoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SettingOverride -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-settingoverride +schema: 2.0.0 +title: Set-SettingOverride --- # Set-SettingOverride @@ -53,6 +54,9 @@ This example modifies the setting override named Change OAB Generation on the se ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the setting override that you want to modify. You can use any value that uniquely identifies the override. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the setting override that you want to modify. Y Type: SettingOverrideIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -82,7 +88,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -116,7 +126,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -MaxVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxVersion parameter specifies the latest version of Exchange 2016 that this override applies to (up to and including the specified value). Valid input for this parameter is an Exchange 2016 version value in the format 15.1.xxx.xx. You can use values with leading zeros, but the leading zeros are removed from the results. For example, 15.01.0225.042 is stored as 15.1.225.42. @@ -136,7 +148,6 @@ To remove a configured version value so the override applies to all versions of Type: Version Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -MinVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MinVersion parameter specifies the earliest version of Exchange 2016 that this override applies to (up to and including the specified value). Valid input for this parameter is an Exchange 2016 version value in the format 15.1.xxx.xx. You can use values with leading zeros, but the leading zeros are removed from the results. For example, 15.01.0225.042 is stored as 15.1.225.42. @@ -156,7 +170,6 @@ To remove a configured version value so the override applies to all versions of Type: Version Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Parameters parameter specifies one or more parameters for the override that are available for the combination of the Component and Section parameter values. This parameter uses the syntax: `@("Parameter1=Value1","Parameter2=Value2"...)`. For example: - `@("Enabled=true")` @@ -175,7 +191,6 @@ The Parameters parameter specifies one or more parameters for the override that Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -185,13 +200,15 @@ Accept wildcard characters: False ``` ### -Reason + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Reason parameter is used to provide a description of why the override was created. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -201,6 +218,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the name of the Exchange 2016 server where you want the override applied. You can specify a single Exchange 2016 server name, or an array of Exchange 2016 server name wildcards. For example, if you have three Exchange 2016 servers named Exchange01, Exchange02 and Exchange03, specify the value Exchange\* to apply the override to all of them. To remove the specified server so the override applies to all Exchange 2016 servers in the Active Directory forest, use the value $null. @@ -209,7 +229,6 @@ To remove the specified server so the override applies to all Exchange 2016 serv Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,13 +238,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SharingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-SharingPolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-SharingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SharingPolicy.md index 5f5182f760..3434cf584b 100644 --- a/exchange/exchange-ps/exchange/Set-SharingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SharingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-sharingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-SharingPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-sharingpolicy +schema: 2.0.0 +title: Set-SharingPolicy --- # Set-SharingPolicy @@ -63,6 +64,9 @@ This example disables the sharing policy SharingPolicy01. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the identity of the sharing policy that you want to modify. You can use one of the following values: - ADObjectID @@ -74,7 +78,6 @@ The Identity parameter specifies the identity of the sharing policy that you wan Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -93,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Default switch specifies that the sharing policy is the default sharing policy for all mailboxes. You don't need to specify a value with this switch. If no sharing policy has been applied to a mailbox, the default policy is automatically applied. If you want to disable sharing across your organization, you disable the default policy. @@ -111,7 +119,6 @@ If no sharing policy has been applied to a mailbox, the default policy is automa Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -129,7 +139,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -Domains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Domains parameter specifies the domains and the associated sharing options for those domains in the sharing policy. Values for this parameter use the basic syntax: `'Domain: SharingPolicyAction'`. You can use the following values for `Domain`: @@ -160,7 +172,6 @@ You can specify multiple `'Domain: SharingPolicyAction'` values separated by com Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Enabled parameter specifies whether to enable the sharing policy. Valid values for this parameter are $true or $false. The default is $true. When the sharing policy is disabled, users who are provisioned to use this policy continue to share information until the sharing policy assistant runs. @@ -178,7 +192,6 @@ When the sharing policy is disabled, users who are provisioned to use this polic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -188,13 +201,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the unique name of the sharing policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -204,13 +219,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SiteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-SiteMailbox.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-SiteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SiteMailbox.md index c9c67e224a..748990da42 100644 --- a/exchange/exchange-ps/exchange/Set-SiteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SiteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-sitemailbox applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SiteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-sitemailbox +schema: 2.0.0 +title: Set-SiteMailbox --- # Set-SiteMailbox @@ -61,6 +62,9 @@ This example disables the duplication of email messages in the site mailbox SMO\ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the site mailbox. You can use any value that uniquely identifies the site mailbox. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the identity of the site mailbox. You can use a Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -Active + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Active parameter specifies whether to change the site mailbox's lifecycle status. This parameter accepts $true or $false. This parameter is intended for use only by the user interface. We recommend that you don't use this parameter in the Exchange Management Shell. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -109,7 +117,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DisplayName parameter specifies the display name of the site mailbox. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -159,7 +173,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is intended for use only by the user interface. We recommend that you don't use this parameter. The Members parameter specifies the members of the site mailbox. You can add or remove members using this parameter. @@ -188,7 +204,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,6 +213,9 @@ Accept wildcard characters: False ``` ### -Owners + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is intended for use only by the user interface. We recommend that you don't use this parameter. The Owners parameter specifies the owners of the site mailbox. You can add or remove owners using this parameter. @@ -217,7 +235,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -227,13 +244,15 @@ Accept wildcard characters: False ``` ### -RemoveDuplicateMessages + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RemoveDuplicateMessages parameter specifies that when users post messages to a site mailbox, duplicate messages will be deleted. This parameter accepts the values of $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,13 +262,15 @@ Accept wildcard characters: False ``` ### -SharePointUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SharePointUrl parameter specifies the URL of the SharePoint site, for example, "https://myserver/teams/edu". ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,6 +280,9 @@ Accept wildcard characters: False ``` ### -ShowInMyClient + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -267,7 +291,6 @@ The ShowInMyClient parameter specifies that the site mailbox folder will show in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,6 +300,9 @@ Accept wildcard characters: False ``` ### -SyncEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The SyncEnabled parameter specifies whether to enable or disable synchronization for the site mailbox. Valid values are: - $true: Synchronization is enabled. @@ -286,7 +312,6 @@ The SyncEnabled parameter specifies whether to enable or disable synchronization Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,13 +321,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-SiteMailboxProvisioningPolicy.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SiteMailboxProvisioningPolicy.md index 460a831c41..3c639b2c78 100644 --- a/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SiteMailboxProvisioningPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-sitemailboxprovisioningpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SiteMailboxProvisioningPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-sitemailboxprovisioningpolicy +schema: 2.0.0 +title: Set-SiteMailboxProvisioningPolicy --- # Set-SiteMailboxProvisioningPolicy @@ -68,6 +69,9 @@ This example changes the default provisioning policy named SM\_DefaultPolicy and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the site mailbox provisioning policy that you want to edit. You can use any value that uniquely identifies the policy. For example: - Name @@ -78,7 +82,6 @@ The Identity parameter specifies the identity of the site mailbox provisioning p Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -AliasPrefix + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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. @@ -97,7 +103,6 @@ The AliasPrefix parameter specifies the custom text prefix to add to the aliases Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -116,7 +124,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -DefaultAliasPrefixEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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`). @@ -137,7 +147,6 @@ The value of this parameter is related to the value of the AliasPrefix parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +174,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsDefault switch specifies that the site mailbox provisioning policy is the default policy. You don't need to specify a value with this switch. You can have multiple policies, but only the default policy is followed when users create site mailboxes. @@ -171,7 +185,6 @@ You can have multiple policies, but only the default policy is followed when use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +194,9 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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: @@ -201,7 +217,6 @@ The default value is 49 GB. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,6 +226,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the site mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -228,7 +246,6 @@ A valid value is a number up to 1.999999 gigabytes (2147482624 bytes) or the val Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,13 +255,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name of the site mailbox provisioning policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,6 +273,9 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + 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: @@ -274,7 +296,6 @@ The default value is 50 GB. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,13 +305,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SmimeConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-SmimeConfig.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-SmimeConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SmimeConfig.md index de3c3c22fa..1c2308992e 100644 --- a/exchange/exchange-ps/exchange/Set-SmimeConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SmimeConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-smimeconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-SmimeConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-smimeconfig +schema: 2.0.0 +title: Set-SmimeConfig --- # Set-SmimeConfig @@ -70,13 +71,15 @@ This example sets the S/MIME configuration to allow users the choice of signing ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -86,13 +89,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -OWAAllowUserChoiceOfSigningCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAAllowUserChoiceOfSigningCertificate parameter specifies whether to allow users to select the certificate to use when they digitally sign email messages in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -110,7 +118,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -OWAAlwaysEncrypt + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAAlwaysEncrypt parameter specifies whether all outgoing messages are automatically encrypted in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -128,7 +138,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -OWAAlwaysSign + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAAlwaysSign parameter specifies whether all outgoing messages are automatically signed in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -146,7 +158,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -156,6 +167,9 @@ Accept wildcard characters: False ``` ### -OWABCCEncryptedEmailForking + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWABCCEncryptedEmailForking parameter specifies how Bcc messages are encrypted in Outlook on the web. Valid values are: - 0: One encrypted message per Bcc recipient. This is the default value. @@ -168,7 +182,6 @@ This setting affects the security and privacy of Outlook on the web. Consult you Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -OWACheckCRLOnSend + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWACheckCRLOnSend parameter specifies how the certificate revocation list (CRL) check is enforced when an email message is sent in Outlook on the web. Valid values are: - $true: When the CRL distribution point is inaccessible, Outlook on the web displays a warning dialog box and prevents signed or encrypted messages from being sent. @@ -187,7 +203,6 @@ The OWACheckCRLOnSend parameter specifies how the certificate revocation list (C Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,6 +212,9 @@ Accept wildcard characters: False ``` ### -OWAClearSign + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAClearSign parameter specifies how email messages are signed in Outlook on the web. Valid values are: - $true: Digitally signed messages are clear-signed. This is the default value. @@ -208,7 +226,6 @@ Clear-signed messages are larger than opaque-signed messages, but clear-signed m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -218,13 +235,15 @@ Accept wildcard characters: False ``` ### -OWACopyRecipientHeaders + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -234,6 +253,9 @@ Accept wildcard characters: False ``` ### -OWACRLConnectionTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWACRLConnectionTimeout parameter specifies the time in milliseconds that Outlook on the web waits while connecting to retrieve a single CRL as part of a certificate validation operation. A valid value is an integer between 0 and 4294967295 (UInt32). The default value is 60000 (60 seconds). @@ -244,7 +266,6 @@ When multiple CRLs in a certificate chain must be retrieved, the time limit that Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -254,6 +275,9 @@ Accept wildcard characters: False ``` ### -OWACRLRetrievalTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWACRLRetrievalTimeout parameter specifies the time in milliseconds that Outlook on the web waits to retrieve all CRLs when validating a certificate. VA valid value is an integer between 0 and 4294967295 (UInt32). The default value is 10000 (10 seconds). @@ -264,7 +288,6 @@ If all the required CRLs are not retrieved before the time limit expires, the op Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -274,6 +297,9 @@ Accept wildcard characters: False ``` ### -OWADisableCRLCheck + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWADisableCRLCheck parameter enables or disables CRL checking in Outlook on the web. Valid values are: - $true: CRL checks are disabled when validating certificates. @@ -285,7 +311,6 @@ Disabling CRL checking can decrease the time that's required to validate the sig Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -295,6 +320,9 @@ Accept wildcard characters: False ``` ### -OWADLExpansionTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWADLExpansionTimeout parameter specifies the time in milliseconds that Outlook on the web waits when sending encrypted messages to members of a distribution group that requires expansion. A valid value is an integer between 0 and 4294967295 (UInt32). The default value is 60000 (60 seconds). If the operation doesn't complete in the time specified by this parameter, the operation fails and the message is not sent. @@ -307,7 +335,6 @@ The timeout value that's specified by this parameter is applied to the expansion Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -317,6 +344,9 @@ Accept wildcard characters: False ``` ### -OWAEncryptionAlgorithms + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAEncryptionAlgorithms parameter specifies a list of symmetric encryption algorithms that are used by Outlook on the web to encrypt messages. Valid values are: - 6601: DES (56-bit) @@ -336,7 +366,6 @@ If the parameter is not specified or is not formatted correctly, Outlook on the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -346,6 +375,9 @@ Accept wildcard characters: False ``` ### -OWAEncryptTemporaryBuffers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAEncryptTemporaryBuffers parameter specifies whether the Outlook on the web client-side temporary message storage buffers are encrypted. Valid values are: - $true: All client-side temporary buffers that store message data are encrypted using an ephemeral key and the 3DES algorithm. This is the default value. @@ -357,7 +389,6 @@ Disabling encryption of the buffers can increase performance of the Outlook on t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -367,6 +398,9 @@ Accept wildcard characters: False ``` ### -OWAForceSMIMEClientUpgrade + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAForceSMIMEClientUpgrade parameter specifies whether or not users are forced to upgrade an S/MIME control that's older than their current version in Outlook on the web. - $true: Users need to download and install the new control before they can use S/MIME. This is the default value. @@ -376,7 +410,6 @@ The OWAForceSMIMEClientUpgrade parameter specifies whether or not users are forc Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -386,6 +419,9 @@ Accept wildcard characters: False ``` ### -OWAIncludeCertificateChainAndRootCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAIncludeCertificateChainAndRootCertificate parameter specifies whether the certificate chains and root certificates of the signing or encryption certificates are included in the message in Outlook on the web. Valid input for this parameter is $true or $false. The default value is $false. @@ -394,7 +430,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -404,6 +439,9 @@ Accept wildcard characters: False ``` ### -OWAIncludeCertificateChainWithoutRootCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAIncludeCertificateChainWithoutRootCertificate parameter specifies whether the certificate chains of the signing or encryption certificates are included in messages in Outlook on the web. Valid values are: - $true: Signed or encrypted messages include the full certificate chain, but not the root certificate. @@ -413,7 +451,6 @@ The OWAIncludeCertificateChainWithoutRootCertificate parameter specifies whether Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -423,6 +460,9 @@ Accept wildcard characters: False ``` ### -OWAIncludeSMIMECapabilitiesInMessage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAIncludeSMIMECapabilitiesInMessage parameter specifies whether signed and encrypted messages in Outlook on the web include attributes that describe the supported encryption and signing algorithms. Valid input for this parameter is $true or $false. The default is $false. @@ -433,7 +473,6 @@ Enabling this option increases the size of messages, but may make it easier for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -443,6 +482,9 @@ Accept wildcard characters: False ``` ### -OWAOnlyUseSmartCard + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAOnlyUseSmartCard parameter specifies whether smartcard-based certificates are required for Outlook on the web message signing and decryption. Valid values are: $true: Smartcard-based certificates for signing and decryption are required when you use Outlook on the web and the S/MIME control. @@ -453,7 +495,6 @@ $false: Smartcard-based certificates for signing and decryption aren't required Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -463,6 +504,9 @@ Accept wildcard characters: False ``` ### -OWASenderCertificateAttributesToDisplay + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWASenderCertificateAttributesToDisplay parameter controls which certificate attributes are displayed when signature verification proceeds despite a mismatch between the sender's email address and the email address in sender's certificate. The parameter accepts a comma-separated list of object identifiers (OIDs). This setting is blank ($null) by default. @@ -471,7 +515,6 @@ The parameter accepts a comma-separated list of object identifiers (OIDs). This Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -481,6 +524,9 @@ Accept wildcard characters: False ``` ### -OWASignedEmailCertificateInclusion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWASignedEmailCertificateInclusion parameter specifies whether the sender's encryption certificate is excluded from a signed email message in Outlook on the web. Valid values are: - $true: Outlook on the web and the S/MIME control include both signing and encrypting certificates with signed email messages. This is the default value. @@ -492,7 +538,6 @@ When you don't include the certificates with signed email messages, the size of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -502,6 +547,9 @@ Accept wildcard characters: False ``` ### -OWASigningAlgorithms + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWASigningAlgorithms parameter specifies the list of symmetric encryption signing algorithms that are used by Outlook on the web to sign messages with the S/MIME control. Valid values are: - 8003: CALG\_MD5 or 128-bit MD5 @@ -522,7 +570,6 @@ If this parameter is not specified or is not formatted correctly, Outlook on the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -532,6 +579,9 @@ Accept wildcard characters: False ``` ### -OWATripleWrapSignedEncryptedMail + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWATripleWrapSignedEncryptedMail parameter specifies whether signed and encrypted email messages in Outlook on the web are triple-wrapped. Valid values are: - $true: A signed message is encrypted, and then the encrypted message is signed (signed-encrypted-signed). @@ -543,7 +593,6 @@ Triple-wrapped messages offer the highest level of security for messages under t Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -553,6 +602,9 @@ Accept wildcard characters: False ``` ### -OWAUseKeyIdentifier + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAUseKeyIdentifier parameter specifies whether a certificate's key identifier is used to encode the asymmetrically encrypted token in Outlook on the web. Valid input for this parameter is $true or $false. The default is $false. @@ -565,7 +617,6 @@ This parameter causes the use of a certificate's key identifier when encoding th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -575,6 +626,9 @@ Accept wildcard characters: False ``` ### -OWAUseSecondaryProxiesWhenFindingCertificates + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OWAUseSecondaryProxiesWhenFindingCertificates parameter specifies whether alternative proxies are used during the certificate search in Outlook on the web. Valid input for this parameter is $true or $false. The default is $true. @@ -585,7 +639,6 @@ Outlook on the web attempts to find the correct certificate for a recipient when Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -595,6 +648,9 @@ Accept wildcard characters: False ``` ### -NoSignOnReply + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter applies only to new Outlook for Windows. It doesn't apply to Outlook on the web. @@ -608,7 +664,6 @@ The NoSignOnReply parameter specifies whether S/MIME signatures are inherited in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -618,6 +673,9 @@ Accept wildcard characters: False ``` ### -SMIMECertificateIssuingCA + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SMIMECertificateIssuingCA parameter specifies the serialized certificate store (SST) that contains the Certificate Authority (CA) signing and intermediate certificate information. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -628,7 +686,6 @@ Each certificate is checked, and if any certificates are expired, the operation Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -638,13 +695,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewPolicyV2.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewPolicyV2.md index ac5377657b..dbc7f85428 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewPolicyV2.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-supervisoryreviewpolicyv2 applicable: Security & Compliance -title: Set-SupervisoryReviewPolicyV2 -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-supervisoryreviewpolicyv2 +schema: 2.0.0 +title: Set-SupervisoryReviewPolicyV2 --- # Set-SupervisoryReviewPolicyV2 @@ -53,6 +54,9 @@ This example adds reviewers and updates the comment for the supervisory review p ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the supervisory review policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -63,7 +67,6 @@ The Identity parameter specifies the supervisory review policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -AddReviewers + +> Applicable: Security & Compliance + The AddReviewers parameter specifies the SMTP addresses of reviewers to add to the supervisory review policy. You can specify multiple email addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -Comment + +> Applicable: Security & Compliance + The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -105,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -114,7 +124,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -124,13 +133,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Security & Compliance + {{ Fill Enabled Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -140,6 +151,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -148,7 +162,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -158,13 +171,15 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + {{ Fill PolicyRBACScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All)) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -174,13 +189,15 @@ Accept wildcard characters: False ``` ### -PolicyTemplate + +> Applicable: Security & Compliance + {{ Fill PolicyTemplate Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -190,13 +207,15 @@ Accept wildcard characters: False ``` ### -PreservationPeriodInDays + +> Applicable: Security & Compliance + {{ Fill PreservationPeriodInDays Description }} ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -206,13 +225,15 @@ Accept wildcard characters: False ``` ### -RemoveReviewers + +> Applicable: Security & Compliance + The RemoveReviewers parameter specifies the SMTP addresses of reviewers to remove from the supervisory review policy. You can specify multiple email addresses separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -222,13 +243,15 @@ Accept wildcard characters: False ``` ### -RetentionPeriodInDays + +> Applicable: Security & Compliance + The RetentionPeriodInDays parameter specifies the number of days that the messages will be retained for review. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -238,6 +261,9 @@ Accept wildcard characters: False ``` ### -Reviewers + +> Applicable: Security & Compliance + The Reviewers parameter specifies the SMTP addresses of the reviewers for the supervisory review policy. You can specify multiple email addresses separated by commas. The reviewers that you specify with this parameter replace the existing reviewers. To selectively add or remove reviewers, use the AddReviewers and RemoveReviewers parameters. @@ -246,7 +272,6 @@ The reviewers that you specify with this parameter replace the existing reviewer Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -256,13 +281,15 @@ Accept wildcard characters: False ``` ### -UserReportingWorkloads + +> Applicable: Security & Compliance + {{ Fill UserReportingWorkloads Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -272,13 +299,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewRule.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewRule.md index 3b3c0210d9..205cc6424b 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SupervisoryReviewRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-supervisoryreviewrule applicable: Security & Compliance -title: Set-SupervisoryReviewRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-supervisoryreviewrule +schema: 2.0.0 +title: Set-SupervisoryReviewRule --- # Set-SupervisoryReviewRule @@ -65,6 +66,9 @@ This example modifies the existing rule named EU Brokers Rule with the following ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the supervisory review rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -75,7 +79,6 @@ The Identity parameter specifies the supervisory review rule that you want to mo Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -AdvancedRule + +> Applicable: Security & Compliance + {{ Fill AdvancedRule Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -CcsiDataModelOperator + +> Applicable: Security & Compliance + {{ Fill CcsiDataModelOperator Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Condition + +> Applicable: Security & Compliance + The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: - User or group communications to supervise: `"((Reviewee:) -OR (Reviewee:)...)"`. Exceptions use the syntax `"(NOT((Reviewee:) -OR (Reviewee:)...))"`. @@ -133,7 +143,6 @@ The Condition parameter specifies the conditions and exceptions for the rule. Th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -152,7 +164,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -162,13 +173,15 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation + +> Applicable: Security & Compliance + {{ Fill ContentContainsSensitiveInformation Description }} ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -ContentMatchesDataModel + +> Applicable: Security & Compliance + {{ Fill ContentMatchesDataModel Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -194,13 +209,15 @@ Accept wildcard characters: False ``` ### -ContentSources + +> Applicable: Security & Compliance + {{ Fill ContentSources Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -210,13 +227,15 @@ Accept wildcard characters: False ``` ### -DayXInsights + +> Applicable: Security & Compliance + {{ Fill DayXInsights Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -226,13 +245,15 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Security & Compliance + {{ Fill ExceptIfFrom Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -242,13 +263,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfRecipientDomainIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -258,13 +281,15 @@ Accept wildcard characters: False ``` ### -ExceptIfRevieweeIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfRevieweeIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -274,13 +299,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Security & Compliance + {{ Fill ExceptIfSenderDomainIs Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -290,13 +317,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Security & Compliance + {{ Fill ExceptIfSentTo Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -306,13 +335,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Security & Compliance + {{ Fill ExceptIfSubjectOrBodyContainsWords Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -322,13 +353,15 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Security & Compliance + {{ Fill From Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -338,13 +371,15 @@ Accept wildcard characters: False ``` ### -IncludeAdaptiveScopes + +> Applicable: Security & Compliance + {{ Fill IncludeAdaptiveScopes Description }} ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -354,13 +389,15 @@ Accept wildcard characters: False ``` ### -InPurviewFilter + +> Applicable: Security & Compliance + {{ Fill InPurviewFilter Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -370,13 +407,15 @@ Accept wildcard characters: False ``` ### -Ocr + +> Applicable: Security & Compliance + {{ Fill Ocr Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -386,13 +425,15 @@ Accept wildcard characters: False ``` ### -PolicyRBACScopes + +> Applicable: Security & Compliance + {{ Fill PolicyRBACScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -402,13 +443,15 @@ Accept wildcard characters: False ``` ### -SamplingRate + +> Applicable: Security & Compliance + The SamplingRate parameter specifies the percentage of communications for review. If you want reviewers to review all detected items, use the value 100. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -418,13 +461,15 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Security & Compliance + {{ Fill SentTo Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -434,13 +479,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SweepRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-SweepRule.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-SweepRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SweepRule.md index 184a02c1af..429110e014 100644 --- a/exchange/exchange-ps/exchange/Set-SweepRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SweepRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-SweepRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-sweeprule +schema: 2.0.0 +title: Set-SweepRule --- # Set-SweepRule @@ -55,6 +56,9 @@ This example modifies the existing rule that has the rule ID value x2hlsdpGmUifj ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the Sweep rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). @@ -67,7 +71,6 @@ You can get these identity values by using the Get-SweepRule cmdlet. Type: SweepRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -86,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -DestinationFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -117,7 +125,6 @@ Example values for this parameter are `john@contoso.com:\Unimportant` or `John:\ Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -135,7 +145,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,13 +154,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFlagged + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ExceptIfFlagged parameter specifies an exception for the Sweep rule that looks messages with a message flag applied. Valid values are: @@ -186,7 +200,6 @@ The typical message flag values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -ExceptIfPinned + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PinMessage parameter specifies an exception for the Sweep rule that looks for pinned messages. Valid values are: @@ -207,7 +223,6 @@ The PinMessage parameter specifies an exception for the Sweep rule that looks fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,6 +232,9 @@ Accept wildcard characters: False ``` ### -KeepForDays + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The KeepForDays parameter specifies an action for the Sweep rule that specifies the number of days to keep messages that match the conditions of the rule. After the number of days have passed, the messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). You can't use this parameter with the KeepLatest parameter, and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. @@ -225,7 +243,6 @@ You can't use this parameter with the KeepLatest parameter, and the Sweep rule m Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -235,6 +252,9 @@ Accept wildcard characters: False ``` ### -KeepLatest + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The KeepLatest parameter specifies an action for the Sweep rule that specifies the number of messages to keep that match the conditions of the rule. After the number of messages is exceeded, the oldest messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). You can't use this parameter with the KeepForDays parameter, and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. @@ -243,7 +263,6 @@ You can't use this parameter with the KeepForDays parameter, and the Sweep rule Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -253,6 +272,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox that contains the rule you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -270,7 +292,6 @@ The Mailbox parameter specifies the mailbox that contains the rule you want to m Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -280,13 +301,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Name parameter specifies the name of the Sweep rule. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -296,6 +319,9 @@ Accept wildcard characters: False ``` ### -Provider + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Provider parameter specifies the provider for the Sweep rule. If the value contains spaces, enclose the value in quotation marks. For Sweep rules that you create in Outlook on the web, the default value is Exchange16. @@ -304,7 +330,6 @@ For Sweep rules that you create in Outlook on the web, the default value is Exch Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -314,6 +339,9 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Sender parameter specifies a condition for the Sweep rule that looks for the specified sender in messages. For internal senders, you can use any value that uniquely identifies the sender. For example: - Name @@ -329,7 +357,6 @@ For external senders, use their email address. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -339,6 +366,9 @@ Accept wildcard characters: False ``` ### -SourceFolder + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: @@ -360,7 +390,6 @@ Example values for this parameter are `john@contoso.com:\Marketing` or `John:\In Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -370,6 +399,9 @@ Accept wildcard characters: False ``` ### -SystemCategory + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SystemCategory parameter specifies a condition for the sweep rule that looks for messages with the specified system category. System categories are available to all mailboxes in the organization. Valid values are: - NotDefined @@ -401,7 +433,6 @@ The SystemCategory parameter specifies a condition for the sweep rule that looks Type: SystemCategoryType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -411,13 +442,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SystemMessage.md b/exchange/exchange-ps/ExchangePowerShell/Set-SystemMessage.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-SystemMessage.md rename to exchange/exchange-ps/ExchangePowerShell/Set-SystemMessage.md index 0cb1bfebec..55f6201f0f 100644 --- a/exchange/exchange-ps/exchange/Set-SystemMessage.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-SystemMessage.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-systemmessage applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-SystemMessage -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-systemmessage +schema: 2.0.0 +title: Set-SystemMessage --- # Set-SystemMessage @@ -53,6 +54,9 @@ This example modifies the text of the custom English WarningMailbox quota messag ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the custom system message that you want to modify. You can use any value that uniquely identifies the system message. For example: - Identity @@ -108,7 +112,6 @@ Maximum number of levels (depth) in a mailbox folder: Type: SystemMessageIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -127,7 +133,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,6 +142,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -145,7 +153,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +162,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies a descriptive name for the system message. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +180,9 @@ Accept wildcard characters: False ``` ### -Original + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Original switch specifies whether to stop using the custom system message and start using the default system message. You don't need to specify a value with this switch. This switch is useful when you want to preserve the custom system message without using it. @@ -181,7 +193,6 @@ This switch only works on custom system messages for default (not new) enhanced Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -Text + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Text parameter specifies the text in the custom system message. The text should explain why the system message was sent and any actions that the user should take. This parameter can contain text and HTML tags. The maximum length is 512 characters (which includes all text and HTML tags). @@ -218,7 +232,6 @@ Here's an example value for this parameter that uses HTML tags and special chara Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,13 +241,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicy.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicy.md index 65370a81b9..c191f04b4c 100644 --- a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-teamsprotectionpolicy applicable: Exchange Online -title: Set-TeamsProtectionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-teamsprotectionpolicy +schema: 2.0.0 +title: Set-TeamsProtectionPolicy --- # Set-TeamsProtectionPolicy @@ -46,13 +47,15 @@ This example changes the quarantine policy that's used for high confidence phish ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Teams protection policy that you want to modify. There's only one Teams protection policy in an organization named Teams Protection Policy. ```yaml Type: TeamsProtectionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -AdminDisplayName + +> Applicable: Exchange Online + The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -78,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -87,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -97,6 +104,9 @@ Accept wildcard characters: False ``` ### -HighConfidencePhishQuarantineTag + +> Applicable: Exchange Online + The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as high confidence phishing by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -111,7 +121,6 @@ If you don't use this parameter, the default quarantine policy that's used is na Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -121,6 +130,9 @@ Accept wildcard characters: False ``` ### -MalwareQuarantineTag + +> Applicable: Exchange Online + The MalwareQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as malware by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: - Name @@ -135,7 +147,6 @@ If you don't use this parameter, the default quarantine policy that's used is na Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -145,14 +156,18 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online -Applicable: Exchange Online Required: False Position: Named @@ -162,6 +177,9 @@ Accept wildcard characters: False ``` ### -ZapEnabled + +> Applicable: Exchange Online + The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware and high confidence phishing messages in Teams messages. Valid values are: - $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This is the default value. @@ -171,7 +189,6 @@ The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicyRule.md similarity index 96% rename from exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicyRule.md index 859d7e7ee7..b01e926fd1 100644 --- a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TeamsProtectionPolicyRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-teamsprotectionpolicyrule applicable: Exchange Online -title: Set-TeamsProtectionPolicyRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-teamsprotectionpolicyrule +schema: 2.0.0 +title: Set-TeamsProtectionPolicyRule --- # Set-TeamsProtectionPolicyRule @@ -49,13 +50,15 @@ This example modifies the existing Teams protection policy rule by excluding rec ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the Teams protection policy rule that you want to modify. There's only one Teams protection policy rule in an organization named Teams Protection Policy Rule. ```yaml Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -65,13 +68,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Online + The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -90,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Online + The ExceptIfRecipientDomainIs parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages with email addresses in the specified domains. To replace all existing domains with the values you specify, use the following syntax: `Domain1,Domain2,...DomainN`. @@ -136,7 +146,6 @@ To empty the list, use the value $null for this parameter. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Online + The ExceptIfSentTo parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages. You can use any value that uniquely identifies the recipient. For example: - Name @@ -189,7 +201,6 @@ To empty the list, use the value $null for this parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -199,6 +210,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Online + The ExceptIfSentToMemberOf parameter specifies an exception to ZAP for Teams protection that looks for Teams messages sent to members of distribution groups or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: - Name @@ -242,7 +256,6 @@ To empty the list, use the value $null for this parameter. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -252,13 +265,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md b/exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListItems.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListItems.md index 797710eedf..b42888f270 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-tenantallowblocklistitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Set-TenantAllowBlockListItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-tenantallowblocklistitems +schema: 2.0.0 +title: Set-TenantAllowBlockListItems --- # Set-TenantAllowBlockListItems @@ -72,6 +73,9 @@ This example changes the expiration date of the URL allow entry for the specifie ## PARAMETERS ### -Entries + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Entries parameter specifies the entries that you want to modify based on the ListType parameter value. Valid values are: - FileHash: The exact SHA256 file hash value. @@ -88,7 +92,6 @@ You can't use this parameter with the Ids parameter. ```yaml Type: String[] Parameter Sets: Entries -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Ids + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Ids parameter specifies the entries that you want to modify. This value is shown in the Identity property in the output of the Get-TenantAllowBlockListItems cmdlet. An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. @@ -108,7 +114,6 @@ You can't use this parameter with the Entries parameter. Type: String[] Parameter Sets: Ids Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -ListType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListType parameter specifies the type of entry that you want to modify. Valid values are: - FileHash @@ -131,7 +139,6 @@ Use the Entries or Ids parameter with this parameter to identify the entry itsel Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -NoExpiration + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. This switch is available to use with the following types of entries: @@ -155,7 +165,6 @@ You can't use this switch with the ExpirationDate parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -Allow + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Allow switch specifies that you're modifying an allow entry. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -181,13 +192,15 @@ Accept wildcard characters: False ``` ### -Block + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Block switch specifies that you're modifying a block entry. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -197,6 +210,9 @@ Accept wildcard characters: False ``` ### -ExpirationDate + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ExpirationDate parameter filters the results by expiration date in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: @@ -210,7 +226,6 @@ You can't use this parameter with the NoExpiration or RemoveAfter parameters. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -220,6 +235,9 @@ Accept wildcard characters: False ``` ### -ListSubType + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The ListSubType parameter further specifies the entry that you want to modify. Valid values are: - AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the advanced delivery policy for non-Microsoft phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). @@ -229,7 +247,6 @@ The ListSubType parameter further specifies the entry that you want to modify. V Type: ListSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -239,13 +256,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -255,6 +274,9 @@ Accept wildcard characters: False ``` ### -OutputJson + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The OutputJson switch specifies whether to return all entries in a single JSON value. You don't need to specify a value with this switch. You use this switch to prevent the command from halting on the first entry that contains a syntax error. @@ -263,7 +285,6 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -273,6 +294,9 @@ Accept wildcard characters: False ``` ### -RemoveAfter + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The RemoveAfter parameter enables the **Remove on** \> **45 days after last used date** feature for an allow entry. The LastUsedDate property is populated when the bad entity in the allow entry is encountered by the filtering system during mail flow or time of click. The allow entry is kept for 45 days after the filtering system determines that the entity is clean. The only valid value for this parameter is 45. @@ -285,7 +309,6 @@ To change the allow entry to a static expiration date/time value that doesn't de Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListSpoofItems.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListSpoofItems.md index e410aa39ca..c2e954de94 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TenantAllowBlockListSpoofItems.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-tenantallowblocklistspoofitems applicable: Exchange Online, Security & Compliance, Exchange Online Protection -title: Set-TenantAllowBlockListSpoofItems -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-tenantallowblocklistspoofitems +schema: 2.0.0 +title: Set-TenantAllowBlockListSpoofItems --- # Set-TenantAllowBlockListSpoofItems @@ -53,13 +54,15 @@ This example removes all external spoof pairs from the Tenant Allow/Block List. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter uses the value Default. ```yaml Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Action parameter specifies whether this entry is an allow or block spoofed sender entry. Valid values are: - Allow @@ -78,7 +84,6 @@ The Action parameter specifies whether this entry is an allow or block spoofed s Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -Ids + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Ids parameter specifies the spoof pair that you want to modify. A valid value is the Identity property value from the output of the Get-TenantAllowBlockListSpoofItems cmdlet. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -113,7 +123,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md b/exchange/exchange-ps/ExchangePowerShell/Set-TextMessagingAccount.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-TextMessagingAccount.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TextMessagingAccount.md index 57563a2af1..5947abf7b4 100644 --- a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TextMessagingAccount.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-textmessagingaccount applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-TextMessagingAccount -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-textmessagingaccount +schema: 2.0.0 +title: Set-TextMessagingAccount --- # Set-TextMessagingAccount @@ -58,6 +59,9 @@ This example sets the region, mobile operator and notification phone number for ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the target mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -75,7 +79,6 @@ The Identity parameter specifies the target mailbox. You can use any value that Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -94,7 +100,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -CountryRegionId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The CountryRegionId parameter specifies the country/region that your mobile phone is registered in. Although this parameter accepts any valid ISO 3166-1 two-letter country code value (for example, AU for Australia), the following values correspond to the country/region selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): - US @@ -116,7 +124,6 @@ A reference for two-letter country codes is available at [Country Codes List](ht Type: RegionInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -134,7 +144,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -155,7 +167,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,6 +176,9 @@ Accept wildcard characters: False ``` ### -MobileOperatorId + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MobileOperatorId parameter specifies the mobile operator (carrier) for your phone. Although this parameter accepts any random number, the following values correspond to the country/region and mobile operator selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): United States: @@ -187,7 +201,6 @@ Romania: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -197,13 +210,15 @@ Accept wildcard characters: False ``` ### -NotificationPhoneNumber + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The NotificationPhoneNumber parameter specifies the telephone number to use for your text messaging notifications. This parameter uses the E.164 format: `+` (for example, `+15551234567`). ```yaml Type: E164Number Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -213,13 +228,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicy.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicy.md index aec6333325..6756049cb7 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-throttlingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ThrottlingPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-throttlingpolicy +schema: 2.0.0 +title: Set-ThrottlingPolicy --- # Set-ThrottlingPolicy @@ -207,13 +208,15 @@ This example modifies a throttling policy so that it restricts a user to be able ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter uniquely identifies the throttling policy that you want to modify values for. The name you use is the name of the throttling policy object in Active Directory. ```yaml Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -223,13 +226,15 @@ Accept wildcard characters: False ``` ### -AnonymousCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnonymousCutoffBalance parameter specifies the resource consumption limits for an anonymous user before the user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,13 +244,15 @@ Accept wildcard characters: False ``` ### -AnonymousMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnonymousMaxBurst parameter specifies the amount of time that an anonymous user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,13 +262,15 @@ Accept wildcard characters: False ``` ### -AnonymousMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnonymousMaxConcurrency parameter specifies how many anonymous connections can be made to a user's calendar data at the same time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If anonymous users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The AnonymousMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 1. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -271,6 +280,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInAD parameter specifies the percentage of a minute that anonymous users can spend executing LDAP requests (PercentTimeInAD) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -279,7 +291,6 @@ The AnonymousPercentTimeInAD parameter specifies the percentage of a minute that Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -289,6 +300,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInCAS parameter specifies the percentage of a minute that anonymous users can spend executing CAS code (PercentTimeInCAS) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -297,7 +311,6 @@ The AnonymousPercentTimeInCAS parameter specifies the percentage of a minute tha Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -307,6 +320,9 @@ Accept wildcard characters: False ``` ### -AnonymousPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The AnonymousPercentTimeInMailboxRPC parameter specifies the percentage of a minute that anonymous users can spend executing mailbox RPC requests (PercentTimeInMailboxRPC) to a user's calendar data. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -315,7 +331,6 @@ The AnonymousPercentTimeInMailboxRPC parameter specifies the percentage of a min Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -325,13 +340,15 @@ Accept wildcard characters: False ``` ### -AnonymousRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AnonymousRechargeRate parameter specifies the rate at which an anonymous user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -341,13 +358,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -357,13 +376,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -373,13 +394,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -389,13 +412,15 @@ Accept wildcard characters: False ``` ### -BookingSelfServiceRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -405,13 +430,15 @@ Accept wildcard characters: False ``` ### -ComplianceMaxExpansionDGRecipients + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ComplianceMaxExpansionDGRecipients parameter specifies the maximum number of recipients to expand in distribution groups when a discovery search is looking for a specified recipient. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -421,13 +448,15 @@ Accept wildcard characters: False ``` ### -ComplianceMaxExpansionNestedDGs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ComplianceMaxExpansionNestedDGs parameter specifies the maximum number of nested distribution groups to expand when a discovery search is looking for a specified recipient. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -437,6 +466,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -446,7 +478,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -456,13 +487,15 @@ Accept wildcard characters: False ``` ### -ConsensusCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -472,13 +505,15 @@ Accept wildcard characters: False ``` ### -ConsensusMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -488,13 +523,15 @@ Accept wildcard characters: False ``` ### -ConsensusMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -504,13 +541,15 @@ Accept wildcard characters: False ``` ### -ConsensusRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -520,13 +559,15 @@ Accept wildcard characters: False ``` ### -CpaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CpaCutoffBalance parameter specifies the resource consumption limits for a cross-premises user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -536,13 +577,15 @@ Accept wildcard characters: False ``` ### -CpaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CpaMaxBurst parameter specifies the amount of time that a cross-premises user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -552,13 +595,15 @@ Accept wildcard characters: False ``` ### -CPAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CpaMaxConcurrency parameter specifies how many concurrent connections a cross-premises user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The CpaMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -568,13 +613,15 @@ Accept wildcard characters: False ``` ### -CPAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + The CPAPercentTimeInCAS parameter specifies the percentage of a minute that a cross-premises user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -584,6 +631,9 @@ Accept wildcard characters: False ``` ### -CPAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CPAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that a cross-premises user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -592,7 +642,6 @@ The CPAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -602,13 +651,15 @@ Accept wildcard characters: False ``` ### -CpaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CpaRechargeRate parameter specifies the rate at which a cross premises user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -618,6 +669,9 @@ Accept wildcard characters: False ``` ### -CPUStartPercent + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The CPUStartPercent parameter specifies the per-process CPU percentage at which users governed by this policy begin to be backed off. Valid values are from 0 through 100. Use $null to turn off CPU percentage-based throttling for this policy. @@ -626,7 +680,6 @@ The CPUStartPercent parameter specifies the per-process CPU percentage at which Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -636,13 +689,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxConcurrency parameter specifies the number of concurrent discovery search executions that a user can have at the same time. To modify the discovery throttling parameters, create a new policy and name it "DiscoveryThrottlingPolicy". ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -652,13 +707,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxKeywords -The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchange/search-mailbox). + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchangepowershell/search-mailbox). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -668,13 +725,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxKeywordsPerPage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxKeywordsPerPage parameter specifies the number of keywords for which to show statistics on a single page in the EAC. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -684,13 +743,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxMailboxes parameter specifies the maximum number of source mailboxes that a user can include in a discovery search. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -700,13 +761,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxPreviewSearchMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxPreviewSearchMailboxes parameter specifies the maximum number of mailboxes that a user can include in eDiscovery Search Preview. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -716,13 +779,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxRefinerResults + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter isn't used and will be removed. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -732,13 +797,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxSearchQueueDepth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxSearchQueueDepth parameter specifies the maximum number of concurrent discovery search threads that can be active at the same time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -748,13 +815,15 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxStatsSearchMailboxes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryMaxStatsSearchMailboxes parameter specifies the maximum number of mailboxes that a user can search in an In-Place eDiscovery search without being able to view the statistics. When the number of mailboxes configured with the DiscoveryMaxStatsSearchMailboxes parameter is exceeded, the user must copy the search results to a discovery mailbox to view the statistics for the discovery search. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -764,13 +833,15 @@ Accept wildcard characters: False ``` ### -DiscoveryPreviewSearchResultsPageSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoveryPreviewSearchResultsPageSize parameter specifies the number of messages displayed on a single page in eDiscovery Search Preview. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -780,13 +851,15 @@ Accept wildcard characters: False ``` ### -DiscoverySearchTimeoutPeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DiscoverySearchTimeoutPeriod parameter specifies the number of minutes that a discovery search will run before it times out. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -796,6 +869,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -804,7 +880,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -814,13 +889,15 @@ Accept wildcard characters: False ``` ### -EasCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasCutoffBalance parameter specifies the resource consumption limits for an Exchange ActiveSync user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -830,13 +907,15 @@ Accept wildcard characters: False ``` ### -EasMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasMaxBurst parameter specifies the amount of time that an Exchange ActiveSync user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -846,13 +925,15 @@ Accept wildcard characters: False ``` ### -EASMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasMaxConcurrency parameter specifies how many concurrent connections an Exchange ActiveSync user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The EasMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 10. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -862,13 +943,15 @@ Accept wildcard characters: False ``` ### -EASMaxDeviceDeletesPerMonth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasMaxDeviceDeletesPerMonth parameter specifies a limit to the number of Exchange ActiveSync partnerships that a user can delete per month. By default, each user can delete a maximum of 20 partnerships per calendar month. When the limit is reached, the partnership deletion attempt fails and an error message is displayed to the user. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -878,13 +961,15 @@ Accept wildcard characters: False ``` ### -EASMaxDevices + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasMaxDevices parameter specifies a limit to the number of Exchange ActiveSync partnerships that a user can have at one time. By default, each user can create 100 Exchange ActiveSync partnerships with their Exchange account. After users exceed the limit, they must delete one of their existing partnerships before they can create any more new partnerships. An email error message describing the limitation is sent to the user when the limit is exceeded. Additionally, an event is logged in the Application log when a user exceeds the limit. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -894,13 +979,15 @@ Accept wildcard characters: False ``` ### -EasMaxInactivityForDeviceCleanup + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasMaxInactivityForDeviceCleanup parameter specifies the length of time that a user's device partnerships will remain active. By default, there is no limit to the number of days that a user's device partnerships will remain active. Use this value if you want to minimize the amount of inactive device partnerships in your organization. To use this setting, specify a value in days since the user's last sync time to cause the device partnership to be removed. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -910,6 +997,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInAD parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -918,7 +1008,6 @@ The EASPercentTimeInAD parameter specifies the percentage of a minute that an Ex Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -928,6 +1017,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInCAS parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -936,7 +1028,6 @@ The EASPercentTimeInCAS parameter specifies the percentage of a minute that an E Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -946,6 +1037,9 @@ Accept wildcard characters: False ``` ### -EASPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EASPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -954,7 +1048,6 @@ The EASPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -964,13 +1057,15 @@ Accept wildcard characters: False ``` ### -EasRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EasRechargeRate parameter specifies the rate at which an Exchange ActiveSync user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -980,13 +1075,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -996,13 +1093,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1012,13 +1111,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1028,13 +1129,15 @@ Accept wildcard characters: False ``` ### -EncryptionRecipientRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1044,13 +1147,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1060,13 +1165,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1076,13 +1183,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1092,13 +1201,15 @@ Accept wildcard characters: False ``` ### -EncryptionSenderRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1108,13 +1219,15 @@ Accept wildcard characters: False ``` ### -EwsCostThreshold + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The EwsCostThreshold parameter specifies the cost threshold for Exchange Web Services users. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1124,13 +1237,15 @@ Accept wildcard characters: False ``` ### -EwsCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EwsCutoffBalance parameter specifies the resource consumption limits for an Exchange Web Services user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1140,13 +1255,15 @@ Accept wildcard characters: False ``` ### -EwsMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EwsMaxBurst parameter specifies the amount of time that an Exchange Web Services user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1156,6 +1273,9 @@ Accept wildcard characters: False ``` ### -EWSFastSearchTimeoutInSeconds + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSFastSearchTimeoutInSeconds parameter specifies the amount of time that searches made using Exchange Web Services continue before they time out. If the search takes more than the time indicated by the policy value, the search stops and an error is returned. The default value of this setting is 60 seconds. @@ -1164,7 +1284,6 @@ The EWSFastSearchTimeoutInSeconds parameter specifies the amount of time that se Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1174,6 +1293,9 @@ Accept wildcard characters: False ``` ### -EWSFindCountLimit + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSFindCountLimit parameter specifies the maximum result size of FindItem or FindFolder calls that can exist in memory on the Client Access server at the same time for this user in this current process. If an attempt is made to find more items or folders than your policy limit allows, an error is returned. However, the limit isn't strictly enforced if the call is made within the context of an indexed page view. Specifically, in this scenario, the search results are truncated to include the number of items and folders that fit within the policy limit. You can then continue paging into your results set via further FindItem or FindFolder calls. @@ -1182,7 +1304,6 @@ The EWSFindCountLimit parameter specifies the maximum result size of FindItem or Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1192,13 +1313,15 @@ Accept wildcard characters: False ``` ### -EWSMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EwsMaxConcurrency parameter specifies how many concurrent connections an Exchange Web Services user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The EwsMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 10. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1208,13 +1331,15 @@ Accept wildcard characters: False ``` ### -EWSMaxSubscriptions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EwsMaxSubscriptions parameter specifies the maximum number of active push and pull subscriptions that an Exchange Web Services user can have on a specified Exchange server at the same time. If a user tries to create more subscriptions than the configured maximum, the subscription fails, and an event is logged in Event Viewer. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1224,6 +1349,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInAD parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1232,7 +1360,6 @@ The EWSPercentTimeInAD parameter specifies the percentage of a minute that an Ex Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1242,6 +1369,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInCAS parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1250,7 +1380,6 @@ The EWSPercentTimeInCAS parameter specifies the percentage of a minute that an E Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1260,6 +1389,9 @@ Accept wildcard characters: False ``` ### -EWSPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The EWSPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1268,7 +1400,6 @@ The EWSPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1278,13 +1409,15 @@ Accept wildcard characters: False ``` ### -EwsRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EwsRechargeRate parameter specifies the rate at which an Exchange Web Services user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1294,6 +1427,9 @@ Accept wildcard characters: False ``` ### -ExchangeMaxCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExchangeMaxCmdlets parameter specifies the number of cmdlets that can be executed within a specific time period before their execution is slowed down. The value specified by this parameter should be less than the value specified by the PowerShellMaxCmdlets parameter. The time period used for this limit is specified by the PowerShellMaxCmdletsTimePeriod parameter. We recommend that you set values for both parameters at the same time. @@ -1302,7 +1438,6 @@ The time period used for this limit is specified by the PowerShellMaxCmdletsTime Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1312,6 +1447,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -1320,7 +1458,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1330,13 +1467,15 @@ Accept wildcard characters: False ``` ### -ForwardeeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ForwardeeLimit parameter specifies the limits for the number of recipients that can be configured in Inbox Rules when using the forward or redirect action. This parameter doesn't limit the number of messages that can be forwarded or redirected to the recipients that are configured. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1346,13 +1485,15 @@ Accept wildcard characters: False ``` ### -ImapCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ImapCutoffBalance parameter specifies the resource consumption limits for an IMAP user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1362,13 +1503,15 @@ Accept wildcard characters: False ``` ### -ImapMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ImapMaxBurst parameter specifies the amount of time that an IMAP user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1378,13 +1521,15 @@ Accept wildcard characters: False ``` ### -IMAPMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ImapMaxConcurrency parameter specifies how many concurrent connections an IMAP user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The ImapMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1394,6 +1539,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInAD parameter specifies the percentage of a minute that an IMAP user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1402,7 +1550,6 @@ The IMAPPercentTimeInAD parameter specifies the percentage of a minute that an I Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1412,6 +1559,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInCAS parameter specifies the percentage of a minute that an IMAP user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1420,7 +1570,6 @@ The IMAPPercentTimeInCAS parameter specifies the percentage of a minute that an Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1430,6 +1579,9 @@ Accept wildcard characters: False ``` ### -IMAPPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The IMAPPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an IMAP user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1438,7 +1590,6 @@ The IMAPPercentTimeInMailboxRPC parameter specifies the percentage of a minute t Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1448,13 +1599,15 @@ Accept wildcard characters: False ``` ### -ImapRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ImapRechargeRate parameter specifies the rate at which the IMAP user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1464,6 +1617,9 @@ Accept wildcard characters: False ``` ### -IsServiceAccount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IsServiceAccount switch specifies that the user accounts associated with this policy are moderated by per-user thresholds and the health of system resources (for example, overall CPU usage). You don't need to specify a value with this switch. You might want to use this switch if you intend to associate this policy with user accounts that require higher throttling limits (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). @@ -1474,7 +1630,6 @@ By using this switch, work done by these accounts is moderated by the higher use Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1484,13 +1639,15 @@ Accept wildcard characters: False ``` ### -MessageRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRateLimit parameter specifies the number of messages per minute that can be submitted to transport by POP3 or IMAP4 clients that use SMTP. Clients receive a transient error if they submit messages at a rate that exceeds the value of this parameter. Exchange attempts to connect and send the messages at a later time. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1500,13 +1657,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the name of the object in Active Directory. The default policy is named `DefaultThrottlingPolicy`. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1516,13 +1675,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1532,13 +1693,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1548,13 +1711,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1564,13 +1729,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSocketConnectionsPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1580,13 +1747,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSocketConnectionsPerUser + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1596,13 +1765,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceMaxSubscriptions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1612,13 +1783,15 @@ Accept wildcard characters: False ``` ### -OutlookServiceRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1628,13 +1801,15 @@ Accept wildcard characters: False ``` ### -OwaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaCutoffBalance parameter specifies the resource consumption limits for an Outlook on the web user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1644,13 +1819,15 @@ Accept wildcard characters: False ``` ### -OwaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaMaxBurst parameter specifies the amount of time that an Outlook on the web user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1660,6 +1837,9 @@ Accept wildcard characters: False ``` ### -OWAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaMaxConcurrency parameter specifies how many concurrent connections an Outlook on the web user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. A valid value for this parameter is an integer from 0 through 2147483647 inclusive. The default value is 5. To indicate that the number of concurrent connections should be unthrottled (no limit), use the value $null. @@ -1670,7 +1850,6 @@ A valid value for this parameter is an integer from 0 through 2147483647 inclusi Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1680,6 +1859,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInAD parameter specifies the percentage of a minute that an Outlook Web App user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1688,7 +1870,6 @@ The OWAPercentTimeInAD parameter specifies the percentage of a minute that an Ou Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1698,6 +1879,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInCAS parameter specifies the percentage of a minute that an Outlook Web App user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1706,7 +1890,6 @@ The OWAPercentTimeInCAS parameter specifies the percentage of a minute that an O Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1716,6 +1899,9 @@ Accept wildcard characters: False ``` ### -OWAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The OWAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Outlook Web App user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1724,7 +1910,6 @@ The OWAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1734,13 +1919,15 @@ Accept wildcard characters: False ``` ### -OwaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaRechargeRate parameter specifies the rate at which an Outlook on the web user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1750,13 +1937,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaVoiceCutoffBalance parameter specifies the resource consumption limits for an Outlook on the web voice user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1766,13 +1955,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaVoiceMaxBurst parameter specifies the amount of time that an Outlook on the web voice user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1782,13 +1973,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaVoiceMaxConcurrency parameter specifies how many concurrent connections an Outlook on the web voice user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The OwaVoiceMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 5. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1798,13 +1991,15 @@ Accept wildcard characters: False ``` ### -OwaVoiceRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OwaVoiceRechargeRate parameter specifies the rate at which an Outlook on the web voice user's budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1814,13 +2009,15 @@ Accept wildcard characters: False ``` ### -PopCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PopCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1830,13 +2027,15 @@ Accept wildcard characters: False ``` ### -PopMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PopMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1846,13 +2045,15 @@ Accept wildcard characters: False ``` ### -POPMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PopMaxConcurrency parameter specifies how many concurrent connections a POP user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The PopMaxConcurrency parameter has a valid range from 0 through 2147483647 inclusive. The default value is 20. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1862,6 +2063,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInAD parameter specifies the percentage of a minute a POP user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1870,7 +2074,6 @@ The POPPercentTimeInAD parameter specifies the percentage of a minute a POP user Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1880,6 +2083,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInCAS parameter specifies the percentage of a minute a POP user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1888,7 +2094,6 @@ The POPPercentTimeInCAS parameter specifies the percentage of a minute a POP use Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1898,6 +2103,9 @@ Accept wildcard characters: False ``` ### -POPPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The POPPercentTimeInMailboxRPC parameter specifies the percentage of a minute a POP user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -1906,7 +2114,6 @@ The POPPercentTimeInMailboxRPC parameter specifies the percentage of a minute a Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -1916,13 +2123,15 @@ Accept wildcard characters: False ``` ### -PopRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PopRechargeRate parameter specifies the rate at which the user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1932,13 +2141,15 @@ Accept wildcard characters: False ``` ### -PowerShellCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1948,13 +2159,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1964,13 +2177,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdletQueueDepth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxCmdletQueueDepth parameter specifies the number of operations allowed to be executed by the user. This value directly affects the behavior of the PowerShellMaxCmdlets and PowerShellMaxConcurrency parameters. For example, the PowerShellMaxConcurrency parameter consumes at least two operations defined by the PowerShellMaxCmdletQueueDepth parameter but additional operations are also consumed per cmdlet execution. The number of operations depends on the cmdlets executed. We recommend that the value for the PowerShellMaxCmdletQueueDepth parameter be at least three times larger than the value of the PowerShellMaxConcurrency parameter. This parameter won't affect Exchange admin center operations or Exchange Web Services operations. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1980,13 +2195,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxCmdlets parameter specifies the number of cmdlets that can be executed within a specific time period before their execution is stopped. The value specified by this parameter should be more than the value specified by the ExchangeMaxCmdlets parameter. The time period used for this limit is specified by the PowerShellMaxCmdletsTimePeriod parameter. Both values should be set at the same time. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1996,13 +2213,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxCmdletsTimePeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxCmdletsTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine whether the number of cmdlets being executed exceeds the limits specified by the PowerShellMaxCmdlets and ExchangeMaxCmdlets parameters. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2012,6 +2231,9 @@ Accept wildcard characters: False ``` ### -PowerShellMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxConcurrency parameter specifies different information depending on context: - In the context of remote PowerShell, the PowerShellMaxConcurrency parameter specifies the maximum number of remote PowerShell sessions that a remote PowerShell user can have open at the same time. @@ -2023,7 +2245,6 @@ This parameter value doesn't necessarily correlate to the number of browsers ope Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2033,6 +2254,9 @@ Accept wildcard characters: False ``` ### -PowerShellMaxDestructiveCmdlets + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxDestructiveCmdlets parameter specifies the number of destructive cmdlets that can be executed within a specific time period before their execution is stopped. Destructive cmdlets are cmdlets that can make significant changes to user data and configuration settings in your Exchange organization. Throttling these cmdlets may help prevent accidental data loss. The following cmdlets are designated as destructive: - Disable-Mailbox @@ -2051,7 +2275,6 @@ The time period used for this limit is specified by the PowerShellMaxDestructive Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2061,13 +2284,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxDestructiveCmdletsTimePeriod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxDestructiveCmdletsTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine how many destructive cmdlets can be run. You set a value for this parameter when you set the PowerShellMaxDestructiveCmdlets parameter. Both values should be set at the same time. For more information, see the description for the PowerShellMaxDestructiveCmdlets parameter. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2077,13 +2302,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxOperations + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxOperations parameter specifies the protocol-level operations that are used to send and receive data. If the execution of a cmdlet results in a significant number of operations (for example, if there is a lot of input/output occurring), throttling may occur. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2093,13 +2320,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxRunspaces + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxRunspaces parameter specifies the number of concurrent Windows PowerShell sessions that a user is allowed to have. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2109,13 +2338,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxRunspacesTimePeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxRunspacesTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine how many Windows PowerShell sessions can be run. You set this value when you set the PowerShellMaxRunspaces parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2125,6 +2356,9 @@ Accept wildcard characters: False ``` ### -PowerShellMaxTenantConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxTenantConcurrency parameter limits the number of concurrent Windows PowerShell connections per tenant organization. By default, the limit for concurrent Windows PowerShell connections per tenant organization is set to 9. If users in a tenant organization try to make more concurrent requests than the limit set by the PowerShellMaxTenantConcurrency parameter, the new connection attempt fails. However, the existing connections remain valid. This limit is enforced even if a single user hasn't exceeded the per-user limit set by the PowerShellMaxConcurrency parameter. The PowerShellMaxTenantConcurrency parameter has a valid range from 0 through 100 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. This property can only be set for the default throttling policy. @@ -2133,7 +2367,6 @@ This property can only be set for the default throttling policy. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2143,13 +2376,15 @@ Accept wildcard characters: False ``` ### -PowerShellMaxTenantRunspaces + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellMaxTenantRunspaces parameter specifies the number of concurrent Windows PowerShell sessions that a tenant is allowed to have. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2159,13 +2394,15 @@ Accept wildcard characters: False ``` ### -PowerShellRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PowerShellRechargeRate parameter specifies the rate at which the user budget is charged (budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2175,6 +2412,9 @@ Accept wildcard characters: False ``` ### -PswsMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PswsMaxConcurrency parameter specifies how many concurrent connections a Windows PowerShell Web Services user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The PswsMaxConcurrency parameter has a default value of 18. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null. @@ -2183,7 +2423,6 @@ The PswsMaxConcurrency parameter has a default value of 18. To indicate that the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2193,13 +2432,15 @@ Accept wildcard characters: False ``` ### -PswsMaxRequest + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PswsMaxRequest parameter specifies how many requests a Windows PowerShell Web Services user can have against an Exchange server at one time. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2209,13 +2450,15 @@ Accept wildcard characters: False ``` ### -PswsMaxRequestTimePeriod + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PswsMaxRequestTimePeriod parameter specifies the period of time, in seconds, that the throttling policy uses to determine how many requests can be run. The default setting is Unlimited. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2225,13 +2468,15 @@ Accept wildcard characters: False ``` ### -PushNotificationCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2241,13 +2486,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2257,13 +2504,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxBurstPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2273,13 +2522,15 @@ Accept wildcard characters: False ``` ### -PushNotificationMaxConcurrency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2289,13 +2540,15 @@ Accept wildcard characters: False ``` ### -PushNotificationRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2305,13 +2558,15 @@ Accept wildcard characters: False ``` ### -PushNotificationRechargeRatePerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2321,13 +2576,15 @@ Accept wildcard characters: False ``` ### -PushNotificationSamplingPeriodPerDevice + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2337,13 +2594,15 @@ Accept wildcard characters: False ``` ### -RcaCutoffBalance + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RcaCutoffBalance parameter specifies the resource consumption limits for a user before that user is completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2353,13 +2612,15 @@ Accept wildcard characters: False ``` ### -RcaMaxBurst + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RcaMaxBurst parameter specifies the amount of time that a user can consume an elevated amount of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2369,6 +2630,9 @@ Accept wildcard characters: False ``` ### -RCAMaxConcurrency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RcaMaxConcurrency parameter specifies how many concurrent connections an RPC Client Access user can have against an Exchange server at one time. A connection is held from the moment a request is received until the connection is closed or the connection is otherwise disconnected (for example, if the user goes offline). If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. A valid value is an integer from 0 through 4294967295, or the value unlimited. The default value is 40. @@ -2379,7 +2643,6 @@ To indicate that the number of concurrent connections should be unthrottled (no Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2389,6 +2652,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInAD + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInAD parameter specifies the percentage of a minute that an Outlook user can spend executing directory requests. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2397,7 +2663,6 @@ The RCAPercentTimeInAD parameter specifies the percentage of a minute that an Ou Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2407,6 +2672,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInCAS + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInCAS parameter specifies the percentage of a minute that an Outlook user can spend executing CAS mailbox requests. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2415,7 +2683,6 @@ The RCAPercentTimeInCAS parameter specifies the percentage of a minute that an O Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2425,6 +2692,9 @@ Accept wildcard characters: False ``` ### -RCAPercentTimeInMailboxRPC + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RCAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an RPC Client Access user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question. @@ -2433,7 +2703,6 @@ The RCAPercentTimeInMailboxRPC parameter specifies the percentage of a minute th Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -2443,13 +2712,15 @@ Accept wildcard characters: False ``` ### -RcaRechargeRate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RcaRechargeRate parameter specifies the rate at which the budget for the user is charged (how much the budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2459,13 +2730,15 @@ Accept wildcard characters: False ``` ### -RcaSharedCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RcaSharedCutoffBalance parameter specifies the resource consumption limits for all users before they're completely blocked from performing operations on a specific component after all available resources have been consumed. There is no preset default value for this parameter but it generally ranges from 600,000 to 3,000,000 in working state depending on the protocol. If for any reason, this value needs to be increased further, you must contact Microsoft Support because a higher value can affect server performance adversely. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2475,13 +2748,15 @@ Accept wildcard characters: False ``` ### -RcaSharedMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RcaShardMaxBurst parameter specifies the amount of time that all users can consume elevated amounts of resources before being throttled. This is measured in milliseconds. This value is set separately for each component. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2491,6 +2766,9 @@ Accept wildcard characters: False ``` ### -RcaSharedMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RcaSharedMaxConcurrency parameter specifies how many concurrent connections all RPC Client Access users can have against an Exchange server at one time. A connection is held from the moment a request is received until the connection is closed or the connection is otherwise disconnected (for example, if users go offline). If there are more concurrent requests than the policy allows, new connection attempts fail. However, the existing connections remain valid. The default value is unlimited, which means the limit is controlled individually for each user by the RcaMaxConcurrency parameter. @@ -2499,7 +2777,6 @@ The default value is unlimited, which means the limit is controlled individually Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2509,13 +2786,15 @@ Accept wildcard characters: False ``` ### -RcaSharedRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The RcaSharedRechargeRate parameter specifies the rate at which the budget for all users is charged (how much the budget grows by) during the budget time. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2525,13 +2804,15 @@ Accept wildcard characters: False ``` ### -RecipientRateLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecipientRateLimit parameter specifies the limits on the number of recipients that a user can address in a 24-hour period. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2541,13 +2822,15 @@ Accept wildcard characters: False ``` ### -SchedulesCutoffBalance + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2557,13 +2840,15 @@ Accept wildcard characters: False ``` ### -SchedulesMaxBurst + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2573,13 +2858,15 @@ Accept wildcard characters: False ``` ### -SchedulesMaxConcurrency + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2589,13 +2876,15 @@ Accept wildcard characters: False ``` ### -SchedulesRechargeRate + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2605,6 +2894,9 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicyScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ThrottlingPolicyScope parameter specifies the scope of the throttling policy. You can use the following values: - Regular: This scope specifies a custom policy that applies to specific users. @@ -2617,7 +2909,6 @@ For more information about throttling policy scopes, see [User workload manageme Type: ThrottlingPolicyScopeType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2627,13 +2918,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicyAssociation.md similarity index 91% rename from exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md rename to exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicyAssociation.md index 7179fe0d72..68a4521905 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-ThrottlingPolicyAssociation.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-throttlingpolicyassociation applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-ThrottlingPolicyAssociation -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-throttlingpolicyassociation +schema: 2.0.0 +title: Set-ThrottlingPolicyAssociation --- # Set-ThrottlingPolicyAssociation @@ -61,13 +62,15 @@ You don't need to use the Set-ThrottlingPolicyAssociation cmdlet to associate a ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the object to which you want to associate a throttling policy. The object can be a user with a mailbox, a user without a mailbox, a contact, or a computer account. ```yaml Type: ThrottlingPolicyAssociationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -86,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -104,7 +112,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ThrottlingPolicy parameter specifies the throttling policy that you want the object specified by the Identity parameter to be associated with. ```yaml Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Set-TransportAgent.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TransportAgent.md index 65fa73a458..590f84d5a2 100644 --- a/exchange/exchange-ps/exchange/Set-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-TransportAgent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-transportagent +schema: 2.0.0 +title: Set-TransportAgent --- # Set-TransportAgent @@ -45,13 +46,15 @@ This example modifies the priority of a fictitious agent named Test App in the F ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name (Identity property value) of the transport agent that you want to modify. If the name contains spaces, enclose the name in quotation marks ("). ```yaml Type: TransportAgentObjectId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -61,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -70,7 +76,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -88,7 +96,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Priority parameter specifies the priority of the transport agent. The priority of the transport agent controls the order in which the transport agents process email messages. The priority must be a value between 0 and the maximum number of transport agents. The default behavior is to append a new transport agent to the end of the priority list. Transport agents with a priority closest to 0 process email messages first. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,6 +123,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -126,7 +138,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TransportConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-TransportConfig.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-TransportConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TransportConfig.md index 57473281ff..9f53fa6bc2 100644 --- a/exchange/exchange-ps/exchange/Set-TransportConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TransportConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-transportconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Set-TransportConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-transportconfig +schema: 2.0.0 +title: Set-TransportConfig --- # Set-TransportConfig @@ -114,6 +115,9 @@ To avoid journaling issues, we recommend that you set JournalingReportNdrTo to a ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -122,7 +126,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -132,6 +135,9 @@ Accept wildcard characters: False ``` ### -AddressBookPolicyRoutingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AddressBookPolicyRoutingEnabled parameter controls how recipients are resolved in an organization that uses address book policies to create separate virtual organizations within the same Exchange organization. Specifically, the global address list (GAL) that's specified in the user's address book policy controls how recipients are resolved. When the value of this parameter is $true, users that are assigned different GALs appear as external recipients. When the value of this parameter is $false, users that are assigned different GALs appear as internal recipients. The default value is $false. Note that this parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter may take up to 30 minutes to take effect. For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). @@ -140,7 +146,6 @@ The default value is $false. Note that this parameter has no effect if your orga Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -150,6 +155,9 @@ Accept wildcard characters: False ``` ### -AgentGeneratedMessageLoopDetectionInSubmissionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AgentGeneratedMessageLoopDetectionInSubmissionEnabled parameter controls the behavior of messages loop detection in for loops caused by transport agents in the Mailbox Transport Submission service. An agent-generated loop occurs when an agent creates a new copy of a message or adds recipients to a message, and the agent continues to process these resulting messages by creating copies or adding recipients. @@ -162,7 +170,6 @@ When Exchange detects an agent-generated message loop, the loop is stopped. When Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +179,9 @@ Accept wildcard characters: False ``` ### -AgentGeneratedMessageLoopDetectionInSmtpEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AgentGeneratedMessageLoopDetectionInSmtpEnabled parameter controls the behavior of messages loop detection in for loops caused by transport agents in the Transport service. An agent-generated loop occurs when an agent creates a new copy of a message or adds recipients to a message, and the agent continues to process these resulting messages by creating copies or adding recipients. @@ -184,7 +194,6 @@ When Exchange detects an agent-generated message loop, the loop is stopped. When Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +203,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyTLSClients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AllowLegacyTLSClients Description }} @@ -202,7 +214,6 @@ This parameter is available only in the cloud-based service. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -212,13 +223,15 @@ Accept wildcard characters: False ``` ### -ClearCategories + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ClearCategories parameter keeps or removes Microsoft Outlook message categories during content conversion. Valid input for this parameter is $true or $false. The default value is $true. This means that by default, Outlook message categories are removed during content conversion. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -228,6 +241,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -237,7 +253,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -247,6 +262,9 @@ Accept wildcard characters: False ``` ### -ConvertDisclaimerWrapperToEml + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -261,7 +279,6 @@ Valid input for this parameter is $true or $false. The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -271,6 +288,9 @@ Accept wildcard characters: False ``` ### -DiagnosticsAggregationServicePort + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DiagnosticsAggregationServicePort parameter specifies the TCP port that's used to collect message queue diagnostic information. The default value is 9710. @@ -279,7 +299,6 @@ The DiagnosticsAggregationServicePort parameter specifies the TCP port that's us Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,6 +308,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -299,7 +321,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -309,6 +330,9 @@ Accept wildcard characters: False ``` ### -DSNConversionMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The DSNConversionMode parameter controls how Exchange handles delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) that are generated by earlier versions of Exchange or other email systems. Valid values are: - DoNotConvert: DSNs aren't modified. The DSN is delivered as a standard message. @@ -321,7 +345,6 @@ The default value in Exchange 2010 and Exchange 2013 is UseExchangeDSNs. Otherwi Type: DSNConversionOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -331,13 +354,15 @@ Accept wildcard characters: False ``` ### -ExternalDelayDsnEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalDelayDsnEnabled parameter specifies whether a delay delivery status notification (DSN) message should be created for external messages that couldn't be immediately delivered. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -347,13 +372,15 @@ Accept wildcard characters: False ``` ### -ExternalDsnDefaultLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create external DSN messages. The default value is the default Windows server language. ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -363,13 +390,15 @@ Accept wildcard characters: False ``` ### -ExternalDsnLanguageDetectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalDsnLanguageDetectionEnabled parameter specifies whether the server should try to send an external DSN message in the same language as the original message that generated the notification. Valid input for this parameter is $true or $false.The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -379,6 +408,9 @@ Accept wildcard characters: False ``` ### -ExternalDsnMaxMessageAttachSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ExternalDsnMaxMessageAttachSize parameter specifies the maximum size of the original message attached to an external DSN message. If the original message exceeds this size, only the headers of the original message are included in the DSN message. The default value is 10 megabytes (MB). @@ -399,7 +431,6 @@ The valid input range for this parameter is from 0 through 2147483647 bytes. If Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -409,13 +440,15 @@ Accept wildcard characters: False ``` ### -ExternalDsnReportingAuthority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalDsnReportingAuthority parameter specifies the domain in the machine-readable part of external DSN messages. The default value is blank ($null), which means the value is the authoritative domain that you specified during the creation of the organization. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -425,6 +458,9 @@ Accept wildcard characters: False ``` ### -ExternalDsnSendHtml + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalDsnSendHtml parameter specifies whether external DSN messages should be HTML or plain text. Valid values are: - $true: External DSNs are HTML. This is the default value. @@ -434,7 +470,6 @@ The ExternalDsnSendHtml parameter specifies whether external DSN messages should Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -444,6 +479,9 @@ Accept wildcard characters: False ``` ### -ExternalPostmasterAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExternalPostmasterAddress parameter specifies the email address in the From header field of an external DSN message. The default value is blank ($null). The default value means the external postmaster address is `postmaster@` in the following locations: @@ -460,7 +498,6 @@ To override the default behavior, you can specify an email address for the Exter Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -470,6 +507,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -478,7 +518,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -488,6 +527,9 @@ Accept wildcard characters: False ``` ### -GenerateCopyOfDSNFor + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The GenerateCopyOfDSNFor parameter controls the non-delivery reports (NDRs) that are copied to a mailbox by specifying the DSN codes that you want to monitor. You must configure the list of monitored DSNs on one Mailbox server and locally on each Edge Transport server in your Exchange organization. @@ -515,7 +557,6 @@ To assign a mailbox to the Exchange recipient, use the Set-OrganizationConfig cm Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -525,6 +566,9 @@ Accept wildcard characters: False ``` ### -HeaderPromotionModeSetting + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HeaderPromotionModeSetting parameter specifies whether named properties are created for custom X-headers on messages received. Valid values are: - MustCreate: Exchange creates a named property for each new custom X-header. @@ -535,7 +579,6 @@ The HeaderPromotionModeSetting parameter specifies whether named properties are Type: HeaderPromotionMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -545,13 +588,15 @@ Accept wildcard characters: False ``` ### -InternalDelayDsnEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InternalDelayDsnEnabled parameter specifies whether a delay DSN message should be created for messages sent to or from recipients or senders in the same Exchange organization that couldn't be immediately delivered. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -561,13 +606,15 @@ Accept wildcard characters: False ``` ### -InternalDsnDefaultLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create internal DSN messages. The default value is the default Windows server language. ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -577,13 +624,15 @@ Accept wildcard characters: False ``` ### -InternalDsnLanguageDetectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InternalDsnLanguageDetectionEnabled parameter specifies whether the server should try to send an internal DSN message in the same language as the original message that generated the notification. Valid input for this parameter is $true or $false. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -593,6 +642,9 @@ Accept wildcard characters: False ``` ### -InternalDsnMaxMessageAttachSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The InternalDsnMaxMessageAttachSize parameter specifies the maximum size of the original message that generated an internal DSN message. If the original message exceeds this size, only the headers of the original message are included in the DSN message. The default value is 10 MB. @@ -612,7 +664,6 @@ The valid input range for this parameter is from 0 through 2147483647 bytes. If Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -622,13 +673,15 @@ Accept wildcard characters: False ``` ### -InternalDsnReportingAuthority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InternalDsnReportingAuthority parameter specifies the domain in the machine-readable part of internal DSN messages. The default value is blank ($null), which means the value is the authoritative domain that you specified during the creation of the organization. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -638,6 +691,9 @@ Accept wildcard characters: False ``` ### -InternalDsnSendHtml + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InternalDsnSendHtml parameter specifies whether internal DSN messages should be HTML or plain text. Valid values are: - $true: Internal DSNs are HTML. This is the default value. @@ -647,7 +703,6 @@ The InternalDsnSendHtml parameter specifies whether internal DSN messages should Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -657,6 +712,9 @@ Accept wildcard characters: False ``` ### -InternalSMTPServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The InternalSMTPServers parameter specifies a list of internal SMTP server IP addresses or IP address ranges that should be ignored by Sender ID and connection filtering. @@ -669,7 +727,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -679,6 +736,9 @@ Accept wildcard characters: False ``` ### -JournalMessageExpirationDays + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The JournalMessageExpirationDays parameter extends the number of days that undeliverable journal reports are queued before they expire. A valid value is an integer from 0 to 7. The default value is 0, which means undeliverable journal reports are treated like regular undeliverable messages. @@ -687,7 +747,6 @@ The JournalMessageExpirationDays parameter extends the number of days that undel Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -697,13 +756,15 @@ Accept wildcard characters: False ``` ### -JournalingReportNdrTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The JournalingReportNdrTo parameter specifies the email address to which journal reports are sent if the journaling mailbox is unavailable. By default, if this parameter is left empty, Exchange continues to try to deliver the journal report to the journaling mailbox. We recommended that you use a dedicated (non-user) mailbox as the value for this parameter. Like the journaling mailbox, the alternate journaling mailbox can't be an Exchange Online mailbox. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -713,6 +774,9 @@ Accept wildcard characters: False ``` ### -LegacyJournalingMigrationEnabled + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The LegacyJournalingMigrationEnabled parameter specifies whether journal messages generated in Microsoft Exchange Server 2003 will be reformatted by Exchange 2010. @@ -723,7 +787,6 @@ The default value is $false. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -733,6 +796,9 @@ Accept wildcard characters: False ``` ### -MaxAllowedAgentGeneratedMessageDepth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxAllowedAgentGeneratedMessageDepth parameter specifies how many times all agents can process any resulting copies of the same message. The default value is 3. Valid input for this parameter is an integer. @@ -741,7 +807,6 @@ The MaxAllowedAgentGeneratedMessageDepth parameter specifies how many times all Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -751,6 +816,9 @@ Accept wildcard characters: False ``` ### -MaxAllowedAgentGeneratedMessageDepthPerAgent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxAllowedAgentGeneratedMessageDepthPerAgent parameter specifies how many times a single agent can process any resulting copies of the same message. The default value is 2. @@ -761,7 +829,6 @@ The value of the MaxAllowedAgentGeneratedMessageDepth parameter should be larger Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -771,6 +838,9 @@ Accept wildcard characters: False ``` ### -MaxDumpsterSizePerDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. @@ -795,7 +865,6 @@ There's no replacement for this parameter in later versions of Exchange. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -805,6 +874,9 @@ Accept wildcard characters: False ``` ### -MaxDumpsterTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. @@ -823,7 +895,6 @@ This parameter is replaced by the SafetyNetHoldTime parameter. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -833,6 +904,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxReceiveSize parameter specifies the maximum message size that can be received by recipients in the organization. The default value is 10 MB. @@ -856,7 +930,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -866,6 +939,9 @@ Accept wildcard characters: False ``` ### -MaxRecipientEnvelopeLimit + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The MaxRecipientEnvelopeLimit parameter specifies the maximum number of recipients in a message. Exchange treats an unexpanded distribution group as one recipient. In on-premises Exchange, the default value is 500. The valid input range for this parameter is from 0 through 2147483647. If you enter a value of Unlimited, no limit is imposed on the number of recipients in a message. @@ -876,7 +952,6 @@ In Exchange Online, the default value is Unlimited, which means the organization Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -886,6 +961,9 @@ Accept wildcard characters: False ``` ### -MaxRetriesForLocalSiteShadow + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxRetriesForLocalSiteShadow parameter specifies the maximum number of attempts to make a shadow copy of the message in the local Active Directory site. Valid input for this parameter is an integer between 0 and 255. The default value is 2. The total number of attempts to create a shadow copy of the message is controlled by the ShadowMessagePreferenceSetting parameter: @@ -900,7 +978,6 @@ If a shadow copy of the message isn't created after the specified number of atte Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -910,6 +987,9 @@ Accept wildcard characters: False ``` ### -MaxRetriesForRemoteSiteShadow + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxRetriesForRemoteSiteShadow parameter specifies the maximum number of attempts to make a shadow copy of the message in a different Active Directory site. Valid input for this parameter is an integer between 0 and 255. The default value is 4. The total number of attempts to create a shadow copy of the message is controlled by the ShadowMessagePreferenceSetting parameter: @@ -924,7 +1004,6 @@ If a shadow copy of the message isn't created after the specified number of atte Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -934,6 +1013,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MaxSendSize parameter specifies the maximum message size that can be sent by senders in the organization. The default value is 10 MB. @@ -957,7 +1039,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -967,6 +1048,9 @@ Accept wildcard characters: False ``` ### -MessageExpiration + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MessageExpiration parameter specifies the message expiration timeout interval for the organization. @@ -983,7 +1067,6 @@ Queued messages typically expire after 24 hours, resulting in an NDR for failed Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -993,6 +1076,9 @@ Accept wildcard characters: False ``` ### -PreventDuplicateJournalingEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The PreventDuplicateJournalingEnabled parameter prevents duplicate journaling reports that can occur when messages are processed by both on-premises and cloud journaling agents. Valid values are: @@ -1004,7 +1090,6 @@ The PreventDuplicateJournalingEnabled parameter prevents duplicate journaling re Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1014,6 +1099,9 @@ Accept wildcard characters: False ``` ### -QueueDiagnosticsAggregationInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The QueueDiagnosticsAggregationInterval parameter specifies the polling interval that's used to retrieve message queue diagnostic information. The default value is 00:01:00 or one minute. @@ -1024,7 +1112,6 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1034,6 +1121,9 @@ Accept wildcard characters: False ``` ### -RejectMessageOnShadowFailure + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The RejectMessageOnShadowFailure parameter specifies whether to accept or reject messages when shadow copies of the messages can't be created. Valid values are: @@ -1047,7 +1137,6 @@ The number of attempts to make a shadow copy of the message and where to make th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1057,6 +1146,9 @@ Accept wildcard characters: False ``` ### -ReplyAllStormBlockDurationHours + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ReplyAllStormBlockDurationHours Description }} @@ -1065,7 +1157,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1075,6 +1166,9 @@ Accept wildcard characters: False ``` ### -ReplyAllStormDetectionMinimumRecipients + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ReplyAllStormDetectionMinimumRecipients Description }} @@ -1083,7 +1177,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1093,6 +1186,9 @@ Accept wildcard characters: False ``` ### -ReplyAllStormDetectionMinimumReplies + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ReplyAllStormDetectionMinimumReplies Description }} @@ -1101,7 +1197,6 @@ This parameter is available only in the cloud-based service. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1111,6 +1206,9 @@ Accept wildcard characters: False ``` ### -ReplyAllStormProtectionEnabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill ReplyAllStormProtectionEnabled Description }} @@ -1119,7 +1217,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1129,13 +1226,15 @@ Accept wildcard characters: False ``` ### -Rfc2231EncodingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Rfc2231EncodingEnabled parameter specifies whether the RFC 2231 encoding of MIME parameters for outbound messages is enabled in your organization. Valid input for this parameter is $true or $false. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1145,6 +1244,9 @@ Accept wildcard characters: False ``` ### -SafetyNetHoldTime + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SafetyNetHoldTime parameter specifies how long a copy of a successfully processed message is retained in Safety Net. Unacknowledged shadow copies of messages auto-expire from Safety Net based on adding the values of the SafetyNetHoldTime parameter and the MessageExpirationTimeout parameter on the Set-TransportService cmdlet. @@ -1157,7 +1259,6 @@ The default value is 2.00:00:00 or 2 days. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1167,6 +1268,9 @@ Accept wildcard characters: False ``` ### -ShadowHeartbeatFrequency + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ShadowHeartbeatFrequency parameter specifies the amount of time a server waits before establishing a connection to a primary server to query the discard status of shadow messages. @@ -1179,7 +1283,6 @@ Valid input for this parameter is 00:00:01 to 1.00:00:00. The default value is 0 Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1189,6 +1292,9 @@ Accept wildcard characters: False ``` ### -ShadowHeartbeatRetryCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. @@ -1201,7 +1307,6 @@ This parameter is replaced by the ShadowResubmitTimeSpan parameter. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1211,6 +1316,9 @@ Accept wildcard characters: False ``` ### -ShadowHeartbeatTimeoutInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. @@ -1227,7 +1335,6 @@ This parameter is replaced by the ShadowHeartbeatFrequency parameter. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1237,6 +1344,9 @@ Accept wildcard characters: False ``` ### -ShadowMessageAutoDiscardInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ShadowMessageAutoDiscardInterval parameter specifies how long a server retains discard events for shadow messages. A primary server queues discard events until queried by the shadow server. However, if the shadow server doesn't query the primary server for the duration specified in this parameter, the primary server deletes the queued discard events. @@ -1249,7 +1359,6 @@ Valid input for this parameter is 00:00:05 to 90.00:00:00. The default value is Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1259,6 +1368,9 @@ Accept wildcard characters: False ``` ### -ShadowMessagePreferenceSetting + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ShadowMessagePreferenceSetting parameter specifies the preferred location for making a shadow copy of a message. Valid values are: @@ -1273,7 +1385,6 @@ The default value is PreferRemote. Type: ShadowMessagePreference Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1283,6 +1394,9 @@ Accept wildcard characters: False ``` ### -ShadowRedundancyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ShadowRedundancyEnabled parameter specifies whether shadow redundancy is enabled in the organization. Valid input for this parameter is $true or $false. The default value is $true. @@ -1291,7 +1405,6 @@ The ShadowRedundancyEnabled parameter specifies whether shadow redundancy is ena Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1301,6 +1414,9 @@ Accept wildcard characters: False ``` ### -ShadowResubmitTimeSpan + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ShadowResubmitTimeSpan parameter specifies amount of time a server waits before deciding that a primary server has failed and assumes ownership of shadow messages in the shadow queue for the primary server that's unreachable. @@ -1315,7 +1431,6 @@ This parameter replaces the ShadowHeartbeatRetryCount parameter. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1325,6 +1440,9 @@ Accept wildcard characters: False ``` ### -SmtpClientAuthenticationDisabled + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SmtpClientAuthenticationDisabled parameter specifies whether to disable authenticated SMTP (SMTP AUTH) for the whole organization. Examples of clients and services that require authenticated SMTP to send email messages include: @@ -1347,7 +1465,6 @@ To selectively enable authenticated SMTP for specific mailboxes only: disable au Type: Boolean Parameter Sets: Exchange Online Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -1357,6 +1474,9 @@ Accept wildcard characters: False ``` ### -SupervisionTags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SupervisionTags parameter specifies the various tags that are used for transport supervision in the organization. @@ -1367,7 +1487,6 @@ When you install Exchange, two tags, Allow and Reject, are created by default. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1377,6 +1496,9 @@ Accept wildcard characters: False ``` ### -TLSReceiveDomainSecureList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The TLSReceiveDomainSecureList parameter specifies the domains from which you want to receive domain secured email by using mutual Transport Layer Security (TLS) authentication. To fully support mutual TLS authentication, you must also perform the following steps: @@ -1395,7 +1517,6 @@ The wildcard character (\*) isn't supported in the domains listed in the TLSRece Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1405,6 +1526,9 @@ Accept wildcard characters: False ``` ### -TLSSendDomainSecureList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The TLSSendDomainSecureList parameter specifies the domains from which you want to send domain secured email by using mutual TLS authentication. To fully support mutual TLS authentication, you must also perform the following steps: @@ -1423,7 +1547,6 @@ Multiple domains may be separated by commas. The wildcard character (\*) isn't s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1433,6 +1556,9 @@ Accept wildcard characters: False ``` ### -TransportRuleAttachmentTextScanLimit + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The TransportRuleAttachmentTextScanLimit parameter specifies the maximum size of text to extract from attachments for scanning by attachment scanning predicates in transport rules and data loss prevention (DLP) policies. @@ -1454,7 +1580,6 @@ If the amount of text in the attachment is larger than the value of this paramet Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1464,6 +1589,9 @@ Accept wildcard characters: False ``` ### -VerifySecureSubmitEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The VerifySecureSubmitEnabled parameter verifies that email clients submitting messages from mailboxes on Mailbox servers are using encrypted MAPI submission. The valid values for this parameter are $true or $false. The default value is $false @@ -1476,7 +1604,6 @@ If the VerifySecureSubmitEnabled parameter is set to $false, all MAPI message su Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1486,6 +1613,9 @@ Accept wildcard characters: False ``` ### -VoicemailJournalingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in on-premises Exchange. The VoicemailJournalingEnabled parameter specifies whether Unified Messaging voice mail messages are journaled by the Journaling agent. Valid input for this parameter is $true or $false. The default value is $true. @@ -1494,7 +1624,6 @@ The VoicemailJournalingEnabled parameter specifies whether Unified Messaging voi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1504,13 +1633,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1520,6 +1651,9 @@ Accept wildcard characters: False ``` ### -Xexch50Enabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Xexch50Enabled parameter specifies whether Xexch50 authentication should be enabled for backward compatibility with computers running Exchange 2003. Valid input for this parameter is $true or $false. The default value is $true. @@ -1528,7 +1662,6 @@ The Xexch50Enabled parameter specifies whether Xexch50 authentication should be Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-TransportRule.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-TransportRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TransportRule.md index a3b87868a6..4f707e0ab4 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TransportRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-TransportRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-transportrule +schema: 2.0.0 +title: Set-TransportRule --- # Set-TransportRule @@ -225,6 +226,9 @@ This example modifies the existing rule named Sales Team Disclaimer transport ru ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - Name @@ -235,7 +239,6 @@ The Identity parameter specifies the rule that you want to modify. You can use a Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -245,6 +248,9 @@ Accept wildcard characters: False ``` ### -ActivationDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + 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". @@ -253,7 +259,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -263,6 +268,9 @@ Accept wildcard characters: False ``` ### -ADComparisonAttribute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -305,7 +313,6 @@ If you don't use the ADComparisonOperator parameter, the default comparison oper Type: ADAttribute Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -315,6 +322,9 @@ Accept wildcard characters: False ``` ### -ADComparisonOperator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -328,7 +338,6 @@ The ADComparisonOperator parameter specifies the comparison operator for the ADC Type: Evaluation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -338,6 +347,9 @@ Accept wildcard characters: False ``` ### -AddManagerAsRecipientType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -355,7 +367,6 @@ This action only works if the sender's Manager attribute is defined. Type: AddedRecipientType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -365,6 +376,9 @@ Accept wildcard characters: False ``` ### -AddToRecipients + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -384,7 +398,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -394,6 +407,9 @@ Accept wildcard characters: False ``` ### -AnyOfCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -417,7 +433,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -427,6 +442,9 @@ Accept wildcard characters: False ``` ### -AnyOfCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -450,7 +468,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -460,6 +477,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -474,7 +494,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -484,6 +503,9 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -498,7 +520,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,6 +529,9 @@ Accept wildcard characters: False ``` ### -AnyOfToCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -531,7 +555,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -541,6 +564,9 @@ Accept wildcard characters: False ``` ### -AnyOfToCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -564,7 +590,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -574,6 +599,9 @@ Accept wildcard characters: False ``` ### -AnyOfToHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -597,7 +625,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -607,6 +634,9 @@ Accept wildcard characters: False ``` ### -AnyOfToHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -630,7 +660,6 @@ A match for this condition applies the rule action to all recipients of the mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -640,6 +669,9 @@ Accept wildcard characters: False ``` ### -ApplyClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -652,7 +684,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -662,6 +693,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerFallbackAction + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -685,7 +719,6 @@ If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the Type: DisclaimerFallbackAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -695,6 +728,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -710,7 +746,6 @@ If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the Type: DisclaimerLocation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -720,6 +755,9 @@ Accept wildcard characters: False ``` ### -ApplyHtmlDisclaimerText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -760,7 +798,6 @@ You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the Type: DisclaimerText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -770,6 +807,9 @@ Accept wildcard characters: False ``` ### -ApplyOME + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -783,7 +823,6 @@ The ApplyOME parameter specifies an action that encrypts messages and their atta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -793,6 +832,9 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionCustomizationTemplate + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -803,7 +845,6 @@ The ApplyRightsProtectionCustomizationTemplate parameter specifies an action tha Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -813,6 +854,9 @@ Accept wildcard characters: False ``` ### -ApplyRightsProtectionTemplate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -829,7 +873,6 @@ For more information, see [Transport protection rules](https://learn.microsoft.c Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -839,6 +882,9 @@ Accept wildcard characters: False ``` ### -AttachmentContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -851,7 +897,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -861,6 +906,9 @@ Accept wildcard characters: False ``` ### -AttachmentExtensionMatchesWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -873,7 +921,6 @@ The AttachmentExtensionMatchesWords parameter specifies a condition that looks f Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -883,6 +930,9 @@ Accept wildcard characters: False ``` ### -AttachmentHasExecutableContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -898,7 +948,6 @@ The system inspects the file properties rather than relying on the file extensio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -908,6 +957,9 @@ Accept wildcard characters: False ``` ### -AttachmentIsPasswordProtected + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -921,7 +973,6 @@ The AttachmentIsPasswordProtected parameter specifies a condition that looks for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -931,6 +982,9 @@ Accept wildcard characters: False ``` ### -AttachmentIsUnsupported + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -950,7 +1004,6 @@ In Exchange 2010, to extend the list of supported file types, see [Register Filt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -960,6 +1013,9 @@ Accept wildcard characters: False ``` ### -AttachmentMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -974,7 +1030,6 @@ Only the first 150 kilobytes (KB) of the attachment is scanned when trying to ma Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -984,6 +1039,9 @@ Accept wildcard characters: False ``` ### -AttachmentNameMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -994,7 +1052,6 @@ The AttachmentNameMatchesPatterns parameter specifies a condition that looks for Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1004,6 +1061,9 @@ Accept wildcard characters: False ``` ### -AttachmentProcessingLimitExceeded + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1019,7 +1079,6 @@ You use this condition to create rules that work together with other attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1029,6 +1088,9 @@ Accept wildcard characters: False ``` ### -AttachmentPropertyContainsWords + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1058,7 +1120,6 @@ When you specify multiple properties, or multiple values for the same property, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1068,6 +1129,9 @@ Accept wildcard characters: False ``` ### -AttachmentSizeOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -1090,7 +1154,6 @@ The embedded images are treated as attachments (for example, messages with a pic Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1100,6 +1163,9 @@ Accept wildcard characters: False ``` ### -BetweenMemberOf1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1119,7 +1185,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1129,6 +1194,9 @@ Accept wildcard characters: False ``` ### -BetweenMemberOf2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1148,7 +1216,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1158,6 +1225,9 @@ Accept wildcard characters: False ``` ### -BlindCopyTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1177,7 +1247,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1187,13 +1256,15 @@ Accept wildcard characters: False ``` ### -Comments + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Comments parameter specifies optional descriptive text for the rule (for example, what the rule is used for, or how it has changed over time). The length of the comment can't exceed 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1203,6 +1274,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -1212,7 +1286,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1222,6 +1295,9 @@ Accept wildcard characters: False ``` ### -ContentCharacterSetContainsWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -1234,7 +1310,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1244,6 +1319,9 @@ Accept wildcard characters: False ``` ### -CopyTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1263,7 +1341,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1273,6 +1350,9 @@ Accept wildcard characters: False ``` ### -DeleteMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -1286,7 +1366,6 @@ The DeleteMessage parameter specifies an action that silently drops messages wit Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1296,6 +1375,9 @@ Accept wildcard characters: False ``` ### -Disconnect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -1309,7 +1391,6 @@ The Disconnect parameter specifies an action that ends the SMTP connection betwe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1319,6 +1400,9 @@ Accept wildcard characters: False ``` ### -DlpPolicy + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note**: This parameter is functional only in on-premises Exchange. The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see [Data loss prevention in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). @@ -1327,7 +1411,6 @@ The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's a Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1337,6 +1420,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -1347,7 +1433,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1357,6 +1442,9 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonAttribute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1399,7 +1487,6 @@ If you don't use the ExceptIfADComparisonOperator parameter, the default compari Type: ADAttribute Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1409,6 +1496,9 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonOperator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1422,7 +1512,6 @@ The ExceptIfADComparisonOperator parameter specifies the comparison operator for Type: Evaluation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1432,6 +1521,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1455,7 +1547,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1465,6 +1556,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1488,7 +1582,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1498,6 +1591,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1512,7 +1608,6 @@ A match for this exception prevents the rule action from being applied to all re Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1522,6 +1617,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1536,7 +1634,6 @@ A match for this exception prevents the rule action from being applied to all re Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1546,6 +1643,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1569,7 +1669,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1579,6 +1678,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1602,7 +1704,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1612,6 +1713,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1635,7 +1739,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1645,6 +1748,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeaderMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1668,7 +1774,6 @@ A match for this exception prevents the rule action from being applied to all re Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1678,6 +1783,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1690,7 +1798,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1700,6 +1807,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentExtensionMatchesWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1712,7 +1822,6 @@ The ExceptIfAttachmentExtensionMatchesWords parameter specifies an exception tha Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1722,6 +1831,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentHasExecutableContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1737,7 +1849,6 @@ The system inspects the file properties rather than relying on the file extensio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1747,6 +1858,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsPasswordProtected + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1760,7 +1874,6 @@ The ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1770,6 +1883,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsUnsupported + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1789,7 +1905,6 @@ In Exchange 2010, to extend the list of supported file types, see [Register Filt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1799,6 +1914,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1813,7 +1931,6 @@ Only the first 150 KB of the attachment is scanned when trying to match a text p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1823,6 +1940,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentNameMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1833,7 +1953,6 @@ The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1843,6 +1962,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentProcessingLimitExceeded + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1858,7 +1980,6 @@ You use this exception to create rules that work together with other attachment Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1868,6 +1989,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentPropertyContainsWords + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1897,7 +2021,6 @@ When you specify multiple properties, or multiple values for the same property, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1907,6 +2030,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentSizeOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1927,7 +2053,6 @@ Unqualified values are typically treated as bytes, but small values may be round Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1937,6 +2062,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf1 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1956,7 +2084,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1966,6 +2093,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf2 + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -1985,7 +2115,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1995,6 +2124,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2007,7 +2139,6 @@ To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phr Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2017,6 +2148,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2038,7 +2172,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2048,6 +2181,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2060,7 +2196,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2070,6 +2205,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2084,7 +2222,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2094,6 +2231,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2115,7 +2255,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2125,6 +2264,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2138,7 +2280,6 @@ The ExceptIfFromScope parameter specifies an exception that looks for the locati Type: FromUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2148,6 +2289,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2164,7 +2308,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2174,6 +2317,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasNoClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2187,7 +2333,6 @@ The ExceptIfHasNoClassification parameter specifies an exception that looks for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2197,6 +2342,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. @@ -2212,7 +2360,6 @@ The ExceptIfHasSenderOverride parameter specifies an exception that looks for me Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2222,6 +2369,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2232,7 +2382,6 @@ The ExceptIfHeaderContainsMessageHeader parameter specifies the name of header f Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2242,6 +2391,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2256,7 +2408,6 @@ You specify the header field to search by using the ExceptIfHeaderContainsMessag Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2266,6 +2417,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2276,7 +2430,6 @@ The ExceptIfHeaderMatchesMessageHeader parameter specifies the name of header fi Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2286,6 +2439,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2298,7 +2454,6 @@ You specify the header field to search by using the ExceptIfHeaderMatchesMessage Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2308,6 +2463,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2329,7 +2487,6 @@ You specify if you want to look for these users as managers of senders or recipi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2339,6 +2496,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerForEvaluatedUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2354,7 +2514,6 @@ You specify the users to look for by using the ExceptIfManagerAddresses paramete Type: EvaluatedUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2364,6 +2523,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageContainsDataClassifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. @@ -2380,7 +2542,6 @@ For a list of sensitive information types available, see [Sensitive information Type: Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -2390,6 +2551,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2410,7 +2574,6 @@ Unqualified values are typically treated as bytes, but small values may be round Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2420,6 +2583,9 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2440,7 +2606,6 @@ The ExceptIfMessageTypeMatches parameter specifies an exception that looks for m Type: MessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2450,6 +2615,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2496,7 +2664,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2506,6 +2673,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2550,7 +2720,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2560,6 +2729,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2570,7 +2742,6 @@ The ExceptIfRecipientAddressContainsWords parameter specifies an exception that Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2580,6 +2751,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2592,7 +2766,6 @@ This parameter works when the recipient is an individual user. This parameter do Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2602,6 +2775,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2614,7 +2790,6 @@ This exception matches domains and subdomains. For example, "contoso.com" matche Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2624,6 +2799,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientInSenderList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2632,7 +2810,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2642,6 +2819,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2657,7 +2837,6 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2667,6 +2846,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2713,7 +2895,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2723,6 +2904,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2767,7 +2951,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2777,6 +2960,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2791,7 +2977,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2801,6 +2986,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderInRecipientList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -2809,7 +2997,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2819,6 +3006,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIpRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2837,7 +3027,6 @@ In Exchange Online, the IP address that's used during evaluation of this excepti Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2847,6 +3036,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderManagementRelationship + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2860,7 +3052,6 @@ The ExceptIfSenderManagementRelationship parameter specifies an exception that l Type: ManagementRelationship Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2870,6 +3061,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2889,7 +3083,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2899,6 +3092,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: @@ -2916,7 +3112,6 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2926,6 +3121,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -2941,7 +3139,6 @@ The ExceptIfSentToScope parameter specifies an exception that looks for the loca Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2951,6 +3148,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2965,7 +3165,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2975,6 +3174,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2985,7 +3187,6 @@ The ExceptIfSubjectMatchesPatterns parameter specifies an exception that looks f Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2995,6 +3196,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3009,7 +3213,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3019,6 +3222,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -3029,7 +3235,6 @@ The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception that l Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3039,6 +3244,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available only on Mailbox servers. @@ -3053,7 +3261,6 @@ The ExceptIfWithImportance parameter specifies an exception that looks for messa Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3063,6 +3270,9 @@ Accept wildcard characters: False ``` ### -ExpiryDate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. @@ -3073,7 +3283,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3083,6 +3292,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3104,7 +3316,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3114,6 +3325,9 @@ Accept wildcard characters: False ``` ### -FromAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3126,7 +3340,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3136,6 +3349,9 @@ Accept wildcard characters: False ``` ### -FromAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3150,7 +3366,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3160,6 +3375,9 @@ Accept wildcard characters: False ``` ### -FromMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3181,7 +3399,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3191,6 +3408,9 @@ Accept wildcard characters: False ``` ### -FromScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3204,7 +3424,6 @@ The FromScope parameter specifies a condition that looks for the location of mes Type: FromUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3214,6 +3433,9 @@ Accept wildcard characters: False ``` ### -GenerateIncidentReport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -3233,7 +3455,6 @@ The GenerateIncidentReport parameter specifies where to send the incident report Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3243,6 +3464,9 @@ Accept wildcard characters: False ``` ### -GenerateNotification + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -3264,7 +3488,6 @@ The maximum number of characters is 5120. Type: DisclaimerText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3274,6 +3497,9 @@ Accept wildcard characters: False ``` ### -HasClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3290,7 +3516,6 @@ The message classification referred to in this parameter is the custom message c Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3300,6 +3525,9 @@ Accept wildcard characters: False ``` ### -HasNoClassification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3313,7 +3541,6 @@ The HasNoClassification parameter specifies a condition that looks for messages Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3323,6 +3550,9 @@ Accept wildcard characters: False ``` ### -HasSenderOverride + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. @@ -3338,7 +3568,6 @@ The HasSenderOverride parameter specifies a condition that looks for messages wh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3348,6 +3577,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3358,7 +3590,6 @@ The HeaderContainsMessageHeader parameter specifies the name of header field in Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3368,6 +3599,9 @@ Accept wildcard characters: False ``` ### -HeaderContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3382,7 +3616,6 @@ You specify the header field to search by using the HeaderContainsMessageHeader Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3392,6 +3625,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesMessageHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3402,7 +3638,6 @@ The HeaderMatchesMessageHeader parameter specifies the name of header field in t Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3412,6 +3647,9 @@ Accept wildcard characters: False ``` ### -HeaderMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3424,7 +3662,6 @@ You specify the header field to search by using the HeaderMatchesMessageHeader p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3434,6 +3671,9 @@ Accept wildcard characters: False ``` ### -IncidentReportContent + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -3461,7 +3701,6 @@ You use this parameter with the GenerateIncidentReport parameter. Type: IncidentReportContent[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3471,6 +3710,9 @@ Accept wildcard characters: False ``` ### -IncidentReportOriginalMail + +> Applicable: Exchange Server 2013 + This parameter is available only in Exchange Server 2013. This parameter has been deprecated and is no longer used. Use the IncidentReportContent parameter instead. The value AttachOriginalMail on the IncidentReportContent parameter is equivalent to setting this parameter to the value IncludeOriginalMail. @@ -3488,7 +3730,6 @@ The IncidentReportOriginalMail parameter specifies whether to include the origin Type: IncidentReportOriginalMail Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 Required: False Position: Named @@ -3498,6 +3739,9 @@ Accept wildcard characters: False ``` ### -LogEventText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -3516,7 +3760,6 @@ The entry contains the following information: Type: EventLogText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3526,6 +3769,9 @@ Accept wildcard characters: False ``` ### -ManagerAddresses + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3547,7 +3793,6 @@ You specify if you want to look for these users as managers of senders or recipi Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3557,6 +3802,9 @@ Accept wildcard characters: False ``` ### -ManagerForEvaluatedUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3572,7 +3820,6 @@ You specify the users to look for by using the ManagerAddresses parameter. Type: EvaluatedUser Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3582,6 +3829,9 @@ Accept wildcard characters: False ``` ### -MessageContainsDataClassifications + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. @@ -3600,7 +3850,6 @@ You can specify the notification options by using the NotifySender parameter. Type: Hashtable[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3610,6 +3859,9 @@ Accept wildcard characters: False ``` ### -MessageSizeOver + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -3630,7 +3882,6 @@ Unqualified values are typically treated as bytes, but small values may be round Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3640,6 +3891,9 @@ Accept wildcard characters: False ``` ### -MessageTypeMatches + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3660,7 +3914,6 @@ The MessageTypeMatches parameter specifies a condition that looks for messages o Type: MessageType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3670,6 +3923,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Mode parameter specifies how the rule operates. Valid values are: - Audit: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport action occurs. @@ -3680,7 +3936,6 @@ The Mode parameter specifies how the rule operates. Valid values are: Type: RuleMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3690,6 +3945,9 @@ Accept wildcard characters: False ``` ### -ModerateMessageByManager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -3705,7 +3963,6 @@ This action only works if the sender's Manager attribute is defined. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3715,6 +3972,9 @@ Accept wildcard characters: False ``` ### -ModerateMessageByUser + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -3736,7 +3996,6 @@ You can't use a distribution group as a moderator. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3746,13 +4005,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the display name of the transport rule to be created. The length of the name canThe Name parameter specifies the unique name of the rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3762,6 +4023,9 @@ Accept wildcard characters: False ``` ### -NotifySender + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + **Note:** This parameter is functional only in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -3786,7 +4050,6 @@ This action is applicable to messages sent by internal users only. External send Type: NotifySenderType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -3796,6 +4059,9 @@ Accept wildcard characters: False ``` ### -PrependSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -3808,7 +4074,6 @@ Consider ending the value for this parameter with a colon (:) and a space, or at Type: SubjectPrefix Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3818,6 +4083,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules: @@ -3832,7 +4100,6 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3842,6 +4109,9 @@ Accept wildcard characters: False ``` ### -Quarantine + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Edge Transport servers. @@ -3857,7 +4127,6 @@ If this action is in a rule that's not the last rule in the list, rule evaluatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3867,6 +4136,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3913,7 +4185,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3923,6 +4194,9 @@ Accept wildcard characters: False ``` ### -RecipientADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3967,7 +4241,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3977,6 +4250,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -3987,7 +4263,6 @@ The RecipientAddressContainsWords parameter specifies a condition that looks for Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3997,6 +4272,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4009,7 +4287,6 @@ This parameter works when the recipient is an individual user. This parameter do Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4019,6 +4296,9 @@ Accept wildcard characters: False ``` ### -RecipientAddressType + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RecipientAddressType parameter specifies how conditions and exceptions check recipient email addresses. Valid values are: @@ -4030,7 +4310,6 @@ The RecipientAddressType parameter specifies how conditions and exceptions check Type: RecipientAddressType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4040,6 +4319,9 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4052,7 +4334,6 @@ This condition matches domains and subdomains. For example, "contoso.com" matche Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4062,6 +4343,9 @@ Accept wildcard characters: False ``` ### -RecipientInSenderList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -4070,7 +4354,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4080,6 +4363,9 @@ Accept wildcard characters: False ``` ### -RedirectMessageTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4099,7 +4385,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4109,6 +4394,9 @@ Accept wildcard characters: False ``` ### -RejectMessageEnhancedStatusCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -4125,7 +4413,6 @@ To further customize the NDR (for example, multiple languages), you need to crea Type: RejectEnhancedStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4135,6 +4422,9 @@ Accept wildcard characters: False ``` ### -RejectMessageReasonText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -4155,7 +4445,6 @@ To further customize the NDR (for example, multiple languages), you need to crea Type: RejectText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4165,6 +4454,9 @@ Accept wildcard characters: False ``` ### -RemoveHeader + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4175,7 +4467,6 @@ The RemoveHeader parameter specifies an action that removes a header field from Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4185,6 +4476,9 @@ Accept wildcard characters: False ``` ### -RemoveOME + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4198,7 +4492,6 @@ The RemoveOME parameter specifies an action that removes the previous version of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4208,6 +4501,9 @@ Accept wildcard characters: False ``` ### -RemoveOMEv2 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4221,7 +4517,6 @@ The RemoveOMEv2 parameter specifies an action that removes Office 365 Message En Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4231,6 +4526,9 @@ Accept wildcard characters: False ``` ### -RemoveRMSAttachmentEncryption + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4246,7 +4544,6 @@ The RemoveRMSAttachmentEncryption parameter specifies an action that removes Mic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4256,6 +4553,9 @@ Accept wildcard characters: False ``` ### -RouteMessageOutboundConnector + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. @@ -4270,7 +4570,6 @@ The RouteMessageOutboundConnector parameter specifies an action that routes mess Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4280,6 +4579,9 @@ Accept wildcard characters: False ``` ### -RouteMessageOutboundRequireTls + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -4293,7 +4595,6 @@ The RouteMessageOutboundRequireTls parameter specifies an action that uses Trans Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4303,6 +4604,9 @@ Accept wildcard characters: False ``` ### -RuleErrorAction + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RuleErrorAction parameter specifies what to do if rule processing can't be completed on messages. Valid values are: - Ignore: The message is sent anyway. This is the default value. @@ -4312,7 +4616,6 @@ The RuleErrorAction parameter specifies what to do if rule processing can't be c Type: RuleErrorAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4322,6 +4625,9 @@ Accept wildcard characters: False ``` ### -RuleSubType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RuleSubType parameter specifies the rule type. Valid values are: - Dlp: The rule is associated with a DLP policy. This value is meaningful only in on-premises Exchange. @@ -4331,7 +4637,6 @@ The RuleSubType parameter specifies the rule type. Valid values are: Type: RuleSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4341,6 +4646,9 @@ Accept wildcard characters: False ``` ### -SCLOver + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4356,7 +4664,6 @@ The rule looks for messages with an SCL value that's greater than or equal to th Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4366,6 +4673,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4412,7 +4722,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4422,6 +4731,9 @@ Accept wildcard characters: False ``` ### -SenderADAttributeMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4466,7 +4778,6 @@ When you specify multiple attributes, or multiple values for the same attribute, Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4476,6 +4787,9 @@ Accept wildcard characters: False ``` ### -SenderAddressLocation + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: - Header: Only examine senders in the message headers. For example, in on-premises Exchange the the From, Sender, or Reply-To fields. In Exchange Online, the From field only. This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). @@ -4494,7 +4808,6 @@ Message envelope searching is available only for the following conditions and ex Type: SenderAddressLocation Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4504,6 +4817,9 @@ Accept wildcard characters: False ``` ### -SenderDomainIs + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4518,7 +4834,6 @@ You can use SenderAddressLocation parameter to specify where to look for the sen Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4528,6 +4843,9 @@ Accept wildcard characters: False ``` ### -SenderInRecipientList + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -4536,7 +4854,6 @@ This parameter is reserved for internal Microsoft use. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4546,6 +4863,9 @@ Accept wildcard characters: False ``` ### -SenderIpRanges + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4564,7 +4884,6 @@ In Exchange Online, the IP address that's used during evaluation of this conditi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4574,6 +4893,9 @@ Accept wildcard characters: False ``` ### -SenderManagementRelationship + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4587,7 +4909,6 @@ The SenderManagementRelationship parameter specifies a condition that looks for Type: ManagementRelationship Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4597,6 +4918,9 @@ Accept wildcard characters: False ``` ### -SentTo + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4616,7 +4940,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4626,6 +4949,9 @@ Accept wildcard characters: False ``` ### -SentToMemberOf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4647,7 +4973,6 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4657,6 +4982,9 @@ Accept wildcard characters: False ``` ### -SentToScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4672,7 +5000,6 @@ The SentToScope parameter specifies a condition that looks for the location of r Type: ToUserScope Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4682,6 +5009,9 @@ Accept wildcard characters: False ``` ### -SetAuditSeverity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available only on Mailbox servers. @@ -4697,7 +5027,6 @@ The SetAuditSeverity parameter specifies an action that sets the severity level Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4707,6 +5036,9 @@ Accept wildcard characters: False ``` ### -SetHeaderName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4717,7 +5049,6 @@ The SetHeaderName parameter specifies an action that adds or modifies a header f Type: HeaderName Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4727,6 +5058,9 @@ Accept wildcard characters: False ``` ### -SetHeaderValue + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4737,7 +5071,6 @@ The SetHeaderValue parameter specifies an action that adds or modifies a header Type: HeaderValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4747,6 +5080,9 @@ Accept wildcard characters: False ``` ### -SetSCL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4760,7 +5096,6 @@ The SetSCL parameter specifies an action that adds or modifies the SCL value of Type: SclValue Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4770,6 +5105,9 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectStatusCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4782,7 +5120,6 @@ You can use this parameter with the SmtpRejectMessageRejectText parameter. If yo Type: RejectStatusCode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4792,6 +5129,9 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4804,7 +5144,6 @@ You can use this parameter with the SmtpRejectMessageRejectStatusCode parameter. Type: RejectText Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4814,6 +5153,9 @@ Accept wildcard characters: False ``` ### -StopRuleProcessing + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. @@ -4827,7 +5169,6 @@ The StopRuleProcessing parameter specifies an action that stops processing more Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4837,6 +5178,9 @@ Accept wildcard characters: False ``` ### -SubjectContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4851,7 +5195,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4861,6 +5204,9 @@ Accept wildcard characters: False ``` ### -SubjectMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4871,7 +5217,6 @@ The SubjectMatchesPatterns parameter specifies a condition that looks for text p Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4881,6 +5226,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyContainsWords + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4895,7 +5243,6 @@ The maximum length of this parameter is 128 characters. Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4905,6 +5252,9 @@ Accept wildcard characters: False ``` ### -SubjectOrBodyMatchesPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. @@ -4915,7 +5265,6 @@ The SubjectOrBodyMatchesPatterns parameter specifies a condition that looks for Type: Pattern[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4925,13 +5274,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4941,6 +5292,9 @@ Accept wildcard characters: False ``` ### -WithImportance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. In on-premises Exchange, this condition is available only on Mailbox servers. @@ -4955,7 +5309,6 @@ The WithImportance parameter specifies a condition that looks for messages with Type: Importance Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TransportServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-TransportServer.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-TransportServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TransportServer.md index ed3050e054..b433ad22ca 100644 --- a/exchange/exchange-ps/exchange/Set-TransportServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TransportServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-transportserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-TransportServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-transportserver +schema: 2.0.0 +title: Set-TransportServer --- # Set-TransportServer @@ -150,6 +151,9 @@ This example sets the ReceiveProtocolLogPath parameter to C:\\SMTP Protocol Logs ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Transport server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -161,7 +165,6 @@ The Identity parameter specifies the Transport server that you want to modify. Y Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -171,6 +174,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveUserStatisticsLogMaxAge parameter specifies the maximum duration that the per user activity statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -181,7 +187,6 @@ For example, to specify 10 days for this parameter, use 10.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,6 +196,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveUserStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the per user activity statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 megabyte (MB). The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -209,7 +217,6 @@ The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -219,6 +226,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveUserStatisticsLogMaxFileSize parameter specifies the maximum file size for the per user activity statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -237,7 +247,6 @@ The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -247,6 +256,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveUserStatisticsLogPath parameter specifies the location of per user activity statistics log storage. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\ActiveUsersStats. @@ -258,7 +270,6 @@ Setting the value of this parameter to $null disables server statistics logging. Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -268,13 +279,15 @@ Accept wildcard characters: False ``` ### -AgentLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,6 +297,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogMaxAge parameter specifies the maximum age for the agent log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -294,7 +310,6 @@ Setting the value of the AgentLogMaxAge parameter to 00:00:00 prevents the autom Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,6 +319,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogMaxDirectorySize parameter specifies the maximum size of all agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -322,7 +340,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -332,6 +349,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogMaxFileSize parameter specifies the maximum size of each agent log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -350,7 +370,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -360,13 +379,15 @@ Accept wildcard characters: False ``` ### -AgentLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogPath parameter specifies the default agent log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\AgentLog. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the AgentLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -376,6 +397,9 @@ Accept wildcard characters: False ``` ### -AntispamAgentsEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AntispamAgentsEnabled parameter specifies whether anti-spam agents are installed on the server specified with the Identity parameter. The default value is $false for the Transport service on Mailbox servers and $true on Edge servers. You set this parameter by using a script. You shouldn't modify this parameter manually. @@ -384,7 +408,6 @@ You set this parameter by using a script. You shouldn't modify this parameter ma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -394,6 +417,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -403,7 +429,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -413,13 +438,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -429,6 +456,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxAge parameter specifies the maximum age for the connectivity log file. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -439,7 +469,6 @@ For example, to specify 25 days for this parameter, use 25.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -449,6 +478,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all connectivity logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 1000 MB. When you enter a value, qualify the value with one of the following units: @@ -467,7 +499,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -477,6 +508,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxFileSize parameter specifies the maximum size of each connectivity log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -495,7 +529,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -505,6 +538,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Connectivity @@ -516,7 +552,6 @@ Setting the value of this parameter to $null disables connectivity logging. Howe Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -526,6 +561,9 @@ Accept wildcard characters: False ``` ### -ContentConversionTracingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service on a Mailbox server or on the Edge server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: - Administrators: Full Control @@ -536,7 +574,6 @@ The ContentConversionTracingEnabled parameter specifies whether content conversi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -546,6 +583,9 @@ Accept wildcard characters: False ``` ### -DelayNotificationTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DelayNotificationTimeout parameter specifies how long the server waits before it generates a delayed delivery status notification (DSN) message. The default value is 4 hours. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -556,7 +596,6 @@ For example, to specify 3.5 hours for this parameter, use 03:30:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -566,13 +605,15 @@ Accept wildcard characters: False ``` ### -DnsLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -582,6 +623,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogMaxAge parameter specifies the maximum age for the DNS log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -592,7 +636,6 @@ Setting the value of the DnsLogMaxAge parameter to 00:00:00 prevents the automat Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -602,6 +645,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogMaxDirectorySize parameter specifies the maximum size of all DNS logs in the DNS log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 100 MB. When you enter a value, qualify the value with one of the following units: @@ -620,7 +666,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -630,6 +675,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogMaxFileSize parameter specifies the maximum size of each DNS log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -648,7 +696,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -658,13 +705,15 @@ Accept wildcard characters: False ``` ### -DnsLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogPath parameter specifies the DNS log directory location. The default value is blank ($null), which indicates no location is configured. If you enable DNS logging, you need to specify a local file path for the DNS log files by using this parameter. If the path contains spaces, enclose the entire path value in quotation marks ("). ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -674,6 +723,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -682,7 +734,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -692,13 +743,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSAdapterEnabled parameter specifies one or more Domain Name System (DNS) servers that Exchange uses for external DNS lookups. When the ExternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations outside the Exchange organization are performed by using the DNS settings of the external network adapter specified by the value of the ExternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for external Exchange DNS lookups only, you must specify the DNS servers by using the ExternalDNSServers parameter, and you must also set the value of the ExternalDNSAdapterEnabled parameter to $false. The default value of the ExternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -708,6 +761,9 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of destinations that exist outside the Exchange organization. The concept of an external network adapter and an internal network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and external DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for external DNS lookups. The default value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the value of the ExternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the ExternalDNSServers parameter is used. @@ -716,7 +772,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -726,13 +781,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSProtocolOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSProtocolOption parameter specifies which protocol to use when querying external DNS servers. The valid options for this parameter are Any, UseTcpOnly, and UseUdpOnly. The default value is Any. ```yaml Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -742,6 +799,9 @@ Accept wildcard characters: False ``` ### -ExternalDNSServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. DNS servers are specified by IP address. The default value is an empty list ({}). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -754,7 +814,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the Ext Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -764,13 +823,15 @@ Accept wildcard characters: False ``` ### -ExternalIPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalIPAddress parameter specifies the IP address used in the Received message header field for every message that travels through the Edge server or the Transport service on a Mailbox server. The IP address in the Received header field is used for hop count and routing loop detection. The IP address specified by the ExternalIPAddress parameter overrides the external network adapter's actual IP address. Typically, you would want to set the value of the ExternalIPAddress parameter to match the value of your domain's public MX record. The default value of the ExternalIPAddress parameter is blank. This means the actual IP address of the external network adapter is used in the Received header field. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -780,13 +841,15 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSAdapterEnabled parameter specifies one or more DNS servers that Exchange uses for internal DNS lookups. When the InternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations inside the Exchange organization are performed by using the DNS settings of the internal network adapter specified by the value of the InternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for internal Exchange DNS lookups only, you must specify the DNS servers by using the InternalDNSServers parameter, and you must also set the value of the InternalDNSAdapterEnabled parameter to $false. The default value of the InternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -796,6 +859,9 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterGuid + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of servers that exist inside the Exchange organization. The concept of an internal network adapter and an external network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and internal DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for internal DNS lookups. The default value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the InternalDNSAdapterEnabled parameter is set to $false, the value of the InternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the InternalDNSServers parameter is used. @@ -804,7 +870,6 @@ If the value of the InternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -814,6 +879,9 @@ Accept wildcard characters: False ``` ### -InternalDNSProtocolOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSProtocolOption parameter specifies which protocol to use when you query internal DNS servers. Valid options for this parameter are Any, UseTcpOnly, or UseUdpOnly. The default value is Any. @@ -822,7 +890,6 @@ The default value is Any. Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -832,6 +899,9 @@ Accept wildcard characters: False ``` ### -InternalDNSServers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSServers parameter specifies the list of DNS servers that should be used when resolving a domain name. DNS servers are specified by IP address. The default value is any empty list ({}). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -844,7 +914,6 @@ If the InternalDNSAdapterGuid parameter is set, and the value of the InternalDNS Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -854,6 +923,9 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorProtocolLoggingLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging on the implicit and invisible intra-organization Send connectors that are used to transmit messages between Exchange servers in the Exchange organization. Valid values for this parameter are None or Verbose. The value Verbose enables protocol logging for the connector. The value None disables protocol logging for the connector. The default value is None. When the IntraOrgConnectorProtocolLoggingLevel parameter is set to Verbose, the information is written to the Send connector protocol log specified by the SendProtocolLog parameters. @@ -862,7 +934,6 @@ Valid values for this parameter are None or Verbose. The value Verbose enables p Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -872,13 +943,15 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorSmtpMaxMessagesPerConnection + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IntraOrgConnectorSmtpMaxMessagesPerConnection parameter specifies the maximum number of messages per connection limit on the implicit and invisible intra-organization Send connectors that are used to transmit messages between Exchange servers in the Exchange organization. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -888,6 +961,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IrmLogEnabled parameter enables logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: - $true: Enable IRM logging @@ -897,7 +973,6 @@ The IrmLogEnabled parameter enables logging of Information Rights Management (IR Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -907,6 +982,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -917,7 +995,6 @@ The valid input range for this parameter is 00:00:00 to 24855.03:14:07. Setting Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -927,6 +1004,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -945,7 +1025,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -955,6 +1034,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -973,7 +1055,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -983,13 +1064,15 @@ Accept wildcard characters: False ``` ### -IrmLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IrmLogPath parameter specifies the default IRM log directory location. The default location is %ExchangeInstallPath%Logging\\IRMLogs. If you set the value of the IrmLogPath parameter to $null, you effectively disable IRM logging. However, if you set the value of the IrmLogPath parameter to $null when the value of the IrmLogEnabled attribute is $true, Exchange will log errors in the Application event log. The preferred way for disabling IRM logging is to set the IrmLogEnabled to $false. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -999,13 +1082,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxDeliveries + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConcurrentMailboxDeliveries parameter specifies the maximum number of delivery threads that the transport service can have open at the same time to deliver messages to mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. We recommend that you don't modify the default value unless Microsoft Customer Service and Support advises you to do this. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1015,13 +1100,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxSubmissions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConcurrentMailboxSubmissions parameter specifies the maximum number of submission threads that the transport service can have open at the same time to send messages from mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1031,13 +1118,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionRatePerMinute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConnectionRatePerMinute parameter specifies the maximum rate that connections are allowed to be opened with the transport service. If many connections are attempted with the transport service at the same time, the MaxConnectionRatePerMinute parameter limits the rate that the connections are opened so that the server's resources aren't overwhelmed. The default value is 1200 connections per minute. The valid input range for this parameter is from 1 through 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1047,13 +1136,15 @@ Accept wildcard characters: False ``` ### -MaxOutboundConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxOutboundConnections parameter specifies the maximum number of outbound connections that can be open at a time. The default value is 1000. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections. The value of the MaxOutboundConnections parameter must be greater than or equal to the value of the MaxPerDomainOutboundConnections parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1063,13 +1154,15 @@ Accept wildcard characters: False ``` ### -MaxPerDomainOutboundConnections + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 40. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1079,6 +1172,9 @@ Accept wildcard characters: False ``` ### -MessageExpirationTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageExpirationTimeout parameter specifies the maximum time that a particular message can remain in a queue. If a message remains in the queue for longer than this period of time, the message is returned to the sender as a permanent failure. The default value is 2 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1089,7 +1185,6 @@ For example, to specify 3 days for this parameter, use 3.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1099,6 +1194,9 @@ Accept wildcard characters: False ``` ### -MessageRetryInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1109,7 +1207,6 @@ For example, to specify 20 minutes for this parameter, use 00:20:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1119,13 +1216,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogEnabled parameter specifies whether message tracking is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1135,6 +1234,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogMaxAge parameter specifies the message tracking log maximum file age. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1145,7 +1247,6 @@ For example, to specify 20 days for this parameter, use 20.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1155,6 +1256,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogMaxDirectorySize parameter specifies the maximum size of the message tracking log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The maximum size of the message tracking log directory is calculated as the total size of all log files that have the same name prefix. Other files that don't follow the name prefix convention aren't counted in the total directory size calculation. Renaming old log files or copying other files into the message tracking log directory could cause the directory to exceed its specified maximum size. @@ -1179,7 +1283,6 @@ The value of the MessageTrackingLogMaxFileSize parameter must be less than or eq Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1189,6 +1292,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogMaxFileSize parameter specifies the maximum size of the message tracking log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1206,7 +1312,6 @@ The value of the MessageTrackingLogMaxFileSize parameter must be less than or eq Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1216,13 +1321,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogPath parameter specifies the location of the message tracking logs. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\MessageTracking. Setting the value of this parameter to $null disables message tracking. However, setting this parameter to $null when the value of the MessageTrackingLogEnabled attribute is $true generates event log errors. The preferred method to disable message tracking is to use the MessageTrackingLogEnabled parameter. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1232,13 +1339,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogSubjectLoggingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogSubjectLoggingEnabled parameter specifies whether the message subject should be included in the message tracking log. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1248,6 +1357,9 @@ Accept wildcard characters: False ``` ### -OutboundConnectionFailureRetryInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OutboundConnectionFailureRetryInterval parameter specifies the retry interval for subsequent connection attempts to a remote server where previous connection attempts have failed. The previously failed connection attempts are controlled by the TransientFailureRetryCount and TransientFailureRetryInterval parameters. For the Transport service on a Mailbox server, the default value of the OutboundConnectionFailureRetryInterval parameter is 10 minutes. On an Edge server, the default value is 30 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1258,7 +1370,6 @@ For example, to specify 15 minutes for this parameter, use 00:15:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1268,6 +1379,9 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxHeaderSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PickupDirectoryMaxHeaderSize parameter specifies the maximum message header size that can be submitted to the Pickup directory. The default value is 64 KB. When you enter a value, qualify the value with one of the following units: @@ -1285,7 +1399,6 @@ The valid input range for this parameter is from 32768 through 2147483647 bytes. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1295,13 +1408,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxMessagesPerMinute + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PickupDirectoryMaxMessagesPerMinute parameter specifies the maximum number of messages processed per minute by the Pickup directory and by the Replay directory. Each directory can independently process message files at the rate specified by the PickupDirectoryMaxMessagesPerMinute parameter. The default value is 100. The valid input range for this parameter is from 1 through 20000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1311,13 +1426,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxRecipientsPerMessage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PickupDirectoryMaxRecipientsPerMessage parameter specifies the maximum number of recipients that can be included on an message. The default value is 100. The valid input range for this parameter is from 1 through 10000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1327,13 +1444,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PickupDirectoryPath parameter specifies the location of the Pickup directory. The Pickup directory is used by administrators and non-Microsoft applications to create and submit messages. The default location is %ExchangeInstallPath%TransportRoles\\Pickup. If the value of the PickupDirectoryPath parameter is set to $null, the Pickup directory is disabled. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1343,13 +1462,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipelineTracingEnabled parameter specifies whether to enable pipeline tracing. Pipeline tracing captures message snapshot files that record the changes made to the message by each transport agent configured in the transport service on the server. Pipeline tracing creates verbose log files that accumulate quickly. Pipeline tracing should only be enabled for a short time to provide in-depth diagnostic information that enables you to troubleshoot problems. In addition to troubleshooting, you can use pipeline tracing to validate changes that you make to the configuration of the transport service where you enable pipeline tracing. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1359,6 +1480,9 @@ Accept wildcard characters: False ``` ### -PipelineTracingPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipelineTracingPath parameter specifies the location of the pipeline tracing logs. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\PipelineTracing. @@ -1378,7 +1502,6 @@ Pipeline tracing captures the complete contents of messages to the path specifie Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1388,13 +1511,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingSenderAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipelineTracingSenderAddress parameter specifies the sender address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1404,13 +1529,15 @@ Accept wildcard characters: False ``` ### -PoisonMessageDetectionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PoisonMessageDetectionEnabled parameter specifies whether poison messages should be detected. The default value is $true. Poison messages are messages determined to be potentially harmful to the Exchange system after a server failure. Poison messages are put in the poison message queue. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1420,13 +1547,15 @@ Accept wildcard characters: False ``` ### -PoisonThreshold + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PoisonThreshold parameter specifies the number of times a message can be rejected before it's classified as a poison message. The default value is 2. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this. The valid input range for this parameter is from 1 through 10. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1436,6 +1565,9 @@ Accept wildcard characters: False ``` ### -QueueMaxIdleTime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QueueMaxIdleTime parameter specifies the period of time an empty delivery queue can exist before the queue is removed. The default value is 3 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1446,7 +1578,6 @@ For example, to specify 5 minutes for this parameter, use 00:05:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1456,6 +1587,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QueueLogMaxAge parameter specifies the maximum age of the queue log files. Log files that are older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds. @@ -1466,7 +1600,6 @@ For example, to specify 10 days for this parameter, use 10.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1476,6 +1609,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QueueLogMaxDirectorySize parameter specifies the maximum size of the queue log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 200 MB. When you enter a value, qualify the value with one of the following units: @@ -1494,7 +1630,6 @@ The value of the QueueLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1504,6 +1639,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QueueLogMaxFileSize parameter specifies the maximum size of the queue log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1522,7 +1660,6 @@ The value of the QueueLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1532,13 +1669,15 @@ Accept wildcard characters: False ``` ### -QueueLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QueueLogPath parameter specifies the path of the queue log directory. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\QueueViewer. Setting the value of this parameter to $null disables queue logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1548,6 +1687,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxAge parameter specifies the maximum age of the Receive connector protocol log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1558,7 +1700,6 @@ For example, to specify 20 days for this parameter, use 20.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1568,6 +1709,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the Receive connector protocol log directory shared by all the Receive connectors that exist on the server. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -1586,7 +1730,6 @@ The value of the ReceiveProtocolLogMaxFileSize parameter must be less than or eq Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1596,6 +1739,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of the Receive connector protocol log files shared by all the Receive connectors that exist on the server. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1614,7 +1760,6 @@ The value of the ReceiveProtocolLogMaxFileSize parameter must be less than or eq Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1624,6 +1769,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogPath parameter specifies the path of the protocol log directory for all the Receive connectors that exist on the server. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\ProtocolLog\\SmtpReceive. @@ -1635,7 +1783,6 @@ Setting the value of this parameter to $null disables protocol logging for all R Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1645,13 +1792,15 @@ Accept wildcard characters: False ``` ### -RecipientValidationCacheEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecipientValidationCacheEnabled parameter specifies whether the recipient addresses used by transport agents, such as the Recipient Filtering agent, are cached. The default value is $true on Edge servers and $false for the Transport service on Mailbox servers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1661,13 +1810,15 @@ Accept wildcard characters: False ``` ### -ReplayDirectoryPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReplayDirectoryPath parameter specifies the path of the Replay directory. The Replay directory is used to resubmit exported messages and to receive messages from foreign gateway servers. The default location is %ExchangeInstallPath%TransportRoles\\Replay. If the value of the ReplayDirectoryPath parameter is set to $null, the Replay directory is disabled. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1677,13 +1828,15 @@ Accept wildcard characters: False ``` ### -RootDropDirectoryPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RootDropDirectoryPath parameter specifies the top-level location of the Drop directory used by all Foreign connectors defined in the Transport service on a Mailbox server. The value of the RootDropDirectoryPath parameter may be a local path, or a Universal Naming Convention (UNC) path to a remote server. By default, the RootDropDirectoryPath parameter is blank. This indicates the value of RootDropDirectoryPath is the Exchange installation folder. The RootDropDirectoryPath parameter is used with the DropDirectory parameter in the Set-ForeignConnector cmdlet to specify the location for outgoing messages going to the address spaces defined on the Foreign connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1693,6 +1846,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogMaxAge parameter specifies the maximum routing table log age. Log files older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1703,7 +1859,6 @@ For example, to specify 5 days for this parameter, use 5.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1713,6 +1868,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the routing table log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 50 MB. When you enter a value, qualify the value with one of the following units: @@ -1731,7 +1889,6 @@ The valid input range for this parameter is from 1 through 9223372036854775807 b Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1741,6 +1898,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Routing. @@ -1752,7 +1912,6 @@ Setting the value of the RoutingTableLogPath parameter to $null disables routing Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1762,6 +1921,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxAge parameter specifies the Send connector protocol log file maximum age. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1772,7 +1934,6 @@ For example, to specify 25 days for this parameter, use 25.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1782,6 +1943,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the Send connector protocol log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 MB. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -1800,7 +1964,6 @@ The value of the SendProtocolLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1810,6 +1973,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxFileSize parameter specifies the maximum size of the Send connector protocol log files shared by all the Send connectors that exist on a server. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1828,7 +1994,6 @@ The value of the SendProtocolLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1838,6 +2003,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogPath parameter specifies the location of protocol log storage for the Send connectors. The default location depends on your version of Exchange: - Exchange 2010: The default location is %ExchangeInstallPath%TransportRoles\\Logs\\ProtocolLog\\SmtpSend. @@ -1849,7 +2017,6 @@ Setting the value of this parameter to $null disables protocol logging for all S Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1859,6 +2026,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxAge + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogMaxAge parameter specifies the maximum duration that the server statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days. @@ -1871,7 +2041,6 @@ For example, to specify 60 days for this parameter, use 60.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1881,6 +2050,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxDirectorySize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the server statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 MB. The default value is 250 MB. When you enter a value, qualify the value with one of the following: @@ -1899,7 +2071,6 @@ The value of the ServerStatisticsLogMaxFileSize parameter must be less than or e Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1909,6 +2080,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxFileSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogMaxFileSize parameter specifies the maximum file size for the server statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following: @@ -1927,7 +2101,6 @@ The value of the ServerStatisticsLogMaxFileSize parameter must be less than or e Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1937,6 +2110,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogPath + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogPath parameter specifies the location of the server statistics log. The default location depends on your version of Exchange: @@ -1950,7 +2126,6 @@ Setting the value of this parameter to $null disables server statistics logging. Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1960,13 +2135,15 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransientFailureRetryCount parameter specifies the maximum number of immediate connection retries attempted when the server encounters a connection failure with a remote server. The default value is 6. The valid input range for this parameter is from 0 through 15. When the value of this parameter is set to 0, the server doesn't immediately attempt to retry an unsuccessful connection, and the next connection attempt is controlled by the OutboundConnectionFailureRetryInterval parameter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1976,6 +2153,9 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryInterval + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransientFailureRetryInterval parameter controls the connection interval between each connection attempt specified by the TransientFailureRetryCount parameter. For the Transport service on a Mailbox server, the default value of the TransientFailureRetryInterval parameter is 5 minutes. On an Edge server, the default value is 10 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1986,7 +2166,6 @@ For example, to specify 8 minutes for this parameter, use 00:08:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1996,6 +2175,9 @@ Accept wildcard characters: False ``` ### -UseDowngradedExchangeServerAuth + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UseDowngradedExchangeServerAuth parameter specifies whether the Generic Security Services application programming interface (GSSAPI) authentication method is used on connections where Transport Layer Security (TLS) is disabled. Normally, TLS is required for connections between the Transport services on Mailbox servers in your organization. On TLS secured connections, Kerberos authentication is used by default. However, there may be scenarios where you need to disable TLS between specific Transport services in your organization. When you do that, you need to set this parameter to $true to provide an alternative authentication method. The default value is $false. You shouldn't set this value to $true unless it's absolutely required. @@ -2006,7 +2188,6 @@ If you set this parameter to $true, you also need to create a specific Receive c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2016,13 +2197,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2032,13 +2215,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2048,13 +2233,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2064,13 +2251,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2080,13 +2269,15 @@ Accept wildcard characters: False ``` ### -WlmLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-TransportService.md b/exchange/exchange-ps/ExchangePowerShell/Set-TransportService.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-TransportService.md rename to exchange/exchange-ps/ExchangePowerShell/Set-TransportService.md index ef182dd820..676be05f31 100644 --- a/exchange/exchange-ps/exchange/Set-TransportService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-TransportService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-transportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-TransportService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-transportservice +schema: 2.0.0 +title: Set-TransportService --- # Set-TransportService @@ -192,6 +193,9 @@ This example sets the ReceiveProtocolLogPath parameter to C:\\SMTP Protocol Logs ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Mailbox server that hosts the Transport service configuration you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -205,7 +209,6 @@ You can't use this parameter on an Edge Transport server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -215,6 +218,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveUserStatisticsLogMaxAge parameter specifies the maximum duration that the per user activity statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -225,7 +231,6 @@ For example, to specify 10 days for this parameter, use 10.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -235,6 +240,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveUserStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the per user activity statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 megabyte (MB). The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -253,7 +261,6 @@ The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -263,6 +270,9 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveUserStatisticsLogMaxFileSize parameter specifies the maximum file size for the per user activity statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -281,7 +291,6 @@ The value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -291,13 +300,15 @@ Accept wildcard characters: False ``` ### -ActiveUserStatisticsLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveUserStatisticsLogPath parameter specifies the location of per user activity statistics log storage. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ActiveUsersStats. Setting the value of this parameter to $null disables server statistics logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -307,13 +318,15 @@ Accept wildcard characters: False ``` ### -AgentLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -323,6 +336,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogMaxAge parameter specifies the maximum age for the agent log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -333,7 +349,6 @@ Setting the value of the AgentLogMaxAge parameter to 00:00:00 prevents the autom Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -343,6 +358,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogMaxDirectorySize parameter specifies the maximum size of all agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -361,7 +379,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -371,6 +388,9 @@ Accept wildcard characters: False ``` ### -AgentLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogMaxFileSize parameter specifies the maximum size of each agent log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -389,7 +409,6 @@ The value of the AgentLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -399,13 +418,15 @@ Accept wildcard characters: False ``` ### -AgentLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AgentLogPath parameter specifies the default agent log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\AgentLog. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the AgentLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -415,6 +436,9 @@ Accept wildcard characters: False ``` ### -AntispamAgentsEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AntispamAgentsEnabled parameter specifies whether anti-spam agents are installed on the server specified with the Identity parameter. The default value is $false for the Transport service on Mailbox servers and $true on Edge Transport servers. You set this parameter by using a script. You shouldn't modify this parameter manually. @@ -423,7 +447,6 @@ You set this parameter by using a script. You shouldn't modify this parameter ma Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -433,6 +456,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -442,7 +468,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -452,13 +477,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -468,6 +495,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxAge parameter specifies the maximum age for the connectivity log file. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -478,7 +508,6 @@ For example, to specify 25 days for this parameter, use 25.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -488,6 +517,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all connectivity logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 1000 MB. When you enter a value, qualify the value with one of the following units: @@ -506,7 +538,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -516,6 +547,9 @@ Accept wildcard characters: False ``` ### -ConnectivityLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogMaxFileSize parameter specifies the maximum size of each connectivity log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -534,7 +568,6 @@ The value of the ConnectivityLogMaxFileSize parameter must be less than or equal Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -544,13 +577,15 @@ Accept wildcard characters: False ``` ### -ConnectivityLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\Connectivity. Setting the value of this parameter to $null disables connectivity logging. However, setting this parameter to $null when the value of the ConnectivityLogEnabled attribute is $true generates event log errors. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -560,6 +595,9 @@ Accept wildcard characters: False ``` ### -ContentConversionTracingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service on a Mailbox server or on the Edge Transport server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of email messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: - Administrators: Full Control @@ -570,7 +608,6 @@ The ContentConversionTracingEnabled parameter specifies whether content conversi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -580,6 +617,9 @@ Accept wildcard characters: False ``` ### -DelayNotificationTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DelayNotificationTimeout parameter specifies how long the server waits before it generates a delayed delivery status notification (DSN) message. The default value is 4 hours. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -590,7 +630,6 @@ For example, to specify 3.5 hours for this parameter, use 03:30:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -600,13 +639,15 @@ Accept wildcard characters: False ``` ### -DnsLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -616,6 +657,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogMaxAge parameter specifies the maximum age for the DNS log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -626,7 +670,6 @@ Setting the value of the DnsLogMaxAge parameter to 00:00:00 prevents the automat Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -636,6 +679,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogMaxDirectorySize parameter specifies the maximum size of all DNS logs in the DNS log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 100 MB. When you enter a value, qualify the value with one of the following units: @@ -654,7 +700,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -664,6 +709,9 @@ Accept wildcard characters: False ``` ### -DnsLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogMaxFileSize parameter specifies the maximum size of each DNS log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -682,7 +730,6 @@ The value of the DnsLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -692,13 +739,15 @@ Accept wildcard characters: False ``` ### -DnsLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DnsLogPath parameter specifies the DNS log directory location. The default value is blank ($null), which indicates no location is configured. If you enable DNS logging, you need to specify a local file path for the DNS log files by using this parameter. If the path contains spaces, enclose the entire path value in quotation marks ("). ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -708,6 +757,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -716,7 +768,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -726,13 +777,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSAdapterEnabled parameter specifies one or more Domain Name System (DNS) servers that Exchange uses for external DNS lookups. When the ExternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations outside the Exchange organization are performed by using the DNS settings of the external network adapter specified by the value of the ExternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for external Exchange DNS lookups only, you must specify the DNS servers by using the ExternalDNSServers parameter, and you must also set the value of the ExternalDNSAdapterEnabled parameter to $false. The default value of the ExternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -742,6 +795,9 @@ Accept wildcard characters: False ``` ### -ExternalDNSAdapterGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of destinations that exist outside the Exchange organization. The concept of an external network adapter and an internal network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and external DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for external DNS lookups. The default value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the value of the ExternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the ExternalDNSServers parameter is used. @@ -750,7 +806,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -760,13 +815,15 @@ Accept wildcard characters: False ``` ### -ExternalDNSProtocolOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSProtocolOption parameter specifies which protocol to use when querying external DNS servers. The valid options for this parameter are Any, UseTcpOnly, and UseUdpOnly. The default value is Any. ```yaml Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -776,6 +833,9 @@ Accept wildcard characters: False ``` ### -ExternalDNSServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. DNS servers are specified by IP address. The default value is an empty list ({}). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -788,7 +848,6 @@ If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the Ext Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -798,13 +857,15 @@ Accept wildcard characters: False ``` ### -ExternalIPAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalIPAddress parameter specifies the IP address used in the Received message header field for every message that travels through the Edge Transport server or the Transport service on a Mailbox server. The IP address in the Received header field is used for hop count and routing loop detection. The IP address specified by the ExternalIPAddress parameter overrides the external network adapter's actual IP address. Typically, you would want to set the value of the ExternalIPAddress parameter to match the value of your domain's public MX record. The default value of the ExternalIPAddress parameter is blank. This means the actual IP address of the external network adapter is used in the Received header field. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -814,13 +875,15 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSAdapterEnabled parameter specifies one or more DNS servers that Exchange uses for internal DNS lookups. When the InternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations inside the Exchange organization are performed by using the DNS settings of the internal network adapter specified by the value of the InternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for internal Exchange DNS lookups only, you must specify the DNS servers by using the InternalDNSServers parameter, and you must also set the value of the InternalDNSAdapterEnabled parameter to $false. The default value of the InternalDNSAdapterEnabled parameter is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -830,6 +893,9 @@ Accept wildcard characters: False ``` ### -InternalDNSAdapterGuid + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of servers that exist inside the Exchange organization. The concept of an internal network adapter and an external network adapter is only applicable in a multi-homed Exchange server environment. When no particular network adapter is specified as the network adapter for external DNS lookups, the value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000, and internal DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for internal DNS lookups. The default value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the InternalDNSAdapterEnabled parameter is set to $false, the value of the InternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the InternalDNSServers parameter is used. @@ -838,7 +904,6 @@ If the value of the InternalDNSAdapterEnabled parameter is set to $false, the va Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -848,13 +913,15 @@ Accept wildcard characters: False ``` ### -InternalDNSProtocolOption + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSProtocolOption parameter specifies which protocol to use when you query internal DNS servers. Valid options for this parameter are Any, UseTcpOnly, or UseUdpOnly.The default value is Any. ```yaml Type: ProtocolOption Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -864,6 +931,9 @@ Accept wildcard characters: False ``` ### -InternalDNSServers + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalDNSServers parameter specifies the list of DNS servers that should be used when resolving a domain name. DNS servers are specified by IP address. The default value is any empty list ({}). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -876,7 +946,6 @@ If the InternalDNSAdapterGuid parameter is set, and the value of the InternalDNS Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -886,6 +955,9 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorProtocolLoggingLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging for the implicit and invisible intra-organization Send connector in the following transport services on the server: - The Transport service. @@ -900,7 +972,6 @@ Valid values are: Type: ProtocolLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -910,6 +981,9 @@ Accept wildcard characters: False ``` ### -IntraOrgConnectorSmtpMaxMessagesPerConnection + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IntraOrgConnectorSmtpMaxMessagesPerConnection parameter specifies the maximum number of messages per connection that are allowed on the implicit and invisible intra-organization Send connector in the Transport service on the server. A valid value is an integer from 0 to 2147483647. The default value is 20. @@ -918,7 +992,6 @@ A valid value is an integer from 0 to 2147483647. The default value is 20. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -928,6 +1001,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IrmLogEnabled parameter enables logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: - $true: Enable IRM logging @@ -937,7 +1013,6 @@ The IrmLogEnabled parameter enables logging of Information Rights Management (IR Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -947,6 +1022,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -957,7 +1035,6 @@ The valid input range for this parameter is 00:00:00 to 24855.03:14:07. Setting Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -967,6 +1044,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: @@ -985,7 +1065,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -995,6 +1074,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1013,7 +1095,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1023,13 +1104,15 @@ Accept wildcard characters: False ``` ### -IrmLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IrmLogPath parameter specifies the default IRM log directory location. The default location is %ExchangeInstallPath%Logging\\IRMLogs. If you set the value of the IrmLogPath parameter to $null, you effectively disable IRM logging. However, if you set the value of the IrmLogPath parameter to $null when the value of the IrmLogEnabled attribute is $true, Exchange will log errors in the Application event log. The preferred way for disabling IRM logging is to set the IrmLogEnabled to $false. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1039,13 +1122,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxDeliveries + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConcurrentMailboxDeliveries parameter specifies the maximum number of delivery threads that the transport service can have open at the same time to deliver messages to mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. We recommend that you don't modify the default value unless Microsoft Customer Service and Support advises you to do this. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1055,13 +1140,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentMailboxSubmissions + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConcurrentMailboxSubmissions parameter specifies the maximum number of submission threads that the transport service can have open at the same time to send messages from mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1071,13 +1158,15 @@ Accept wildcard characters: False ``` ### -MaxConnectionRatePerMinute + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxConnectionRatePerMinute parameter specifies the maximum rate that connections are allowed to be opened with the transport service. If many connections are attempted with the transport service at the same time, the MaxConnectionRatePerMinute parameter limits the rate that the connections are opened so that the server's resources aren't overwhelmed. The default value is 1200 connections per minute. The valid input range for this parameter is from 1 through 2147483647. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1087,13 +1176,15 @@ Accept wildcard characters: False ``` ### -MaxOutboundConnections + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxOutboundConnections parameter specifies the maximum number of outbound connections that can be open at a time. The default value is 1000. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections. The value of the MaxOutboundConnections parameter must be greater than or equal to the value of the MaxPerDomainOutboundConnections parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1103,13 +1194,15 @@ Accept wildcard characters: False ``` ### -MaxPerDomainOutboundConnections + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 40. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1119,6 +1212,9 @@ Accept wildcard characters: False ``` ### -MessageExpirationTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageExpirationTimeout parameter specifies the maximum time that a particular message can remain in a queue. If a message remains in the queue for longer than this period of time, the message is returned to the sender as a permanent failure. The default value is 2 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1129,7 +1225,6 @@ For example, to specify 3 days for this parameter, use 3.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1139,6 +1234,9 @@ Accept wildcard characters: False ``` ### -MessageRetryInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1149,7 +1247,6 @@ For example, to specify 20 minutes for this parameter, use 00:20:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1159,13 +1256,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogEnabled parameter specifies whether message tracking is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1175,6 +1274,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogMaxAge parameter specifies the message tracking log maximum file age. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1185,7 +1287,6 @@ For example, to specify 20 days for this parameter, use 20.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1195,6 +1296,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogMaxDirectorySize parameter specifies the maximum size of the message tracking log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The maximum size of the message tracking log directory is calculated as the total size of all log files that have the same name prefix. Other files that don't follow the name prefix convention aren't counted in the total directory size calculation. Renaming old log files or copying other files into the message tracking log directory could cause the directory to exceed its specified maximum size. @@ -1219,7 +1323,6 @@ The value of the MessageTrackingLogMaxFileSize parameter must be less than or eq Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1229,6 +1332,9 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogMaxFileSize parameter specifies the maximum size of the message tracking log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1246,7 +1352,6 @@ The value of the MessageTrackingLogMaxFileSize parameter must be less than or eq Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1256,13 +1361,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogPath parameter specifies the location of the message tracking logs. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\MessageTracking. Setting the value of this parameter to $null disables message tracking. However, setting this parameter to $null when the value of the MessageTrackingLogEnabled attribute is $true generates event log errors. The preferred method to disable message tracking is to use the MessageTrackingLogEnabled parameter. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1272,13 +1379,15 @@ Accept wildcard characters: False ``` ### -MessageTrackingLogSubjectLoggingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MessageTrackingLogSubjectLoggingEnabled parameter specifies whether the message subject should be included in the message tracking log. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1288,6 +1397,9 @@ Accept wildcard characters: False ``` ### -OutboundConnectionFailureRetryInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OutboundConnectionFailureRetryInterval parameter specifies the retry interval for subsequent connection attempts to a remote server where previous connection attempts have failed. The previously failed connection attempts are controlled by the TransientFailureRetryCount and TransientFailureRetryInterval parameters. For the Transport service on a Mailbox server, the default value of the OutboundConnectionFailureRetryInterval parameter is 10 minutes. On an Edge Transport server, the default value is 30 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1298,7 +1410,6 @@ For example, to specify 15 minutes for this parameter, use 00:15:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1308,6 +1419,9 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxHeaderSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PickupDirectoryMaxHeaderSize parameter specifies the maximum message header size that can be submitted to the Pickup directory. The default value is 64 KB. When you enter a value, qualify the value with one of the following units: @@ -1325,7 +1439,6 @@ The valid input range for this parameter is from 32768 through 2147483647 bytes. Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1335,13 +1448,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxMessagesPerMinute + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PickupDirectoryMaxMessagesPerMinute parameter specifies the maximum number of messages processed per minute by the Pickup directory and by the Replay directory. Each directory can independently process message files at the rate specified by the PickupDirectoryMaxMessagesPerMinute parameter. The default value is 100. The valid input range for this parameter is from 1 through 20000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1351,13 +1466,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxRecipientsPerMessage + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PickupDirectoryMaxRecipientsPerMessage parameter specifies the maximum number of recipients that can be included on an email message. The default value is 100. The valid input range for this parameter is from 1 through 10000. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1367,13 +1484,15 @@ Accept wildcard characters: False ``` ### -PickupDirectoryPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PickupDirectoryPath parameter specifies the location of the Pickup directory. The Pickup directory is used by administrators and non-Microsoft applications to create and submit messages. The default location is %ExchangeInstallPath%TransportRoles\\Pickup. If the value of the PickupDirectoryPath parameter is set to $null, the Pickup directory is disabled. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1383,13 +1502,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipelineTracingEnabled parameter specifies whether to enable pipeline tracing. Pipeline tracing captures message snapshot files that record the changes made to the message by each transport agent configured in the transport service on the server. Pipeline tracing creates verbose log files that accumulate quickly. Pipeline tracing should only be enabled for a short time to provide in-depth diagnostic information that enables you to troubleshoot problems. In addition to troubleshooting, you can use pipeline tracing to validate changes that you make to the configuration of the transport service where you enable pipeline tracing. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1399,6 +1520,9 @@ Accept wildcard characters: False ``` ### -PipelineTracingPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipelineTracingPath parameter specifies the location of the pipeline tracing logs. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\PipelineTracing. The path must be local to the Exchange server. Setting the value of this parameter to $null disables pipeline tracing. However, setting this parameter to $null when the value of the PipelineTracingEnabled attribute is $true generates event log errors. The preferred method to disable pipeline tracing is to use the PipelineTracingEnabled parameter. @@ -1413,7 +1537,6 @@ Pipeline tracing captures the complete contents of email messages to the path sp Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1423,13 +1546,15 @@ Accept wildcard characters: False ``` ### -PipelineTracingSenderAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PipelineTracingSenderAddress parameter specifies the sender email address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1439,13 +1564,15 @@ Accept wildcard characters: False ``` ### -PoisonMessageDetectionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PoisonMessageDetectionEnabled parameter specifies whether poison messages should be detected. The default value is $true. Poison messages are messages determined to be potentially harmful to the Exchange system after a server failure. Poison messages are put in the poison message queue. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1455,13 +1582,15 @@ Accept wildcard characters: False ``` ### -PoisonThreshold + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PoisonThreshold parameter specifies the number of times a message can be rejected before it's classified as a poison message. The default value is 2. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this. The valid input range for this parameter is from 1 through 10. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1471,6 +1600,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QueueLogMaxAge parameter specifies the maximum age of the queue log files. Log files that are older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1481,7 +1613,6 @@ For example, to specify 10 days for this parameter, use 10.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1491,6 +1622,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QueueLogMaxDirectorySize parameter specifies the maximum size of the queue log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 200 MB. When you enter a value, qualify the value with one of the following units: @@ -1509,7 +1643,6 @@ The value of the QueueLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1519,6 +1652,9 @@ Accept wildcard characters: False ``` ### -QueueLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QueueLogMaxFileSize parameter specifies the maximum size of the queue log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -1537,7 +1673,6 @@ The value of the QueueLogMaxFileSize parameter must be less than or equal to the Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1547,13 +1682,15 @@ Accept wildcard characters: False ``` ### -QueueLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QueueLogPath parameter specifies the path of the queue log directory. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\QueueViewer. Setting the value of this parameter to $null disables queue logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1563,6 +1700,9 @@ Accept wildcard characters: False ``` ### -QueueMaxIdleTime + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The QueueMaxIdleTime parameter specifies the period of time an empty delivery queue can exist before the queue is removed. The default value is 3 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1573,7 +1713,6 @@ For example, to specify 5 minutes for this parameter, use 00:05:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1583,6 +1722,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Receive connectors in the Transport service on the server. Log files that are older than the specified value are automatically deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1595,7 +1737,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1605,6 +1746,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Receive connectors in the Transport service on the server. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -1627,7 +1771,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1637,6 +1780,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all Receive connectors in the Transport on the server. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -1659,7 +1805,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1669,6 +1814,9 @@ Accept wildcard characters: False ``` ### -ReceiveProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReceiveProtocolLogPath parameter specifies the location of the protocol log directory for all Receive connectors in the Transport service on the server. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ProtocolLog\\SmtpReceive. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for any Receive connector in the Transport service. To disable protocol logging for these Receive connectors, use the value None for the ProtocolLoggingLevel parameter on the Set-ReceiveConnector cmdlet for each Receive connector in the Transport service. @@ -1677,7 +1825,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1687,13 +1834,15 @@ Accept wildcard characters: False ``` ### -RecipientValidationCacheEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RecipientValidationCacheEnabled parameter specifies whether the recipient addresses used by transport agents, such as the Recipient Filtering agent, are cached. The default value is $true on Edge Transport servers and $false for the Transport service on Mailbox servers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1703,13 +1852,15 @@ Accept wildcard characters: False ``` ### -ReplayDirectoryPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ReplayDirectoryPath parameter specifies the path of the Replay directory. The Replay directory is used to resubmit exported messages and to receive messages from foreign gateway servers. The default location is %ExchangeInstallPath%TransportRoles\\Replay. If the value of the ReplayDirectoryPath parameter is set to $null, the Replay directory is disabled. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1719,13 +1870,15 @@ Accept wildcard characters: False ``` ### -RequestBrokerLogEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1735,13 +1888,15 @@ Accept wildcard characters: False ``` ### -RequestBrokerLogMaxAge + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1751,13 +1906,15 @@ Accept wildcard characters: False ``` ### -RequestBrokerLogMaxDirectorySize + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1767,13 +1924,15 @@ Accept wildcard characters: False ``` ### -RequestBrokerLogMaxFileSize + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1783,13 +1942,15 @@ Accept wildcard characters: False ``` ### -RequestBrokerLogPath + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1799,13 +1960,15 @@ Accept wildcard characters: False ``` ### -ResourceLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1815,13 +1978,15 @@ Accept wildcard characters: False ``` ### -ResourceLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1831,13 +1996,15 @@ Accept wildcard characters: False ``` ### -ResourceLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1847,13 +2014,15 @@ Accept wildcard characters: False ``` ### -ResourceLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1863,13 +2032,15 @@ Accept wildcard characters: False ``` ### -ResourceLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1879,13 +2050,15 @@ Accept wildcard characters: False ``` ### -RootDropDirectoryPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RootDropDirectoryPath parameter specifies the top-level location of the Drop directory used by all Foreign connectors defined in the Transport service on a Mailbox server. The value of the RootDropDirectoryPath parameter may be a local path, or a Universal Naming Convention (UNC) path to a remote server. By default, the RootDropDirectoryPath parameter is blank. This indicates the value of RootDropDirectoryPath is the Exchange installation folder. The RootDropDirectoryPath parameter is used with the DropDirectory parameter in the Set-ForeignConnector cmdlet to specify the location for outgoing messages going to the address spaces defined on the Foreign connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1895,6 +2068,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogMaxAge parameter specifies the maximum routing table log age. Log files older than the specified value are deleted. The default value is 7 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1905,7 +2081,6 @@ For example, to specify 5 days for this parameter, use 5.00:00:00. The valid inp Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1915,6 +2090,9 @@ Accept wildcard characters: False ``` ### -RoutingTableLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the routing table log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 50 MB. When you enter a value, qualify the value with one of the following units: @@ -1933,7 +2111,6 @@ The valid input range for this parameter is from 1 through 9223372036854775807 b Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1943,13 +2120,15 @@ Accept wildcard characters: False ``` ### -RoutingTableLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\Routing. Setting the value of the RoutingTableLogPath parameter to $null disables routing table logging. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1959,6 +2138,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Send connectors in the Transport service that have this server configured as a source server. Log files that are older than the specified value are automatically deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1971,7 +2153,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1981,6 +2162,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Send connectors in the Transport service that have this server configured as a source server. When the maximum directory size is reached, the server deletes the oldest log files first. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 250 megabytes (262144000 bytes). @@ -2003,7 +2187,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2013,6 +2196,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all Send connectors in the Transport service that have this server configured as a source server. When a log file reaches its maximum file size, a new log file is created. A valid value is a number up to 909.5 terabytes (999999999999999 bytes) or the value unlimited. The default value is 10 megabytes (10485760 bytes). @@ -2035,7 +2221,6 @@ This parameter is only meaningful when protocol logging is enabled for at least Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2045,6 +2230,9 @@ Accept wildcard characters: False ``` ### -SendProtocolLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SendProtocolLogPath parameter specifies the location of the protocol log directory for all Send connectors in the Transport service on the server. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ProtocolLog\\SmtpSend. Don't use the value $null for this parameter, because event log errors are generated if protocol logging is enabled for any Send connector in the Transport service that has this server configured as a source server. To disable protocol logging for these Send connectors, use the value None for the following parameters: @@ -2056,7 +2244,6 @@ Don't use the value $null for this parameter, because event log errors are gener Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2066,6 +2253,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogMaxAge parameter specifies the maximum duration that the server statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days. @@ -2078,7 +2268,6 @@ For example, to specify 60 days for this parameter, use 60.00:00:00. The valid i Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2088,6 +2277,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the server statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 MB. The default value is 250 MB. @@ -2108,7 +2300,6 @@ The value of the ServerStatisticsLogMaxFileSize parameter must be less than or e Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2118,6 +2309,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogMaxFileSize parameter specifies the maximum file size for the server statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. @@ -2138,7 +2332,6 @@ The value of the ServerStatisticsLogMaxFileSize parameter must be less than or e Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2148,6 +2341,9 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogPath parameter specifies the location of server statistics log storage. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ServerStats. Setting the value of this parameter to $null disables server statistics logging. @@ -2156,7 +2352,6 @@ The ServerStatisticsLogPath parameter specifies the location of server statistic Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2166,13 +2361,15 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryCount + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransientFailureRetryCount parameter specifies the maximum number of immediate connection retries attempted when the server encounters a connection failure with a remote server. The default value is 6. The valid input range for this parameter is from 0 through 15. When the value of this parameter is set to 0, the server doesn't immediately attempt to retry an unsuccessful connection, and the next connection attempt is controlled by the OutboundConnectionFailureRetryInterval parameter. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2182,6 +2379,9 @@ Accept wildcard characters: False ``` ### -TransientFailureRetryInterval + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransientFailureRetryInterval parameter controls the connection interval between each connection attempt specified by the TransientFailureRetryCount parameter. For the Transport service on a Mailbox server, the default value of the TransientFailureRetryInterval parameter is 5 minutes. On an Edge Transport server, the default value is 10 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -2192,7 +2392,6 @@ For example, to specify 8 minutes for this parameter, use 00:08:00. The valid in Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2202,13 +2401,15 @@ Accept wildcard characters: False ``` ### -TransportHttpLogEnabled + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2218,13 +2419,15 @@ Accept wildcard characters: False ``` ### -TransportHttpLogMaxAge + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2234,13 +2437,15 @@ Accept wildcard characters: False ``` ### -TransportHttpLogMaxDirectorySize + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2250,13 +2455,15 @@ Accept wildcard characters: False ``` ### -TransportHttpLogMaxFileSize + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2266,13 +2473,15 @@ Accept wildcard characters: False ``` ### -TransportHttpLogPath + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2282,13 +2491,15 @@ Accept wildcard characters: False ``` ### -TransportMaintenanceLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2298,13 +2509,15 @@ Accept wildcard characters: False ``` ### -TransportMaintenanceLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2314,13 +2527,15 @@ Accept wildcard characters: False ``` ### -TransportMaintenanceLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2330,13 +2545,15 @@ Accept wildcard characters: False ``` ### -TransportMaintenanceLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2346,13 +2563,15 @@ Accept wildcard characters: False ``` ### -TransportMaintenanceLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2362,13 +2581,15 @@ Accept wildcard characters: False ``` ### -TransportSyncAccountsPoisonAccountThreshold + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2378,13 +2599,15 @@ Accept wildcard characters: False ``` ### -TransportSyncAccountsPoisonDetectionEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2394,13 +2617,15 @@ Accept wildcard characters: False ``` ### -TransportSyncAccountsPoisonItemThreshold + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2410,13 +2635,15 @@ Accept wildcard characters: False ``` ### -TransportSyncAccountsSuccessivePoisonItemThreshold + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2426,13 +2653,15 @@ Accept wildcard characters: False ``` ### -TransportSyncEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2442,13 +2671,15 @@ Accept wildcard characters: False ``` ### -TransportSyncExchangeEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2458,13 +2689,15 @@ Accept wildcard characters: False ``` ### -TransportSyncHubHealthLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2474,13 +2707,15 @@ Accept wildcard characters: False ``` ### -TransportSyncHubHealthLogFilePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2490,13 +2725,15 @@ Accept wildcard characters: False ``` ### -TransportSyncHubHealthLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2506,13 +2743,15 @@ Accept wildcard characters: False ``` ### -TransportSyncHubHealthLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2522,13 +2761,15 @@ Accept wildcard characters: False ``` ### -TransportSyncHubHealthLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2538,13 +2779,15 @@ Accept wildcard characters: False ``` ### -TransportSyncImapEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2554,13 +2797,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2570,13 +2815,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogFilePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2586,13 +2833,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogLoggingLevel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SyncLogLoggingLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2602,13 +2851,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2618,13 +2869,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2634,13 +2887,15 @@ Accept wildcard characters: False ``` ### -TransportSyncLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2650,13 +2905,15 @@ Accept wildcard characters: False ``` ### -TransportSyncMaxDownloadItemsPerConnection + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2666,13 +2923,15 @@ Accept wildcard characters: False ``` ### -TransportSyncMaxDownloadSizePerConnection + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2682,13 +2941,15 @@ Accept wildcard characters: False ``` ### -TransportSyncMaxDownloadSizePerItem + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2698,13 +2959,15 @@ Accept wildcard characters: False ``` ### -TransportSyncPopEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2714,13 +2977,15 @@ Accept wildcard characters: False ``` ### -TransportSyncRemoteConnectionTimeout + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2730,6 +2995,9 @@ Accept wildcard characters: False ``` ### -UseDowngradedExchangeServerAuth + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UseDowngradedExchangeServerAuth parameter specifies whether the Generic Security Services application programming interface (GSSAPI) authentication method is used on connections where Transport Layer Security (TLS) is disabled. Normally, TLS is required for connections between the Transport services on Mailbox servers in your organization. On TLS secured connections, Kerberos authentication is used by default. However, there may be scenarios where you need to disable TLS between specific Transport services in your organization. When you do that, you need to set this parameter to $true to provide an alternative authentication method. The default value is $false. You shouldn't set this value to $true unless it's absolutely required. @@ -2740,7 +3008,6 @@ If you set this parameter to $true, you also need to create a specific Receive c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2750,13 +3017,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2766,13 +3035,15 @@ Accept wildcard characters: False ``` ### -WindowsLiveHotmailTransportSyncEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2782,13 +3053,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2798,13 +3071,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2814,13 +3089,15 @@ Accept wildcard characters: False ``` ### -WlmLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -2830,13 +3107,15 @@ Accept wildcard characters: False ``` ### -WlmLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMAutoAttendant.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-UMAutoAttendant.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMAutoAttendant.md index c224bb9dc4..5845994472 100644 --- a/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMAutoAttendant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMAutoAttendant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umautoattendant +schema: 2.0.0 +title: Set-UMAutoAttendant --- # Set-UMAutoAttendant @@ -102,13 +103,15 @@ This example configures the UM auto attendant MyAutoAttendant and enables busine ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM auto attendant being viewed. This parameter is the directory object ID for the UM auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -AfterHoursKeyMapping + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursKeyMapping parameter specifies the key mappings to be used for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. The following is an example for a custom table that has two entries: @@ -130,7 +136,6 @@ The default value is disabled. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -140,6 +145,9 @@ Accept wildcard characters: False ``` ### -AfterHoursKeyMappingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursKeyMappingEnabled parameter specifies whether to enable or disable key mappings for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. The following is an example for a custom table that has two entries: @@ -150,7 +158,6 @@ The following is an example for a custom table that has two entries: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -160,13 +167,15 @@ Accept wildcard characters: False ``` ### -AfterHoursMainMenuCustomPromptEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursMainMenuCustomPromptEnabled parameter specifies whether the after business hours custom main menu is enabled. The default value is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -176,13 +185,15 @@ Accept wildcard characters: False ``` ### -AfterHoursMainMenuCustomPromptFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursMainMenuCustomPromptFilename parameter specifies the .wav file to be used for the after business hours custom main menu prompt. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -192,13 +203,15 @@ Accept wildcard characters: False ``` ### -AfterHoursTransferToOperatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursTransferToOperatorEnabled parameter specifies whether to allow calls to be transferred to the operator's extension number after business hours. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -208,13 +221,15 @@ Accept wildcard characters: False ``` ### -AfterHoursWelcomeGreetingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursWelcomeGreetingEnabled parameter specifies whether the after hours greeting is enabled. The system default audio is used if this parameter is set to disabled. The default value is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -224,13 +239,15 @@ Accept wildcard characters: False ``` ### -AfterHoursWelcomeGreetingFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AfterHoursWelcomeGreetingFilename parameter specifies the .wav file to be used for the after hours greeting message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -240,13 +257,15 @@ Accept wildcard characters: False ``` ### -AllowDialPlanSubscribers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowDialPlanSubscribers parameter specifies whether to allow the dial plan subscribers to dial numbers that are resolved to a subscriber in the same dial plan. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -256,13 +275,15 @@ Accept wildcard characters: False ``` ### -AllowedInCountryOrRegionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/region dial group names allowed. The names must match group names defined in the dial plan. The string must have fewer than 128 characters. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -272,13 +293,15 @@ Accept wildcard characters: False ``` ### -AllowedInternationalGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInternationalGroups parameter specifies the list of international dial group names allowed. The names must match group names defined in the dial plan. The string must have fewer than 128 characters. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -288,13 +311,15 @@ Accept wildcard characters: False ``` ### -AllowExtensions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowExtensions parameter specifies whether callers can make calls to extensions that have the same number of digits as the number specified on the dial plan object. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -304,6 +329,9 @@ Accept wildcard characters: False ``` ### -BusinessHoursKeyMapping + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursKeyMapping parameter specifies the key mappings for business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. The following is an example for a custom table that has two entries: @@ -316,7 +344,6 @@ The default is disabled. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -326,13 +353,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursKeyMappingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursKeyMappingEnabled parameter specifies whether the custom menus for business hours are enabled or disabled. The default value is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -342,13 +371,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursMainMenuCustomPromptEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursMainMenuCustomPromptEnabled parameter specifies whether the business hours custom main menu prompt is enabled. The default value is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -358,13 +389,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursMainMenuCustomPromptFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursMainMenuCustomPromptFilename parameter specifies the .wav file to be used for the business hours custom main menu prompt. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -374,6 +407,9 @@ Accept wildcard characters: False ``` ### -BusinessHoursSchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursSchedule parameter specifies the hours the business is open. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. @@ -401,7 +437,6 @@ Here are some examples: Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -411,13 +446,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursTransferToOperatorEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursTransferToOperatorEnabled parameter specifies whether to allow call transfers to the operator's extension number during business hours. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -427,13 +464,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursWelcomeGreetingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursWelcomeGreetingEnabled parameter specifies whether the custom business hours greeting is enabled. The system default audio is used if this parameter is set to disabled. The default value is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -443,13 +482,15 @@ Accept wildcard characters: False ``` ### -BusinessHoursWelcomeGreetingFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessHoursWelcomeGreetingFilename parameter specifies the .wav file to be used for the welcome message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -459,13 +500,15 @@ Accept wildcard characters: False ``` ### -BusinessLocation + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessLocation parameter specifies what the Mailbox server should read to the caller who selected the business location option on a UM auto attendant menu. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -475,13 +518,15 @@ Accept wildcard characters: False ``` ### -BusinessName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The BusinessName parameter specifies the name of the company or organization being used to generate the UM auto attendant welcome greeting for callers. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -491,13 +536,15 @@ Accept wildcard characters: False ``` ### -CallSomeoneEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -507,6 +554,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -516,7 +566,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -526,13 +575,15 @@ Accept wildcard characters: False ``` ### -ContactAddressList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactAddressList parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, this parameter defines the scope for directory searches. ```yaml Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -542,13 +593,15 @@ Accept wildcard characters: False ``` ### -ContactRecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches. ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -558,13 +611,15 @@ Accept wildcard characters: False ``` ### -ContactScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactScope parameter specifies the scope of the directory search given to callers when they access the UM auto attendant and specify a user's name. ```yaml Type: DialScopeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -574,13 +629,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -590,13 +647,15 @@ Accept wildcard characters: False ``` ### -DTMFFallbackAutoAttendant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DTMFFallbackAutoAttendant parameter specifies the dual tone multi-frequency (DTMF) auto attendant used if the speech-enabled auto attendant is unavailable. If the SpeechEnabled parameter is set to $true, this auto attendant must have an associated DTMF auto attendant to use as the fallback auto attendant. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -606,13 +665,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -622,6 +683,9 @@ Accept wildcard characters: False ``` ### -HolidaySchedule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The HolidaySchedule parameter specifies the holiday schedule for the organization. The schedule is formatted as an array of strings. Each string contains three parts: - Name, which is limited to 64 characters @@ -636,7 +700,6 @@ The following is an example: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -646,13 +709,15 @@ Accept wildcard characters: False ``` ### -InfoAnnouncementEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InfoAnnouncementEnabled parameter specifies whether to enable the informational greeting. The default setting is $true. ```yaml Type: InfoAnnouncementEnabledEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -662,13 +727,15 @@ Accept wildcard characters: False ``` ### -InfoAnnouncementFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InfoAnnouncementFilename parameter specifies the .wav file to be used for the informational announcement. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -678,13 +745,15 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Language parameter specifies the language used by the UM auto attendant. This language is selected from the list of available dial plan languages. ```yaml Type: UMLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -694,6 +763,9 @@ Accept wildcard characters: False ``` ### -MatchedNameSelectionMethod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MatchedNameSelectionMethod parameter specifies the selection to use to differentiate between users who have names that match the touchtone or speech input. This setting can be set to the following: - Department @@ -707,7 +779,6 @@ The MatchedNameSelectionMethod parameter specifies the selection to use to diffe Type: AutoAttendantDisambiguationFieldEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -717,13 +788,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name to be used for the UM auto attendant. This name is limited to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -733,13 +806,15 @@ Accept wildcard characters: False ``` ### -NameLookupEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NameLookupEnabled parameter specifies whether to allow callers to perform directory lookups by dialing the name or by speaking the name. This parameter can prevent callers from connecting to unknown extensions. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -749,13 +824,15 @@ Accept wildcard characters: False ``` ### -OperatorExtension + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the dial plan operator is used. If the dial plan operator isn't specified, the feature isn't enabled. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -765,13 +842,15 @@ Accept wildcard characters: False ``` ### -PilotIdentifierList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PilotIdentifierList parameter specifies a list of one or more pilot numbers. Pilot numbers are used to route incoming calls to Mailbox servers. The calls are then answered by the UM auto attendant. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -781,13 +860,15 @@ Accept wildcard characters: False ``` ### -SendVoiceMsgEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SendVoiceMsgEnabled parameter specifies whether to allow the Send Message feature. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -797,13 +878,15 @@ Accept wildcard characters: False ``` ### -SpeechEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SpeechEnabled parameter specifies whether the auto attendant is speech-enabled. The default setting on the UM auto attendant is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -813,13 +896,15 @@ Accept wildcard characters: False ``` ### -Timezone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Timezone parameter specifies the time zone used with the auto attendant. The default time zone is the time zone setting on the server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -829,13 +914,15 @@ Accept wildcard characters: False ``` ### -Timezone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Timezone parameter specifies the time zone used with the auto attendant. The default time zone is the time zone setting on the server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -845,13 +932,15 @@ Accept wildcard characters: False ``` ### -TimeZoneName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TimeZoneName parameter specifies all or part of a MicrosoftWindows time zone display name. The string is compared to the display names in the local system registry to determine a simple contains match. An error is returned if the time zone name isn't correct. ```yaml Type: UMTimeZone Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -861,13 +950,15 @@ Accept wildcard characters: False ``` ### -WeekStartDay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WeekStartDay parameter specifies the starting day of the week. The valid values for this parameter are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. ```yaml Type: DayOfWeek Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -877,13 +968,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMCallAnsweringRule.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMCallAnsweringRule.md index f5a3f24afa..c0944e0ead 100644 --- a/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMCallAnsweringRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 -title: Set-UMCallAnsweringRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umcallansweringrule +schema: 2.0.0 +title: Set-UMCallAnsweringRule --- # Set-UMCallAnsweringRule @@ -121,13 +122,15 @@ This example sets a custom period for the time of day on the call answering rule ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for a call answering rule being changed. ```yaml Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -137,13 +140,15 @@ Accept wildcard characters: False ``` ### -CallerIds + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CallerIds parameter specifies an entry for the "If the Caller is" condition. Each entry for this parameter can contain a phone number, an Active Directory contact, a personal contact, or the personal Contacts folder. The parameter can contain 50 phone numbers or contact entries and no more than one entry for specifying the default Contacts folder. If the CallerIds parameter doesn't contain a condition, the condition isn't set and is ignored. The default value is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -153,13 +158,15 @@ Accept wildcard characters: False ``` ### -CallersCanInterruptGreeting + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CallersCanInterruptGreeting parameter specifies whether a caller can interrupt the voice mail greeting while it's being played. The default is $null. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -169,13 +176,15 @@ Accept wildcard characters: False ``` ### -CheckAutomaticReplies + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CheckAutomaticReplies parameter specifies an entry for the "If My Automatic Replies are Enabled" condition. The default is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -185,6 +194,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -194,7 +206,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -204,13 +215,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -220,13 +233,15 @@ Accept wildcard characters: False ``` ### -ExtensionsDialed + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The ExtensionsDialed parameter specifies an entry for the "If the Caller Dials" condition. Each entry must be unique per call answering rule. Each extension must correspond to existing extension numbers assigned to UM-enabled users. The default is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -236,13 +251,15 @@ Accept wildcard characters: False ``` ### -KeyMappings + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The KeyMappings parameter specifies a key mapping entry for a call answering rule. The key mappings are those menu options offered to callers if the call answering rule is set to $true. You can configure a maximum of 10 entries. None of the defined key mappings can overlap. The default is $null. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -252,6 +269,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule will be changed. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -271,7 +291,6 @@ If you don't use this parameter, the mailbox of the user who is running the comm Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -281,13 +300,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the name of the UM call answering rule or Call Answering Rule ID being modified. The call answering ID or name must be unique per the user's UM-enabled mailbox. The name or ID for the call answering rule can contain up to 255 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -297,13 +318,15 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Priority parameter specified the order that the call answering rule will be evaluated against other existing call answering rules. Call answering rules are processed in order of increasing priority values. The priority must be unique between all call answering rules in the UM-enabled mailbox. The priority on the call answering rule must be between 1 (highest) and 9 (lowest). The default is 9. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -313,6 +336,9 @@ Accept wildcard characters: False ``` ### -ScheduleStatus + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The ScheduleStatus parameter specifies an entry for the "If my Schedule show that I am" condition. Users can specify their free/busy status to be checked. This parameter can be set from 0 through 15 and is interpreted as a 4-bit mask that represents the calendar status including Free, Tentative, Busy and Out of Office. The following settings can be used to set the schedule status: - None = 0x0 @@ -327,7 +353,6 @@ The default setting is $null. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -337,13 +362,15 @@ Accept wildcard characters: False ``` ### -TimeOfDay + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The TimeOfDay parameter specifies an entry for the "If the Call Arrives During" condition for the call answering rule. You can specify working hours, non-working hours or custom hours. The default is $null. ```yaml Type: TimeOfDay Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -353,13 +380,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMCallRouterSettings.md similarity index 92% rename from exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMCallRouterSettings.md index e2d42d19d4..d7d8b0961c 100644 --- a/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMCallRouterSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umcallroutersettings applicable: Exchange Server 2013, Exchange Server 2016 -title: Set-UMCallRouterSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umcallroutersettings +schema: 2.0.0 +title: Set-UMCallRouterSettings --- # Set-UMCallRouterSettings @@ -62,6 +63,9 @@ This example removes the Exchange server named UMCallRouter001 from all UM SIP d ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -75,7 +79,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -94,7 +100,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -DialPlans + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DialPlans parameter specifies the dial plan used by the Microsoft Exchange Unified Messaging Call Router service. The Exchange server only needs to be associated with a UM dial plan if Lync Server 2010, Lync Server 2013, or Skype for Business Server 2015 is used in your organization. To remove an Exchange server from a dial plan, use $null. The default is no dial plans assigned. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -114,7 +122,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -124,13 +131,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -IPAddressFamily + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IPAddressFamily parameter specifies whether the UM IP gateway will use Internet Protocol version 4 (IPv4), IPv6, or both to communicate. If set to IPv4Only, the UM IP gateway only uses IPv4 to communicate. If set to IPv6Only, the UM IP gateway only uses IPv6. If set to Any, IPv6 is used first, and then if necessary, it falls back to IPv4. The default is Any. ```yaml Type: IPAddressFamily Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -156,13 +167,15 @@ Accept wildcard characters: False ``` ### -IPAddressFamilyConfigurable + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IPAddressFamilyConfigurable parameter specifies whether you're able to set the IPAddressFamily parameter to IPv6Only or Any. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -MaxCallsAllowed + +> Applicable: Exchange Server 2013, Exchange Server 2016 + This parameter has been deprecated and is no longer used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -SipTcpListeningPort + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The SipTcpListeningPort parameter specifies the TCP port that's used by the Microsoft Exchange Unified Messaging Call Router service to receive incoming calls. This TCP port is used when a UM dial plan isn't configured to use SIP Secured or Secured mode. The default is port 5060. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -SipTlsListeningPort + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The SipTlsListeningPort parameter specifies the Transport Layer Security (TLS) port that's used by the Microsoft Exchange Unified Messaging Call Router service to receive incoming calls. This TLS port is used when a UM dial plan is configured to use SIP Secured or Secured mode. The default is port 5061. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -220,13 +239,15 @@ Accept wildcard characters: False ``` ### -UMStartupMode + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The UMStartupMode parameter specifies whether the Microsoft Exchange Unified Messaging Call Router service starts up in TCP, TLS, or Dual mode. If the Exchange server isn't associated with any UM dial plans or is being added to UM dial plans that have different security settings, you should choose Dual mode. In Dual mode, the Microsoft server can listen on ports 5060 and 5061 at the same time. If the startup mode is changed, the Microsoft Exchange Unified Messaging Call Router service must be restarted. ```yaml Type: UMStartupMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -236,13 +257,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMDialPlan.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMDialPlan.md similarity index 86% rename from exchange/exchange-ps/exchange/Set-UMDialPlan.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMDialPlan.md index 0255771570..66c7c50481 100644 --- a/exchange/exchange-ps/exchange/Set-UMDialPlan.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMDialPlan.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMDialPlan -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umdialplan +schema: 2.0.0 +title: Set-UMDialPlan --- # Set-UMDialPlan @@ -114,13 +115,15 @@ This example configures the UM dial plan MyDialPlan with dialing rules. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the UM dial plan ID. This parameter is the directory object identifier for the UM dial plan. This parameter is used to link mailboxes and Mailbox and Client Access servers to dial plans. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -130,13 +133,15 @@ Accept wildcard characters: False ``` ### -AccessTelephoneNumbers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AccessTelephoneNumbers parameter specifies a single valid voice mail pilot number or a list of valid voice mail pilot numbers. This list is presented to you when a user is being enabled for Unified Messaging. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -146,13 +151,15 @@ Accept wildcard characters: False ``` ### -AllowDialPlanSubscribers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowDialPlanSubscribers parameter specifies whether to allow subscribers dial numbers that resolve to a subscriber within the same dial plan. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -162,13 +169,15 @@ Accept wildcard characters: False ``` ### -AllowedInCountryOrRegionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/region names from the same dial group that can be dialed. The name of the allowed in-country/region group must match the group name specified in the UM dial plan. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -178,13 +187,15 @@ Accept wildcard characters: False ``` ### -AllowedInternationalGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInternationalGroups parameter specifies the list of international dial group names allowed. The international dial group name must match the group name specified in the dial plan. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -194,13 +205,15 @@ Accept wildcard characters: False ``` ### -AllowExtensions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowExtensions parameter specifies whether to allow calls to dial plan extensions. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -210,13 +223,15 @@ Accept wildcard characters: False ``` ### -AllowHeuristicADCallingLineIdResolution + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowHeuristicADCallingLineIdResolution parameter specifies whether to allow calling line ID resolution using telephone number fields that may be configured in Active Directory. When this parameter is set to $true, the telephone numbers such as those defined in the Mobile or Home telephone number fields in Active Directory are used. Setting this parameter to $true allows for resolution of calling IDs for both UM-enabled and non-UM-enabled users. The default is $true. You may want to set this parameter to $false if the telephone numbers for users aren't in a standard format. If the telephone numbers aren't in a standard format, the Mailbox server may not be able to correctly resolve the caller ID to a name of a user in a consistent manner. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -226,13 +241,15 @@ Accept wildcard characters: False ``` ### -AudioCodec + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AudioCodec parameter specifies the audio codec used for recording. Mp3 is the default setting. ```yaml Type: AudioCodecEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -242,13 +259,15 @@ Accept wildcard characters: False ``` ### -AutomaticSpeechRecognitionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AutomaticSpeechRecognitionEnabled parameter specifies whether Automatic Speech Recognition (ASR) is enabled for users who are members of the dial plan. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -258,13 +277,15 @@ Accept wildcard characters: False ``` ### -CallAnsweringRulesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CallAnsweringRulesEnabled parameter specifies whether Call Answering Rules are enabled for UM-enabled users associated with the UM dial plan. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -274,13 +295,15 @@ Accept wildcard characters: False ``` ### -CallSomeoneEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -290,6 +313,9 @@ Accept wildcard characters: False ``` ### -ConfiguredInCountryOrRegionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ConfiguredInCountryOrRegionGroups parameter specifies the in-country groups that can be used. Each string consists of four parts: - Group name (up to 32 characters) @@ -301,7 +327,6 @@ The ConfiguredInCountryOrRegionGroups parameter specifies the in-country groups Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -311,6 +336,9 @@ Accept wildcard characters: False ``` ### -ConfiguredInternationalGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ConfiguredInternationalGroups parameter specifies the international groups that can be used. Each string consists of four parts: - Group name (up to 32 characters) @@ -322,7 +350,6 @@ The ConfiguredInternationalGroups parameter specifies the international groups t Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -332,6 +359,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -341,7 +371,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -351,13 +380,15 @@ Accept wildcard characters: False ``` ### -ContactAddressList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactAddressList parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, this parameter defines the scope for directory searches. ```yaml Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -367,13 +398,15 @@ Accept wildcard characters: False ``` ### -ContactRecipientContainer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches. ```yaml Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -383,13 +416,15 @@ Accept wildcard characters: False ``` ### -ContactScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ContactScope parameter specifies the scope of the directory search provided to callers when they access the UM dial plan and specify a user's name. ```yaml Type: CallSomeoneScopeEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -399,13 +434,15 @@ Accept wildcard characters: False ``` ### -CountryOrRegionCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is located. For example, 1 is the code used for North America, and 44 is the code used for the United Kingdom. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -415,13 +452,15 @@ Accept wildcard characters: False ``` ### -DefaultLanguage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DefaultLanguage parameter specifies the default language of the system. This default language is selected from the list of available languages. The default value is U.S. English. ```yaml Type: UMLanguage Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -431,13 +470,15 @@ Accept wildcard characters: False ``` ### -DialByNamePrimary + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DialByNamePrimary parameter specifies that the Dial by Name lookup key is to be created from the specified source. The default value is LastFirst. ```yaml Type: DialByNamePrimaryEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -447,13 +488,15 @@ Accept wildcard characters: False ``` ### -DialByNameSecondary + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DialByNameSecondary parameter specifies that the secondary Dial by Name lookup key is to be created from the specified source. The default value is SMTPAddress. ```yaml Type: DialByNameSecondaryEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -463,13 +506,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -479,13 +524,15 @@ Accept wildcard characters: False ``` ### -EquivalentDialPlanPhoneContexts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The EquivalentDialPlanPhoneContexts parameter specifies the name of an equivalency dial plan. This parameter can be used when two UM dial plans exist but are in different forests or when a Private Branch eXchange (PBX) numbering plan spans two UM dial plans. Adding the name of the equivalency dial plan allows name lookups using a caller ID to search in the user's dial plan but then also search for a name for the calling line ID in any equivalent dial plans that are configured. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -495,13 +542,15 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Extension parameter specifies the extension number used by the Call Someone feature when a call is transferred. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -511,13 +560,15 @@ Accept wildcard characters: False ``` ### -FaxEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The FaxEnabled parameter specifies whether the Mailbox servers associated with the UM dial plan answers and processes incoming fax calls. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -527,13 +578,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -543,13 +596,15 @@ Accept wildcard characters: False ``` ### -InCountryOrRegionNumberFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InCountryOrRegionNumberFormat parameter specifies the prefix string to use and the number of digits to take from the directory. This number is used when dialing into this dial plan from inside the same country or region code. ```yaml Type: NumberFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -559,13 +614,15 @@ Accept wildcard characters: False ``` ### -InfoAnnouncementEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InfoAnnouncementEnabled parameter specifies whether an informational announcement is enabled. This parameter can be set to True, False, or Uninterruptible. The default value is False. ```yaml Type: InfoAnnouncementEnabledEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -575,13 +632,15 @@ Accept wildcard characters: False ``` ### -InfoAnnouncementFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InfoAnnouncementFilename parameter specifies the audio file name for an informational announcement. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -591,13 +650,15 @@ Accept wildcard characters: False ``` ### -InputFailuresBeforeDisconnect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InputFailuresBeforeDisconnect parameter specifies the number of sequential user input errors allowed before the call is disconnected. The default value is 3. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -607,13 +668,15 @@ Accept wildcard characters: False ``` ### -InternationalAccessCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InternationalAccessCode parameter specifies the code that precedes a telephone number to dial international calls. For example, 011 is the code used to call the United States. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -623,13 +686,15 @@ Accept wildcard characters: False ``` ### -InternationalNumberFormat + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InternationalNumberFormat parameter specifies the prefix string to use and the number of digits to take from the directory, when dialing into this dial plan from a different country code. ```yaml Type: NumberFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -639,13 +704,15 @@ Accept wildcard characters: False ``` ### -LegacyPromptPublishingPoint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The LegacyPromptPublishingPoint parameter was used to specify the location of the prompt publishing point for Exchange Server 2007 Unified Messaging servers. This parameter was used in coexistence scenarios when Exchange 2007 Unified Messaging servers were also included in the UM dial plan. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -655,13 +722,15 @@ Accept wildcard characters: False ``` ### -LogonFailuresBeforeDisconnect + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The LogonFailuresBeforeDisconnect parameter specifies the number of sequential unsuccessful logon attempts that can be made before the call is disconnected. The default value is 3. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -671,6 +740,9 @@ Accept wildcard characters: False ``` ### -MatchedNameSelectionMethod + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MatchedNameSelectionMethod parameter specifies the selection to use to differentiate between users who have names that match the touchtone or speech input. This setting can be set to the following: - Title @@ -683,7 +755,6 @@ The MatchedNameSelectionMethod parameter specifies the selection to use to diffe Type: DisambiguationFieldEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -693,13 +764,15 @@ Accept wildcard characters: False ``` ### -MaxCallDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MaxCallDuration parameter specifies the maximum length of time that a call can last before it's interrupted and the call is dropped. The default value is 30 minutes. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -709,13 +782,15 @@ Accept wildcard characters: False ``` ### -MaxRecordingDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MaxRecordingDuration parameter specifies the maximum length of time that messages can be recorded. This includes all kinds of calls. The default is 20 minutes. The value of this setting can be from 1 through 100. Setting this value too low can cause long voice messages to be disconnected before they are completed. Setting this value too high lets users save lengthy voice messages in their Inboxes. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -725,13 +800,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name to use for the UM dial plan. This name is limited to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -741,13 +818,15 @@ Accept wildcard characters: False ``` ### -NationalNumberPrefix + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NationalNumberPrefix parameter specifies the dialing code that precedes a telephone number when placing calls from one local area to another within a specific country or region. For example, 1 is the code used within North America, and 0 is the code used within the United Kingdom. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -757,13 +836,15 @@ Accept wildcard characters: False ``` ### -NumberingPlanFormats + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NumberingPlanFormats parameter specifies one or more phone number masks that can be used for resolving caller ID to names of users in Active Directory. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -773,13 +854,15 @@ Accept wildcard characters: False ``` ### -OperatorExtension + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the Do Not Allow Transfer to the Operator feature is unavailable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -789,13 +872,15 @@ Accept wildcard characters: False ``` ### -OutsideLineAccessCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OutsideLineAccessCode parameter specifies the code that precedes a telephone number to dial an external in-country telephone number. This code is also referred to as a trunk access code. The default value is 9. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -805,13 +890,15 @@ Accept wildcard characters: False ``` ### -PilotIdentifierList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PilotIdentifierList parameter specifies the pilot numbers configured on the dial plan. A single dial plan can have multiple pilot numbers. The pilot numbers must be in the E.164 format. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -821,13 +908,15 @@ Accept wildcard characters: False ``` ### -RecordingIdleTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The RecordingIdleTimeout parameter specifies the length of time that a caller can be silent when recording a voice message before the recording is ended. The default value is 5 seconds. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -837,13 +926,15 @@ Accept wildcard characters: False ``` ### -SendVoiceMsgEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SendVoiceMsgEnabled parameter specifies whether the Send Message feature is enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -853,13 +944,15 @@ Accept wildcard characters: False ``` ### -TUIPromptEditingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TUIPromptEditingEnabled parameter specifies whether authorized users are permitted to record UM dial plan or automated attendant prompts by using the Telephone User Interface (TUI). The default setting is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -869,13 +962,15 @@ Accept wildcard characters: False ``` ### -UMAutoAttendant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMAutoAttendant parameter specifies the auto attendant run when the caller presses the star (\*) key. If this parameter is specified, it overrides the Call Someone feature. ```yaml Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -885,13 +980,15 @@ Accept wildcard characters: False ``` ### -VoIPSecurity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoIPSecurity parameter specifies whether the Voice over IP (VoIP) traffic is encrypted or that the signaling channel or the signaling and the media channels are encrypted by using mutual Transport Layer Security (TLS). The default setting is Unsecured. ```yaml Type: UMVoIPSecurityType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -901,13 +998,15 @@ Accept wildcard characters: False ``` ### -WelcomeGreetingEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WelcomeGreetingEnabled parameter specifies whether a custom welcome greeting is enabled. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -917,13 +1016,15 @@ Accept wildcard characters: False ``` ### -WelcomeGreetingFilename + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WelcomeGreetingFilename parameter specifies the audio file name for the welcome greeting. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -933,13 +1034,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMIPGateway.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMIPGateway.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-UMIPGateway.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMIPGateway.md index af9d1ffda1..31c4296216 100644 --- a/exchange/exchange-ps/exchange/Set-UMIPGateway.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMIPGateway.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMIPGateway -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umipgateway +schema: 2.0.0 +title: Set-UMIPGateway --- # Set-UMIPGateway @@ -80,13 +81,15 @@ This example enables the UM IP gateway to function as an IP gateway simulator an ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM IP gateway being modified. This parameter is the directory object ID for the UM IP gateway. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -Address + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Address parameter specifies the IP address or the fully qualified domain name (FQDN) configured on the UM IP gateway or SIP-enabled IP PBX. An FQDN is required if the UM dial plan associated with the UM IP gateway is operating in SIP Secured or Secured mode. If an FQDN is used, verify that the Domain Name System (DNS) has been configured correctly. ```yaml Type: UMSmartHost Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -121,7 +129,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -DelayedSourcePartyInfoEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DelayedSourcePartyInfoEnabled parameter specifies whether Unified Messaging should delay the process of accepting an inbound call from the Voice over IP (VoIP) gateway if the corresponding SIP INVITE of the call contains no calling party and diversion information. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -163,13 +174,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -179,6 +192,9 @@ Accept wildcard characters: False ``` ### -IPAddressFamily + +> Applicable: Exchange Server 2013, Exchange Server 2016 + 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. @@ -189,7 +205,6 @@ The IPAddressFamily parameter specifies whether the UM IP gateway will use Inter Type: IPAddressFamily Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -MessageWaitingIndicatorAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MessageWaitingIndicatorAllowed parameter specifies whether to enable the UM IP gateway to allow SIP NOTIFY messages to be sent to users associated with a UM dial plan and the UM IP gateway. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -215,13 +232,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the UM IP gateway. This display name is limited to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -231,13 +250,15 @@ Accept wildcard characters: False ``` ### -OutcallsAllowed + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OutcallsAllowed parameter specifies whether to allow this UM IP gateway to be used for outgoing calls. This doesn't govern call transfers. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -247,13 +268,15 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Port parameter specifies the IP port on which the IP gateway or IP PBX is listening. By default, it's port 5060. The range for this parameter is from 0 through 65535. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -263,13 +286,15 @@ Accept wildcard characters: False ``` ### -Simulator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Simulator parameter specifies the simulator used for the UM IP gateway being viewed. A simulator allows a client to connect to the Mailbox server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -279,6 +304,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Status parameter specifies whether to enable or disable the UM IP gateway. Valid values are: - Enabled @@ -289,7 +317,6 @@ The Status parameter specifies whether to enable or disable the UM IP gateway. V Type: GatewayStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -299,13 +326,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailbox.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-UMMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMMailbox.md index 7e179f4bc5..642df840a8 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ummailbox +schema: 2.0.0 +title: Set-UMMailbox --- # Set-UMMailbox @@ -81,6 +82,9 @@ This example prevents the user tony@contoso.com from accessing his calendar and ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -98,7 +102,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -108,13 +111,15 @@ Accept wildcard characters: False ``` ### -AllowUMCallsFromNonUsers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowUMCallsFromNonUsers parameter specifies whether to exclude the mailbox from Unified Messaging directory searches. ```yaml Type: AllowUMCallsFromNonUsersFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -124,13 +129,15 @@ Accept wildcard characters: False ``` ### -AnonymousCallersCanLeaveMessages + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AnonymousCallersCanLeaveMessages parameter specifies whether diverted calls without a caller ID are allowed to leave a message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -140,13 +147,15 @@ Accept wildcard characters: False ``` ### -AutomaticSpeechRecognitionEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AutomaticSpeechRecognitionEnabled parameter specifies whether users can use Automatic Speech Recognition (ASR) when they log on to their mailbox. This parameter can only be set to $true if there is ASR support for the language selected by the user in Microsoft Outlook on the web Options. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -CallAnsweringAudioCodec + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CallAnsweringAudioCodec parameter specifies the audio codec used to encode voice mail messages left for the user. The audio codec used is the audio codec set on the UM dial plan. The default value is Mp3. ```yaml Type: AudioCodecEnum Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -CallAnsweringRulesEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CallAnsweringRulesEnabled parameter specifies whether users can configure or set up Call Answering Rules for their accounts. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -197,7 +213,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -207,13 +222,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -223,13 +240,15 @@ Accept wildcard characters: False ``` ### -FaxEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The FaxEnabled parameter specifies whether a user is allowed to receive incoming faxes. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -239,6 +258,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -250,7 +272,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -260,6 +281,9 @@ Accept wildcard characters: False ``` ### -ImListMigrationCompleted + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The ImListMigrationCompleted parameter specifies whether the UM-enabled user's Lync or Skype for Business contact list is stored in their mailbox. Valid values are: @@ -275,7 +299,6 @@ If you migrate an Exchange 2013 mailbox back to Exchange 2010 while the user's L Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -285,6 +308,9 @@ Accept wildcard characters: False ``` ### -MissedCallNotificationEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MissedCallNotificationEnabled parameter specifies whether to send missed call notifications. When you're integrating Unified Messaging and Lync Server or Skype for Business Server, missed call notifications aren't available to users who have mailboxes located on Exchange 2010 Mailbox servers. A missed call notification is generated when a user disconnects before the call is sent to a Mailbox server. @@ -293,7 +319,6 @@ When you're integrating Unified Messaging and Lync Server or Skype for Business Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -303,13 +328,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the user. The display name is limited to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -319,13 +346,15 @@ Accept wildcard characters: False ``` ### -OperatorNumber + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The OperatorNumber parameter specifies the string of digits for the personal operator. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -335,13 +364,15 @@ Accept wildcard characters: False ``` ### -PinlessAccessToVoiceMailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PinlessAccessToVoiceMailEnabled parameter specifies whether UM-enabled users are required to use a PIN to access their voice mail. A PIN is still required to access email and the calendar. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -351,13 +382,15 @@ Accept wildcard characters: False ``` ### -PlayOnPhoneEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PlayOnPhoneEnabled parameter specifies whether a user can use the Play on Phone feature to listen to voice messages. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -367,13 +400,15 @@ Accept wildcard characters: False ``` ### -SubscriberAccessEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SubscriberAccessEnabled parameter specifies whether the users are allowed subscriber access to their individual mailboxes. If it's set to $true, after users are authenticated, they're able to retrieve voice mail over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -383,13 +418,15 @@ Accept wildcard characters: False ``` ### -TUIAccessToCalendarEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TUIAccessToCalendarEnabled parameter specifies whether UM-enabled users can access and manage their individual calendar using the Microsoft Outlook Voice Access telephone user interface (TUI) or touchtone interface. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -399,13 +436,15 @@ Accept wildcard characters: False ``` ### -TUIAccessToEmailEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TUIAccessToEmailEnabled parameter specifies whether users can access their individual email messages over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -415,13 +454,15 @@ Accept wildcard characters: False ``` ### -UMMailboxPolicy + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMMailboxPolicy parameter specifies the UM mailbox policy associated with the UM-enabled user's mailbox. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -431,13 +472,15 @@ Accept wildcard characters: False ``` ### -UMSMSNotificationOption + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMSMSNotificationOption parameter specifies whether a UM-enabled user gets SMS or text messaging notifications for voice mail only, voice mail and missed calls, or no notifications. The values for this parameter are: VoiceMail, VoiceMailAndMissedCalls, and None. The default value is None. ```yaml Type: UMSMSNotificationOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -447,13 +490,15 @@ Accept wildcard characters: False ``` ### -VoiceMailAnalysisEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The VoiceMailAnalysisEnabled parameter specifies whether a copy of each voice mail left for a UM-enabled user will be forwarded to Microsoft for analysis and improvement of speech recognition features. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -463,13 +508,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPIN.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-UMMailboxPIN.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPIN.md index bec81a4cf6..12b5298d35 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPIN.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ummailboxpin applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMMailboxPIN -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ummailboxpin +schema: 2.0.0 +title: Set-UMMailboxPIN --- # Set-UMMailboxPIN @@ -74,6 +75,9 @@ This example unlocks the UM-enabled mailbox for tonysmith@contoso.com and allows ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -91,7 +95,6 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -110,7 +116,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -147,7 +157,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -157,13 +166,15 @@ Accept wildcard characters: False ``` ### -LockedOut + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The LockedOut parameter specifies whether the mailbox will continue to be locked. If set to $true, the mailbox is marked as locked out. By default, if this parameter is omitted or set to $false, the command clears the locked-out status on the mailbox. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -173,13 +184,15 @@ Accept wildcard characters: False ``` ### -NotifyEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The NotifyEmail parameter specifies the email address to which the server sends the email message that contains the PIN reset information. By default, the message is sent to the SMTP address of the enabled user. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -189,13 +202,15 @@ Accept wildcard characters: False ``` ### -Pin + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Pin parameter specifies a new PIN for use with the mailbox. The PIN is checked against the PIN rules defined in the Unified Messaging mailbox policy. If the PIN isn't supplied, the command generates a new PIN for the mailbox and includes it in an email message sent to the user. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -205,13 +220,15 @@ Accept wildcard characters: False ``` ### -PINExpired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PINExpired parameter specifies whether the PIN is treated as expired. If this parameter is supplied and is set to $false, the user isn't required to reset the PIN the next time that the user logs on. If the PIN isn't supplied, the PIN is treated as expired and the user is prompted to reset the PIN the next time that the user logs on. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -221,13 +238,15 @@ Accept wildcard characters: False ``` ### -SendEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SendEmail parameter specifies whether to send a PIN to the user in an email message. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -237,13 +256,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -253,13 +274,15 @@ Accept wildcard characters: False ``` ### -PINExpired + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PINExpired parameter specifies whether the PIN is treated as expired. If this parameter is supplied and is set to $false, the user isn't required to reset the PIN the next time that the user logs on. If the PIN isn't supplied, the PIN is treated as expired and the user is prompted to reset the PIN the next time that the user logs on. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPolicy.md similarity index 87% rename from exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPolicy.md index 789aabc713..abb4d78fb2 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMMailboxPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Set-UMMailboxPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-ummailboxpolicy +schema: 2.0.0 +title: Set-UMMailboxPolicy --- # Set-UMMailboxPolicy @@ -106,13 +107,15 @@ This example configures the text of voice mail messages sent to UM-enabled users ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the identifier for the UM mailbox policy being modified. This is the directory object ID for the UM mailbox policy. ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -122,13 +125,15 @@ Accept wildcard characters: False ``` ### -AllowAutomaticSpeechRecognition + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowAutomaticSpeechRecognition parameter specifies whether users associated with the UM mailbox policy can use Automatic Speech Recognition (ASR). The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -138,13 +143,15 @@ Accept wildcard characters: False ``` ### -AllowCallAnsweringRules + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowCallAnsweringRules parameter specifies whether users associated with the UM mailbox policy are allowed to configure or set up Call Answering Rules for their accounts. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -154,13 +161,15 @@ Accept wildcard characters: False ``` ### -AllowCommonPatterns + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowCommonPatterns parameter specifies whether to allow obvious PINs. Examples of obvious PINs include subsets of the telephone number, sequential numbers, or repeated numbers. If set to $false, sequential and repeated numbers and the suffix of the mailbox extension are rejected. If set to $true, only the suffix of the mailbox extension is rejected. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -170,13 +179,15 @@ Accept wildcard characters: False ``` ### -AllowDialPlanSubscribers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowDialPlanSubscribers parameter specifies whether to let subscribers in a dial plan dial a number that resolves to another subscriber within the same dial plan. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -186,13 +197,15 @@ Accept wildcard characters: False ``` ### -AllowedInCountryOrRegionGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInCountryOrRegionGroups parameter specifies whether to let subscribers dial the list of in-country/region dial group names. The names that subscribers are allowed to dial must match the group names defined in the UM dial plan. The string is limited to 128 characters. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -202,13 +215,15 @@ Accept wildcard characters: False ``` ### -AllowedInternationalGroups + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowedInternationalGroups parameter specifies whether to let subscribers dial the list of international dial group names. The names that subscribers dial must match the group names defined in the dial plan. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -218,13 +233,15 @@ Accept wildcard characters: False ``` ### -AllowExtensions + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowExtensions parameter specifies whether to let subscribers dial calls to the number of digits specified on the UM dial plan. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -234,13 +251,15 @@ Accept wildcard characters: False ``` ### -AllowFax + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowFax parameter specifies whether users associated with the UM mailbox policy are allowed to receive incoming faxes. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -250,13 +269,15 @@ Accept wildcard characters: False ``` ### -AllowMessageWaitingIndicator + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowMessageWaitingIndicator parameter specifies whether users associated with the UM mailbox policy can receive notifications that they've received a new voice mail message. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -266,6 +287,9 @@ Accept wildcard characters: False ``` ### -AllowMissedCallNotifications + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowMissedCallNotifications parameter specifies whether missed call notifications are enabled for users associated with the UM mailbox policy. The default value is $true. When you're integrating Unified Messaging and Lync Server or Skype for Business Server, missed call notifications aren't available to users who have mailboxes located on Exchange 2010 Mailbox servers. A missed call notification is generated when a user disconnects before the call is sent to a Mailbox server. @@ -274,7 +298,6 @@ When you're integrating Unified Messaging and Lync Server or Skype for Business Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -284,13 +307,15 @@ Accept wildcard characters: False ``` ### -AllowPinlessVoiceMailAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowPinlessVoiceMailAccess parameter specifies whether users associated with the UM mailbox policy are required to use a PIN to access their voice mail. A PIN is still required to access their email and calendar. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -300,13 +325,15 @@ Accept wildcard characters: False ``` ### -AllowPlayOnPhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowPlayOnPhone parameter specifies whether users associated with the UM mailbox policy can use the Play on Phone feature to listen to voice mail messages. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -316,13 +343,15 @@ Accept wildcard characters: False ``` ### -AllowSMSNotification + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowSMSNotification parameter specifies whether UM-enabled users associated with the UM mailbox policy are allowed to get SMS or text messages sent to their mobile phones. If this parameter is set to $true, you also want to set the Set-UMMailbox cmdlet UMSMSNotificationOption parameter for the UM-enabled user to either VoiceMail or VoiceMailAndMissedCalls. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -332,13 +361,15 @@ Accept wildcard characters: False ``` ### -AllowSubscriberAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowSubscriberAccess parameter specifies whether users associated with the UM mailbox policy are allowed subscriber access to their individual mailboxes. If this parameter is set to $true, after users are authenticated, they're able to retrieve voice mail over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -348,13 +379,15 @@ Accept wildcard characters: False ``` ### -AllowTUIAccessToCalendar + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowTUIAccessToCalendar parameter specifies whether users associated with the UM mailbox policy can access their individual calendars over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -364,13 +397,15 @@ Accept wildcard characters: False ``` ### -AllowTUIAccessToDirectory + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowTUIAccessToDirectory parameter specifies whether users associated with the UM mailbox policy can access the directory over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -380,13 +415,15 @@ Accept wildcard characters: False ``` ### -AllowTUIAccessToEmail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowTUIAccessToEmail parameter specifies whether users associated with the UM mailbox policy can access their individual email messages over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -396,13 +433,15 @@ Accept wildcard characters: False ``` ### -AllowTUIAccessToPersonalContacts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowTUIAccessToPersonalContacts parameter specifies whether users associated with the UM mailbox policy can access their personal contacts over the telephone. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -412,13 +451,15 @@ Accept wildcard characters: False ``` ### -AllowVoiceMailAnalysis + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowVoiceMailAnalysis parameter specifies whether a copy of each voice mail left for the users associated with the UM mailbox policy will be forwarded to Microsoft for analysis and improvement of our speech recognition features. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -428,13 +469,15 @@ Accept wildcard characters: False ``` ### -AllowVoiceMailPreview + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowVoiceMailPreview parameter specifies whether users associated with the UM mailbox policy are able to receive Voice Mail Previews for call-answered messages, or have Voice Mail Previews provided for voice mail messages that they send to other users in their mailbox. The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -444,13 +487,15 @@ Accept wildcard characters: False ``` ### -AllowVoiceResponseToOtherMessageTypes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The AllowVoiceResponseToOtherMessageTypes parameter specifies whether UM-enabled users associated with the UM mailbox policy can record and attach a voice mail message when replying to email messages and calendar items. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -460,6 +505,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -469,7 +517,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -479,13 +526,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -495,13 +544,15 @@ Accept wildcard characters: False ``` ### -FaxMessageText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The FaxMessageText parameter specifies the text included in the body part of fax messages. This text is limited to 512 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -511,13 +562,15 @@ Accept wildcard characters: False ``` ### -FaxServerURI + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The FaxServerURI parameter specifies the Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) for the fax solution that serves the UM-enabled users associated with the UM mailbox policy. This fax product or fax service accepts incoming fax calls that were redirected from Exchange Unified Messaging servers and creates inbound fax messages for the UM-enabled users associated with the UM mailbox policy. Although you can enter more than one fax server URI, only one URI will be used by the Unified Messaging server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -527,13 +580,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -543,13 +598,15 @@ Accept wildcard characters: False ``` ### -InformCallerOfVoiceMailAnalysis + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The InformCallerOfVoiceMailAnalysis parameter specifies whether the callers leaving the voice mails will be informed about the possibility of their voice mails being forwarded to Microsoft for analysis. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -559,13 +616,15 @@ Accept wildcard characters: False ``` ### -LogonFailuresBeforePINReset + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The LogonFailuresBeforePINReset parameter specifies the number of sequential unsuccessful logon attempts before the mailbox PIN is automatically reset. To disable this feature, set this parameter to Unlimited. If this parameter isn't set to Unlimited, it must be set to less than the value of the MaxLogonAttempts parameter. The range is from 0 through 999. The default setting is 5. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -575,13 +634,15 @@ Accept wildcard characters: False ``` ### -MaxGreetingDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MaxGreetingDuration parameter specifies the maximum greeting length. The range is from 1 through 10 minutes. The default value is 5 minutes. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -591,13 +652,15 @@ Accept wildcard characters: False ``` ### -MaxLogonAttempts + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MaxLogonAttempts parameter specifies the number of times users can try unsuccessfully to log on, in sequence, before the UM mailboxes are locked. The range is from 1 through 999. The default value is 15. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -607,13 +670,15 @@ Accept wildcard characters: False ``` ### -MinPINLength + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MinPINLength parameter specifies the minimum number of digits required in a PIN for UM-enabled users. The range is from 4 through 24. The default value is 6. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -623,13 +688,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Name parameter specifies the display name for the UM mailbox policy. This setting is limited to 64 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -639,13 +706,15 @@ Accept wildcard characters: False ``` ### -PINHistoryCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PINHistoryCount parameter specifies the number of previous PINs that are remembered and aren't allowed during a PIN reset. This number includes the first time that the PIN was set. The range is from 1 through 20. The default value is 5. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -655,13 +724,15 @@ Accept wildcard characters: False ``` ### -PINLifetime + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PINLifetime parameter specifies the number of days until a new password is required. The range is from 1 through 999. The default value is 60. If you specify Unlimited, the users' PINs won't expire. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -671,13 +742,15 @@ Accept wildcard characters: False ``` ### -ProtectAuthenticatedVoiceMail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ProtectAuthenticatedVoiceMail parameter specifies whether Mailbox servers that answer Outlook Voice Access calls for UM-enabled users associated with the UM mailbox policy create protected voice mail messages. The default setting is None. This means that no protection is applied to voice mail messages. If the value is set to Private, only messages marked as private are protected. If the value is set to All, every voice mail message is protected. ```yaml Type: DRMProtectionOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -687,13 +760,15 @@ Accept wildcard characters: False ``` ### -ProtectedVoiceMailText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ProtectedVoiceMailText parameter specifies the text included in the body part of the protected voice mail messages for UM-enabled users associated with the UM mailbox policy. This text can contain up to 512 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -703,13 +778,15 @@ Accept wildcard characters: False ``` ### -ProtectUnauthenticatedVoiceMail + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ProtectUnauthenticatedVoiceMail parameter specifies whether the Mailbox servers that answer calls for UM-enabled users associated with the UM mailbox policy create protected voice mail messages. This also applies when a message is sent from a UM auto attendant to a UM-enabled user associated with the UM mailbox policy. The default setting is None. This means that no protection is applied to voice mail messages. If the value is set to Private, only messages marked as private are protected. If the value is set to All, every voice mail message is protected. ```yaml Type: DRMProtectionOptions Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -719,13 +796,15 @@ Accept wildcard characters: False ``` ### -RequireProtectedPlayOnPhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The RequireProtectedPlayOnPhone parameter specifies whether users associated with the UM mailbox policy can only use Play on Phone for protected voice mail messages or whether users can use multimedia software to play the protected message. The default value is $false. When set to $false, users are able to use both methods to listen to protected voice mail messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -735,13 +814,15 @@ Accept wildcard characters: False ``` ### -ResetPINText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ResetPINText parameter specifies the text to be included in the PIN reset email message. This text is limited to 512 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -751,13 +832,15 @@ Accept wildcard characters: False ``` ### -SourceForestPolicyNames + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The SourceForestPolicyNames parameter specifies the name or names of the corresponding UM mailbox policy objects located in the source forest during a cross-forest migration. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -767,13 +850,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan associated with the UM mailbox policy. ```yaml Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -783,13 +868,15 @@ Accept wildcard characters: False ``` ### -UMEnabledText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMEnabledText parameter specifies the text to be included when a user is enabled for Unified Messaging. This text is limited to 512 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -799,13 +886,15 @@ Accept wildcard characters: False ``` ### -VoiceMailPreviewPartnerAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoiceMailPreviewPartnerAddress parameter specifies the SMTP address of a Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is $null. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -815,13 +904,15 @@ Accept wildcard characters: False ``` ### -VoiceMailPreviewPartnerAssignedID + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoiceMailPreviewPartnerAssignedID parameter specifies the identification string, if any, provided to the organization by the Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is $null. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -831,13 +922,15 @@ Accept wildcard characters: False ``` ### -VoiceMailPreviewPartnerMaxDeliveryDelay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoiceMailPreviewPartnerMaxDeliveryDelay parameter specifies the number of seconds that a Mailbox server waits for a Voice Mail Preview partner system to return a message with a Voice Mail Preview. If this time is exceeded, the Mailbox server delivers the voice mail message without a preview. The default value is 1200. The minimum value for this parameter is 300. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -847,13 +940,15 @@ Accept wildcard characters: False ``` ### -VoiceMailPreviewPartnerMaxMessageDuration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoiceMailPreviewPartnerMaxMessageDuration parameter specifies the maximum duration, in seconds, of voice mail messages sent to the Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is 180. The minimum number for this parameter is 60. This setting should be set equal to the maximum value allowed by the Voice Mail Preview partner. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -863,13 +958,15 @@ Accept wildcard characters: False ``` ### -VoiceMailText + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The VoiceMailText parameter specifies the text to be included in the body part of voice mail messages. The parameter applies to call answering messages in addition to messages originated by an authenticated subscriber. This text is limited to 512 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -879,13 +976,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UmServer.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMServer.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-UmServer.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMServer.md index 6fa2f340bf..14c1d36b5b 100644 --- a/exchange/exchange-ps/exchange/Set-UmServer.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMServer.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umserver applicable: Exchange Server 2010 -title: Set-UmServer -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umserver +schema: 2.0.0 +title: Set-UMServer --- # Set-UMServer @@ -82,6 +83,9 @@ This example changes the grammar generation schedule to 02:30-03:00 every day on ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Unified Messaging server that you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -93,7 +97,6 @@ The Identity parameter specifies the Unified Messaging server that you want to m Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -112,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -DialPlans + +> Applicable: Exchange Server 2010 + The DialPlans parameter specifies all the dial plans for which this server will handle UM calls. If no dial plans are defined, the Unified Messaging server won't handle UM calls. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -154,13 +163,15 @@ Accept wildcard characters: False ``` ### -ExternalServiceFqdn + +> Applicable: Exchange Server 2010 + The ExternalServiceFqdn parameter is the FQDN or host name of a load balancer servicing Unified Messaging servers. This parameter is useful when you're migrating Unified Messaging servers from within your organization to a Microsoft Exchange Server 2010 hosted environment. The external service host FQDN can contain up to 2,048 characters. ```yaml Type: UMSmartHost Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -GrammarGenerationSchedule + +> Applicable: Exchange Server 2010 + The GrammarGenerationSchedule parameter specifies the scheduled times to start speech grammar generation. This parameter allows only one start time per day. The default scheduled time for grammar generation is 02:00-02:30 local time each day. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. @@ -197,7 +211,6 @@ Here are some examples: Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -207,6 +220,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2010 + The IrmLogEnabled parameter specifies whether to enable logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: - $true Enable IRM logging @@ -216,7 +232,6 @@ The IrmLogEnabled parameter specifies whether to enable logging of Information R Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -226,13 +241,15 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2010 + The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter the value as a time span: dd.hh:mm:ss, where d = days, h = hours, m = minutes, and s = seconds. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of the IrmLogMaxAge parameter to 00:00:00 prevents the automatic removal of IRM log files because of their age. ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -242,6 +259,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2010 + The IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 megabytes (MB). When you enter a value, qualify the value with one of the following units: - B (bytes) @@ -256,7 +276,6 @@ Unqualified values are treated as bytes. The value of the IrmLogMaxFileSize para Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -266,6 +285,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2010 + The IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: - B (bytes) @@ -280,7 +302,6 @@ Unqualified values are treated as bytes. The value of the IrmLogMaxFileSize para Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -290,13 +311,15 @@ Accept wildcard characters: False ``` ### -IrmLogPath + +> Applicable: Exchange Server 2010 + The IrmLogPath parameter specifies the default IRM log directory location. The default value is C:\\Program Files\\Microsoft\\Exchange Server\\V14. If you set the value of the IrmLogPath parameter to $null, you effectively disable IRM logging. However, if you set the value of the IrmLogPath parameter to $null when the value of the IrmLogEnabled attribute is $true, Exchange will log errors in the Application event log. The preferred way for disabling IRM logging is to set the IrmLogEnabled parameter to $false. ```yaml Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -306,13 +329,15 @@ Accept wildcard characters: False ``` ### -MaxCallsAllowed + +> Applicable: Exchange Server 2010 + The MaxCallsAllowed parameter specifies the maximum number of concurrent voice calls that the Unified Messaging server allows. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -322,6 +347,9 @@ Accept wildcard characters: False ``` ### -SIPAccessService + +> Applicable: Exchange Server 2010 + The SIPAccessService parameter specifies the FQDN and TCP port of the nearest Lync Server Edge pool or Skype for Business Server Edge pool location for inbound and outbound calls from remote Lync or Skype for Business users located outside of the network. We recommend that you always use this parameter in Lync Server or Skype for Business Server deployments that span multiple geographic regions; otherwise, the Unified Messaging server might select a pool for Real-Time Transport Protocol (RTP) media traffic that isn't the closest geographically to the remote user. @@ -332,7 +360,6 @@ You configure this parameter for each Unified Messaging server so the value iden Type: ProtocolConnectionSettings Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -342,13 +369,15 @@ Accept wildcard characters: False ``` ### -SipTcpListeningPort + +> Applicable: Exchange Server 2010 + The SipTcpListeningPort parameter specifies the TCP port used by the Unified Messaging server to receive incoming calls. This TCP port is used by Unified Messaging servers added to a UM dial plan that isn't configured to use SIP Secured or Secured mode. The default is port 5060. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -358,13 +387,15 @@ Accept wildcard characters: False ``` ### -SipTlsListeningPort + +> Applicable: Exchange Server 2010 + The SipTlsListeningPort parameter specifies the Transport Layer Security (TLS) port used by the Unified Messaging server to receive incoming calls. This TLS port is used by Unified Messaging servers that are added to a UM dial plan configured to use SIP Secured or Secured mode. The default is port 5061. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -374,13 +405,15 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2010 + The Status parameter specifies the Unified Messaging server status. The available options are Enabled, Disabled, and NoNewCalls. ```yaml Type: ServerStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -390,13 +423,15 @@ Accept wildcard characters: False ``` ### -UMStartupMode + +> Applicable: Exchange Server 2010 + The UMStartupMode parameter specifies whether the Microsoft Exchange Unified Messaging service on a Unified Messaging server will start up in TCP, TLS, or Dual mode. If the Unified Messaging server is being added to UM dial plans that have different security settings, you should choose Dual mode. In Dual mode, the Unified Messaging server can listen on ports 5060 and 5061 at the same time. If the startup mode is changed, the Microsoft Exchange Unified Messaging service must be restarted. ```yaml Type: UMStartupMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -406,13 +441,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UMService.md b/exchange/exchange-ps/ExchangePowerShell/Set-UMService.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-UMService.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UMService.md index 51772cc547..296d0acef8 100644 --- a/exchange/exchange-ps/exchange/Set-UMService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UMService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-umservice applicable: Exchange Server 2013, Exchange Server 2016 -title: Set-UMService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-umservice +schema: 2.0.0 +title: Set-UMService --- # Set-UMService @@ -78,6 +79,9 @@ This example performs the following actions: ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Identity parameter specifies the Mailbox server that hosts the Unified Messaging service configuration you want to modify. You can use any value that uniquely identifies the server. For example: - Name @@ -89,7 +93,6 @@ The Identity parameter specifies the Mailbox server that hosts the Unified Messa Type: UMServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: True Position: 1 @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -108,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -DialPlans + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DialPlans parameter specifies all dial plans that the Unified Messaging service handles incoming calls for. Exchange 2016 and Exchange 2013 servers can't be associated with a TelExt or E.164 UM dial plan, but can be associated or added to SIP dial plans. If you're integrating Unified Messaging with Lync Server 2010, Lync Server 2013, or Skype for Business Server 2015, you need to associate or add all Exchange 2016 and Exchange 2013 servers to SIP dial plans. @@ -132,7 +140,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -142,13 +149,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -GrammarGenerationSchedule + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The GrammarGenerationSchedule parameter specifies the scheduled times to start speech grammar generation. This parameter allows only one start time per day. The default scheduled time for grammar generation is 02:00-02:30 local time each day. The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. @@ -185,7 +197,6 @@ Here are some examples: Type: ScheduleInterval[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -195,6 +206,9 @@ Accept wildcard characters: False ``` ### -IPAddressFamily + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IPAddressFamily parameter specifies whether the UM IP gateway will use IPv4, IPv6, or both to communicate. Valid values are: - IPv4 @@ -205,7 +219,6 @@ The IPAddressFamily parameter specifies whether the UM IP gateway will use IPv4, Type: IPAddressFamily Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -215,13 +228,15 @@ Accept wildcard characters: False ``` ### -IPAddressFamilyConfigurable + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IPAddressFamilyConfigurable parameter specifies whether you're able to set the IPAddressFamily parameter to IPv6Only or Any. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -IrmLogEnabled + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IrmLogEnabled parameter specifies whether to enable logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Valid values are: - $true: Enable IRM logging @@ -240,7 +258,6 @@ The IrmLogEnabled parameter specifies whether to enable logging of Information R Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -250,6 +267,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxAge + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -260,7 +280,6 @@ The valid input range for this parameter is from 00:00:00 through 24855.03:14:07 Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -270,6 +289,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxDirectorySize + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 megabytes (MB). When you enter a value, qualify the value with one of the following units: @@ -288,7 +310,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -298,6 +319,9 @@ Accept wildcard characters: False ``` ### -IrmLogMaxFileSize + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: @@ -316,7 +340,6 @@ The value of the IrmLogMaxFileSize parameter must be less than or equal to the v Type: ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -326,6 +349,9 @@ Accept wildcard characters: False ``` ### -IrmLogPath + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The IrmLogPath parameter specifies the default IRM log directory location. The default location is %ExchangeInstallPath%IRMLogs. If you set the value of this parameter to $null, you effectively disable IRM logging. However, setting this parameter to $null when the value of the IrmLogEnabled parameter is $true, generates errors in the Application event log. The preferred way to disable IRM logging is to set the IrmLogEnabled parameter to $false. @@ -334,7 +360,6 @@ If you set the value of this parameter to $null, you effectively disable IRM log Type: LocalLongFullPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -344,13 +369,15 @@ Accept wildcard characters: False ``` ### -MaxCallsAllowed + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The MaxCallsAllowed parameter specifies the maximum number of concurrent voice calls that the Unified Messaging service allows. The default value is 100. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -360,6 +387,9 @@ Accept wildcard characters: False ``` ### -SIPAccessService + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The SIPAccessService parameter specifies the FQDN and TCP port of the nearest Lync Server Front End pool or Skype for Business Server Front End pool location for inbound and outbound calls from remote Lync or Skype for Business users located outside of the network. We recommend that you always use this parameter in Lync Server or Skype for Business Server deployments that span multiple geographic regions; otherwise, the Microsoft Exchange Unified Messaging service might select a pool for Real-Time Transport Protocol (RTP) media traffic that isn't the closest geographically to the remote user. @@ -370,7 +400,6 @@ You configure this parameter for each instance of the Unified Messaging service Type: ProtocolConnectionSettings Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -380,13 +409,15 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: Exchange Server 2013, Exchange Server 2016 + This parameter has been deprecated and is no longer used. ```yaml Type: ServerStatus Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -396,6 +427,9 @@ Accept wildcard characters: False ``` ### -UMStartupMode + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The UMStartupMode parameter specifies the startup mode for the Unified Messaging service. Valid values are: - TCP (This is the default value) @@ -408,7 +442,6 @@ If you change the value of this parameter, you need to restart the Unified Messa Type: UMStartupMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -418,13 +451,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Set-UnifiedAuditLogRetentionPolicy.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UnifiedAuditLogRetentionPolicy.md index b54bb64a99..060174cdd0 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UnifiedAuditLogRetentionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-unifiedauditlogretentionpolicy applicable: Security & Compliance -title: Set-UnifiedAuditLogRetentionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-unifiedauditlogretentionpolicy +schema: 2.0.0 +title: Set-UnifiedAuditLogRetentionPolicy --- # Set-UnifiedAuditLogRetentionPolicy @@ -55,6 +56,9 @@ This example modifies an audit log retention policy and changes to retention dur ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the unified audit log retention policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name @@ -65,7 +69,6 @@ The Identity parameter specifies the unified audit log retention policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Security & Compliance + The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A higher integer value indicates a lower priority. The value 1 is the highest priority, and the value 10000 is the lowest priority. No two policies can have the same priority value. This parameter is required when you modify an audit log retention policy, and you must use a unique priority value. @@ -83,7 +89,6 @@ This parameter is required when you modify an audit log retention policy, and yo Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -RetentionDuration + +> Applicable: Security & Compliance + The RetentionDuration parameter specifies how long audit log records are kept. Valid values are: - ThreeMonths @@ -108,7 +116,6 @@ Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears -Applicable: Security & Compliance Required: True Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -127,7 +137,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -137,13 +146,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Security & Compliance + The Description parameter specifies a description for the audit log retention policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -153,6 +164,9 @@ Accept wildcard characters: False ``` ### -Operations + +> Applicable: Security & Compliance + The Operations parameter specifies the audit log operations that are retained by the policy. The values you specify will overwrite any existing entries. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -161,7 +175,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -RecordTypes + +> Applicable: Security & Compliance + The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). You can specify multiple values separated by commas. The values you specify will overwrite any existing entries. @@ -179,7 +195,6 @@ You can specify multiple values separated by commas. The values you specify will Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -189,6 +204,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Security & Compliance + The UserIds parameter specifies the audit logs that are retained by the policy based on the ID of the user who performed the action. 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"`. @@ -197,7 +215,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -207,13 +224,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md b/exchange/exchange-ps/ExchangePowerShell/Set-UnifiedGroup.md similarity index 93% rename from exchange/exchange-ps/exchange/Set-UnifiedGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UnifiedGroup.md index c592fda80d..0e64d4de95 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UnifiedGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-unifiedgroup applicable: Exchange Online, Exchange Online Protection -title: Set-UnifiedGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-unifiedgroup +schema: 2.0.0 +title: Set-UnifiedGroup --- # Set-UnifiedGroup @@ -112,6 +113,9 @@ This example changes the Microsoft 365 Group named Legal Department from a publi ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 Group that you want to modify. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -125,7 +129,6 @@ The Identity parameter specifies the Microsoft 365 Group that you want to modify Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -135,6 +138,9 @@ Accept wildcard characters: False ``` ### -AcceptMessagesOnlyFromSendersOrMembers + +> Applicable: Exchange Online, Exchange Online Protection + The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient. @@ -156,7 +162,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -166,6 +171,9 @@ Accept wildcard characters: False ``` ### -AccessType + +> Applicable: Exchange Online, Exchange Online Protection + The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Valid values are: - Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. @@ -177,7 +185,6 @@ The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Type: ModernGroupTypeInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,6 +194,9 @@ Accept wildcard characters: False ``` ### -Alias + +> Applicable: Exchange Online, Exchange Online Protection + The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Microsoft 365 Group. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. The Alias value can contain letters, numbers and the following characters: @@ -200,7 +210,6 @@ The Alias value can contain letters, numbers and the following characters: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -210,6 +219,9 @@ Accept wildcard characters: False ``` ### -AlwaysSubscribeMembersToCalendarEvents + +> Applicable: Exchange Online, Exchange Online Protection + The AlwaysSubscribeMembersToCalendarEvents switch controls the default subscription settings of new members that are added to the Microsoft 365 Group. Changing this setting doesn't affect existing group members. - If you use this switch without a value, all future members that are added to the group will have their subscriptions set to ReplyAndEvents. Previous events are not automatically added to their calendars. @@ -225,7 +237,6 @@ The AutoSubscribeNewMembers switch overrides this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -235,6 +246,9 @@ Accept wildcard characters: False ``` ### -AuditLogAgeLimit + +> Applicable: Exchange Online, Exchange Online Protection + The AuditLogAgeLimit parameter specifies the maximum age of audit log entries for the Microsoft 365 Group. Log entries older than the specified value are removed. The default value is 90 days. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -245,7 +259,6 @@ For example, to specify 60 days for this parameter, use 60.00:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,6 +268,9 @@ Accept wildcard characters: False ``` ### -AutoSubscribeNewMembers + +> Applicable: Exchange Online, Exchange Online Protection + The AutoSubscribeNewMembers switch specifies whether to automatically subscribe new members that are added to the Microsoft 365 Group to conversations and calendar events. Only users that are added to the group after you enable this setting are automatically subscribed to the group. - To subscribe new members to conversations and calendar events, use the AutoSubscribeNewMembers switch without a value. @@ -266,7 +282,6 @@ The AutoSubscribeNewMembers switch specifies whether to automatically subscribe Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -276,6 +291,9 @@ Accept wildcard characters: False ``` ### -CalendarMemberReadOnly + +> Applicable: Exchange Online, Exchange Online Protection + The CalendarMemberReadOnly switch specifies whether to set read-only Calendar permissions to the Microsoft 365 Group for members of the group. - To set read-only Calendar permissions, use the CalendarMemberReadOnly switch without a value. @@ -287,7 +305,6 @@ To view the current value of the CalendarMemberReadOnly property on a Microsoft Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -297,13 +314,15 @@ Accept wildcard characters: False ``` ### -Classification + +> Applicable: Exchange Online, Exchange Online Protection + The Classification parameter specifies the classification for the Microsoft 365 Group. You need to configure the list of available classifications in Microsoft Entra ID before you can specify a value for this parameter. For more information, see [Microsoft Entra cmdlets for configuring group settings](https://learn.microsoft.com/azure/active-directory/users-groups-roles/groups-settings-cmdlets). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,6 +332,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -322,7 +344,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -332,6 +353,9 @@ Accept wildcard characters: False ``` ### -ConnectorsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorsEnabled specifies whether to enable the ability to use connectors for the Microsoft 365 Group. - To enable connectors, use the ConnectorsEnabled switch without a value. @@ -345,7 +369,6 @@ For more information about connectors for Microsoft 365 Groups, see [Connect app Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -355,13 +378,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute1 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -371,13 +396,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute10 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -387,13 +414,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute11 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -403,13 +432,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute12 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -419,13 +450,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute13 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -435,13 +468,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute14 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -451,13 +486,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute15 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -467,13 +504,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute2 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -483,13 +522,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute3 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -499,13 +540,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute4 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -515,13 +558,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute5 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -531,13 +576,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute6 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -547,13 +594,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute7 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -563,13 +612,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute8 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -579,13 +630,15 @@ Accept wildcard characters: False ``` ### -CustomAttribute9 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -595,6 +648,9 @@ Accept wildcard characters: False ``` ### -DataEncryptionPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The DataEncryptionPolicy parameter specifies the data encryption policy that's applied to the Microsoft 365 Group. You can use any value that uniquely identifies the policy. For example: - Name @@ -607,7 +663,6 @@ To remove an existing policy, use the value $null. Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -617,13 +672,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the name of the Microsoft 365 Group. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -633,6 +690,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: Exchange Online, Exchange Online Protection + The EmailAddresses parameter specifies all email addresses (proxy addresses) for the Microsoft 365 Group, including the primary SMTP address. In cloud-based organizations, the primary SMTP address and other proxy addresses for Microsoft 365 Groups are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the Microsoft 365 Group. Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -657,7 +717,6 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -667,6 +726,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute1 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -677,7 +739,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -687,6 +748,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute2 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -697,7 +761,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -707,6 +770,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute3 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -717,7 +783,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -727,6 +792,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute4 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -737,7 +805,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -747,6 +814,9 @@ Accept wildcard characters: False ``` ### -ExtensionCustomAttribute5 + +> Applicable: Exchange Online, Exchange Online Protection + This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. @@ -757,7 +827,6 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -767,13 +836,15 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Online, Exchange Online Protection + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -783,6 +854,9 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo + +> Applicable: Exchange Online, Exchange Online Protection + The GrantSendOnBehalfTo parameter specifies who can send on behalf of this Microsoft 365 Group. Although messages that are sent on behalf of the group clearly show the sender in the From field (` on behalf of `), replies to these messages are delivered to the group, not the sender. The sender you specify for this parameter must a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the sender. For example: @@ -808,7 +882,6 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -818,6 +891,9 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The HiddenFromAddressListsEnabled parameter specifies whether the Microsoft 365 Group appears in the global address list (GAL) and other address lists in your organization. Valid values are: - $true: The Microsoft 365 Group is hidden from the GAL and other address lists. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users also can't find the group by using the Discover option in Outlook on the web. For users that are members of the Microsoft 365 Group, the group will still appear in the navigation pane in Outlook and Outlook on the web if HiddenFromExchangeClientsEnabled property is **NOT** enabled. @@ -827,7 +903,6 @@ The HiddenFromAddressListsEnabled parameter specifies whether the Microsoft 365 Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -837,6 +912,9 @@ Accept wildcard characters: False ``` ### -HiddenFromExchangeClientsEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The HiddenFromExchangeClientsEnabled switch specifies whether the Microsoft 365 Group is hidden from Outlook clients connected to Microsoft 365. - To enable this setting, you don't need to specify a value with this switch. The Microsoft 365 Group is hidden from Outlook experiences. The group isn't visible in the Outlook left-hand navigation and isn't visible in the global address list (GAL). The group name doesn't resolve during the creation of a new message in Outlook. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users can't find the group by using the Discover option in Outlook on the web. The HiddenFromAddressListsEnabled property is set to the value True to prevent the group from showing in the GAL and in the Offline Address Book (OAB). @@ -847,7 +925,6 @@ The HiddenFromExchangeClientsEnabled switch specifies whether the Microsoft 365 Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -857,6 +934,9 @@ Accept wildcard characters: False ``` ### -InformationBarrierMode + +> Applicable: Exchange Online, Exchange Online Protection + The InformationBarrierMode parameter specifies the information barrier mode for the Microsoft 365 Group. Valid values are: - Explicit @@ -868,7 +948,6 @@ The InformationBarrierMode parameter specifies the information barrier mode for Type: GroupInformationBarrierMode Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -878,13 +957,15 @@ Accept wildcard characters: False ``` ### -IsMemberAllowedToEditContent + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill IsMemberAllowedToEditContent Description }} ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -894,6 +975,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: Exchange Online, Exchange Online Protection + The Language parameter specifies language preference for the Microsoft 365 Group. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -902,7 +986,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -912,13 +995,15 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online, Exchange Online Protection + The MailboxRegion parameter specifies the preferred data location (PDL) for the Microsoft 365 Group in multi-geo environments. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -928,6 +1013,9 @@ Accept wildcard characters: False ``` ### -MailTip + +> Applicable: Exchange Online, Exchange Online Protection + The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks ("). When you add a MailTip to a recipient, two things happen: @@ -939,7 +1027,6 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -949,6 +1036,9 @@ Accept wildcard characters: False ``` ### -MailTipTranslations + +> Applicable: Exchange Online, Exchange Online Protection + The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters. To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: @@ -963,7 +1053,6 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -973,6 +1062,9 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize + +> Applicable: Exchange Online, Exchange Online Protection + The MaxReceiveSize parameter specifies the maximum size of an email message that can be sent to this group. Messages that exceed the maximum size are rejected by the group. When you enter a value, qualify the value with one of the following units: @@ -992,7 +1084,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1002,6 +1093,9 @@ Accept wildcard characters: False ``` ### -MaxSendSize + +> Applicable: Exchange Online, Exchange Online Protection + The MaxSendSize parameter specifies the maximum size of an email message that can be sent by this group. When you enter a value, qualify the value with one of the following units: @@ -1021,7 +1115,6 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1031,6 +1124,9 @@ Accept wildcard characters: False ``` ### -ModeratedBy + +> Applicable: Exchange Online, Exchange Online Protection + The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator. For example: - Name @@ -1048,7 +1144,6 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1058,6 +1153,9 @@ Accept wildcard characters: False ``` ### -ModerationEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: - $true: Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered. @@ -1069,7 +1167,6 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1079,13 +1176,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Online, Exchange Online Protection + The Notes parameter specifies the description of the Microsoft 365 Group. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1095,13 +1194,15 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress + +> Applicable: Exchange Online, Exchange Online Protection + The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1111,6 +1212,9 @@ Accept wildcard characters: False ``` ### -RejectMessagesFromSendersOrMembers + +> Applicable: Exchange Online, Exchange Online Protection + The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. Valid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient. @@ -1136,7 +1240,6 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1146,6 +1249,9 @@ Accept wildcard characters: False ``` ### -RequireSenderAuthenticationEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: - $true: Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected. @@ -1155,7 +1261,6 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1165,6 +1270,9 @@ Accept wildcard characters: False ``` ### -SensitivityLabelId + +> Applicable: Exchange Online, Exchange Online Protection + The SensitivityLabelId parameter specifies the GUID value of the sensitivity label that's assigned to the Microsoft 365 Group. **Note**: In the output of the Get-UnifiedGroup cmdlet, this property is named SensitivityLabel, not SensitivityLabelId. @@ -1173,7 +1281,6 @@ The SensitivityLabelId parameter specifies the GUID value of the sensitivity lab Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1183,6 +1290,9 @@ Accept wildcard characters: False ``` ### -SubscriptionEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The SubscriptionEnabled switch specifies whether the group owners can enable subscription to conversations and calendar events on the groups they own. This option can be set only in Exchange Online PowerShell. - To change the value to $true, use this switch without a value. @@ -1196,7 +1306,6 @@ The SubscriptionEnabled switch specifies whether the group owners can enable sub Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1206,6 +1315,9 @@ Accept wildcard characters: False ``` ### -UnifiedGroupWelcomeMessageEnabled + +> Applicable: Exchange Online, Exchange Online Protection + The UnifiedGroupWelcomeMessageEnabled switch specifies whether to enable or disable sending system-generated welcome messages to users who are added as members to the Microsoft 365 Group. - To enable this setting, you don't need to specify a value with this switch. @@ -1219,7 +1331,6 @@ This setting is enabled by default. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1229,13 +1340,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-User.md b/exchange/exchange-ps/ExchangePowerShell/Set-User.md similarity index 82% rename from exchange/exchange-ps/exchange/Set-User.md rename to exchange/exchange-ps/ExchangePowerShell/Set-User.md index 09606906d6..e8c30cc153 100644 --- a/exchange/exchange-ps/exchange/Set-User.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-User.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-user applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Set-User -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-user +schema: 2.0.0 +title: Set-User --- # Set-User @@ -118,6 +119,9 @@ Performing this procedure on a linked mailbox removes all permissions on the mai ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the user that you want to modify. You can use any value that uniquely identifies the user. For example: - Name @@ -131,7 +135,6 @@ The Identity parameter specifies the user that you want to modify. You can use a Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -141,6 +144,9 @@ Accept wildcard characters: False ``` ### -AllowUMCallsFromNonUsers + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user from Unified Messaging directory searches. @@ -149,7 +155,6 @@ The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user fro Type: AllowUMCallsFromNonUsersFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +164,9 @@ Accept wildcard characters: False ``` ### -Arbitration + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Arbitration switch is required to modify arbitration mailboxes. You don't need to specify a value with this switch. @@ -169,7 +177,6 @@ Arbitration mailboxes are system mailboxes that are used for storing different t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -179,13 +186,15 @@ Accept wildcard characters: False ``` ### -AssistantName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AssistantName parameter specifies the name of the user's assistant. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -195,6 +204,9 @@ Accept wildcard characters: False ``` ### -AuthenticationPolicy + +> Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection + The AuthenticationPolicy parameter specifies the authentication policy to apply to the user. You can use any value that uniquely identifies the policy. For example: - Name @@ -209,7 +221,6 @@ You create authentication policies with the New-AuthenticationPolicy cmdlet to b Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,6 +230,9 @@ Accept wildcard characters: False ``` ### -BlockCloudCache + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill BlockCloudCache Description }} @@ -227,7 +241,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -237,6 +250,9 @@ Accept wildcard characters: False ``` ### -CanHaveCloudCache + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill CanHaveCloudCache Description }} @@ -245,7 +261,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,6 +270,9 @@ Accept wildcard characters: False ``` ### -CertificateSubject + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CertificateSubject parameter specifies the value of the subject field of the user's digital certificate. @@ -263,7 +281,6 @@ The CertificateSubject parameter specifies the value of the subject field of the Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,13 +290,15 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The City parameter specifies the user's city. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -289,6 +308,9 @@ Accept wildcard characters: False ``` ### -ClearDataEncryptionPolicy + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill ClearDataEncryptionPolicy Description }} @@ -297,7 +319,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,13 +328,15 @@ Accept wildcard characters: False ``` ### -Company + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Company parameter specifies the user's company. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -323,6 +346,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -332,7 +358,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -342,6 +367,9 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The CountryOrRegion parameter specifies the user's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name). A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). @@ -352,7 +380,6 @@ The friendly name is returned in the CountryOrRegion property value by the Get-U Type: CountryInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -362,6 +389,9 @@ Accept wildcard characters: False ``` ### -CreateDTMFMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are: @@ -373,7 +403,6 @@ The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-fre Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -383,13 +412,15 @@ Accept wildcard characters: False ``` ### -Department + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Department parameter specifies the user's department. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -399,6 +430,9 @@ Accept wildcard characters: False ``` ### -DesiredWorkloads + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill DesiredWorkloads Description }} @@ -407,7 +441,6 @@ This parameter is available only in the cloud-based service. Type: Microsoft.Exchange.Data.MailboxWorkloadFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -417,13 +450,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The DisplayName parameter specifies the display name of the user. The display name is visible in the Exchange admin center and in Active Directory. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -433,6 +468,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -441,7 +479,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -451,6 +488,9 @@ Accept wildcard characters: False ``` ### -EXOModuleEnabled + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The EXOModuleEnabled parameter specifies whether the user can connect to Exchange Online PowerShell in Microsoft 365 organizations using the Exchange Online PowerShell V3 module. Valid values are: @@ -466,7 +506,6 @@ The default value depends on the management roles that are assigned to the user. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -476,13 +515,15 @@ Accept wildcard characters: False ``` ### -Fax + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Fax parameter specifies the user's fax number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -492,13 +533,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The FirstName parameter specifies the user's first name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,6 +551,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -518,7 +564,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -528,6 +573,9 @@ Accept wildcard characters: False ``` ### -GeoCoordinates + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The GeoCoordinates parameter specifies the user's location in latitude, longitude and (optionally) altitude coordinates. A valid value for this parameter uses one of the following formats: - Latitude and longitude: For example, "47.644125;-122.122411" @@ -539,7 +587,6 @@ The GeoCoordinates parameter specifies the user's location in latitude, longitud Type: GeoCoordinates Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -549,13 +596,15 @@ Accept wildcard characters: False ``` ### -HomePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The HomePhone parameter specifies the user's home telephone number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -565,6 +614,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -578,7 +630,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -588,13 +639,15 @@ Accept wildcard characters: False ``` ### -Initials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Initials parameter specifies the user's middle initials. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -604,6 +657,9 @@ Accept wildcard characters: False ``` ### -IsShadowMailbox + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill IsShadowMailbox Description }} @@ -612,7 +668,6 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -622,13 +677,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The LastName parameter specifies the user's last name. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -638,6 +695,9 @@ Accept wildcard characters: False ``` ### -LinkedCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. @@ -650,7 +710,6 @@ You can only use the LinkedCredential parameter with a linked user. Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -660,6 +719,9 @@ Accept wildcard characters: False ``` ### -LinkedDomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if this user is a linked user. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter. @@ -670,7 +732,6 @@ This parameter is required only if you're connecting a linked user. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -680,6 +741,9 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if this user is a linked user. The master account is the account to which the user links. The master account grants access to the user. You can use one of the following values: @@ -701,7 +765,6 @@ This parameter is required only if you're connecting a linked user. Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -711,6 +774,9 @@ Accept wildcard characters: False ``` ### -MailboxRegion + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MailboxRegion Description }} @@ -719,7 +785,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -729,6 +794,9 @@ Accept wildcard characters: False ``` ### -MailboxRegionSuffix + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill MailboxRegionSuffix Description }} @@ -737,7 +805,6 @@ This parameter is available only in the cloud-based service. Type: MailboxRegionSuffixValue Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -747,6 +814,9 @@ Accept wildcard characters: False ``` ### -ManagedOnboardingType + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. {{ Fill ManagedOnboardingType Description }} @@ -755,7 +825,6 @@ This parameter is available only in the cloud-based service. Type: ManagedOnboardingType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -765,13 +834,15 @@ Accept wildcard characters: False ``` ### -Manager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Manager parameter specifies the user's manager. ```yaml Type: UserContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -781,6 +852,9 @@ Accept wildcard characters: False ``` ### -MobilePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The MobilePhone parameter specifies the user's primary mobile phone number. **Note**: In Exchange Online, you can't use this parameter. Instead, use the MobilePhone parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. @@ -789,7 +863,6 @@ The MobilePhone parameter specifies the user's primary mobile phone number. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -799,13 +872,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Name parameter specifies the unique name of the user. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -815,13 +890,15 @@ Accept wildcard characters: False ``` ### -Notes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -831,13 +908,15 @@ Accept wildcard characters: False ``` ### -Office + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Office parameter specifies the user's physical office name or number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -847,13 +926,15 @@ Accept wildcard characters: False ``` ### -OtherFax + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OtherFax parameter specifies the user's alternative fax number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -863,13 +944,15 @@ Accept wildcard characters: False ``` ### -OtherHomePhone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OtherHomePhone parameter specifies the user's alternative home telephone number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -879,13 +962,15 @@ Accept wildcard characters: False ``` ### -OtherTelephone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OtherTelephone parameter specifies the user's alternative telephone number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -895,13 +980,15 @@ Accept wildcard characters: False ``` ### -Pager + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Pager parameter specifies the user's pager number. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -911,6 +998,9 @@ Accept wildcard characters: False ``` ### -PermanentlyClearPreviousMailboxInfo + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is functional only in the cloud-based service. The PermanentlyClearPreviousMailboxInfo switch specifies whether to clear the Exchange Online mailbox attributes on a user. You don't need to specify a value with this switch. @@ -923,7 +1013,6 @@ Clearing these attributes might be required in mailbox move and re-licensing sce Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -933,6 +1022,9 @@ Accept wildcard characters: False ``` ### -Phone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Phone parameter specifies the user's office telephone number. **Note**: In Exchange Online, you can't use this parameter. Instead, use the BusinessPhones parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. @@ -941,7 +1033,6 @@ The Phone parameter specifies the user's office telephone number. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -951,13 +1042,15 @@ Accept wildcard characters: False ``` ### -PhoneticDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -967,13 +1060,15 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PostalCode parameter specifies the user's zip code or postal code. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -983,13 +1078,15 @@ Accept wildcard characters: False ``` ### -PostOfficeBox + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PostOfficeBox parameter specifies the user's post office box number. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -999,6 +1096,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The PublicFolder switch is required to modify public folder mailboxes. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -1007,7 +1107,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1017,6 +1116,9 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + **Note**: In cloud-based environments, this parameter is being deprecated, so use the EXOModuleEnabled parameter instead. The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: @@ -1034,7 +1136,6 @@ A user's experience in any of these management interfaces is still controlled by Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1044,6 +1145,9 @@ Accept wildcard characters: False ``` ### -RemoveMailboxProvisioningConstraint + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -1052,7 +1156,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1062,6 +1165,9 @@ Accept wildcard characters: False ``` ### -ResetPasswordOnNextLogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The ResetPasswordOnNextLogon parameter specifies whether the user must change their password the next time they log on. Valid values are: - $true: The user is required to change their password the next time they log on. @@ -1071,7 +1177,6 @@ The ResetPasswordOnNextLogon parameter specifies whether the user must change th Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1081,6 +1186,9 @@ Accept wildcard characters: False ``` ### -SamAccountName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. @@ -1089,7 +1197,6 @@ The SamAccountName parameter (also known as the pre-Windows 2000 user account or Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1099,13 +1206,15 @@ Accept wildcard characters: False ``` ### -SeniorityIndex + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SeniorityIndex parameter specifies the order in which this user will display in a hierarchical address book. A user with a value of 2 will display higher in an address book than a user with a value of 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1115,6 +1224,9 @@ Accept wildcard characters: False ``` ### -SimpleDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: - a - z @@ -1127,7 +1239,6 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1137,6 +1248,9 @@ Accept wildcard characters: False ``` ### -SkipDualWrite + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1145,7 +1259,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1155,13 +1268,15 @@ Accept wildcard characters: False ``` ### -StateOrProvince + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The StateOrProvince parameter specifies the user's state or province. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1171,13 +1286,15 @@ Accept wildcard characters: False ``` ### -StreetAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The StreetAddress parameter specifies the user's physical address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1187,6 +1304,9 @@ Accept wildcard characters: False ``` ### -StsRefreshTokensValidFrom + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The StsRefreshTokensValidFrom specifies the date-time that the user's STS refresh tokens are valid from. @@ -1197,7 +1317,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1207,6 +1326,9 @@ Accept wildcard characters: False ``` ### -TelephoneAssistant + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The TelephoneAssistant parameter specifies the telephone number of the user's assistant. @@ -1215,7 +1337,6 @@ The TelephoneAssistant parameter specifies the telephone number of the user's as Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1225,13 +1346,15 @@ Accept wildcard characters: False ``` ### -Title + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Title parameter specifies the user's title. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1241,6 +1364,9 @@ Accept wildcard characters: False ``` ### -UMCallingLineIds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMCallingLineIds parameter specifies telephone numbers or extensions that can be mapped to a Unified Messaging (UM)-enabled user. You can specify more than one telephone number for each user, separated by a comma. This parameter accepts digits less than 128 characters in length and may include an optional plus sign (+) preceding the numbers. Each UM-enabled user must have a unique UMCallingLineIds parameter value. @@ -1249,7 +1375,6 @@ The UMCallingLineIds parameter specifies telephone numbers or extensions that ca Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1259,6 +1384,9 @@ Accept wildcard characters: False ``` ### -UMDtmfMap + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: @@ -1279,7 +1407,6 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1289,6 +1416,9 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. @@ -1297,7 +1427,6 @@ The UserPrincipalName parameter specifies the logon name for the user account. T Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1307,6 +1436,9 @@ Accept wildcard characters: False ``` ### -VIP + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The VIP parameter specifies whether the user is a priority account. Valid values are: @@ -1320,7 +1452,6 @@ For more information about priority accounts, see [Manage and monitor priority a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1330,13 +1461,15 @@ Accept wildcard characters: False ``` ### -WebPage + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WebPage parameter specifies the user's Web page. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1346,13 +1479,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1362,6 +1497,9 @@ Accept wildcard characters: False ``` ### -WindowsEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results: - In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value. @@ -1373,7 +1511,6 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md b/exchange/exchange-ps/ExchangePowerShell/Set-UserBriefingConfig.md similarity index 94% rename from exchange/exchange-ps/exchange/Set-UserBriefingConfig.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UserBriefingConfig.md index d036882c11..aa2f125de5 100644 --- a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UserBriefingConfig.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-userbriefingconfig applicable: Exchange Online -title: Set-UserBriefingConfig -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-userbriefingconfig +schema: 2.0.0 +title: Set-UserBriefingConfig --- # Set-UserBriefingConfig @@ -53,13 +54,15 @@ This example enables the Briefing email for lila@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user that you want to modify (for example, lila@contoso.onmicrosoft.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter specifies whether to enable or disable the Briefing email for a specified user's mailbox. Valid values are: - $true: The daily briefing message is enabled. @@ -78,7 +84,6 @@ The Enabled parameter specifies whether to enable or disable the Briefing email Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-UserPhoto.md b/exchange/exchange-ps/ExchangePowerShell/Set-UserPhoto.md similarity index 89% rename from exchange/exchange-ps/exchange/Set-UserPhoto.md rename to exchange/exchange-ps/ExchangePowerShell/Set-UserPhoto.md index d2c06bedea..81d35e2f23 100644 --- a/exchange/exchange-ps/exchange/Set-UserPhoto.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-UserPhoto.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-userphoto applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-UserPhoto -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-userphoto +schema: 2.0.0 +title: Set-UserPhoto --- # Set-UserPhoto @@ -129,6 +130,9 @@ This example deletes the preview photo that was uploaded in the previous example ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the user. You can use any value that uniquely identifies the user. For example: - Name @@ -146,7 +150,6 @@ The Identity parameter specifies the identity of the user. You can use any value Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -156,6 +159,9 @@ Accept wildcard characters: False ``` ### -Cancel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Cancel switch deletes the photo that's currently uploaded as the preview photo. You don't need to specify a value with this switch. To delete the photo that's currently associated with a user's account, use the Remove-UserPhoto cmdlet. The Cancel switch only deletes the preview photo. @@ -164,7 +170,6 @@ To delete the photo that's currently associated with a user's account, use the R Type: SwitchParameter Parameter Sets: CancelPhoto Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -174,15 +179,17 @@ Accept wildcard characters: False ``` ### -PictureData + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PictureData parameter specifies the photo file that will be uploaded to the user's account. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] -Parameter Sets: UploadPhotoData +Parameter Sets: UploadPhotoData, UploadPreview Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -191,27 +198,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Byte[] -Parameter Sets: UploadPreview -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -PictureStream -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -PictureStream The PictureStream parameter specifies the photo that will be uploaded to the user's account. This parameter is used by client applications such as Outlook on the web when users add a photo. To upload a photo using PowerShell, use the PictureData parameter to specify the photo file. ```yaml Type: Stream -Parameter Sets: UploadPhotoStream +Parameter Sets: UploadPhotoStream, UploadPreview Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -220,20 +216,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Stream -Parameter Sets: UploadPreview -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -Preview -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -### -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. @@ -242,7 +228,6 @@ A preview photo is the photo object that is uploaded to the user's account, but Type: SwitchParameter Parameter Sets: UploadPreview Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -252,13 +237,15 @@ Accept wildcard characters: False ``` ### -Save + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Save switch specifies that the photo that's uploaded to the user's account will be saved as the user's photo. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: SavePhoto Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -268,6 +255,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -279,7 +269,6 @@ This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -289,13 +278,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -305,13 +296,15 @@ Accept wildcard characters: False ``` ### -GroupMailbox + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -321,6 +314,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: @@ -332,7 +328,6 @@ This switch enables the command to access Active Directory objects that aren't c Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -342,13 +337,15 @@ Accept wildcard characters: False ``` ### -PhotoType + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -358,13 +355,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md b/exchange/exchange-ps/ExchangePowerShell/Set-VivaInsightsSettings.md similarity index 95% rename from exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md rename to exchange/exchange-ps/ExchangePowerShell/Set-VivaInsightsSettings.md index d794753e4e..e15f50ba9d 100644 --- a/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-VivaInsightsSettings.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/set-vivainsightssettings applicable: Exchange Online -title: Set-VivaInsightsSettings -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-vivainsightssettings +schema: 2.0.0 +title: Set-VivaInsightsSettings --- # Set-VivaInsightsSettings @@ -54,13 +55,15 @@ This example disables access to all the Headspace features in Microsoft Viva Ins ## PARAMETERS ### -Identity + +> Applicable: Exchange Online + The Identity parameter specifies the user that you want to modify. You identify the user by their User Principal Name (UPN) (for example, roy@contoso.onmicrosoft.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Exchange Online + The Enabled parameter enables or disables access to specific features of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are: - $true: The specified features in Microsoft Viva Insights in Microsoft Teams are enabled for the user. @@ -79,7 +85,6 @@ The Enabled parameter enables or disables access to specific features of Microso Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Feature + +> Applicable: Exchange Online + The Feature parameter specifies the feature of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are: - Headspace: Represents all features of Headspace. @@ -99,7 +107,6 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: headspace -Applicable: Exchange Online Required: True Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md b/exchange/exchange-ps/ExchangePowerShell/Set-WebServicesVirtualDirectory.md similarity index 88% rename from exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md rename to exchange/exchange-ps/ExchangePowerShell/Set-WebServicesVirtualDirectory.md index 09636df6f4..d1c909dfa0 100644 --- a/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-WebServicesVirtualDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-webservicesvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-WebServicesVirtualDirectory -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-webservicesvirtualdirectory +schema: 2.0.0 +title: Set-WebServicesVirtualDirectory --- # Set-WebServicesVirtualDirectory @@ -73,6 +74,9 @@ This example enables MRSProxy on the EWS default website. MRSProxy is the servic ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the EWS virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: - Name or Server\\Name @@ -85,7 +89,6 @@ The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the p Type: VirtualDirectoryIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -BasicAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are: - $true: Basic authentication is enabled. This is the default value. @@ -104,7 +110,6 @@ The BasicAuthentication parameter specifies whether Basic authentication is enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -CertificateAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CertificateAuthentication parameter specifies whether certificate authentication is enabled. This parameter affects the `/ews/management/` virtual directory. It doesn't affect the `/ews/` virtual directory. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -139,7 +149,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -DigestAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are: - $true: Digest authentication is enabled. @@ -158,7 +170,6 @@ The DigestAuthentication parameter specifies whether Digest authentication is en Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,13 +179,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,6 +197,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -196,7 +212,6 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,6 +221,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -215,7 +233,6 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -225,6 +242,9 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -237,7 +257,6 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -247,6 +266,9 @@ Accept wildcard characters: False ``` ### -ExternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. @@ -255,7 +277,6 @@ This setting is important when Secure Sockets Layer (SSL) is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -273,7 +297,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -283,6 +306,9 @@ Accept wildcard characters: False ``` ### -GzipLevel + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The GzipLevel parameter sets the Gzip configuration for the Exchange Web Services virtual directory. Valid values are: - Off: No compression. @@ -294,7 +320,6 @@ The GzipLevel parameter sets the Gzip configuration for the Exchange Web Service Type: GzipLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,6 +329,9 @@ Accept wildcard characters: False ``` ### -InternalNLBBypassUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + **Note:** This parameter applies only to Exchange 2010. By default, Exchange 2013 or later already has the InternalNLBBypassUrl value configured on the backend Exchange Web Services (EWS) virtual directory on Mailbox servers. The InternalNLBBypassUrl parameter specifies the URL of the Exchange server that has the Client Access server role installed, regardless of whether it's behind a Network Load Balancing (NLB) array or not. @@ -314,7 +342,6 @@ When you set the InternalUrl parameter to the URL of the NLB array, you should s Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,6 +351,9 @@ Accept wildcard characters: False ``` ### -InternalUrl + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. This setting is important when SSL is used. @@ -332,7 +362,6 @@ This setting is important when SSL is used. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -342,13 +371,15 @@ Accept wildcard characters: False ``` ### -MRSProxyEnabled + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MRSProxyEnabled parameter specifies whether to enable MRSProxy for the Exchange Web Services virtual directory on Exchange servers that have the Client Access server role installed. MRSProxy helps to proxy mailbox moves between Active Directory forests. The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -358,6 +389,9 @@ Accept wildcard characters: False ``` ### -MRSProxyMaxConnections + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy will accept. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). @@ -366,7 +400,6 @@ The MRSProxyMaxConnections parameter specifies the maximum number of simultaneou Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -376,6 +409,9 @@ Accept wildcard characters: False ``` ### -OAuthAuthentication + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OAuthAuthentication parameter specifies whether OAuth authentication is enabled on the virtual directory. Valid values are: - $true: OAuth authentication is enabled. This is the default value. @@ -385,7 +421,6 @@ The OAuthAuthentication parameter specifies whether OAuth authentication is enab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -395,13 +430,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -411,6 +448,9 @@ Accept wildcard characters: False ``` ### -WindowsAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are: - $true: Integrated Windows authentication is enabled. This is the default value. @@ -420,7 +460,6 @@ The WindowsAuthentication parameter specifies whether Integrated Windows authent Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -430,6 +469,9 @@ Accept wildcard characters: False ``` ### -WSSecurityAuthentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are: - $true: WS-Security authentication is enabled. This is the default value. @@ -439,7 +481,6 @@ The WSSecurityAuthentication parameter specifies whether WS-Security (Web Servic Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md b/exchange/exchange-ps/ExchangePowerShell/Set-X400AuthoritativeDomain.md similarity index 90% rename from exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md rename to exchange/exchange-ps/ExchangePowerShell/Set-X400AuthoritativeDomain.md index 30872ecd30..f23347ccc2 100644 --- a/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/ExchangePowerShell/Set-X400AuthoritativeDomain.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-x400authoritativedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Set-X400AuthoritativeDomain -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/set-x400authoritativedomain +schema: 2.0.0 +title: Set-X400AuthoritativeDomain --- # Set-X400AuthoritativeDomain @@ -83,6 +84,9 @@ This example makes the following changes to an existing X.400 authoritative doma ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the X.400 authoritative domain that you want to modify. You can use any value that uniquely identifies the domain. For example: - Name @@ -93,7 +97,6 @@ The Identity parameter specifies the X.400 authoritative domain that you want to Type: X400AuthoritativeDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -112,7 +118,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -130,7 +138,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -140,13 +147,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Name parameter specifies the unique name for the X.400 authoritative domain. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +183,9 @@ Accept wildcard characters: False ``` ### -X400DomainName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The X400DomainName parameter specifies the X.400 namespace that can only include the X.400 organizational components. Specifically, only the following attribute types are supported: - C (Country) @@ -189,7 +203,6 @@ Separate the address attributes with semicolons and enclose the entire address i Type: X400Domain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,13 +212,15 @@ Accept wildcard characters: False ``` ### -X400ExternalRelay + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The X400ExternalRelay parameter specifies whether this authoritative domain is an external relay domain. If you set the X400ExternalRelay parameter to $true, Exchange routes to the external address and doesn't treat resolution failures to this subdomain as errors. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/Start-ComplianceSearch.md similarity index 91% rename from exchange/exchange-ps/exchange/Start-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Start-ComplianceSearch.md index ddcb34db75..098c14c750 100644 --- a/exchange/exchange-ps/exchange/Start-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-ComplianceSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-compliancesearch applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Start-ComplianceSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-compliancesearch +schema: 2.0.0 +title: Start-ComplianceSearch --- # Start-ComplianceSearch @@ -48,6 +49,9 @@ This example starts the compliance search named Case 1234 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Identity parameter specifies the compliance search that you want to start. You can use any value that uniquely identifies the compliance search. For example: @@ -61,7 +65,6 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -98,7 +106,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -RetryOnError + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The RetryOnError switch specifies whether to retry the search on any items that failed without re-running the entire search all over again. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The WhatIf parameter doesn't work in the Microsoft Purview compliance portal. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -132,7 +144,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Start-DatabaseAvailabilityGroup.md similarity index 88% rename from exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Start-DatabaseAvailabilityGroup.md index 771a794112..8ee061322f 100644 --- a/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Start-DatabaseAvailabilityGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-databaseavailabilitygroup +schema: 2.0.0 +title: Start-DatabaseAvailabilityGroup --- # Start-DatabaseAvailabilityGroup @@ -64,13 +65,15 @@ This example starts the members of the DAG DAG1 in the Active Directory site Red ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the DAG being started. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectorySite + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveDirectorySite parameter specifies whether to start all DAG members in the specified site. ```yaml Type: AdSiteIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies whether to start a single DAG member. ```yaml Type: MailboxServerIdParameter Parameter Sets: MailboxSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConfigurationOnly switch specifies whether to update the Active Directory properties with the start action, but doesn't perform a start of the DAG or any members. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -128,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -137,7 +149,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-EdgeSynchronization.md b/exchange/exchange-ps/ExchangePowerShell/Start-EdgeSynchronization.md similarity index 89% rename from exchange/exchange-ps/exchange/Start-EdgeSynchronization.md rename to exchange/exchange-ps/ExchangePowerShell/Start-EdgeSynchronization.md index a61cfb7896..5f049f451d 100644 --- a/exchange/exchange-ps/exchange/Start-EdgeSynchronization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-EdgeSynchronization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-edgesynchronization applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Start-EdgeSynchronization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-edgesynchronization +schema: 2.0.0 +title: Start-EdgeSynchronization --- # Start-EdgeSynchronization @@ -47,6 +48,9 @@ This example starts edge synchronization on the Mailbox server named Mailbox01. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -56,7 +60,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -ForceFullSync + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ForceFullSync switch specifies whether to initiate a full edge synchronization. You don't need to specify a value with this switch. If you don't use this switch, only changes since the last replication are synchronized. If you use this switch, the entire configuration information and recipient data are synchronized. @@ -74,7 +80,6 @@ If you don't use this switch, only changes since the last replication are synchr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -ForceUpdateCookie + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ForceUpdateCookie switch specifies whether to force the Microsoft Exchange EdgeSync service to update the replication cookie even if it encounters an error. You don't need to specify a value with this switch. The cookie maintains the changes in Active Directory since the previous EdgeSync replication. Normally, the Microsoft Exchange EdgeSync service doesn't update the cookie if it encounters any errors during replication. @@ -92,7 +100,6 @@ The cookie maintains the changes in Active Directory since the previous EdgeSync Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -115,7 +125,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -TargetServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetServer parameter specifies an Edge Transport server to initiate edge synchronization with. If omitted, all Edge Transport servers are synchronized. You may want to use this parameter to specify a single Edge Transport server for synchronization if a new Edge Transport server has been installed or if that Edge Transport server has been unavailable for some time. @@ -133,7 +145,6 @@ You may want to use this parameter to specify a single Edge Transport server for Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md b/exchange/exchange-ps/ExchangePowerShell/Start-HistoricalSearch.md similarity index 91% rename from exchange/exchange-ps/exchange/Start-HistoricalSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Start-HistoricalSearch.md index 598f93159b..24d6078d40 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-HistoricalSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-historicalsearch applicable: Exchange Online, Exchange Online Protection -title: Start-HistoricalSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-historicalsearch +schema: 2.0.0 +title: Start-HistoricalSearch --- # Start-HistoricalSearch @@ -68,6 +69,9 @@ This example starts a new historical search named "Fabrikam Search" that has the ## PARAMETERS ### -EndDate + +> Applicable: Exchange Online, Exchange Online Protection + The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -80,7 +84,6 @@ You also need to use at least one of the following parameters in the command: Me Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -ReportTitle + +> Applicable: Exchange Online, Exchange Online Protection + The ReportTitle parameter specifies a descriptive name for the historical search. If the value contains spaces, enclose the value in quotation marks ("). You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. @@ -98,7 +104,6 @@ You also need to use at least one of the following parameters in the command: Me Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -108,6 +113,9 @@ Accept wildcard characters: False ``` ### -ReportType + +> Applicable: Exchange Online, Exchange Online Protection + The ReportType parameter specifies the type of historical search that you want to perform. You can use one of the following values: - ATPReport: Defender for Office 365 File types report and Defender for Office 365 Message disposition report @@ -128,7 +136,6 @@ You also need to use at least one of the following parameters in the command: Me Type: HistoricalSearchReportType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Exchange Online, Exchange Online Protection + The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". @@ -146,7 +156,6 @@ Use the short date format that's defined in the Regional Options settings on the Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -BlockStatus + +> Applicable: Exchange Online, Exchange Online Protection + The BlockStatus parameter filters the results in OutboundSecurityReport reports by the status of messages sent externally, messages blocked due to security checks, or messages sent successfully. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -CompressFile + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill CompressFile Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -ConnectorType + +> Applicable: Exchange Online, Exchange Online Protection + The ConnectorType parameter filters the results in ConnectorReport reports by the connector type. Valid values are: - OnPremises @@ -198,7 +214,6 @@ The ConnectorType parameter filters the results in ConnectorReport reports by th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,6 +223,9 @@ Accept wildcard characters: False ``` ### -DeliveryStatus + +> Applicable: Exchange Online, Exchange Online Protection + The DeliveryStatus parameter filters the results by the delivery status of the message. You can use one of the following values: - Delivered @@ -218,7 +236,6 @@ The DeliveryStatus parameter filters the results by the delivery status of the m Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -228,6 +245,9 @@ Accept wildcard characters: False ``` ### -Direction + +> Applicable: Exchange Online, Exchange Online Protection + The Direction parameter filters the results by the direction of the message. Valid values are: - All: Incoming and outgoing messages. @@ -238,7 +258,6 @@ The Direction parameter filters the results by the direction of the message. Val Type: MessageDirection Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,13 +267,15 @@ Accept wildcard characters: False ``` ### -DLPPolicy + +> Applicable: Exchange Online, Exchange Online Protection + The DLPPolicy parameter filters the results by the name of the DLP policy that acted on the message. You can specify multiple DLP policies separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -264,13 +285,15 @@ Accept wildcard characters: False ``` ### -EncryptionTemplate + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill EncryptionTemplate Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,13 +303,15 @@ Accept wildcard characters: False ``` ### -EncryptionType + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill EncryptionType Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -296,6 +321,9 @@ Accept wildcard characters: False ``` ### -Locale + +> Applicable: Exchange Online, Exchange Online Protection + The Locale parameter filters the results by the locale of the message. Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -304,7 +332,6 @@ Valid input for this parameter is a supported culture code value from the Micros Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -314,13 +341,15 @@ Accept wildcard characters: False ``` ### -MessageID + +> Applicable: Exchange Online, Exchange Online Protection + The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -330,13 +359,15 @@ Accept wildcard characters: False ``` ### -NetworkMessageID + +> Applicable: Exchange Online, Exchange Online Protection + The NetworkMessageId parameter filters the message tracking log entries by the value of the NetworkMessageId field. This field contains a unique message ID value that persists across copies of the message that may be created due to bifurcation or distribution group expansion. An example value is 1341ac7b13fb42ab4d4408cf7f55890f. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -346,6 +377,9 @@ Accept wildcard characters: False ``` ### -NotifyAddress + +> Applicable: Exchange Online, Exchange Online Protection + The NotifyAddress parameter specifies the email addresses of internal recipients to notify when the historical search is complete. The email address must be in an accepted domain that's configured for your organization. You can enter multiple email addresses separated by commas. To view the results of the historical search, you need to specify at least one email address for the NotifyAddress parameter. Otherwise, you need to click on the completed message trace in the Exchange admin center at **Mail flow** \> **Message trace**. @@ -354,7 +388,6 @@ To view the results of the historical search, you need to specify at least one e Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -364,13 +397,15 @@ Accept wildcard characters: False ``` ### -OriginalClientIP + +> Applicable: Exchange Online, Exchange Online Protection + The OriginalClientIP parameter filters the results by the original IP address of the message. For incoming messages, the OriginalClientIP value is the sender's IP address. For outgoing messages, the OriginalClientIP value is the IP address of the external SMTP server that received the message. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -380,13 +415,15 @@ Accept wildcard characters: False ``` ### -RecipientAddress + +> Applicable: Exchange Online, Exchange Online Protection + The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. The maximum number of addresses is 100. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -396,13 +433,15 @@ Accept wildcard characters: True ``` ### -SenderAddress + +> Applicable: Exchange Online, Exchange Online Protection + The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. The maximum number of addresses is 100. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -412,13 +451,15 @@ Accept wildcard characters: False ``` ### -SmtpSecurityError + +> Applicable: Exchange Online, Exchange Online Protection + The SmtpSecurityError parameter filters the results in OutboundSecurityReport reports by the error type of blocked messages when sent externally. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -428,6 +469,9 @@ Accept wildcard characters: False ``` ### -TLSUsed + +> Applicable: Exchange Online, Exchange Online Protection + The TLSUsed parameter filters the results in ConnectorReport reports by the TLS version. Valid values are: - No Tls @@ -438,7 +482,6 @@ The TLSUsed parameter filters the results in ConnectorReport reports by the TLS Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -448,13 +491,15 @@ Accept wildcard characters: False ``` ### -TransportRule + +> Applicable: Exchange Online, Exchange Online Protection + The TransportRule parameter filters the results by the name of the Exchange mail flow rule (also known as a transport rule) that acted on the message. You can specify multiple transport rules separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -464,13 +509,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Exchange Online, Exchange Online Protection + {{ Fill Url Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md b/exchange/exchange-ps/ExchangePowerShell/Start-InformationBarrierPoliciesApplication.md similarity index 92% rename from exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md rename to exchange/exchange-ps/ExchangePowerShell/Start-InformationBarrierPoliciesApplication.md index 2afb3f3ca7..24ad708c99 100644 --- a/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-InformationBarrierPoliciesApplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication applicable: Security & Compliance -title: Start-InformationBarrierPoliciesApplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-informationbarrierpoliciesapplication +schema: 2.0.0 +title: Start-InformationBarrierPoliciesApplication --- # Start-InformationBarrierPoliciesApplication @@ -43,13 +44,15 @@ This applies all active information barrier policies. ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + This parameter is reserved for internal Microsoft use. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: 0 @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -CleanupGroupSegmentLink + +> Applicable: Security & Compliance + The CleanupGroupSegmentLink switch specifies whether to remove group segment links. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: False Position: Named @@ -75,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -84,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named @@ -122,4 +131,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchangepowershell/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Start-MailboxAssistant.md b/exchange/exchange-ps/ExchangePowerShell/Start-MailboxAssistant.md similarity index 94% rename from exchange/exchange-ps/exchange/Start-MailboxAssistant.md rename to exchange/exchange-ps/ExchangePowerShell/Start-MailboxAssistant.md index 52a05e9bcb..262c4ad84e 100644 --- a/exchange/exchange-ps/exchange/Start-MailboxAssistant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-MailboxAssistant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-mailboxassistant applicable: Exchange Server 2019 -title: Start-MailboxAssistant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-mailboxassistant +schema: 2.0.0 +title: Start-MailboxAssistant --- # Start-MailboxAssistant @@ -46,6 +47,9 @@ This example starts the `BigFunnelRetryFeederTimeBasedAssistant` assistant and l ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2019 + The Identity parameter specifies the user whose mailbox should be processed by the Mailbox Assistant. Valid values are: - Distinguished name (DN) @@ -56,7 +60,6 @@ The Identity parameter specifies the user whose mailbox should be processed by t Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: True Position: 0 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssistantName + +> Applicable: Exchange Server 2019 + The AssistantName parameter specifies the assistant that should process the mailbox. Valid values are: - BigFunnelRetryFeederTimeBasedAssistant @@ -76,7 +82,6 @@ Values are case sensitive. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: True Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2019 Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -Parameters + +> Applicable: Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -137,6 +148,9 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox + +> Applicable: Exchange Server 2019 + The SoftDeletedMailbox switch specifies that the mailbox to be processed by the assistant is a soft-deleted mailbox. Soft-deleted mailboxes are deleted mailboxes that are still recoverable. @@ -145,7 +159,6 @@ Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/Start-MailboxSearch.md similarity index 88% rename from exchange/exchange-ps/exchange/Start-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Start-MailboxSearch.md index a84f5ccd78..8f54ac3548 100644 --- a/exchange/exchange-ps/exchange/Start-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-MailboxSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-mailboxsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-MailboxSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-mailboxsearch +schema: 2.0.0 +title: Start-MailboxSearch --- # Start-MailboxSearch @@ -56,13 +57,15 @@ This example starts the mailbox search ProjectContoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the search. The name is referenced when starting, stopping, or removing the search. ```yaml Type: SearchObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -99,7 +107,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -117,7 +127,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -127,6 +136,9 @@ Accept wildcard characters: False ``` ### -Resume + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Resume switch resumes a stopped, failed, or partially succeeded search from the point it stopped. You don't need to specify a value with this switch. If you use this switch to resume a search, previous search results aren't removed from the target mailbox. @@ -135,7 +147,6 @@ If you use this switch to resume a search, previous search results aren't remove Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -145,13 +156,15 @@ Accept wildcard characters: False ``` ### -StatisticsStartIndex + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The StatisticsStartIndex parameter is used by the EAC to retrieve keyword statistics in a paged operation. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -161,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md b/exchange/exchange-ps/ExchangePowerShell/Start-ManagedFolderAssistant.md similarity index 92% rename from exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md rename to exchange/exchange-ps/ExchangePowerShell/Start-ManagedFolderAssistant.md index 2e90b4cf4d..1d766dcae6 100644 --- a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-ManagedFolderAssistant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-managedfolderassistant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-ManagedFolderAssistant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-managedfolderassistant +schema: 2.0.0 +title: Start-ManagedFolderAssistant --- # Start-ManagedFolderAssistant @@ -137,6 +138,9 @@ This example uses the Get-Mailbox command to retrieve all the mailboxes that res ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the mailbox to be processed. In cross-premises deployments, you can also specify a mail user who has a mailbox in the cloud. You can use any value that uniquely identifies the mailbox or mail user. For example: - Name @@ -156,7 +160,6 @@ The Identity parameter specifies the mailbox to be processed. In cross-premises Type: MailboxOrMailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -166,6 +169,9 @@ Accept wildcard characters: False ``` ### -AdaptiveScope + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill AdaptiveScope Description }} @@ -174,7 +180,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ComplianceBoundaryAssistantParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -184,6 +189,9 @@ Accept wildcard characters: False ``` ### -AggMailboxCleanup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The AggMailboxCleanup switch specifies aggregate mailbox cleanup. You don't need to specify a value with this switch. This switch cleans up aggregate mailboxes, audits, and calendar logging. @@ -192,7 +200,6 @@ This switch cleans up aggregate mailboxes, audits, and calendar logging. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -202,6 +209,9 @@ Accept wildcard characters: False ``` ### -B2DumpsterArchiver + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill B2DumpsterArchiver Description }} @@ -210,7 +220,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ElcB2DumpsterArchiverAssistantParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -220,6 +229,9 @@ Accept wildcard characters: False ``` ### -B2IPMArchiver + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. {{ Fill B2IPMArchiver Description }} @@ -228,7 +240,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ElcB2IPMArchiverAssistantParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -238,6 +249,9 @@ Accept wildcard characters: False ``` ### -ComplianceJob + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -246,7 +260,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: ComplianceJobAssistantParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -256,6 +269,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -265,7 +281,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -275,6 +290,9 @@ Accept wildcard characters: False ``` ### -DataGovernance + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -283,7 +301,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: DataGovernanceAssistantParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -293,6 +310,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -301,7 +321,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -311,6 +330,9 @@ Accept wildcard characters: False ``` ### -FullCrawl + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The FullCrawl switch recalculates the application of tags across the whole mailbox. You don't need to specify a value with this switch. @@ -319,7 +341,6 @@ The FullCrawl switch recalculates the application of tags across the whole mailb Type: SwitchParameter Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -329,6 +350,9 @@ Accept wildcard characters: False ``` ### -HoldCleanup + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The HoldCleanup switch instructs the Managed Folder Assistant to clean up duplicate versions of items in the Recoverable Items folder that may have been created when a mailbox is on In-Place Hold, Litigation Hold, or has Single Item Recovery enabled. You don't need to specify a value with this switch. Removing duplicate items from the Recoverable Items folder reduces the folder size and may help prevent reaching Recoverable Items quota limits. For more details about Recoverable Items quota limits, see [Recoverable Items folder in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). @@ -337,7 +361,6 @@ Removing duplicate items from the Recoverable Items folder reduces the folder si Type: SwitchParameter Parameter Sets: Identity, HoldCleanupParameterSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -347,6 +370,9 @@ Accept wildcard characters: False ``` ### -InactiveMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The InactiveMailbox switch runs the command only on inactive mailboxes. You don't need to specify a value with this switch. @@ -359,7 +385,6 @@ When you use this switch, items aren't moved from the inactive mailbox to the ar Type: SwitchParameter Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -369,6 +394,9 @@ Accept wildcard characters: False ``` ### -StopHoldCleanup + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The StopHoldCleanup switch stops a previous hold clean-up command that was issued on the mailbox. You don't need to specify a value with this switch. @@ -379,7 +407,6 @@ A hold clean-up command will run until it completely scans the Recoverable Items Type: SwitchParameter Parameter Sets: StopHoldCleanupParameterSet Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -389,13 +416,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -421,4 +450,4 @@ To see the return types, which are also known as output types, that this cmdlet ## RELATED LINKS -[Export-MailboxDiagnosticLogs](https://learn.microsoft.com/powershell/module/exchange/Export-MailboxDiagnosticLogs) +[Export-MailboxDiagnosticLogs](https://learn.microsoft.com/powershell/module/exchangepowershell/Export-MailboxDiagnosticLogs) diff --git a/exchange/exchange-ps/exchange/Start-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Start-MigrationBatch.md similarity index 91% rename from exchange/exchange-ps/exchange/Start-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Start-MigrationBatch.md index cf1d3e9731..5edc513378 100644 --- a/exchange/exchange-ps/exchange/Start-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-MigrationBatch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-MigrationBatch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-migrationbatch +schema: 2.0.0 +title: Start-MigrationBatch --- # Start-MigrationBatch @@ -51,13 +52,15 @@ This example starts the migration batch SEM1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter identifies the migration batch that you want to start. Use the migration batch Name parameter as the value for this parameter. Use the Get-MigrationBatch cmdlet to identify the name of the migration batch. ```yaml Type: MigrationBatchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -76,7 +82,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -94,7 +102,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -112,7 +122,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Validate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Validate switch starts the migration batch in the validation stage of the migration process. You don't need to specify a value with this switch. @@ -132,7 +144,6 @@ If you use this switch, the migration performs a validation check of the mailbox Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-MigrationUser.md b/exchange/exchange-ps/ExchangePowerShell/Start-MigrationUser.md similarity index 91% rename from exchange/exchange-ps/exchange/Start-MigrationUser.md rename to exchange/exchange-ps/ExchangePowerShell/Start-MigrationUser.md index be88fe1878..4d47899a39 100644 --- a/exchange/exchange-ps/exchange/Start-MigrationUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-MigrationUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-migrationuser applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Start-MigrationUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-migrationuser +schema: 2.0.0 +title: Start-MigrationUser --- # Start-MigrationUser @@ -44,6 +45,9 @@ This example starts the migration of the user named laura@contoso.com ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the email address of the user that's being migrated. You can also identify the user by the GUID value in the MigrationUser property from the output of the Get-MigrationUser cmdlet. This identification method is useful if you accidentally submitted the same user in multiple batches. @@ -52,7 +56,6 @@ You can also identify the user by the GUID value in the MigrationUser property f Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -89,7 +97,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -107,7 +117,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md b/exchange/exchange-ps/ExchangePowerShell/Start-RetentionAutoTagLearning.md similarity index 94% rename from exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md rename to exchange/exchange-ps/ExchangePowerShell/Start-RetentionAutoTagLearning.md index 3ad1a2652d..829414c47f 100644 --- a/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md +++ b/exchange/exchange-ps/ExchangePowerShell/Start-RetentionAutoTagLearning.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/start-retentionautotaglearning applicable: Exchange Server 2010 -title: Start-RetentionAutoTagLearning -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/start-retentionautotaglearning +schema: 2.0.0 +title: Start-RetentionAutoTagLearning --- # Start-RetentionAutoTagLearning @@ -73,6 +74,9 @@ This example sets user Joe Healy's mailbox to clear all retention policy tags as ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter identifies the mailbox. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -90,7 +94,6 @@ The Identity parameter identifies the mailbox. You can use any value that unique Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -100,13 +103,15 @@ Accept wildcard characters: False ``` ### -CrossValidate + +> Applicable: Exchange Server 2010 + The CrossValidate switch specifies whether items in the specified mailbox are being auto-tagged. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: CrossValidate Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -116,13 +121,15 @@ Accept wildcard characters: False ``` ### -Clear + +> Applicable: Exchange Server 2010 + The Clear switch specifies whether to clear auto-tags from the specified mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Train Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -141,7 +151,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -NumberOfSegments + +> Applicable: Exchange Server 2010 + The NumberOfSegments parameter specifies the number of segments. Auto-tagging divides a mailbox into the number of segments specified and learns tagging behavior from n-1 segments. Tags are then predicted for items in the remaining segment based on this behavior. This is done for each segment. The default value is 10. @@ -179,7 +193,6 @@ You csn only use this parameter with the CrossValidate parameter. Type: Int32 Parameter Sets: CrossValidate Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -189,6 +202,9 @@ Accept wildcard characters: False ``` ### -Train + +> Applicable: Exchange Server 2010 + The Train switch specifies whether to start the training algorithm for auto-tagging on the specified mailbox. You don't need to specify a value with this switch. This switch is especially useful for retraining. @@ -197,7 +213,6 @@ This switch is especially useful for retraining. Type: SwitchParameter Parameter Sets: Train Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -207,13 +222,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md b/exchange/exchange-ps/ExchangePowerShell/Stop-ComplianceSearch.md similarity index 92% rename from exchange/exchange-ps/exchange/Stop-ComplianceSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-ComplianceSearch.md index a0b52107ee..0c82fe54f0 100644 --- a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-ComplianceSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-compliancesearch applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance -title: Stop-ComplianceSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-compliancesearch +schema: 2.0.0 +title: Stop-ComplianceSearch --- # Stop-ComplianceSearch @@ -46,6 +47,9 @@ This example stops the active compliance search named Case 1234 ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Identity parameter specifies the compliance search that you want to stop. You can use any value that uniquely identifies the compliance search. For example: @@ -59,7 +63,6 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -96,7 +104,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/ExchangePowerShell/Stop-DatabaseAvailabilityGroup.md similarity index 89% rename from exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-DatabaseAvailabilityGroup.md index c9f3ae6135..19efc5a0e9 100644 --- a/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-DatabaseAvailabilityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Stop-DatabaseAvailabilityGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-databaseavailabilitygroup +schema: 2.0.0 +title: Stop-DatabaseAvailabilityGroup --- # Stop-DatabaseAvailabilityGroup @@ -71,13 +72,15 @@ This example stops the Mailbox server MBX3, which is currently offline, in the D ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the DAG being stopped. ```yaml Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectorySite + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveDirectorySite parameter specifies the Active Directory site containing the DAG members to stop (for example, stop all DAG members in a particular Active Directory site). ```yaml Type: AdSiteIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies a single DAG member to stop. If Datacenter Activation Coordination mode is enabled for the DAG and all DAG members are in the same Active Directory site, use the MailboxServer parameter to stop individual DAG members instead of the ActiveDirectorySite parameter when stopping failed DAG members. ```yaml Type: MailboxServerIdParameter Parameter Sets: MailboxSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConfigurationOnly switch updates the Active Directory properties with the stop action, but doesn't perform a stop of the DAG or any members. You don't need to specify a value with this switch. You eed to use this switch when the DAG member servers are offline, but Active Directory is up and accessible in the primary datacenter. @@ -127,7 +137,6 @@ You eed to use this switch when the DAG member servers are offline, but Active D Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -146,7 +158,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -156,13 +167,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-HistoricalSearch.md b/exchange/exchange-ps/ExchangePowerShell/Stop-HistoricalSearch.md similarity index 95% rename from exchange/exchange-ps/exchange/Stop-HistoricalSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-HistoricalSearch.md index 314339dd93..9cc67f057f 100644 --- a/exchange/exchange-ps/exchange/Stop-HistoricalSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-HistoricalSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-historicalsearch applicable: Exchange Online, Exchange Online Protection -title: Stop-HistoricalSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-historicalsearch +schema: 2.0.0 +title: Stop-HistoricalSearch --- # Stop-HistoricalSearch @@ -44,13 +45,15 @@ This example stops the historical search that has the JobId value f9c66f83-b5c8- ## PARAMETERS ### -JobId + +> Applicable: Exchange Online, Exchange Online Protection + The JobId parameter specifies the identity GUID value of the historical search that you want to stop. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md b/exchange/exchange-ps/ExchangePowerShell/Stop-InformationBarrierPoliciesApplication.md similarity index 94% rename from exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-InformationBarrierPoliciesApplication.md index 00b91d2c2c..1bdb947ae3 100644 --- a/exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-InformationBarrierPoliciesApplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication applicable: Security & Compliance -title: Stop-InformationBarrierPoliciesApplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-informationbarrierpoliciesapplication +schema: 2.0.0 +title: Stop-InformationBarrierPoliciesApplication --- # Stop-InformationBarrierPoliciesApplication @@ -42,13 +43,15 @@ This example stops the application of information barrier policies per the polic ## PARAMETERS ### -Identity + +> Applicable: Security & Compliance + The Identity parameter specifies the active application of information barrier policies that you want to stop. This value is a GUID that's assigned when you run the Start-InformationBarrierPoliciesApplication cmdlet (for example, 46237888-12ca-42e3-a541-3fcb7b5231d1). You can also find the Identity value of the most recent policy application running the command Get-InformationBarrierPoliciesApplicationStatus. ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 0 @@ -58,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -67,7 +73,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-MailboxSearch.md b/exchange/exchange-ps/ExchangePowerShell/Stop-MailboxSearch.md similarity index 90% rename from exchange/exchange-ps/exchange/Stop-MailboxSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-MailboxSearch.md index b78b8cb8b3..aceebefb3b 100644 --- a/exchange/exchange-ps/exchange/Stop-MailboxSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-MailboxSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-mailboxsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Stop-MailboxSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-mailboxsearch +schema: 2.0.0 +title: Stop-MailboxSearch --- # Stop-MailboxSearch @@ -47,13 +48,15 @@ This example stops the mailbox search Project Contoso. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the name of the mailbox search. ```yaml Type: SearchObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -90,7 +98,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md b/exchange/exchange-ps/ExchangePowerShell/Stop-ManagedFolderAssistant.md similarity index 91% rename from exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-ManagedFolderAssistant.md index 0b03abf051..f616dc45bb 100644 --- a/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-ManagedFolderAssistant.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-managedfolderassistant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Stop-ManagedFolderAssistant -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-managedfolderassistant +schema: 2.0.0 +title: Stop-ManagedFolderAssistant --- # Stop-ManagedFolderAssistant @@ -52,6 +53,9 @@ This example stops the Managed Folder Assistant on the servers ExchSrvr1 and Exc ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -65,7 +69,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -84,7 +90,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-MigrationBatch.md b/exchange/exchange-ps/ExchangePowerShell/Stop-MigrationBatch.md similarity index 92% rename from exchange/exchange-ps/exchange/Stop-MigrationBatch.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-MigrationBatch.md index 2c68616341..7673381499 100644 --- a/exchange/exchange-ps/exchange/Stop-MigrationBatch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-MigrationBatch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Stop-MigrationBatch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-migrationbatch +schema: 2.0.0 +title: Stop-MigrationBatch --- # Stop-MigrationBatch @@ -53,13 +54,15 @@ This example stops the migration batch MigrationBatch1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter identifies the name of the current migration batch. The value for this parameter is specified by the Name parameter of the New-MigrationBatch cmdlet. ```yaml Type: MigrationBatchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -96,7 +104,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +113,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -114,7 +124,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -124,13 +133,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Stop-MigrationUser.md b/exchange/exchange-ps/ExchangePowerShell/Stop-MigrationUser.md similarity index 91% rename from exchange/exchange-ps/exchange/Stop-MigrationUser.md rename to exchange/exchange-ps/ExchangePowerShell/Stop-MigrationUser.md index ccaca8fe4d..4572e320b5 100644 --- a/exchange/exchange-ps/exchange/Stop-MigrationUser.md +++ b/exchange/exchange-ps/ExchangePowerShell/Stop-MigrationUser.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/stop-migrationuser applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Stop-MigrationUser -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/stop-migrationuser +schema: 2.0.0 +title: Stop-MigrationUser --- # Stop-MigrationUser @@ -44,6 +45,9 @@ This example stops the migration of the user laura@contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the email address of the user that's being migrated. You can also identify the user by the GUID value in the MigrationUser property from the output of the Get-MigrationUser cmdlet. This identification method is useful if you accidentally submitted the same user in multiple batches. @@ -52,7 +56,6 @@ You can also identify the user by the GUID value in the MigrationUser property f Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -81,6 +86,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -89,7 +97,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +106,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -107,7 +117,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxDatabaseCopy.md similarity index 88% rename from exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxDatabaseCopy.md index bbd7d1ecfa..c9af7877eb 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboxdatabasecopy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-MailboxDatabaseCopy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-mailboxdatabasecopy +schema: 2.0.0 +title: Suspend-MailboxDatabaseCopy --- # Suspend-MailboxDatabaseCopy @@ -63,13 +64,15 @@ This example only suspends activation for the copy of the database DB3 hosted on ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name of the database copy being suspended. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -ActivationOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActivationOnly switch specifies whether to suspend only activation for the mailbox database copy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -104,7 +112,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -EnableReplayLag + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: EnableReplayLag Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -146,13 +157,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuspendComment parameter specifies the reason that the database copy is being suspended. This parameter is limited to 512 characters. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -162,13 +175,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxExportRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxExportRequest.md index 5f063c4f44..b307a83704 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxExportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-MailboxExportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-mailboxexportrequest +schema: 2.0.0 +title: Suspend-MailboxExportRequest --- # Suspend-MailboxExportRequest @@ -53,13 +54,15 @@ This example suspends all export requests that are in progress by using the Get- ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). Use the following syntax: `Alias\Name`. ```yaml Type: MailboxExportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxImportRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxImportRequest.md index 41e44b0123..0e85b70046 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxImportRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Suspend-MailboxImportRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-mailboximportrequest +schema: 2.0.0 +title: Suspend-MailboxImportRequest --- # Suspend-MailboxImportRequest @@ -55,13 +56,15 @@ This example suspends all import requests that are in progress by using the Get- ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you created the request by using the Name parameter, use the following syntax: `Alias\Name`. ```yaml Type: MailboxImportRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -80,7 +86,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -98,7 +106,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -124,13 +133,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxRestoreRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxRestoreRequest.md index ca7cdcbde0..bee939b219 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-MailboxRestoreRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Suspend-MailboxRestoreRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-mailboxrestorerequest +schema: 2.0.0 +title: Suspend-MailboxRestoreRequest --- # Suspend-MailboxRestoreRequest @@ -51,6 +52,9 @@ This example suspends all restore requests that are in progress by using the Get ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). @@ -59,7 +63,6 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: MailboxRestoreRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -96,7 +104,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendComment parameter specifies a description about why the request was suspended. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-Message.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-Message.md similarity index 91% rename from exchange/exchange-ps/exchange/Suspend-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-Message.md index e978e8d3de..6c10bb3750 100644 --- a/exchange/exchange-ps/exchange/Suspend-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-message applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-Message -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-message +schema: 2.0.0 +title: Suspend-Message --- # Suspend-Message @@ -42,7 +43,7 @@ A message already in delivery won't be suspended. Delivery will continue and the A message being sent to multiple recipients might be located in multiple queues. If you specify an Identity parameter, the message is suspended in a single queue if that identity matches only a single message. If the identity matches more than one message, you receive an error. To suspend a message in more than one queue in a single operation, you must use the Filter parameter. -For instructions on how to resume a suspended message, see [Resume-Message](https://learn.microsoft.com/powershell/module/exchange/resume-message). +For instructions on how to resume a suspended message, see [Resume-Message](https://learn.microsoft.com/powershell/module/exchangepowershell/resume-message). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -61,13 +62,15 @@ This example prevents delivery of all messages for which the following condition ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -85,7 +91,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -104,7 +112,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -129,7 +139,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,13 +148,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-MoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-MoveRequest.md similarity index 89% rename from exchange/exchange-ps/exchange/Suspend-MoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-MoveRequest.md index 852bd02d0b..36c9a4986b 100644 --- a/exchange/exchange-ps/exchange/Suspend-MoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-MoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Suspend-MoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-moverequest +schema: 2.0.0 +title: Suspend-MoveRequest --- # Suspend-MoveRequest @@ -52,6 +53,9 @@ This example suspends all move requests that are in progress by using the Get-Mo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the identity of the mailbox or mail user. You can use one of the following values: - GUID @@ -66,7 +70,6 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c Type: MoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -85,7 +91,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -103,7 +111,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -ProxyToMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ProxyToMailbox parameter specifies the move destination by the location of the specified mailbox (also known as proxying). You can use any value that uniquely identifies the mailbox. For example: @@ -132,7 +142,6 @@ The ProxyToMailbox parameter specifies the move destination by the location of t Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendComment parameter specifies a description as to why the request was suspended. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -158,13 +169,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMailboxMigrationRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMailboxMigrationRequest.md index 6e8a63fbb7..8cff5348ae 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMailboxMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-publicfoldermailboxmigrationrequest applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Suspend-PublicFolderMailboxMigrationRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-publicfoldermailboxmigrationrequest +schema: 2.0.0 +title: Suspend-PublicFolderMailboxMigrationRequest --- # Suspend-PublicFolderMailboxMigrationRequest @@ -44,13 +45,15 @@ This example suspends the specified public folder mailbox migration request. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the public folder mailbox migration request that you want to suspend. This value uses the syntax `\PublicFolderMailboxMigration` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). ```yaml Type: PublicFolderMailboxMigrationRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -87,7 +95,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,13 +104,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The SuspendComment parameter specifies a descriptive reason for why you suspended the public folder mailbox migration. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -113,13 +122,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderMigrationRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMigrationRequest.md similarity index 91% rename from exchange/exchange-ps/exchange/Suspend-PublicFolderMigrationRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMigrationRequest.md index 824fe531ac..d3cdd9a07d 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMigrationRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-publicfoldermigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-PublicFolderMigrationRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-publicfoldermigrationrequest +schema: 2.0.0 +title: Suspend-PublicFolderMigrationRequest --- # Suspend-PublicFolderMigrationRequest @@ -53,6 +54,9 @@ This example suspends all migration requests that are in progress by using the G ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the migration request that you want to suspend. You can use the following values: - Name @@ -62,7 +66,6 @@ The Identity parameter specifies the migration request that you want to suspend. Type: PublicFolderMigrationRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -81,7 +87,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuspendComment parameter specifies a description as to why the request was suspended. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderMoveRequest.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMoveRequest.md similarity index 90% rename from exchange/exchange-ps/exchange/Suspend-PublicFolderMoveRequest.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMoveRequest.md index fc298d21c8..3642df39c3 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderMoveRequest.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-publicfoldermoverequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-PublicFolderMoveRequest -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-publicfoldermoverequest +schema: 2.0.0 +title: Suspend-PublicFolderMoveRequest --- # Suspend-PublicFolderMoveRequest @@ -44,13 +45,15 @@ This example suspends the public folder move request \\PublicFolderMove. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the identity of the public folder move request. The default identity is \\PublicFolderMove. ```yaml Type: PublicFolderMoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -60,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -69,7 +75,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -95,13 +102,15 @@ Accept wildcard characters: False ``` ### -SuspendComment + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,13 +120,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderReplication.md similarity index 95% rename from exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderReplication.md index 8819989303..499d868c9f 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-PublicFolderReplication.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-publicfolderreplication applicable: Exchange Server 2010 -title: Suspend-PublicFolderReplication -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-publicfolderreplication +schema: 2.0.0 +title: Suspend-PublicFolderReplication --- # Suspend-PublicFolderReplication @@ -42,6 +43,9 @@ This example stops public folder replication for the organization. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -51,7 +55,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -61,13 +64,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Suspend-Queue.md b/exchange/exchange-ps/ExchangePowerShell/Suspend-Queue.md similarity index 90% rename from exchange/exchange-ps/exchange/Suspend-Queue.md rename to exchange/exchange-ps/ExchangePowerShell/Suspend-Queue.md index 14102cc59b..eb7ca20f2e 100644 --- a/exchange/exchange-ps/exchange/Suspend-Queue.md +++ b/exchange/exchange-ps/ExchangePowerShell/Suspend-Queue.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/suspend-queue applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Suspend-Queue -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/suspend-queue +schema: 2.0.0 +title: Suspend-Queue --- # Suspend-Queue @@ -40,7 +41,7 @@ Suspend-Queue [-Identity] ## DESCRIPTION The Suspend-Queue cmdlet stops processing on a queue that has a status of Active or Retry. Messages being processed are delivered, but no additional messages leave the queue. When you use the Identity parameter, the queue is suspended only if the identity matches a single queue. If the identity matches more than one queue, you receive an error. To suspend more than one queue in a single operation, you must use the Filter parameter. -For instructions on how to resume suspended queues, see [Resume-Queue](https://learn.microsoft.com/powershell/module/exchange/resume-queue). +For instructions on how to resume suspended queues, see [Resume-Queue](https://learn.microsoft.com/powershell/module/exchangepowershell/resume-queue). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -63,13 +64,15 @@ This example suspends processing on all queues on the server Server1.contoso.com ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -87,7 +93,6 @@ You can specify multiple criteria by using the and comparison operator. Property Type: String Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -106,7 +114,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -131,7 +141,6 @@ You can use the Server parameter and the Filter parameter in the same command. Y Type: ServerIdParameter Parameter Sets: Filter Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,13 +150,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-ActiveSyncConnectivity.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ActiveSyncConnectivity.md index 48f24eefda..dd664d7ac3 100644 --- a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ActiveSyncConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-activesyncconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ActiveSyncConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-activesyncconnectivity +schema: 2.0.0 +title: Test-ActiveSyncConnectivity --- # Test-ActiveSyncConnectivity @@ -79,6 +80,9 @@ This example tests the Exchange ActiveSync connectivity for the mailbox PaulS us ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -94,7 +98,6 @@ You can't use this parameter with the Url parameter. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -URL + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The URL parameter specifies the URL that's used to connect to the Exchange ActiveSync virtual directory. You can't use this parameter with the ClientAccessServer parameter. @@ -112,7 +118,6 @@ You can't use this parameter with the ClientAccessServer parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -AllowUnsecureAccess + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AllowUnsecureAccess switch allows the test to continue over an unsecured channel that doesn't require Secure Sockets Layer (SSL). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -147,7 +157,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,13 +166,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LightMode switch tells the command to perform only a subset of the tests. You don't need to specify a value with this switch. When you use this switch, only the Options test is run. @@ -183,7 +197,6 @@ If you don't use this switch, the First Sync, GetItemEstimate, Sync Data, Ping a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -201,7 +217,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,6 +226,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -226,7 +244,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -244,7 +264,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,13 +273,15 @@ Accept wildcard characters: False ``` ### -MonitoringInstance + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringInstance parameter specifies an identifier for this task when the test is run from Microsoft System Center Operations Manager (SCOM). This parameter is important because SCOM may run multiple instances of the test from the same server at the same time. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,6 +291,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -278,7 +302,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -288,13 +311,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Timeout parameter specifies the amount of time (in seconds) to wait for a response from the command. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,6 +329,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -312,7 +340,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -322,13 +349,15 @@ Accept wildcard characters: False ``` ### -UseAutodiscoverForClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UseAutodiscoverForClientAccessServer switch specifies whether the test should use the Autodiscover service to locate the Exchange ActiveSync virtual directory. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -338,13 +367,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Test-ApplicationAccessPolicy.md similarity index 93% rename from exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ApplicationAccessPolicy.md index 24d8280b0b..adf203bba5 100644 --- a/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ApplicationAccessPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection -title: Test-ApplicationAccessPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-applicationaccesspolicy +schema: 2.0.0 +title: Test-ApplicationAccessPolicy --- # Test-ApplicationAccessPolicy @@ -49,6 +50,9 @@ This example tests access to the user RandomUser9911@AppPolicyTest2.com for the ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the recipient to test. You can use any value that uniquely identifies the recipient. For example: - Name @@ -61,7 +65,6 @@ The Identity parameter specifies the recipient to test. You can use any value th Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -AppId + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the GUID of the app that you want to test. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. You can specify multiple app GUID values separated by commas. @@ -79,7 +85,6 @@ You can specify multiple app GUID values separated by commas. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-ArchiveConnectivity.md similarity index 90% rename from exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ArchiveConnectivity.md index 219f178aa0..8ed3187035 100644 --- a/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ArchiveConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-archiveconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ArchiveConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-archiveconnectivity +schema: 2.0.0 +title: Test-ArchiveConnectivity --- # Test-ArchiveConnectivity @@ -53,13 +54,15 @@ This command retrieves mailboxes that have a cloud-based archive provisioned and ## PARAMETERS ### -UserSmtp + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UserSmtp parameter specifies the SMTP address of the mailbox. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -IncludeArchiveMRMConfiguration + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeArchiveMRMConfiguration switch retrieves retention tags that are provisioned in the user's archive mailbox and the last time the archive was processed by the Managed Folder Assistant. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -MessageId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -120,13 +129,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-AssistantHealth.md b/exchange/exchange-ps/ExchangePowerShell/Test-AssistantHealth.md similarity index 90% rename from exchange/exchange-ps/exchange/Test-AssistantHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Test-AssistantHealth.md index 95868838da..bf783610ca 100644 --- a/exchange/exchange-ps/exchange/Test-AssistantHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-AssistantHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-assistanthealth applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-AssistantHealth -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-assistanthealth +schema: 2.0.0 +title: Test-AssistantHealth --- # Test-AssistantHealth @@ -58,6 +59,9 @@ This example detects the mailbox assistant's health on the local Mailbox server. ## PARAMETERS ### -ServerName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ServerName parameter specifies the Mailbox server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -71,7 +75,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -90,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -IncludeCrashDump + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeCrashDump switch specifies that the command should take an error report prior to taking any recovery actions. You don't need to specify a value with this switch. You should only use this switch on the local computer. If you use this switch while connected remotely, the command will fail. @@ -108,7 +116,6 @@ You should only use this switch on the local computer. If you use this switch wh Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -MaxProcessingTimeInMinutes + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxProcessingTimeInMinutes parameter specifies the maximum amount of time the MSExchangeMailboxAssistants service is allowed to process an event without responding. You can specify a value from 1 through 3600 minutes. The default value is 15 minutes. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -142,7 +154,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -ResolveProblems + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This ResolveProblems switch specifies that if the command detects an issue, it attempts to fix it. You don't need to specify a value with this switch. This command attempts to fix the following issues: @@ -163,7 +177,6 @@ This command attempts to fix the following issues: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,6 +186,9 @@ Accept wildcard characters: False ``` ### -WatermarkBehindWarningThreholdInMinutes + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WatermarkBehindWarningThreholdInMinutes parameter specifies the threshold for watermark age. Event watermarks indicate the last time that events were successfully processed by an assistant. An event watermark that hasn't been updated in a while may indicate a problem. For each Mailbox Assistant, the Test-AssistantHealth cmdlet compares the current time with the time stamp of the last event watermark to determine the watermark age. If that age exceeds the value set by the WatermarkBehindWarningThreholdInMinutes parameter, a warning is generated. You can specify a value from 1 through 10080 minutes. The default value is 60 minutes. @@ -181,7 +197,6 @@ You can specify a value from 1 through 10080 minutes. The default value is 60 mi Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,13 +206,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-CalendarConnectivity.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-CalendarConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-CalendarConnectivity.md index c2836a32a6..4053d7ba11 100644 --- a/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-CalendarConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-calendarconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-CalendarConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-calendarconnectivity +schema: 2.0.0 +title: Test-CalendarConnectivity --- # Test-CalendarConnectivity @@ -72,6 +73,9 @@ This example tests the anonymous calendar sharing for the server named MBX01. ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -85,7 +89,6 @@ You can use any value that uniquely identifies the server. For example: Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -104,7 +110,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of this command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -161,7 +173,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +182,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -179,7 +193,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,6 +202,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -197,7 +213,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,13 +222,15 @@ Accept wildcard characters: False ``` ### -TestType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TestType parameter specifies whether the command tests internal or external URLs. Values are Internal and External. The default value is Internal. ```yaml Type: OwaConnectivityTestType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -223,13 +240,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of this command. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -239,13 +258,15 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of this command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -255,6 +276,9 @@ Accept wildcard characters: False ``` ### -VirtualDirectoryName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The VirtualDirectoryName parameter specifies the name of the Outlook on the web virtual directory that you want to test. Enclose values that contain spaces in quotation marks ("). If you don't use this parameter, all available Outlook on the web virtual directories are tested. @@ -263,7 +287,6 @@ If you don't use this parameter, all available Outlook on the web virtual direct Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,13 +296,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md b/exchange/exchange-ps/ExchangePowerShell/Test-ClientAccessRule.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-ClientAccessRule.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ClientAccessRule.md index 3389d80031..85272491f6 100644 --- a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ClientAccessRule.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-clientaccessrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Test-ClientAccessRule -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-clientaccessrule +schema: 2.0.0 +title: Test-ClientAccessRule --- # Test-ClientAccessRule @@ -61,6 +62,9 @@ This example tests client access by using the following client properties: ## PARAMETERS ### -AuthenticationType + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The AuthenticationType parameter specifies the client authentication type to test. Valid values for this parameter are: @@ -77,7 +81,6 @@ In client access rules, authentication types are defined by the AnyOfAuthenticat Type: ClientAccessAuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Protocol + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Protocol parameter specifies the client protocol to test. Valid values for this parameter are: @@ -109,7 +115,6 @@ In client access rules, protocol types are defined by the AnyOfProtocols and Exc Type: ClientAccessProtocol Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -RemoteAddress + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RemoteAddress parameter specifies the client IP address to test. Valid input for this parameter is an IP address. For example, 192.168.1.50. In client access rules, IP addresses are defined by the AnyOfClientIPAddressesOrRanges and ExceptAnyOfClientIPAddressesOrRanges parameters. @@ -127,7 +135,6 @@ In client access rules, IP addresses are defined by the AnyOfClientIPAddressesOr Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -137,13 +144,15 @@ Accept wildcard characters: False ``` ### -RemotePort + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The RemotePort parameter specifies the client TCP port to test. Valid input for this parameter is an integer from 1 to 65535. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The User parameter specifies the user account to test. For the best results, we recommend using the following values: @@ -179,7 +191,6 @@ In client access rules, users are defined by the UsernameMatchesAnyOfPatterns, U Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -189,6 +200,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -198,7 +212,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,13 +221,15 @@ Accept wildcard characters: False ``` ### -OAuthClaims + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The OAuthClaims parameter specifies the OAuth claims token of a middle-tier app. ```yaml Type: Hashtable Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -224,13 +239,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-DataClassification.md b/exchange/exchange-ps/ExchangePowerShell/Test-DataClassification.md similarity index 89% rename from exchange/exchange-ps/exchange/Test-DataClassification.md rename to exchange/exchange-ps/ExchangePowerShell/Test-DataClassification.md index 7d9109fd68..f9003e70b8 100644 --- a/exchange/exchange-ps/exchange/Test-DataClassification.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-DataClassification.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-dataclassification applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance -title: Test-DataClassification -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-dataclassification +schema: 2.0.0 +title: Test-DataClassification --- # Test-DataClassification @@ -49,6 +50,9 @@ This example lists all sensitive info types, their count, and confidence in the ## PARAMETERS ### -ClassificationNames + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + The ClassificationNames parameter specifies the sensitive information type that you want to find in the text specified by the TextToClassify parameter. Valid values are: - Name @@ -60,7 +64,6 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -70,6 +73,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -78,7 +84,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -FileExtension + +> Applicable: Exchange Online, Security & Compliance + This parameter is available only in the cloud-based service. {{ Fill FileExtension Description }} @@ -96,7 +104,6 @@ This parameter is available only in the cloud-based service. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -TestTextExtractionResults + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + The TestTextExtractionResults parameter specifies the extracted text from the Test-TextExtraction cmdlet as the input text stream. ```yaml Type: TestTextExtractionResult[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -122,13 +131,15 @@ Accept wildcard characters: False ``` ### -TextToClassify + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + The TextToClassify parameter specifies the text string for which classification results need to be shown. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-EcpConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-EcpConnectivity.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-EcpConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-EcpConnectivity.md index 81cf892ecd..36fa0baa49 100644 --- a/exchange/exchange-ps/exchange/Test-EcpConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-EcpConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-ecpconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-EcpConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-ecpconnectivity +schema: 2.0.0 +title: Test-EcpConnectivity --- # Test-EcpConnectivity @@ -71,6 +72,9 @@ This example tests user connectivity to the Exchange admin center on Server01. ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -84,7 +88,6 @@ You can use any value that uniquely identifies the server. For example: Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -103,7 +109,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,13 +118,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -129,13 +136,15 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of this command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -160,7 +172,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -178,7 +192,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -196,7 +212,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -RSTEndpoint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,13 +239,15 @@ Accept wildcard characters: False ``` ### -TestType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TestType parameter specifies whether the command tests internal or external URLs. Values are Internal and External. The default value is Internal. ```yaml Type: OwaConnectivityTestType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,13 +257,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. The default value for the Timeout parameter is 30 seconds. You must specify a time-out value greater than 0 seconds and less than 1 hour (3,600 seconds). We recommend that you always configure this parameter with a value of 5 seconds or more. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,6 +275,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -262,7 +286,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -272,6 +295,9 @@ Accept wildcard characters: False ``` ### -VirtualDirectoryName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The VirtualDirectoryName parameter specifies the name of the EAC virtual directory that you want to test. Enclose values that contain spaces in quotation marks ("). If you don't use this parameter, all available EAC virtual directories are tested. @@ -280,7 +306,6 @@ If you don't use this parameter, all available EAC virtual directories are teste Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -290,13 +315,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md b/exchange/exchange-ps/ExchangePowerShell/Test-EdgeSynchronization.md similarity index 90% rename from exchange/exchange-ps/exchange/Test-EdgeSynchronization.md rename to exchange/exchange-ps/ExchangePowerShell/Test-EdgeSynchronization.md index 8f9a1e1fb9..46379fa713 100644 --- a/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-EdgeSynchronization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-edgesynchronization applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-EdgeSynchronization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-edgesynchronization +schema: 2.0.0 +title: Test-EdgeSynchronization --- # Test-EdgeSynchronization @@ -68,13 +69,15 @@ This example verifies the synchronization status of the single recipient kate@co ## PARAMETERS ### -VerifyRecipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The VerifyRecipient parameter specifies a single recipient with which to verify the synchronization status. You identify the recipient by specifying a proxy address assigned to the recipient. The proxy address is the recipient's email address. The recipient verification test is mutually exclusive of the test that verifies synchronization of configuration data. ```yaml Type: ProxyAddress Parameter Sets: SingleValidation Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -93,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -ExcludeRecipientTest + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExcludeRecipientTest switch specifies whether to exclude validation of recipient data synchronization. You don't need to specify a value with this switch. If you use this switch, only the synchronization of configuration objects is validated. Validating that recipient data is synchronized takes longer than validating only configuration data. @@ -127,7 +137,6 @@ If you use this switch, only the synchronization of configuration objects is val Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -FullCompareMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FullCompareMode switch specifies whether a full comparison of the configuration data between Active Directory and AD LDS instance on the target Edge Transport server is performed. You don't need to specify a value with this switch. If you don't use this switch, a full comparison of replicated configuration data is skipped and the command only tests the Edge synchronization by verifying the replication cookie. @@ -145,7 +157,6 @@ If you don't use this switch, a full comparison of replicated configuration data Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -MaxReportSize + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxReportSize parameter specifies the total number of objects and properties listed in the results. The results output by this command include a list of all out-of-sync objects and properties in both AD LDS and Active Directory. If the directory services aren't synchronized, a large amount of data can result. If you don't specify a value for this parameter, the default value of 1,000 is used. The minimum value for this parameter is 1. The maximum value for this parameter is unlimited. ```yaml Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -180,7 +196,6 @@ The MonitoringContext parameter specifies whether to include the associated moni Type: Boolean Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -TargetServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetServer parameter specifies an Edge Transport server to initiate edge synchronization with. If omitted, all Edge Transport servers are synchronized. You may want to use this parameter to specify a single Edge Transport server for synchronization if a new Edge Transport server has been installed or if that Edge Transport server has been unavailable for some time. @@ -198,7 +216,6 @@ You may want to use this parameter to specify a single Edge Transport server for Type: String Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,13 +225,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ExchangeSearch.md b/exchange/exchange-ps/ExchangePowerShell/Test-ExchangeSearch.md similarity index 89% rename from exchange/exchange-ps/exchange/Test-ExchangeSearch.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ExchangeSearch.md index de07b2a9a7..b8ccea20c0 100644 --- a/exchange/exchange-ps/exchange/Test-ExchangeSearch.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ExchangeSearch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-exchangesearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ExchangeSearch -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-exchangesearch +schema: 2.0.0 +title: Test-ExchangeSearch --- # Test-ExchangeSearch @@ -80,6 +81,9 @@ This example tests Exchange Search results for the mailbox database on which the ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox that you want to test Exchange Search against. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -99,7 +103,6 @@ You can't use this parameter with the MailboxDatabase or Server parameters. Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -109,13 +112,15 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Archive switch specifies that the test is run against the archive mailbox for the mailbox user specified by the Identity parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -134,7 +142,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +151,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -160,13 +169,15 @@ Accept wildcard characters: False ``` ### -IndexingTimeoutInSeconds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IndexingTimeoutInSeconds parameter specifies, in seconds, the maximum amount of time to wait between adding the new email message to the test mailbox and waiting for it to be returned in a search result. The default value is 120 seconds. If this parameter isn't specified, the default interval is used. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -MailboxDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010 and 2013. The MailboxDatabase parameter specifies the mailbox database to test Exchange Search against. You can use any value that uniquely identifies the database. For example: @@ -190,7 +204,6 @@ You can't use this parameter with the Identity or Server parameters. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,6 +213,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -208,7 +224,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -218,6 +233,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server for the recipient that you want to test Exchange Search against. You can use any value that uniquely identifies the server. For example: - Name @@ -231,7 +249,6 @@ You can't use this parameter with the MailboxDatabase or Identity parameters. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,13 +258,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-FederationTrust.md b/exchange/exchange-ps/ExchangePowerShell/Test-FederationTrust.md similarity index 91% rename from exchange/exchange-ps/exchange/Test-FederationTrust.md rename to exchange/exchange-ps/ExchangePowerShell/Test-FederationTrust.md index d8910cf09d..691cbaca05 100644 --- a/exchange/exchange-ps/exchange/Test-FederationTrust.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-FederationTrust.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-federationtrust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-FederationTrust -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-federationtrust +schema: 2.0.0 +title: Test-FederationTrust --- # Test-FederationTrust @@ -56,6 +57,9 @@ This example validates the federation trust deployed in the Exchange organizatio ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -65,7 +69,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -100,7 +108,6 @@ The MonitoringContext parameter specifies whether to include the associated moni Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -UserIdentity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UserIdentity parameter specifies a mailbox user to request a token for. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -125,7 +135,6 @@ If you don't specify a mailbox, the command uses the default test mailbox. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md b/exchange/exchange-ps/ExchangePowerShell/Test-FederationTrustCertificate.md similarity index 91% rename from exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md rename to exchange/exchange-ps/ExchangePowerShell/Test-FederationTrustCertificate.md index d26350dd00..15940fa909 100644 --- a/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-FederationTrustCertificate.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-federationtrustcertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-FederationTrustCertificate -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-federationtrustcertificate +schema: 2.0.0 +title: Test-FederationTrustCertificate --- # Test-FederationTrustCertificate @@ -44,6 +45,9 @@ This example reports the status of federation certificates. ## PARAMETERS ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -53,7 +57,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Test-IPAllowListProvider.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-IPAllowListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Test-IPAllowListProvider.md index 4b2de63622..4d368590b2 100644 --- a/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-IPAllowListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-ipallowlistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-IPAllowListProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-ipallowlistprovider +schema: 2.0.0 +title: Test-IPAllowListProvider --- # Test-IPAllowListProvider @@ -46,6 +47,9 @@ This example tests the existing IP Allow list provider named Contoso,com by send ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the IP Allow list provider that you want to test. You can use any value that uniquely identifies the IP Allow list provider. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the IP Allow list provider that you want to tes Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddress parameter specifies an IP address to be used in testing the IP Allow list provider. You need to use a known allowed IP address. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -91,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -109,7 +119,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -134,7 +146,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md b/exchange/exchange-ps/ExchangePowerShell/Test-IPBlockListProvider.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-IPBlockListProvider.md rename to exchange/exchange-ps/ExchangePowerShell/Test-IPBlockListProvider.md index 7ab51aad23..bd4bab5f58 100644 --- a/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-IPBlockListProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-ipblocklistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-IPBlockListProvider -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-ipblocklistprovider +schema: 2.0.0 +title: Test-IPBlockListProvider --- # Test-IPBlockListProvider @@ -46,6 +47,9 @@ This example tests the existing IP Block list provider named Contoso.com by send ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the IP Block list provider that you want to test. You can use any value that uniquely identifies the IP Block list provider. For example: - Name @@ -56,7 +60,6 @@ The Identity parameter specifies the IP Block list provider that you want to tes Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,13 +69,15 @@ Accept wildcard characters: False ``` ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddress parameter specifies an IP address to be used in testing the IP Block list provider. You need to use a known blocked IP address. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -82,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -91,7 +99,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -101,6 +108,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -109,7 +119,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -134,7 +146,6 @@ You can't use this parameter to configure other Edge Transport servers remotely. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -144,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-IRMConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Test-IRMConfiguration.md similarity index 87% rename from exchange/exchange-ps/exchange/Test-IRMConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Test-IRMConfiguration.md index c3b0a5ae4e..630e6705f1 100644 --- a/exchange/exchange-ps/exchange/Test-IRMConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-IRMConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-irmconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Test-IRMConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-irmconfiguration +schema: 2.0.0 +title: Test-IRMConfiguration --- # Test-IRMConfiguration @@ -54,6 +55,9 @@ This example tests the IRM configuration in the cloud-based service for messages ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -62,7 +66,6 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Sender parameter specifies the email address of the sender to test. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -97,7 +105,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -115,7 +125,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -Recipient + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Recipient parameter specifies the email address of the recipient to test. You can specify multiple email addresses separated by commas. This parameter is required in the cloud-based service. @@ -135,7 +147,6 @@ In on-premises Exchange, if you don't use this parameter, the sender address tha Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -145,6 +156,9 @@ Accept wildcard characters: False ``` ### -RMSOnline + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is available only in the cloud-based service. The RMSOnline switch specifies whether to test connectivity from Exchange Online to RMS Online, obtain your Exchange Online organization's TPD, and test its validity. You don't need to specify a value with this switch. @@ -153,7 +167,6 @@ The RMSOnline switch specifies whether to test connectivity from Exchange Online Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ImapConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-ImapConnectivity.md similarity index 89% rename from exchange/exchange-ps/exchange/Test-ImapConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ImapConnectivity.md index 44bf2c9053..b6812f1335 100644 --- a/exchange/exchange-ps/exchange/Test-ImapConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ImapConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-imapconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ImapConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-imapconnectivity +schema: 2.0.0 +title: Test-ImapConnectivity --- # Test-ImapConnectivity @@ -85,6 +86,9 @@ This example tests the client IMAP4 connectivity of the server named Contoso12 a ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -98,7 +102,6 @@ You can use any value that uniquely identifies the server. For example: Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -117,7 +123,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -ConnectionType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectionType parameter specifies the type of connection that's used to connect to the IMAP4 service. Valid values are: - Plaintext @@ -137,7 +145,6 @@ The ConnectionType parameter specifies the type of connection that's used to con Type: ProtocolConnectionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,13 +154,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LightMode switch tells the command to perform only a test logon to the server by using the IMAP4 protocol. You don't need to specify a value with this switch. If you don't use this switch, the command also tests sending and receiving a message using the IMAP4 protocol. @@ -171,7 +183,6 @@ If you don't use this switch, the command also tests sending and receiving a mes Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -189,7 +203,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -199,6 +212,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -214,7 +230,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,6 +239,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -232,7 +250,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -242,6 +259,9 @@ Accept wildcard characters: False ``` ### -PerConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PerConnectionTimeout parameter specifies the amount of time, in seconds, to wait per connection for the test operation to finish. Valid values are between 0 and 120 seconds. The default value is 120 seconds. We recommend that you configure this parameter with a value of 5 seconds or more. @@ -250,7 +270,6 @@ We recommend that you configure this parameter with a value of 5 seconds or more Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,13 +279,15 @@ Accept wildcard characters: False ``` ### -PortClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PortClientAccessServer parameter specifies the port to use to connect to the Client Access server. The default port is 143 for IMAP4. The valid range is from 0 through 65,535. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -276,6 +297,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -284,7 +308,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -294,6 +317,9 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. Valid values are between 0 and 3600 seconds (1 hour). The default value is 180 seconds (3 minutes). We recommend that you configure this parameter with a value of 5 seconds or more. @@ -302,7 +328,6 @@ We recommend that you configure this parameter with a value of 5 seconds or more Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -312,6 +337,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -320,7 +348,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -330,13 +357,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Test-M365DataAtRestEncryptionPolicy.md similarity index 92% rename from exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Test-M365DataAtRestEncryptionPolicy.md index f166b0c365..ce462c6e24 100644 --- a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-M365DataAtRestEncryptionPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-m365dataatrestencryptionpolicy applicable: Exchange Online, Exchange Online Protection -title: Test-M365DataAtRestEncryptionPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-m365dataatrestencryptionpolicy +schema: 2.0.0 +title: Test-M365DataAtRestEncryptionPolicy --- # Test-M365DataAtRestEncryptionPolicy @@ -43,6 +44,9 @@ This example tests the Microsoft 365 data-at-rest encryption policy named Contos ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Microsoft 365 data-at-rest encryption policy that you want to test. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ You can find the existing data-at-rest encryption policies by using the Get-M365 Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: 0 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-MAPIConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-MAPIConnectivity.md similarity index 89% rename from exchange/exchange-ps/exchange/Test-MAPIConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-MAPIConnectivity.md index 0b615b567c..423f2aba20 100644 --- a/exchange/exchange-ps/exchange/Test-MAPIConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-MAPIConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-mapiconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-MAPIConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-mapiconnectivity +schema: 2.0.0 +title: Test-MAPIConnectivity --- # Test-MAPIConnectivity @@ -95,6 +96,9 @@ This example tests connectivity to a mailbox, specified as a domain name and use ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies a mailbox to test. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -118,7 +122,6 @@ You can't use the Identity, Database, or Server parameters in the same command. Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -128,6 +131,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Database parameter specifies the database on which to test the connectivity to the system mailbox. You can use any value that uniquely identifies the database. For example: @@ -144,7 +150,6 @@ You can't use the Identity, Database, or Server parameters in the same command. Type: DatabaseIdParameter Parameter Sets: Database Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -154,6 +159,9 @@ Accept wildcard characters: False ``` ### -ActiveDirectoryTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The ActiveDirectoryTimeout parameter specifies the amount of time, in seconds, allowed for each Active Directory operation to complete before the operation times out. The default value is 15 seconds. @@ -162,7 +170,6 @@ The ActiveDirectoryTimeout parameter specifies the amount of time, in seconds, a Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -172,6 +179,9 @@ Accept wildcard characters: False ``` ### -AllConnectionsTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The AllConnectionsTimeout parameter specifies the amount of time, in seconds, allowed for all connections to complete before the cmdlet times out. The time-out countdown doesn't begin until all information necessary to perform the connections is gathered from Active Directory.The default value is 90 seconds. @@ -180,7 +190,6 @@ The AllConnectionsTimeout parameter specifies the amount of time, in seconds, al Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,6 +199,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Archive switch specifies whether to test the MAPI connectivity of the personal archive that's associated with the specified mailbox. You don't need to specify a value with this switch. If you don't use this switch, only the primary mailbox is tested. @@ -198,7 +210,6 @@ If you don't use this switch, only the primary mailbox is tested. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,6 +219,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -217,7 +231,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -227,6 +240,9 @@ Accept wildcard characters: False ``` ### -CopyOnServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The CopyOnServer parameter specifies the Mailbox server that holds the specific database copy to test. You can use any value that uniquely identifies the server. For example: @@ -242,7 +258,6 @@ You can only use this parameter with the Server parameter, not the Identify or D Type: ServerIdParameter Parameter Sets: Database, Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,6 +267,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -260,7 +278,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,6 +287,9 @@ Accept wildcard characters: False ``` ### -IncludePassive + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The IncludePassive switch tests MAPI connectivity from all active and passive database copies. You don't need to specify a value with this switch. @@ -280,7 +300,6 @@ If you don't use this switch, the command tests MAPI connectivity from active da Type: SwitchParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -290,6 +309,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: @@ -301,7 +323,6 @@ The MonitoringContext parameter specifies whether to include the associated moni Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -311,6 +332,9 @@ Accept wildcard characters: False ``` ### -PerConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The PerConnectionTimeout parameter specifies the amount of time, in seconds, allowed for each connection to complete before the connection times out. The default value is 10 seconds. @@ -319,7 +343,6 @@ The PerConnectionTimeout parameter specifies the amount of time, in seconds, all Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -329,6 +352,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The Server parameter specifies the server on which you will test the MAPI connectivity. The command tests the MAPI connectivity to each system mailbox hosted on active databases on the specified server. You can use any value that uniquely identifies the server. For example: @@ -346,7 +372,6 @@ You can't use the Identity, Database, or Server parameters in the same command. Type: ServerIdParameter Parameter Sets: Server Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +381,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-MRSHealth.md b/exchange/exchange-ps/ExchangePowerShell/Test-MRSHealth.md similarity index 90% rename from exchange/exchange-ps/exchange/Test-MRSHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Test-MRSHealth.md index c4208ccf1f..36a7b10727 100644 --- a/exchange/exchange-ps/exchange/Test-MRSHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-MRSHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-mrshealth applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-MRSHealth -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-mrshealth +schema: 2.0.0 +title: Test-MRSHealth --- # Test-MRSHealth @@ -56,6 +57,9 @@ This example tests the health of the Mailbox Replication service on the Mailbox ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the server on which to perform the health test. You can use any value that uniquely identifies the server. For example: - Name @@ -69,7 +73,6 @@ If you don't specify the server, the command runs on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +94,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -MaxQueueScanAgeSeconds + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaxQueueScanAgeSeconds parameter specifies the threshold for the last queue scan property. If the time stamp on the last queue scan property is older than the value specified by this parameter, an error event is created that shows the Mailbox Replication service isn't scanning mailbox database queues. The default value is 1800 seconds (30 minutes). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -139,7 +151,6 @@ The MonitoringContext parameter specifies whether to include the associated moni Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -MRSProxyCredentials + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MRSProxyCredentials parameter specifies the credentials that are required for the MRSProxyPingCheck test on the server that's specified by the MRSProxyServer parameter. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -157,7 +171,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,6 +180,9 @@ Accept wildcard characters: False ``` ### -MRSProxyServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MRSProxyServer parameter specifies the fully qualified domain name (FQDN) of the target server for the MRSProxyPingCheck test. The Microsoft Replication proxy service is part of the Mailbox Replication service, and is used for remote mailbox moves. However, the Mailbox Replication proxy service communicates only with the Mailbox Replication service on another server. You can test the Mailbox Replication proxy service in the following ways: @@ -179,7 +195,6 @@ The Microsoft Replication proxy service is part of the Mailbox Replication servi Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,13 +204,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-Mailflow.md b/exchange/exchange-ps/ExchangePowerShell/Test-Mailflow.md similarity index 89% rename from exchange/exchange-ps/exchange/Test-Mailflow.md rename to exchange/exchange-ps/ExchangePowerShell/Test-Mailflow.md index 628848623e..b233b26e4c 100644 --- a/exchange/exchange-ps/exchange/Test-Mailflow.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-Mailflow.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-mailflow applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-Mailflow -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-mailflow +schema: 2.0.0 +title: Test-Mailflow --- # Test-Mailflow @@ -135,6 +136,9 @@ This example tests message flow from the local Mailbox server where you're runni ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the source Mailbox server name from which a test message is sent. You can use any value that uniquely identifies the server. For example: - Name @@ -148,7 +152,6 @@ If you don't use this parameter, the local Mailbox server is used. Type: ServerIdParameter Parameter Sets: AutoDiscoverTargetMailboxServer, TargetDatabase, TargetEmailAddress, TargetMailboxServer, SourceServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -158,6 +161,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverTargetMailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDiscoverTargetMailboxServer switch specifies whether to automatically populate a list of target Mailbox servers to which to send a test message. You don't need to specify a value with this switch. The task queries Active Directory to discover all Mailbox servers and then sends each server a test message. @@ -168,7 +174,6 @@ When you use this switch, you can't use the CrossPremises, TargetDatabase, Targe Type: SwitchParameter Parameter Sets: AutoDiscoverTargetMailboxServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -178,6 +183,9 @@ Accept wildcard characters: False ``` ### -CrossPremises + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CrossPremises parameter specifies whether the mail flow test will be conducted in cross-premises mode. Set this parameter to $true if your organization is using a cross-premises deployment and you want to verify cross-premises mail flow. @@ -188,7 +196,6 @@ When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, Type: Boolean Parameter Sets: CrossPremises Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -198,6 +205,9 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetDatabase parameter specifies the mailbox database to which test messages are sent. You can use any value that uniquely identifies the database. For example: - Name @@ -210,7 +220,6 @@ You can't use this parameter with the AutoDiscoverTargetMailboxServer, CrossPrem Type: DatabaseIdParameter Parameter Sets: TargetDatabase Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -220,6 +229,9 @@ Accept wildcard characters: False ``` ### -TargetEmailAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetEmailAddress parameter specifies the SMTP address of the mailbox to which test messages are sent. Use this parameter to send test messages to a Mailbox server in a remote forest. If this parameter is used, the test is always a remote test. When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, CrossPremises, TargetDatabase or TargetMailboxServer parameters. @@ -228,7 +240,6 @@ When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, Type: String Parameter Sets: TargetEmailAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -238,6 +249,9 @@ Accept wildcard characters: False ``` ### -TargetMailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetMailboxServer parameter specifies one or more Mailbox servers in the local Exchange organization to send test messages to. You can use any value that uniquely identifies the server. For example: - Name @@ -251,7 +265,6 @@ When you use this parameter, you can't use the AutoDiscoverTargetMailboxServer, Type: ServerIdParameter Parameter Sets: TargetMailboxServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -261,13 +274,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectoryTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveDirectoryTimeout parameter specifies the number of seconds that elapse before the task provides an informational message about the delay. The default value is 15 seconds. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,6 +292,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -286,7 +304,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,13 +313,15 @@ Accept wildcard characters: False ``` ### -CrossPremisesExpirationTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CrossPremisesExpirationTimeout parameter is used when this cmdlet is run by Microsoft System Center Operations Manager 2007 agents for asynchronous monitoring. We don't recommend using this parameter when running this cmdlet manually. ```yaml Type: EnhancedTimeSpan Parameter Sets: CrossPremises Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -312,13 +331,15 @@ Accept wildcard characters: False ``` ### -CrossPremisesPendingErrorCount + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CrossPremisesPendingErrorCount parameter is used when this cmdlet is run by System Center Operations Manager 2007 agents for asynchronous monitoring. We don't recommend using this parameter when running this cmdlet manually. ```yaml Type: Int32 Parameter Sets: CrossPremises Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -328,13 +349,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -344,13 +367,15 @@ Accept wildcard characters: False ``` ### -ErrorLatency + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ErrorLatency parameter specifies how long to wait for a test message to be delivered before an error event is logged in Microsoft System Center Operations Manager 2007. The default value when a test message is sent to the local Mailbox server is 15 seconds and 180 seconds when a test message is sent to a remote Mailbox server. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -360,13 +385,15 @@ Accept wildcard characters: False ``` ### -ExecutionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ExecutionTimeout parameter specifies the maximum time that this task can run before the test is determined to be a failure. If no test message or delivery report arrives before this time expires, the task ends and an error is reported. When the task is run in the Exchange Management Shell, the default setting is 240 seconds. When the MonitoringContext parameter is used, the default setting is 15 seconds. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -376,6 +403,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -385,7 +415,6 @@ The MonitoringContext parameter specifies whether to include the associated moni Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -395,6 +424,9 @@ Accept wildcard characters: False ``` ### -TargetEmailAddressDisplayName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TargetEmailAddressDisplayName parameter specifies a custom display name that's used on events and reports in Microsoft System Center Operations Manager 2007 when the TargetEmailAddress parameter is used. If you don't use the TargetEmailAddressDisplayName parameter, the events and reports use the email address value specified by the TargetEmailAddress parameter. This parameter is available only with the TargetEmailAddress parameter and has no effect on the output of the cmdlet outside of Microsoft System Center Operations Manager. @@ -403,7 +435,6 @@ This parameter is available only with the TargetEmailAddress parameter and has n Type: String Parameter Sets: TargetEmailAddress Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -413,13 +444,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/ExchangePowerShell/Test-Message.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-Message.md rename to exchange/exchange-ps/ExchangePowerShell/Test-Message.md index c4b62c4ac7..38282de336 100644 --- a/exchange/exchange-ps/exchange/Test-Message.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-Message.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-message applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection -title: Test-Message -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-message +schema: 2.0.0 +title: Test-Message --- # Test-Message @@ -60,6 +61,9 @@ This example uses the test.eml message file at C:\Data to test mail flow rules a ## PARAMETERS ### -Recipients + +> Applicable: Exchange Online, Exchange Online Protection + The Recipients parameter specifies the recipient email address to use for the test message. You can specify multiple email addresses separated by commas. @@ -68,7 +72,6 @@ You can specify multiple email addresses separated by commas. Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -SendReportTo + +> Applicable: Exchange Online, Exchange Online Protection + The SendReportTo parameter specifies the target email address for the command results. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -TransportRules + +> Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection + The TransportRules switch specifies that you want to test mail flow rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: TransportRules Aliases: -Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -UnifiedDlpRules + +> Applicable: Exchange Online, Exchange Online Protection + The UnifiedDlpRules switch specifies that you want to unified DLP rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter -Parameter Sets: UnifiedDLPRules +Parameter Sets: UnifiedDLPRules, TransportRules Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -125,20 +134,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: TransportRules -Aliases: -Applicable: Exchange Online +### -Confirm -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection -### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -148,7 +147,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -158,13 +156,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Online, Exchange Online Protection + The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -174,6 +174,9 @@ Accept wildcard characters: False ``` ### -MessageFileData + +> Applicable: Exchange Online, Exchange Online Protection + The MessageFileData parameter specifies the .eml message file to test. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -182,7 +185,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -192,13 +194,15 @@ Accept wildcard characters: False ``` ### -Sender + +> Applicable: Exchange Online, Exchange Online Protection + The Sender parameter specifies the sender email address to use for the test message. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md b/exchange/exchange-ps/ExchangePowerShell/Test-MigrationServerAvailability.md similarity index 89% rename from exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md rename to exchange/exchange-ps/ExchangePowerShell/Test-MigrationServerAvailability.md index d37917bd9e..7f8ff1c92e 100644 --- a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-MigrationServerAvailability.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-migrationserveravailability applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-MigrationServerAvailability -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-migrationserveravailability +schema: 2.0.0 +title: Test-MigrationServerAvailability --- # Test-MigrationServerAvailability @@ -226,13 +227,15 @@ This example tests multiple existing endpoints. ## PARAMETERS ### -Autodiscover + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Autodiscover switch specifies that the command should use the Autodiscover service to obtain the connection settings for the target server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -242,13 +245,15 @@ Accept wildcard characters: False ``` ### -Compliance + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The Compliance switch specifies that the endpoint type is compliance. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Compliance Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -258,15 +263,17 @@ Accept wildcard characters: False ``` ### -Credentials + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\\username format or the user principal name (UPN) format (for example, `user@contoso.com`). A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, PSTImport, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup, MrsProxyPublicFolder +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, PSTImport, ExchangeOutlookAnywhere, PublicFolder, Compliance, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, ExchangeRemoteMove Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -275,27 +282,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: PSCredential -Parameter Sets: ExchangeRemoteMove -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -EmailAddress -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -EmailAddress The EmailAddress parameter specifies the email address of an administrator account that can access the remote server. This parameter is required when you use the Autodiscover parameter. ```yaml Type: SmtpAddress -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -304,27 +300,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SmtpAddress -Parameter Sets: ExchangeOutlookAnywhere, Gmail -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Endpoint -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -Endpoint The Endpoint parameter specifies the name of the migration endpoint to connect to. A migration endpoint contains the connection settings and other migration configuration settings. If you include this parameter, the Test-MigrationServerAvailability cmdlet attempts to verify the ability to connect to the remote server using the settings in the migration endpoint. ```yaml Type: MigrationEndpointIdParameter Parameter Sets: TestEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -334,6 +319,9 @@ Accept wildcard characters: False ``` ### -ExchangeOutlookAnywhere + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeOutlookAnywhere switch specifies a migration type for migrating on-premises mailboxes to Exchange Online. You don't need to specify a value with this switch. @@ -344,7 +332,6 @@ Use this switch if you plan to migrate mailboxes to Exchange Online using a stag Type: SwitchParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -354,6 +341,9 @@ Accept wildcard characters: False ``` ### -ExchangeRemoteMove + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ExchangeRemoteMove switch specifies a migration type where mailboxes are moved with full fidelity between two on-premises forests or between an on-premises forest and Exchange Online. You don't need to specify a value with this switch. Use this switch if you plan to perform a cross-forest move or migrate mailboxes between an on-premises Exchange organization and Exchange Online in a hybrid deployment. @@ -362,7 +352,6 @@ Use this switch if you plan to perform a cross-forest move or migrate mailboxes Type: SwitchParameter Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeRemoteMove Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -372,6 +361,9 @@ Accept wildcard characters: False ``` ### -ExchangeServer + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ExchangeServer parameter specifies the FQDN of the on-premises Exchange server. Use this parameter when you plan to perform a staged Exchange migration or a cutover Exchange migration. This parameter is required if you don't use the Autodiscover parameter. @@ -380,7 +372,6 @@ The ExchangeServer parameter specifies the FQDN of the on-premises Exchange serv Type: String Parameter Sets: ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -390,6 +381,9 @@ Accept wildcard characters: False ``` ### -Imap + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Imap parameter specifies an IMAP migration type. You don't need to specify a value with this switch. @@ -400,7 +394,6 @@ This switch is required when you want to migrate data from an IMAP mail server t Type: SwitchParameter Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -410,6 +403,9 @@ Accept wildcard characters: False ``` ### -Gmail + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Gmail parameter specifies Gmail as the migration type. You don't need to specify a value with this switch. @@ -420,7 +416,6 @@ This switch is required when you want to migrate data from a Google Workspace (f Type: SwitchParameter Parameter Sets: Gmail Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -430,6 +425,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Port parameter specifies the TCP port number used by the IMAP migration process to connect to the target server. This parameter is required only for IMAP migrations. @@ -440,7 +438,6 @@ The standard is to use port 143 for unencrypted connections, port 143 for Transp Type: Int32 Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -450,6 +447,9 @@ Accept wildcard characters: False ``` ### -PSTImport + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -458,7 +458,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: PSTImport Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -468,6 +467,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -476,7 +478,6 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: PublicFolder, MrsProxyPublicFolder Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -486,6 +487,9 @@ Accept wildcard characters: False ``` ### -PublicFolderDatabaseServerLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -494,7 +498,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -504,13 +507,15 @@ Accept wildcard characters: False ``` ### -PublicFolderToUnifiedGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The PublicFolderToUnifiedGroup switch specifies that the endpoint type is public folders to Microsoft 365 Groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -520,6 +525,9 @@ Accept wildcard characters: False ``` ### -RemoteServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The RemoteServer parameter specifies the FQDN of the on-premises mail server. This parameter is required when you want to perform one of the following migration types: - Cross-forest move @@ -528,9 +536,8 @@ The RemoteServer parameter specifies the FQDN of the on-premises mail server. Th ```yaml Type: Fqdn -Parameter Sets: PSTImport, ExchangeRemoteMove, IMAP, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder +Parameter Sets: PSTImport, ExchangeRemoteMove, IMAP, MrsProxyPublicFolderToUnifiedGroup, MrsProxyPublicFolder, Compliance Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -539,20 +546,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Fqdn -Parameter Sets: Compliance -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -RPCProxyServer -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -RPCProxyServer This parameter is available only in the cloud-based service. The RPCProxyServer parameter specifies the FQDN of the RPC proxy server for the on-premises Exchange server. This parameter is required when you don't use the Autodiscover parameter. Use this parameter if you plan to perform a staged Exchange migration or a cutover Exchange migration to migrate mailboxes to Exchange Online. @@ -561,7 +558,6 @@ The RPCProxyServer parameter specifies the FQDN of the RPC proxy server for the Type: Fqdn Parameter Sets: ExchangeOutlookAnywhere, PublicFolder, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -571,6 +567,9 @@ Accept wildcard characters: False ``` ### -ServiceAccountKeyFileData + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. @@ -581,7 +580,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: Gmail Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -591,15 +589,17 @@ Accept wildcard characters: False ``` ### -SourceMailboxLegacyDN + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The SourceMailboxLegacyDN parameter specifies a mailbox on the target server. Use the LegacyExchangeDN for the on-premises test mailbox as the value for this parameter. The cmdlet will attempt to access this mailbox using the credentials for the administrator account on the target server. ```yaml Type: String -Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup +Parameter Sets: PublicFolder, LegacyPublicFolderToUnifiedGroup, ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -608,20 +608,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere -Aliases: -Applicable: Exchange Online +### -AcceptUntrustedCertificates -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Online -### -AcceptUntrustedCertificates This parameter is available only in the cloud-based service. {{ Fill AcceptUntrustedCertificates Description }} @@ -630,7 +620,6 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, IMAP Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -640,6 +629,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The Authentication parameter specifies the authentication method used by the on-premises mail server. Use Basic or NTLM. If you don't include this parameter, Basic authentication is used. @@ -650,7 +642,6 @@ The parameter is only used for cutover Exchange migrations and staged Exchange m Type: AuthenticationMethod Parameter Sets: ExchangeOutlookAnywhere, PublicFolder, IMAP, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -660,6 +651,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -669,7 +663,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -679,13 +672,15 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FilePath parameter specifies the path containing the PST files when testing a PST Import migration endpoint. ```yaml Type: String Parameter Sets: PSTImport Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -695,6 +690,9 @@ Accept wildcard characters: False ``` ### -MailboxPermission + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The MailboxPermission parameter specifies what permissions 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. @@ -710,7 +708,6 @@ This parameter isn't used for testing the connection to the remote server for a Type: MigrationMailboxPermission Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -720,6 +717,9 @@ Accept wildcard characters: False ``` ### -Partition + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. @@ -728,7 +728,6 @@ This parameter is reserved for internal Microsoft use. Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -738,6 +737,9 @@ Accept wildcard characters: False ``` ### -Security + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl. @@ -746,7 +748,6 @@ For an IMAP migration, the Security parameter specifies the encryption method us Type: IMAPSecurityMechanism Parameter Sets: IMAP Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -756,6 +757,9 @@ Accept wildcard characters: False ``` ### -TestMailbox + +> Applicable: Exchange Online + This parameter is available only in the cloud-based service. The TestMailbox parameter specifies a mailbox on the target server. Use the primary SMTP address as the value for this parameter. The cmdlet will attempt to access this mailbox using the credentials for the administrator account on the target server. @@ -764,7 +768,6 @@ The TestMailbox parameter specifies a mailbox on the target server. Use the prim Type: MailboxIdParameter Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail, PublicFolder, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -774,13 +777,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-OAuthConnectivity.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-OAuthConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-OAuthConnectivity.md index 69c08e2c8a..5af0c9a463 100644 --- a/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-OAuthConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-oauthconnectivity applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Test-OAuthConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-oauthconnectivity +schema: 2.0.0 +title: Test-OAuthConnectivity --- # Test-OAuthConnectivity @@ -48,6 +49,9 @@ This example tests OAuth connectivity with Exchange for Gurinder Singh. ## PARAMETERS ### -Service + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Service parameter specifies the partner application. Valid values for this parameter are: - EWS @@ -58,7 +62,6 @@ The Service parameter specifies the partner application. Valid values for this p Type: ModServiceType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -TargetUri + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TargetUri parameter specifies the URL for the service you want to test OAuth connectivity with. ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -AppOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The AppOnly switch specifies the cmdlet will authenticate to the specified service as Exchange without any user context. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -109,7 +119,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -119,6 +128,9 @@ Accept wildcard characters: False ``` ### -Mailbox + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Mailbox parameter specifies the mailbox for which you want to test OAuth connectivity to the specified partner application. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -136,7 +148,6 @@ The Mailbox parameter specifies the mailbox for which you want to test OAuth con Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -ReloadConfig + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReloadConfig switch reloads all the configuration settings from the Exchange configuration objects. You don't need to specify a value with this switch. If you don't use this switch, the cached configuration settings are used. @@ -154,7 +168,6 @@ If you don't use this switch, the cached configuration settings are used. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,13 +177,15 @@ Accept wildcard characters: False ``` ### -UseCachedToken + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The UseCachedToken switch specifies that OAuth will try to use an existing, cached authorization token. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -180,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md b/exchange/exchange-ps/ExchangePowerShell/Test-OrganizationRelationship.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-OrganizationRelationship.md rename to exchange/exchange-ps/ExchangePowerShell/Test-OrganizationRelationship.md index 79352a03a2..df35984338 100644 --- a/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-OrganizationRelationship.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-organizationrelationship applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Test-OrganizationRelationship -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-organizationrelationship +schema: 2.0.0 +title: Test-OrganizationRelationship --- # Test-OrganizationRelationship @@ -47,6 +48,9 @@ This example validates the organization relationship deployed in the fabrikam.co ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the organization relationship to be tested. You can use the following values: - Canonical name @@ -57,7 +61,6 @@ The Identity parameter specifies the organization relationship to be tested. You Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -67,6 +70,9 @@ Accept wildcard characters: False ``` ### -UserIdentity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The UserIdentity parameter specifies the mailbox for which a delegation token is requested to access the external organization's configuration information. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -80,7 +86,6 @@ The UserIdentity parameter specifies the mailbox for which a delegation token is Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -99,7 +107,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -117,7 +127,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-OutlookConnectivity.md similarity index 94% rename from exchange/exchange-ps/exchange/Test-OutlookConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-OutlookConnectivity.md index 2443888dbc..dd41d9350f 100644 --- a/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-OutlookConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-outlookconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-OutlookConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-outlookconnectivity +schema: 2.0.0 +title: Test-OutlookConnectivity --- # Test-OutlookConnectivity @@ -94,7 +95,7 @@ Test-OutlookConnectivity [[-Identity] ] -WSTestType Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Identity parameter specifies a target user mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -171,7 +175,6 @@ If you don't use this parameter, the command looks for a test user in Active Dir Type: MailboxIdParameter Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -181,6 +184,9 @@ Accept wildcard characters: False ``` ### -ProbeIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ProbeIdentity parameter specifies the probe to use. Valid values are: Outlook Anywhere (RPC over HTTP) probes: @@ -199,7 +205,6 @@ MAPI over HTTP probes: Type: String Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -209,6 +214,9 @@ Accept wildcard characters: False ``` ### -GetDefaultsFromAutodiscover + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The GetDefaultsFromAutodiscover parameter specifies whether to get default values for all of the other parameters for the command from the Autodiscover service settings. If you run the command specifying values for other parameters, those values override the default values from the Autodiscover service. The default value for this parameter is $true. @@ -217,7 +225,6 @@ The GetDefaultsFromAutodiscover parameter specifies whether to get default value Type: Boolean Parameter Sets: RpcProxyServer Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -227,6 +234,9 @@ Accept wildcard characters: False ``` ### -Protocol + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Protocol parameter specifies whether to test for Outlook Anywhere connectivity or directly test for RPC or TCP/IP connectivity. The value is either HTTP or TCP. @@ -235,7 +245,6 @@ The Protocol parameter specifies whether to test for Outlook Anywhere connectivi Type: Protocol Parameter Sets: Protocol Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -245,6 +254,9 @@ Accept wildcard characters: False ``` ### -RpcTestType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcTestType parameter specifies which type of RPC endpoint the command should test. Valid values are: @@ -256,7 +268,6 @@ The RpcTestType parameter specifies which type of RPC endpoint the command shoul Type: RpcTestType Parameter Sets: RpcTestType Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -266,6 +277,9 @@ Accept wildcard characters: False ``` ### -WSTestType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The WSTestType parameter specifies type of servers that you want to include in your Outlook connectivity test. You can use the following values: @@ -278,7 +292,6 @@ The WSTestType parameter specifies type of servers that you want to include in y Type: VirtualDirectoryUriScope Parameter Sets: WSTestType Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -288,6 +301,9 @@ Accept wildcard characters: False ``` ### -Archive + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Archive parameter specifies whether tests should be performed to connect to the user's on-premises archive mailbox. Valid values are: @@ -300,7 +316,6 @@ $false: Don't connect to the user's on-premises mailbox. This is the default val Type: Boolean Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -310,6 +325,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. @@ -321,7 +339,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -331,6 +348,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Credential parameter specifies the credential used by the probe. The system's test credentials are used by default A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -339,7 +359,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -349,13 +368,15 @@ Accept wildcard characters: False ``` ### -Hostname + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + TheHostname parameter specifies the protocol endpoint target of the probe. You can use a specific Mailbox server or route through Distributed Name Service server. ```yaml Type: String Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -365,6 +386,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MailboxCredential parameter specifies certain credentials to allow logon access to a user's mailbox. Use the parameter along with the Identity parameter to access a user's mailbox when you don't have access permissions. @@ -375,7 +399,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -385,6 +408,9 @@ Accept wildcard characters: False ``` ### -MailboxId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxID parameter specifies the target mailbox. In Exchange 2013 or later, the Identity parameter specifies a target user mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -406,7 +432,6 @@ If you don't use this parameter, the command uses the test account. Type: MailboxIdParameter Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -416,6 +441,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. @@ -426,7 +454,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -436,6 +463,9 @@ Accept wildcard characters: False ``` ### -RpcAuthenticationType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcAuthenticationType parameter specifies the authentication setting to test for the RPC layer. Using this parameter is helpful if a different authentication type is set at the RPC proxy virtual directory. You can use the following values: @@ -450,7 +480,6 @@ The default value is Negotiate. Type: RpcAuthenticationType Parameter Sets: RpcProxyServer, RpcTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -460,6 +489,9 @@ Accept wildcard characters: False ``` ### -RpcClientAccessServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcClientAccessServer parameter specifies the target server with the Client Access server role installed that you want to test. This can be a server fully qualified domain name (FQDN) or a GUID. @@ -468,7 +500,6 @@ The RpcClientAccessServer parameter specifies the target server with the Client Type: ClientAccessServerIdParameter Parameter Sets: RpcProxyServer, RpcTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -478,6 +509,9 @@ Accept wildcard characters: False ``` ### -RpcProxyAuthenticationType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcProxyAuthenticationType parameter specifies the authentication setting for the RPC Proxy endpoint. The value can be specified as Basic, NTLM, or Negotiate. There is no default value unless used with the GetDefaultsFromAutodiscover parameter. @@ -486,7 +520,6 @@ The RpcProxyAuthenticationType parameter specifies the authentication setting fo Type: RPCProxyAuthenticationType Parameter Sets: RpcProxyServer, RpcTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -496,6 +529,9 @@ Accept wildcard characters: False ``` ### -RpcProxyServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcProxyServer parameter specifies whether to set the target RpcProxy server for testing. This parameter can be used when the RpcProxy server is different from the Client Access server. @@ -504,7 +540,6 @@ The RpcProxyServer parameter specifies whether to set the target RpcProxy server Type: ServerIdParameter Parameter Sets: RpcProxyServer Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -514,6 +549,9 @@ Accept wildcard characters: False ``` ### -RpcProxyTestType + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The RpcProxyTestType parameter specifies which HTTP endpoint the command should connect to. Valid values are: @@ -525,7 +563,6 @@ The RpcProxyTestType parameter specifies which HTTP endpoint the command should Type: RpcProxyTestType Parameter Sets: RpcTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -535,13 +572,15 @@ Accept wildcard characters: False ``` ### -RunFromServerId + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RunFromServerID parameter specifies the server on which the probe should be run. ```yaml Type: ServerIdParameter Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -551,13 +590,15 @@ Accept wildcard characters: False ``` ### -TimeOutSeconds + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TimeOutSeconds parameter specifies the timeout period in seconds before the probe is ended. The default value is 30 seconds. The digits can be entered with or with the use of quotation marks. Either 10 or "10" will work. Any input error will default back to 30 seconds. ```yaml Type: String Parameter Sets: Probe Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -567,6 +608,9 @@ Accept wildcard characters: False ``` ### -TotalTimeoutInMinutes + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The TotalTimeoutInMinutes parameter specifies the time limit, in minutes, for the command to wait for test results before ending the request. The default value is two minutes. @@ -575,7 +619,6 @@ The TotalTimeoutInMinutes parameter specifies the time limit, in minutes, for th Type: Int32 Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -585,6 +628,9 @@ Accept wildcard characters: False ``` ### -TrustAnySslCert + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. @@ -595,7 +641,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -605,6 +650,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -613,7 +661,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: RpcProxyServer, Protocol, RpcTestType, WSTestType Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OutlookWebServices.md b/exchange/exchange-ps/ExchangePowerShell/Test-OutlookWebServices.md similarity index 92% rename from exchange/exchange-ps/exchange/Test-OutlookWebServices.md rename to exchange/exchange-ps/ExchangePowerShell/Test-OutlookWebServices.md index a9eae33fd1..e0b137c685 100644 --- a/exchange/exchange-ps/exchange/Test-OutlookWebServices.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-OutlookWebServices.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-outlookwebservices applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-OutlookWebServices -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-outlookwebservices +schema: 2.0.0 +title: Test-OutlookWebServices --- # Test-OutlookWebServices @@ -86,13 +87,15 @@ The example tests for a connection to each service. The example also submits a r ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies any valid address in the forest. If you specify this parameter, incorrectly formed addresses and addresses that are outside the forest are rejected. This address is used to test the Outlook provider. This property accepts the domain and username in the domain\\username format or an Active Directory GUID and resolves them to the SMTP address that's needed to authenticate. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDiscoverServer parameter specifies the server with the Client Access server role installed that's used for Autodiscover. You can use any value that uniquely identifies the server. For example: @@ -117,7 +123,6 @@ You can't use this parameter with the ClientAccessServer parameter. Type: ClientAccessServerIdParameter Parameter Sets: AutoDiscoverServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is functional only in Exchange Server 2010. The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. @@ -144,7 +152,6 @@ You can't use this parameter with the AutoDiscoverServer parameter. Type: ClientAccessServerIdParameter Parameter Sets: Default, ClientAccessServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -154,6 +161,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -163,7 +173,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,13 +182,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -189,6 +200,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -197,7 +211,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: AutoDiscoverServer, ClientAccessServer, MonitoringContext Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -207,6 +220,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -216,7 +232,6 @@ The MonitoringContext parameter specifies whether to include the associated moni Type: Boolean Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -226,13 +241,15 @@ Accept wildcard characters: False ``` ### -TargetAddress + +> Applicable: Exchange Server 2010 + The TargetAddress parameter specifies the recipient that's used to test whether Availability service data can be retrieved. ```yaml Type: RecipientIdParameter[] Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -242,6 +259,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -250,7 +270,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: AutoDiscoverServer, ClientAccessServer, MonitoringContext Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -260,13 +279,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-OwaConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-OwaConnectivity.md similarity index 95% rename from exchange/exchange-ps/exchange/Test-OwaConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-OwaConnectivity.md index 3f6dbf78e8..05d8755233 100644 --- a/exchange/exchange-ps/exchange/Test-OwaConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-OwaConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-owaconnectivity applicable: Exchange Server 2010 -title: Test-OwaConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-owaconnectivity +schema: 2.0.0 +title: Test-OwaConnectivity --- # Test-OwaConnectivity @@ -89,6 +90,9 @@ This example tests the connectivity of a specific Client Access server Contoso12 ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010 The ClientAccessServer parameter specifies the name of the Client Access server to test. If this parameter is included, all Exchange Outlook Web App virtual directories on the Client Access server are tested against all Exchange Mailbox servers in the local Active Directory site. @@ -99,7 +103,6 @@ Don't use this parameter with the URL parameter. Type: ServerIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: 1 @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -URL + +> Applicable: Exchange Server 2010 + The URL parameter specifies the URL to test. This parameter is required only when you want to test a single Outlook Web App URL. If this parameter is used, the MailboxCredential parameter is also required. @@ -119,7 +125,6 @@ You can't use the URL parameter with the TestType or ClientAccessServer paramete Type: String Parameter Sets: URL Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -129,6 +134,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010 + The MailboxCredential parameter specifies the mailbox credential for a single URL test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -139,7 +147,6 @@ The MailboxCredential parameter is required only when using the URL parameter. Type: PSCredential Parameter Sets: URL Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -149,6 +156,9 @@ Accept wildcard characters: False ``` ### -AllowUnsecureAccess + +> Applicable: Exchange Server 2010 + The AllowUnsecureAccess switch specifies whether virtual directories that don't require SSL are tested. You don't need to specify a value with this switch. If you don't use this switch, the command skips virtual directories that don't require SSL, and an error is generated. @@ -157,7 +167,6 @@ If you don't use this switch, the command skips virtual directories that don't r Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -167,6 +176,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -176,7 +188,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -186,13 +197,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -202,6 +215,9 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010 + The LightMode parameter isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of the command. This parameter is implemented for other Exchange diagnostic commands where it's used to run a less intensive version of a command. @@ -210,7 +226,6 @@ This parameter is implemented for other Exchange diagnostic commands where it's Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -220,13 +235,15 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010 + The MailboxServer parameter specifies the name of the Mailbox server to test. If not specified, all Mailbox servers in the local Active Directory site are tested. ```yaml Type: ServerIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -244,7 +264,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -254,6 +273,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010 + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -262,7 +284,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -272,13 +293,15 @@ Accept wildcard characters: False ``` ### -RSTEndpoint + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -288,13 +311,15 @@ Accept wildcard characters: False ``` ### -TestType + +> Applicable: Exchange Server 2010 + The TestType parameter specifies whether the command tests internal or external URLs. Values are Internal and External. You can't use this parameter with the URL parameter. When neither the TestType parameter nor the URL parameter is specified, the default is TestType:Internal. ```yaml Type: OwaConnectivityTestType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -304,13 +329,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010 + The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. The default value for the Timeout parameter is 30 seconds. You must specify a time-out value greater than 0 seconds and less than 1 hour (3,600 seconds). We recommend that you always configure this parameter with a value of 5 seconds or more. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -320,6 +347,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -328,7 +358,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -338,13 +367,15 @@ Accept wildcard characters: False ``` ### -VirtualDirectoryName + +> Applicable: Exchange Server 2010 + The VirtualDirectoryName parameter specifies the name of the virtual directory to test on a particular Client Access server. If this parameter isn't included, all Exchange Outlook Web App virtual directories that support Exchange mailboxes are tested. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -354,13 +385,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-PopConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-PopConnectivity.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-PopConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-PopConnectivity.md index fedc41347a..76991b73a4 100644 --- a/exchange/exchange-ps/exchange/Test-PopConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-PopConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-popconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-PopConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-popconnectivity +schema: 2.0.0 +title: Test-PopConnectivity --- # Test-PopConnectivity @@ -79,6 +80,9 @@ This example tests the client POP3 connectivity of the specific server named Con ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -92,7 +96,6 @@ You can use any value that uniquely identifies the server. For example: Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -111,7 +117,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -ConnectionType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectionType parameter specifies the type of connection that's used to connect to the POP3 service. Valid values are: - Plaintext @@ -131,7 +139,6 @@ The ConnectionType parameter specifies the type of connection that's used to con Type: ProtocolConnectionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,13 +148,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LightMode switch tells the command to perform only a test logon to the server by using the POP3 protocol. You don't need to specify a value with this switch. If you don't use this switch, the command also tests receiving a message using the POP3 protocol. @@ -165,7 +177,6 @@ If you don't use this switch, the command also tests receiving a message using t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -183,7 +197,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -208,7 +224,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -218,6 +233,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -226,7 +244,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,6 +253,9 @@ Accept wildcard characters: False ``` ### -PerConnectionTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PerConnectionTimeout parameter specifies the amount of time, in seconds, to wait per connection for the test operation to finish. Valid values are between 0 and 120 seconds. The default value is 120 seconds. We recommend that you configure this parameter with a value of 5 seconds or more. @@ -244,7 +264,6 @@ We recommend that you configure this parameter with a value of 5 seconds or more Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -254,13 +273,15 @@ Accept wildcard characters: False ``` ### -PortClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PortClientAccessServer parameter specifies the port to use to connect to the Client Access server. The default port is 110 for POP3. The valid range is from 0 through 65,535. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,6 +291,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -278,7 +302,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -288,6 +311,9 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. Valid values are between 0 and 3600 seconds (1 hour). The default value is 180 seconds (3 minutes). We recommend that you configure this parameter with a value of 5 seconds or more. @@ -296,7 +322,6 @@ We recommend that you configure this parameter with a value of 5 seconds or more Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -306,6 +331,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -314,7 +342,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,13 +351,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-PowerShellConnectivity.md similarity index 89% rename from exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-PowerShellConnectivity.md index b418302280..3a86af6c76 100644 --- a/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-PowerShellConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-powershellconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-PowerShellConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-powershellconnectivity +schema: 2.0.0 +title: Test-PowerShellConnectivity --- # Test-PowerShellConnectivity @@ -95,6 +96,9 @@ The credentials that are used to connect to the virtual directory are stored in ## PARAMETERS ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -110,7 +114,6 @@ You can't use this parameter with the ConnectionUri parameter. Type: ServerIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -ConnectionUri + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ConnectionUri parameter specifies the URL of the remote PowerShell virtual directory to test, for example, `https://contoso.com/powershell`. You can't use this parameter with the ClientAccessServer parameter. @@ -128,7 +134,6 @@ You can't use this parameter with the ClientAccessServer parameter. Type: Uri Parameter Sets: URL Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -TestCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TestCredential parameter specifies the credentials to use for the test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -148,7 +156,6 @@ You can only use this parameter with the ConnectionUri parameter. Type: PSCredential Parameter Sets: URL Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -158,6 +165,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Authentication parameter specifies the type of authentication that's used to connect. Valid values are: - Default @@ -171,7 +181,6 @@ The Authentication parameter specifies the type of authentication that's used to Type: AuthenticationMethod Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -190,7 +202,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -200,13 +211,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -216,6 +229,9 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -231,7 +247,6 @@ If you don't use this parameter, connections to all Mailbox servers in the local Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -241,6 +256,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -249,7 +267,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -259,6 +276,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -267,7 +287,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -277,6 +296,9 @@ Accept wildcard characters: False ``` ### -TestType + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TestType parameter specifies whether the command tests internal or external URLs. Values are Internal and External. The default value is Internal. You can only use this parameter with the ClientAccessServer parameter. @@ -285,7 +307,6 @@ You can only use this parameter with the ClientAccessServer parameter. Type: OwaConnectivityTestType Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -295,6 +316,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -303,7 +327,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,6 +336,9 @@ Accept wildcard characters: False ``` ### -VirtualDirectoryName + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The VirtualDirectoryName parameter specifies the name of the remote PowerShell virtual directory that you want to test. Enclose values that contain spaces in quotation marks ("). You can only use this parameter with the ClientAccessServer parameter. If you don't use this parameter, all available remote PowerShell virtual directories on the server are tested. @@ -321,7 +347,6 @@ You can only use this parameter with the ClientAccessServer parameter. If you do Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -331,13 +356,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ReplicationHealth.md b/exchange/exchange-ps/ExchangePowerShell/Test-ReplicationHealth.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-ReplicationHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ReplicationHealth.md index 384af71e00..16dd2f9e99 100644 --- a/exchange/exchange-ps/exchange/Test-ReplicationHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ReplicationHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-replicationhealth applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ReplicationHealth -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-replicationhealth +schema: 2.0.0 +title: Test-ReplicationHealth --- # Test-ReplicationHealth @@ -50,6 +51,9 @@ This example tests the health of replication for the Mailbox server MBX1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the Mailbox server that you want to test. You can use any value that uniquely identifies the server. For example: - Name @@ -63,7 +67,6 @@ You can't use this parameter with the DatabaseAvailabilityGroup parameter. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectoryTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveDirectoryTimeout parameter specifies the time interval in seconds that's allowed for each directory service operation before the operation times out. The default value is 15 seconds. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DatabaseAvailabilityGroup + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The DatabaseAvailabilityGroup parameter specifies whether to test all servers in the specified DAG. You can use any value that uniquely identifies the DAG. For example: - Name @@ -120,7 +130,6 @@ You can't use this parameter with the Identity parameter. Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -155,7 +169,6 @@ The MonitoringContext parameter specifies whether to include the associated moni Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -OutputObjects + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The OutputObjects switch specifies whether to output an array of information regarding failures. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,13 +196,15 @@ Accept wildcard characters: False ``` ### -TransientEventSuppressionWindow + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransientEventSuppressionWindow parameter specifies the number of minutes that the queue lengths can be exceeded before the queue length tests are considered to have failed. This parameter is used to reduce the number of failures due to transient load generation. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,13 +214,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-SenderId.md b/exchange/exchange-ps/ExchangePowerShell/Test-SenderId.md similarity index 88% rename from exchange/exchange-ps/exchange/Test-SenderId.md rename to exchange/exchange-ps/ExchangePowerShell/Test-SenderId.md index 53db8aa93a..90f55ad910 100644 --- a/exchange/exchange-ps/exchange/Test-SenderId.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-SenderId.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-senderid applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-SenderId -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-senderid +schema: 2.0.0 +title: Test-SenderId --- # Test-SenderId @@ -47,13 +48,15 @@ This example checks whether the IP address 192.168.0.1 is the legitimate sender ## PARAMETERS ### -IPAddress + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IPAddress parameter specifies the originating IP address of the sending server. ```yaml Type: IPAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -PurportedResponsibleDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The PurportedResponsibleDomain parameter specifies the domain name that you want to verify with Sender ID. ```yaml Type: SmtpDomain Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -79,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -88,7 +96,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,6 +105,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -106,7 +116,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -HelloDomain + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The HelloDomain parameter specifies the domain address displayed in the HELO or EHLO SMTP commands from this sender. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,6 +143,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -145,7 +159,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -155,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ServiceHealth.md b/exchange/exchange-ps/ExchangePowerShell/Test-ServiceHealth.md similarity index 89% rename from exchange/exchange-ps/exchange/Test-ServiceHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ServiceHealth.md index 1016e36a2c..6ea5b4bb58 100644 --- a/exchange/exchange-ps/exchange/Test-ServiceHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ServiceHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-servicehealth applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-ServiceHealth -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-servicehealth +schema: 2.0.0 +title: Test-ServiceHealth --- # Test-ServiceHealth @@ -47,6 +48,9 @@ This example uses the Test-ServiceHealth command without parameters to test the ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -60,7 +64,6 @@ If you don't use this parameter, the command is run on the local server. Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectoryTimeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ActiveDirectoryTimeout parameter specifies the amount of time, in seconds, allowed for each Active Directory operation to complete before the operation times out. The default value is 15 seconds. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -86,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -95,7 +103,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,6 +112,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -113,7 +123,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -123,6 +132,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -132,7 +144,6 @@ The MonitoringContext parameter specifies whether to include the associated moni Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -142,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/ExchangePowerShell/Test-ServicePrincipalAuthorization.md similarity index 93% rename from exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md rename to exchange/exchange-ps/ExchangePowerShell/Test-ServicePrincipalAuthorization.md index 896490cd63..957f3de564 100644 --- a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-ServicePrincipalAuthorization.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-serviceprincipalauthorization applicable: Exchange Online, Exchange Online Protection -title: Test-ServicePrincipalAuthorization -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-serviceprincipalauthorization +schema: 2.0.0 +title: Test-ServicePrincipalAuthorization --- # Test-ServicePrincipalAuthorization @@ -62,6 +63,9 @@ This example tests the entitlement of the app named "DemoB", including which per ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the service principal that you want to test. You can use any value that uniquely identifies the service principal. For example: - Name @@ -74,7 +78,6 @@ The Identity parameter specifies the service principal that you want to test. Yo Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Resource + +> Applicable: Exchange Online, Exchange Online Protection + The Resource parameter specifies the target mailbox where the scoped permissions apply. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -111,7 +119,6 @@ The Resource parameter specifies the target mailbox where the scoped permissions Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-SiteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Test-SiteMailbox.md similarity index 92% rename from exchange/exchange-ps/exchange/Test-SiteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Test-SiteMailbox.md index 249202e6e8..2361c7f9ca 100644 --- a/exchange/exchange-ps/exchange/Test-SiteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-SiteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-sitemailbox applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-SiteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-sitemailbox +schema: 2.0.0 +title: Test-SiteMailbox --- # Test-SiteMailbox @@ -64,6 +65,9 @@ This example tests a specific user's ability to access a SharePoint site by usin ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the site mailbox that you want to test. You can use any value that uniquely identifies the site mailbox. For example: - Name @@ -79,7 +83,6 @@ You can't use this parameter with the SharePointUrl parameter. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -BypassOwnerCheck + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. @@ -97,7 +103,6 @@ If you don't use this switch, and you aren't a member or owner of the site mailb Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -116,7 +124,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -RequestorIdentity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The RequestorIdentity parameter specifies the user to test for correct permissions to the SharePoint site mailbox. You can use any value that uniquely identifies the user. For example: - Name @@ -143,7 +153,6 @@ If you don't specify this parameter, the command uses the identification of the Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -SharePointUrl + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SharePointUrl parameter specifies the SharePoint URL where the site mailbox is hosted, for example, "https://myserver/teams/edu". You can't use this parameter with the Identity parameter. @@ -161,7 +173,6 @@ You can't use this parameter with the Identity parameter. Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -171,6 +182,9 @@ Accept wildcard characters: False ``` ### -UseAppTokenOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UseAppTokenOnly switch specifies that you want to test the site mailbox by using the identity of the Exchange server. You don't need to specify a value with this switch. You can't use this switch with the RequestorIdentity parameter. @@ -179,7 +193,6 @@ You can't use this switch with the RequestorIdentity parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -189,13 +202,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-SmtpConnectivity.md similarity index 92% rename from exchange/exchange-ps/exchange/Test-SmtpConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-SmtpConnectivity.md index 68097adcaf..502a332306 100644 --- a/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-SmtpConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-smtpconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-SmtpConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-smtpconnectivity +schema: 2.0.0 +title: Test-SmtpConnectivity --- # Test-SmtpConnectivity @@ -62,6 +63,9 @@ This example verifies SMTP connectivity for all Receive connectors on all Mailbo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the transport server for which the cmdlet verifies SMTP connectivity . The Identity parameter specifies the transport server where you want to verify SMTP connectivity (test all Receive connectors on the specified server). You can use any value that uniquely identifies the server. For example: @@ -77,7 +81,6 @@ The Identity parameter specifies the transport server where you want to verify S Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -96,7 +102,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -114,7 +122,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -133,7 +143,6 @@ The MonitoringContext parameter specifies whether to include the associated moni Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,13 +152,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-SystemHealth.md b/exchange/exchange-ps/ExchangePowerShell/Test-SystemHealth.md similarity index 92% rename from exchange/exchange-ps/exchange/Test-SystemHealth.md rename to exchange/exchange-ps/ExchangePowerShell/Test-SystemHealth.md index 8248f8de34..5d3c22eb66 100644 --- a/exchange/exchange-ps/exchange/Test-SystemHealth.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-SystemHealth.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-systemhealth applicable: Exchange Server 2010 -title: Test-SystemHealth -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-systemhealth +schema: 2.0.0 +title: Test-SystemHealth --- # Test-SystemHealth @@ -70,6 +71,9 @@ This example saves the output data as a byte stream to the variable named $SysHe ## PARAMETERS ### -ADCredentials + +> Applicable: Exchange Server 2010 + The ADCredentials parameter specifies the username and password that's used to access Active Directory. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -78,7 +82,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -Analyze + +> Applicable: Exchange Server 2010 + The Analyze switch enables analysis on the data gathered. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -Collect + +> Applicable: Exchange Server 2010 + The Collect switch enables data collection. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -ConfigurationData + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -ConfigurationFileLocation + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: LongPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -161,7 +175,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Exchange Server 2010 + The Description parameter specifies a descriptive label for the scan. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -187,13 +202,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -203,13 +220,15 @@ Accept wildcard characters: False ``` ### -DownloadConfigurationUpdates + +> Applicable: Exchange Server 2010 + The DownloadConfigurationUpdates switch checks for and downloads newer versions of the configuration file. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -ExchangeCredentials + +> Applicable: Exchange Server 2010 + The ExchangeCredentials parameter specifies the username and password that's used to access Exchange servers. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -227,7 +249,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -237,13 +258,15 @@ Accept wildcard characters: False ``` ### -Export + +> Applicable: Exchange Server 2010 + The Export switch causes sensitive data to be removed from the output file specified. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -253,13 +276,15 @@ Accept wildcard characters: False ``` ### -GenerateEvents + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -269,13 +294,15 @@ Accept wildcard characters: False ``` ### -GenerateSQMData + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -285,13 +312,15 @@ Accept wildcard characters: False ``` ### -MaxThreads + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -301,13 +330,15 @@ Accept wildcard characters: False ``` ### -MergeFileLocation + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: LongPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -317,6 +348,9 @@ Accept wildcard characters: False ``` ### -OutData + +> Applicable: Exchange Server 2010 + The OutData switch specifies whether the output data is sent as a byte stream. You don't need to specify a value with this switch. For example, if you run the command: `$temp = Test-SystemHealth -OutData`, `$temp` contains the byte stream of the output data, and you can covert it back to xml by using the Set-Content command. For a code sample, see "Example 2" in this topic. @@ -325,7 +359,6 @@ For example, if you run the command: `$temp = Test-SystemHealth -OutData`, `$tem Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -335,13 +368,15 @@ Accept wildcard characters: False ``` ### -OutFileLocation + +> Applicable: Exchange Server 2010 + The OutFileLocation parameter identifies the name and path to the data file to generate. ```yaml Type: LongPath Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -351,13 +386,15 @@ Accept wildcard characters: False ``` ### -Roles + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -367,13 +404,15 @@ Accept wildcard characters: False ``` ### -ScanType + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -383,13 +422,15 @@ Accept wildcard characters: False ``` ### -ServerList + +> Applicable: Exchange Server 2010 + This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -399,13 +440,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010 + The Timeout parameter specifies the number of seconds before the operation times out. The default value is 300 seconds (5 minutes). ```yaml Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -415,13 +458,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-TextExtraction.md b/exchange/exchange-ps/ExchangePowerShell/Test-TextExtraction.md similarity index 91% rename from exchange/exchange-ps/exchange/Test-TextExtraction.md rename to exchange/exchange-ps/ExchangePowerShell/Test-TextExtraction.md index 43b3808f00..f703ca42a6 100644 --- a/exchange/exchange-ps/exchange/Test-TextExtraction.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-TextExtraction.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-textextraction applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance -title: Test-TextExtraction -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-textextraction +schema: 2.0.0 +title: Test-TextExtraction --- # Test-TextExtraction @@ -58,6 +59,9 @@ This example extracts the text from the email message file named "financial data ## PARAMETERS ### -FileData + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + The FileData parameter specifies the name and path of the file from which text should be extracted. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -66,7 +70,6 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: True Position: 0 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -85,7 +91,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -103,7 +111,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-UMConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-UMConnectivity.md similarity index 89% rename from exchange/exchange-ps/exchange/Test-UMConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-UMConnectivity.md index 7a6b3e9a41..5ca409cf40 100644 --- a/exchange/exchange-ps/exchange/Test-UMConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-UMConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-umconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 -title: Test-UMConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.MediaAndDevices-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-umconnectivity +schema: 2.0.0 +title: Test-UMConnectivity --- # Test-UMConnectivity @@ -138,13 +139,15 @@ This example tests a SIP dial plan by using a SIP URI. This example can be used ## PARAMETERS ### -Phone + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Phone parameter specifies the telephone number or Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) used when the test call is redirected. The extension number should be configured in the PBX to forward calls to the UM hunt group. ```yaml Type: String Parameter Sets: TuiLogonSpecific, EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -154,13 +157,15 @@ Accept wildcard characters: False ``` ### -PIN + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The PIN parameter specifies the PIN associated with the UM-enabled mailbox. ```yaml Type: String Parameter Sets: TuiLogonSpecific Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -170,13 +175,15 @@ Accept wildcard characters: False ``` ### -ResetPIN + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ResetPIN parameter specifies whether to generate or regenerate a new PIN for all the test mailboxes in the current site. ```yaml Type: Boolean Parameter Sets: PinReset Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -186,13 +193,15 @@ Accept wildcard characters: False ``` ### -TUILogon + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TUILogon parameter specifies whether the cmdlet tries to log on to one or more UM-enabled mailboxes. The mailboxes must be UM-enabled and associated with the UM dial plan to which the Mailbox server running the Microsoft Exchange Unified Messaging service belongs. The default setting is $false. ```yaml Type: Boolean Parameter Sets: TuiLogonSpecific Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -202,13 +211,15 @@ Accept wildcard characters: False ``` ### -TUILogonAll + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The TUILogonAll parameter specifies whether to try to connect to all test mailboxes in the current Active Directory site. The default setting is $false. The accounts that are tested must be generated by calling the New-TestCasConnectivityUser.ps1 script, and the corresponding mailboxes must be UM-enabled. Otherwise, no action is taken. ```yaml Type: Boolean Parameter Sets: TuiLogonGeneral Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -218,13 +229,15 @@ Accept wildcard characters: False ``` ### -UMDialPlan + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMDialPlan parameter specifies the UM dial plan to be tested. This parameter must be used with the TUILogon parameter. ```yaml Type: UMDialPlanIdParameter Parameter Sets: TuiLogonSpecific Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -234,13 +247,15 @@ Accept wildcard characters: False ``` ### -UMIPGateway + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The UMIPGateway parameter specifies the name of the UM IP gateway or IP PBX to use for the outgoing test call. ```yaml Type: UMIPGatewayIdParameter Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -250,13 +265,15 @@ Accept wildcard characters: False ``` ### -CallRouter + +> Applicable: Exchange Server 2013, Exchange Server 2016 + The CallRouter switch specifies whether to test the Microsoft Exchange Unified Messaging Call Router service (front-end). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: LocalLoop Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -266,13 +283,15 @@ Accept wildcard characters: False ``` ### -CertificateThumbprint + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The CertificateThumbprint parameter specifies the certificate thumbprint used for SIP Secured and Secured mode. ```yaml Type: String Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -282,6 +301,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -291,7 +313,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -301,13 +322,15 @@ Accept wildcard characters: False ``` ### -DiagDtmfDurationInMilisecs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DiagDtmfDurationInMilisecs parameter specifies the duration of each digit sent. ```yaml Type: Int32 Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -317,13 +340,15 @@ Accept wildcard characters: False ``` ### -DiagDtmfSequence + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DiagDtmfSequence parameter specifies the sequence of digits sent. ```yaml Type: String Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -333,13 +358,15 @@ Accept wildcard characters: False ``` ### -DiagInitialSilenceInMilisecs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DiagInitialSilenceInMilisecs parameter specifies the time period in milliseconds that the cmdlet pauses before the digit sequence is sent. ```yaml Type: Int32 Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -349,13 +376,15 @@ Accept wildcard characters: False ``` ### -DiagInterDtmfDiffGapInMilisecs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DiagInterDtmfDiffGapInMilisecs parameter specifies whether to customize the time between the digits in the diagnostic sequence. This is a comma-delimited list that can accept null entries. This should include multiple values. ```yaml Type: String Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -365,13 +394,15 @@ Accept wildcard characters: False ``` ### -DiagInterDtmfGapInMilisecs + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DiagInterDtmfGapInMilisecs parameter specifies the time in milliseconds between each digit sent in the digit sequence. This is a single value. ```yaml Type: Int32 Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -381,13 +412,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -397,13 +430,15 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The From parameter specifies the SIP URI or SIP address that the call originated from. It's used only when you use the Phone parameter. The default setting is the SIP URI specified when you use the Phone parameter. ```yaml Type: String Parameter Sets: EndToEnd Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -413,13 +448,15 @@ Accept wildcard characters: False ``` ### -ListenPort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The ListenPort parameter specifies the IP port number on which to listen. If not specified, IP port 9000 is used. ```yaml Type: Int32 Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -429,13 +466,15 @@ Accept wildcard characters: False ``` ### -MediaSecured + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MediaSecured parameter specifies whether to use Secure RTP or RTP (unsecured) mode. ```yaml Type: Boolean Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -445,6 +484,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: - $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -454,7 +496,6 @@ The MonitoringContext parameter specifies whether to include the associated moni Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -464,13 +505,15 @@ Accept wildcard characters: False ``` ### -RemotePort + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The RemotePort parameter specifies the port used for the call. If not specified, the default is port 5060 for Transmission Control Protocol (TCP) and 5061 for mutual Transport Layer Security (TLS). ```yaml Type: Int32 Parameter Sets: TuiLogonSpecific, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -480,13 +523,15 @@ Accept wildcard characters: False ``` ### -Secured + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Secured parameter specifies whether the test is run in SIP Secured mode. ```yaml Type: Boolean Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -496,13 +541,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The Timeout parameter specifies the length of time in seconds to wait for the test operation to finish. The default is 600 seconds. You can't set this parameter with a value of less than 60 seconds. However, we recommend that you always configure this parameter with a value of 60 seconds or more. The maximum value for this parameter is 1800 seconds. ```yaml Type: Int32 Parameter Sets: TuiLogonSpecific, EndToEnd, TuiLogonGeneral, LocalLoop Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -512,13 +559,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md b/exchange/exchange-ps/ExchangePowerShell/Test-WebServicesConnectivity.md similarity index 90% rename from exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md rename to exchange/exchange-ps/ExchangePowerShell/Test-WebServicesConnectivity.md index fba4a45320..db4d21c3d1 100644 --- a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md +++ b/exchange/exchange-ps/ExchangePowerShell/Test-WebServicesConnectivity.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/test-webservicesconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Test-WebServicesConnectivity -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/test-webservicesconnectivity +schema: 2.0.0 +title: Test-WebServicesConnectivity --- # Test-WebServicesConnectivity @@ -109,6 +110,9 @@ This example tests the client connection to Exchange Web Services on the server ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox to use for the test. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -128,7 +132,6 @@ When you use this parameter, you also need to use the MailboxCredential paramete Type: MailboxIdParameter Parameter Sets: AutoDiscoverServer, MonitoringContext, ClientAccessServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -138,6 +141,9 @@ Accept wildcard characters: False ``` ### -ClientAccessServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. You can use any value that uniquely identifies the server. For example: @@ -153,7 +159,6 @@ You can't use this parameter with the AutoDiscoverServer parameter. Type: ServerIdParameter Parameter Sets: Default, ClientAccessServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -163,6 +168,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverServer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The AutoDiscoverServer parameter specifies the server with the Client Access server role installed that's used for Autodiscover. You can use any value that uniquely identifies the server. For example: @@ -176,9 +184,8 @@ You can't use this parameter with the ClientAccessServer parameter. ```yaml Type: ClientAccessServerIdParameter -Parameter Sets: AutoDiscoverServer +Parameter Sets: AutoDiscoverServer, ClientAccessServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -187,20 +194,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: ServerIdParameter -Parameter Sets: ClientAccessServer -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +### -AllowUnsecureAccess -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2010 -### -AllowUnsecureAccess This parameter is available only in Exchange Server 2010. The AllowUnsecureAccess switch specifies whether to enable the command to continue to run over an unsecured channel that doesn't require Secure Sockets Layer (SSL). You don't need to specify a value with this switch. @@ -209,7 +206,6 @@ The AllowUnsecureAccess switch specifies whether to enable the command to contin Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -219,6 +215,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -228,7 +227,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,6 +236,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -246,7 +247,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -256,6 +256,9 @@ Accept wildcard characters: False ``` ### -LightMode + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The LightMode switch tells the command to perform only a subset of the tests. You don't need to specify a value with this switch. When you use this switch, the EWS: ConvertId test is run instead of the EWS: GetFolder test. @@ -264,7 +267,6 @@ When you use this switch, the EWS: ConvertId test is run instead of the EWS: Get Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -274,6 +276,9 @@ Accept wildcard characters: False ``` ### -MailboxCredential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -284,7 +289,6 @@ This parameter is required when you use the Identity parameter. Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -294,13 +298,15 @@ Accept wildcard characters: False ``` ### -MailboxServer + +> Applicable: Exchange Server 2010 + The MailboxServer parameter specifies the identity of the Exchange Mailbox server on which the test is run. ```yaml Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -310,6 +316,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). @@ -318,7 +327,6 @@ Typically, you include the monitoring events and performance counters in the res Type: SwitchParameter Parameter Sets: MonitoringContext Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -328,6 +336,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials + +> Applicable: Exchange Server 2010 + The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. @@ -336,7 +347,6 @@ The password for the test account is typically reset every seven days. Use this Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -346,13 +356,15 @@ Accept wildcard characters: False ``` ### -Timeout + +> Applicable: Exchange Server 2010 + The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. The default value for the Timeout parameter is 300 seconds. You must specify a time-out value greater than 0 seconds. We recommend that you always configure this parameter with a value of 5 seconds or more. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -362,6 +374,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -370,7 +385,6 @@ This switch is useful for testing internal URLs, because a URL that has an assoc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -380,6 +394,9 @@ Accept wildcard characters: False ``` ### -UseAutodiscoverForClientAccessServer + +> Applicable: Exchange Server 2010 + This parameter is available only in Exchange Server 2010. The UseAutodiscoverForClientAccessServer switch specifies whether the test should use the Autodiscover service to locate the Client Access server. You don't need to specify a value with this switch. @@ -388,7 +405,6 @@ The UseAutodiscoverForClientAccessServer switch specifies whether the test shoul Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -398,13 +414,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedMailbox.md similarity index 95% rename from exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedMailbox.md index 50c11224ce..9adf6497ad 100644 --- a/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/undo-softdeletedmailbox applicable: Exchange Online -title: Undo-SoftDeletedMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/undo-softdeletedmailbox +schema: 2.0.0 +title: Undo-SoftDeletedMailbox --- # Undo-SoftDeletedMailbox @@ -69,13 +70,15 @@ This example recovers the deleted mailbox for the user Brian Johnson. When this ## PARAMETERS ### -SoftDeletedObject + +> Applicable: Exchange Online + The SoftDeletedObject parameter specifies the deleted mailbox to recover. You can use the alias or the email address of the deleted mailbox for the value of this parameter. Use the Get-Mailbox -SoftDeletedMailbox command to get information for deleted mailboxes. ```yaml Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -PublicFolder + +> Applicable: Exchange Online + The PublicFolder switch is required to recover public folder mailboxes. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -93,7 +99,6 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: PublicFolder Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -112,7 +120,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Exchange Online + The DisplayName parameter specifies the new display name for the recovered mailbox. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies a new value for the Name property of the recovered mailbox. Otherwise, the original value is retained when the mailbox is recovered. The new name value is also used in the DistinguishedName property. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -154,6 +165,9 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Exchange Online + The Password parameter specifies a new password for the mailbox. You can use the following methods as a value for this parameter: @@ -168,7 +182,6 @@ You have to include the Password parameter to recover a deleted mailbox with an Type: SecureString Parameter Sets: SoftDeletedMailbox Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named @@ -194,6 +209,9 @@ Accept wildcard characters: False ``` ### -WindowsLiveID + +> Applicable: Exchange Online + The WindowsLiveID parameter specifies a new Microsoft account (formerly known as a Windows Live ID) and primary SMTP address for the mailbox. The previous Microsoft account is retained as a proxy address for the mailbox. You have to include the WindowsLiveID parameter to recover a deleted mailbox with an existing Microsoft account that wasn't deleted with the mailbox. @@ -202,7 +220,6 @@ You have to include the WindowsLiveID parameter to recover a deleted mailbox wit Type: WindowsLiveId Parameter Sets: SoftDeletedMailbox Aliases: -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md b/exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedUnifiedGroup.md similarity index 96% rename from exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedUnifiedGroup.md index 7402d91bdb..b9843c0afd 100644 --- a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Undo-SoftDeletedUnifiedGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/undo-softdeletedunifiedgroup applicable: Exchange Online -title: Undo-SoftDeletedUnifiedGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/undo-softdeletedunifiedgroup +schema: 2.0.0 +title: Undo-SoftDeletedUnifiedGroup --- # Undo-SoftDeletedUnifiedGroup @@ -48,6 +49,9 @@ This example restores the soft-deleted Microsoft 365 Group named Marketing Depar ## PARAMETERS ### -SoftDeletedObject + +> Applicable: Exchange Online + The SoftDeletedObject parameter specifies the soft-deleted Microsoft 365 Group that you want to restore. You can use any value that uniquely identifies the Microsoft 365 Group. For example: - Name @@ -67,7 +71,6 @@ The SoftDeletedObject parameter specifies the soft-deleted Microsoft 365 Group t Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -86,7 +92,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md b/exchange/exchange-ps/ExchangePowerShell/Uninstall-TransportAgent.md similarity index 90% rename from exchange/exchange-ps/exchange/Uninstall-TransportAgent.md rename to exchange/exchange-ps/ExchangePowerShell/Uninstall-TransportAgent.md index 5618a653c7..016b827ab3 100644 --- a/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md +++ b/exchange/exchange-ps/ExchangePowerShell/Uninstall-TransportAgent.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/uninstall-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Uninstall-TransportAgent -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/uninstall-transportagent +schema: 2.0.0 +title: Uninstall-TransportAgent --- # Uninstall-TransportAgent @@ -50,13 +51,15 @@ This example uninstalls a fictitious application named Test App from the Transpo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the display name of the transport agent that you want to uninstall. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: TransportAgentObjectId Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -75,7 +81,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -85,6 +90,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -93,7 +101,6 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -TransportService + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are: - Hub for the Transport service on Mailbox servers. @@ -115,7 +125,6 @@ The TransportService parameter specifies the transport service that you want to Type: TransportService Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-AddressList.md b/exchange/exchange-ps/ExchangePowerShell/Update-AddressList.md similarity index 90% rename from exchange/exchange-ps/exchange/Update-AddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Update-AddressList.md index 8c44e68434..f932437a97 100644 --- a/exchange/exchange-ps/exchange/Update-AddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-AddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-AddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-addresslist +schema: 2.0.0 +title: Update-AddressList --- # Update-AddressList @@ -43,6 +44,9 @@ This example updates the recipients of the address list named building4 that's u ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the address list that you want to update. You can use any value that uniquely identifies the address list. For example: - Name @@ -54,7 +58,6 @@ The Identity parameter specifies the address list that you want to update. You c Type: AddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md b/exchange/exchange-ps/ExchangePowerShell/Update-ComplianceCaseMember.md similarity index 95% rename from exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md rename to exchange/exchange-ps/ExchangePowerShell/Update-ComplianceCaseMember.md index dfbaff31dc..57863d7f9f 100644 --- a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-ComplianceCaseMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-compliancecasemember applicable: Security & Compliance -title: Update-ComplianceCaseMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-compliancecasemember +schema: 2.0.0 +title: Update-ComplianceCaseMember --- # Update-ComplianceCaseMember @@ -50,6 +51,9 @@ This example replaces the existing members of the eDiscovery case named Case 515 ## PARAMETERS ### -Case + +> Applicable: Security & Compliance + The Case parameter specifies the name of the eDiscovery case that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. @@ -58,7 +62,6 @@ To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Security & Compliance + 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 @@ -81,7 +87,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -100,7 +108,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-DatabaseSchema.md b/exchange/exchange-ps/ExchangePowerShell/Update-DatabaseSchema.md similarity index 91% rename from exchange/exchange-ps/exchange/Update-DatabaseSchema.md rename to exchange/exchange-ps/ExchangePowerShell/Update-DatabaseSchema.md index 1ca485d6cb..a23646c719 100644 --- a/exchange/exchange-ps/exchange/Update-DatabaseSchema.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-DatabaseSchema.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-databaseschema applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-DatabaseSchema -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-databaseschema +schema: 2.0.0 +title: Update-DatabaseSchema --- # Update-DatabaseSchema @@ -42,6 +43,9 @@ This example updates the database schema for database DB1. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox database for which you want to set one or more attributes. You can use any value that uniquely identifies the database. For example: - Name @@ -52,7 +56,6 @@ The Identity parameter specifies the mailbox database for which you want to set Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,13 +65,15 @@ Accept wildcard characters: False ``` ### -MajorVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -78,13 +83,15 @@ Accept wildcard characters: False ``` ### -MinorVersion + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -94,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -103,7 +113,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,13 +122,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Update-DistributionGroupMember.md similarity index 88% rename from exchange/exchange-ps/exchange/Update-DistributionGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Update-DistributionGroupMember.md index cc94a00944..797e2d1195 100644 --- a/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-DistributionGroupMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-distributiongroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Update-DistributionGroupMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-distributiongroupmember +schema: 2.0.0 +title: Update-DistributionGroupMember --- # Update-DistributionGroupMember @@ -45,6 +46,9 @@ This example replaces the existing members of the distribution group name Resear ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - Name @@ -58,7 +62,6 @@ The Identity parameter specifies the distribution group or mail-enabled security Type: DistributionGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -79,7 +85,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,6 +115,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -116,7 +126,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -126,6 +135,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + 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 @@ -145,7 +157,6 @@ The maximum number of entries for this parameter is 10000. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md b/exchange/exchange-ps/ExchangePowerShell/Update-EmailAddressPolicy.md similarity index 89% rename from exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Update-EmailAddressPolicy.md index a5ab8316da..57d5e9ca5d 100644 --- a/exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-EmailAddressPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-emailaddresspolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-EmailAddressPolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-emailaddresspolicy +schema: 2.0.0 +title: Update-EmailAddressPolicy --- # Update-EmailAddressPolicy @@ -45,6 +46,9 @@ This example applies the email address policy named Northwest Executives to all ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the email address policy that you want to apply to recipients. You can use any value that uniquely identifies the policy. For example: - Name @@ -55,7 +59,6 @@ The Identity parameter specifies the email address policy that you want to apply Type: EmailAddressPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -FixMissingAlias + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FixMissingAlias switch repairs recipients that don't have an alias. The alias is generated based on the Name property of the recipient. You don't need to specify a value with this switch. You need to use this switch if you receive an error message when you attempt to update the email address policy, global address list, or address list. @@ -108,7 +118,6 @@ You need to use this switch if you receive an error message when you attempt to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,6 +127,9 @@ Accept wildcard characters: False ``` ### -UpdateSecondaryAddressesOnly + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The UpdateSecondaryAddressesOnly switch specifies that only the proxy email addresses are updated for the recipients. You don't need to specify a value with this switch. The recipient's primary email address isn't updated. @@ -126,7 +138,6 @@ The recipient's primary email address isn't updated. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -136,13 +147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-ExchangeHelp.md b/exchange/exchange-ps/ExchangePowerShell/Update-ExchangeHelp.md similarity index 95% rename from exchange/exchange-ps/exchange/Update-ExchangeHelp.md rename to exchange/exchange-ps/ExchangePowerShell/Update-ExchangeHelp.md index 01778dcf54..4d5145517d 100644 --- a/exchange/exchange-ps/exchange/Update-ExchangeHelp.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-ExchangeHelp.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-exchangehelp applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-ExchangeHelp -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-exchangehelp +schema: 2.0.0 +title: Update-ExchangeHelp --- # Update-ExchangeHelp @@ -44,6 +45,9 @@ This example checks for the latest available version of Help for the Exchange Ma ## PARAMETERS ### -Force + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. By default, the Update-ExchangeHelp cmdlet has a throttling period of 24 hours. If you run this cmdlet within 24 hours of the last time you ran it, it won't check for updates. You can use this switch to force the cmdlet to check for updates more frequently and to display status or error messages. @@ -52,7 +56,6 @@ By default, the Update-ExchangeHelp cmdlet has a throttling period of 24 hours. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-FileDistributionService.md b/exchange/exchange-ps/ExchangePowerShell/Update-FileDistributionService.md similarity index 95% rename from exchange/exchange-ps/exchange/Update-FileDistributionService.md rename to exchange/exchange-ps/ExchangePowerShell/Update-FileDistributionService.md index 869bf696a3..62bd156223 100644 --- a/exchange/exchange-ps/exchange/Update-FileDistributionService.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-FileDistributionService.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-filedistributionservice applicable: Exchange Server 2010 -title: Update-FileDistributionService -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-filedistributionservice +schema: 2.0.0 +title: Update-FileDistributionService --- # Update-FileDistributionService @@ -62,6 +63,9 @@ This example polls Server1 for changes to Group Metrics files associated with Se ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: - Name @@ -73,7 +77,6 @@ The Identity parameter specifies the Exchange server where you want to run this Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -92,7 +98,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010 + The Type parameter specifies whether to reload OAB, Unified Messaging, or Group Metrics data. If you don't use the Type parameter when running this command, OAB, Unified Messaging, and Group Metrics data are reloaded. The Type parameter takes the following values: @@ -130,7 +140,6 @@ The Type parameter takes the following values: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -140,13 +149,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-GlobalAddressList.md b/exchange/exchange-ps/ExchangePowerShell/Update-GlobalAddressList.md similarity index 90% rename from exchange/exchange-ps/exchange/Update-GlobalAddressList.md rename to exchange/exchange-ps/ExchangePowerShell/Update-GlobalAddressList.md index 8fe39ea94d..9122493067 100644 --- a/exchange/exchange-ps/exchange/Update-GlobalAddressList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-GlobalAddressList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-globaladdresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-GlobalAddressList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-globaladdresslist +schema: 2.0.0 +title: Update-GlobalAddressList --- # Update-GlobalAddressList @@ -43,6 +44,9 @@ This example updates the recipients in the default GAL. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the global address list that you want to update. You can use any value that uniquely identifies the GAL. For example: - Name @@ -53,7 +57,6 @@ The Identity parameter specifies the global address list that you want to update Type: GlobalAddressListIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -63,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -72,7 +78,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,13 +87,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md b/exchange/exchange-ps/ExchangePowerShell/Update-HybridConfiguration.md similarity index 90% rename from exchange/exchange-ps/exchange/Update-HybridConfiguration.md rename to exchange/exchange-ps/ExchangePowerShell/Update-HybridConfiguration.md index bb0e1ea9e9..25c53663ef 100644 --- a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-HybridConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-hybridconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Update-HybridConfiguration -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-hybridconfiguration +schema: 2.0.0 +title: Update-HybridConfiguration --- # Update-HybridConfiguration @@ -55,6 +56,9 @@ Use the last command to define the credentials that are used to update the hybri ## PARAMETERS ### -OnPremisesCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The OnPremisesCredentials parameter specifies the on-premises Active Directory account and password that's used to configure the hybrid configuration object. This account must be a member of the Organization Management role group. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -63,7 +67,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -TenantCredentials + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The TenantCredentials parameter specifies the Microsoft 365 organization account and password that's used to configure the hybrid configuration object. This is often the administrator account that's assigned when the Microsoft 365 organization was created. This account must be a member of the Global Administrators role. > [!IMPORTANT] @@ -84,7 +90,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -103,7 +111,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -121,7 +131,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -ForceUpgrade + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. This confirmation prompt is displayed only when the existing HybridConfiguration Active Directory object version is Exchange 2010. @@ -139,7 +151,6 @@ This confirmation prompt is displayed only when the existing HybridConfiguration Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -SuppressOAuthWarning + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -165,13 +178,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md b/exchange/exchange-ps/ExchangePowerShell/Update-MailboxDatabaseCopy.md similarity index 87% rename from exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md rename to exchange/exchange-ps/ExchangePowerShell/Update-MailboxDatabaseCopy.md index b7f5614479..388cc0d20a 100644 --- a/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-MailboxDatabaseCopy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-mailboxdatabasecopy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-MailboxDatabaseCopy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.ServerStatus-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-mailboxdatabasecopy +schema: 2.0.0 +title: Update-MailboxDatabaseCopy --- # Update-MailboxDatabaseCopy @@ -121,13 +122,15 @@ This example performs a full server reseed of all of the databases on the Mailbo ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the name or GUID of the mailbox database whose copy is being seeded. ```yaml Type: DatabaseCopyIdParameter Parameter Sets: CancelSeed, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -137,13 +140,15 @@ Accept wildcard characters: False ``` ### -CancelSeed + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CancelSeed switch specifies whether to cancel an in-progress seeding operation. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: CancelSeed Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -153,13 +158,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter is used as part of a full server reseed operation. It can be used with the MaximumSeedsInParallel parameter to start reseeds of database copies in parallel across the specified server in batches of up to the value of the MaximumSeedsInParallel parameter copies at a time. ```yaml Type: MailboxServerIdParameter Parameter Sets: ExplicitServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -169,6 +176,9 @@ Accept wildcard characters: False ``` ### -BeginSeed + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BeginSeed switch asynchronously starts the seeding operation and then exits the cmdlet. You don't need to specify a value with this switch. This switch is useful for scripting reseeds. @@ -177,7 +187,6 @@ This switch is useful for scripting reseeds. Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -187,13 +196,15 @@ Accept wildcard characters: False ``` ### -CatalogOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The CatalogOnly switch specifies that only the content index catalog for the database copy should be seeded. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,6 +214,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -212,7 +226,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,13 +235,15 @@ Accept wildcard characters: False ``` ### -DatabaseOnly + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DatabaseOnly switch specifies that only the database copy should be seeded. The content index catalog isn't seeded. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -238,6 +253,9 @@ Accept wildcard characters: False ``` ### -DeleteExistingFiles + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DeleteExistingFiles switch specifies whether to remove the existing log files at the target location. You don't need to specify a value with this switch. This switch removes only the files that it checks for and fails if other files are present. No action is taken on other files at the target location. Therefore, if database-related files are present, you must manually remove them. @@ -246,7 +264,6 @@ This switch removes only the files that it checks for and fails if other files a Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -256,13 +273,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -272,6 +291,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -280,7 +302,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -290,6 +311,9 @@ Accept wildcard characters: False ``` ### -ManualResume + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The ManualResume switch specifies whether to automatically resume replication on the database copy. You don't need to specify a value with this switch. With this switch, you can manually resume replication to the database copy. @@ -298,7 +322,6 @@ With this switch, you can manually resume replication to the database copy. Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -308,13 +331,15 @@ Accept wildcard characters: False ``` ### -MaximumSeedsInParallel + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The MaximumSeedsInParallel parameter is used with the Server parameter to specify the maximum number of parallel seeding operations that should occur across the specified server during a full server reseed operation. The default value is 10. ```yaml Type: Int32 Parameter Sets: ExplicitServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,13 +349,15 @@ Accept wildcard characters: False ``` ### -Network + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Network parameter specifies which DAG network should be used for seeding. Note that content index catalog seeding always occurs over the MAPI network, even if you use this parameter to specify the DAG network. ```yaml Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,13 +367,15 @@ Accept wildcard characters: False ``` ### -NetworkCompressionOverride + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The NetworkCompressionOverride parameter specifies whether to override the current DAG network compression settings. ```yaml Type: UseDagDefaultOnOff Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,13 +385,15 @@ Accept wildcard characters: False ``` ### -NetworkEncryptionOverride + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The NetworkEncryptionOverride parameter specifies whether to override the current DAG encryption settings. ```yaml Type: UseDagDefaultOnOff Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -372,13 +403,15 @@ Accept wildcard characters: False ``` ### -NoThrottle + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The NoThrottle switch prevents the seeding operation from being throttled. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -388,13 +421,15 @@ Accept wildcard characters: False ``` ### -PrimaryDatabasePartitionOnly + +> Applicable: Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -404,6 +439,9 @@ Accept wildcard characters: False ``` ### -SafeDeleteExistingFiles + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SafeDeleteExistingFiles switch specifies a seeding operation with a single copy redundancy pre-check prior to the seed. You don't need to specify a value with this switch. Because this switch includes the redundancy safety check, it requires a lower level of permissions than the DeleteExistingFiles parameter. Limited permission administrators can perform the seeding operation by using this switch. @@ -412,7 +450,6 @@ Because this switch includes the redundancy safety check, it requires a lower le Type: SwitchParameter Parameter Sets: Identity, ExplicitServer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -422,13 +459,15 @@ Accept wildcard characters: False ``` ### -SecondaryDatabasePartitionOnly + +> Applicable: Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2019 Required: False Position: Named @@ -438,6 +477,9 @@ Accept wildcard characters: False ``` ### -SourceServer + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The SourceServer parameter specifies the Mailbox server with a passive copy of the mailbox database to be used as the source for the seed operation. You can use any value that uniquely identifies the server. For example: @@ -451,7 +493,6 @@ The SourceServer parameter specifies the Mailbox server with a passive copy of t Type: ServerIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -461,13 +502,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md b/exchange/exchange-ps/ExchangePowerShell/Update-OfflineAddressBook.md similarity index 89% rename from exchange/exchange-ps/exchange/Update-OfflineAddressBook.md rename to exchange/exchange-ps/ExchangePowerShell/Update-OfflineAddressBook.md index c9dd29eb20..24c1ffe456 100644 --- a/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-OfflineAddressBook.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-OfflineAddressBook -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-offlineaddressbook +schema: 2.0.0 +title: Update-OfflineAddressBook --- # Update-OfflineAddressBook @@ -44,6 +45,9 @@ This example updates the OAB MyOAB. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the GUID, distinguished name (DN), or OAB name that represents a specific OAB. You can also include the path by using the format Server\\OfflineAddressBookName. You can omit the parameter label Identity so that only the OAB name or GUID is supplied. @@ -52,7 +56,6 @@ You can omit the parameter label Identity so that only the OAB name or GUID is s Type: OfflineAddressBookIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -71,7 +77,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -81,13 +86,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -97,6 +104,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Exchange Server 2016, Exchange Server 2019 + The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. @@ -105,7 +115,6 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,13 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-PublicFolder.md b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolder.md similarity index 95% rename from exchange/exchange-ps/exchange/Update-PublicFolder.md rename to exchange/exchange-ps/ExchangePowerShell/Update-PublicFolder.md index 52de562a91..7bf00fe065 100644 --- a/exchange/exchange-ps/exchange/Update-PublicFolder.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolder.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-publicfolder applicable: Exchange Server 2010 -title: Update-PublicFolder -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-publicfolder +schema: 2.0.0 +title: Update-PublicFolder --- # Update-PublicFolder @@ -50,6 +51,9 @@ This example also starts content replication of the public folder My Public Fold ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010 + The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path by using the format TopLevelPublicFolder\\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. @@ -58,7 +62,6 @@ You can omit the parameter label so that only the public folder name or GUID is Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: 1 @@ -68,6 +71,9 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Mailbox server that holds the source public folder database for replication. You can use any value that uniquely identifies the server. For example: - Name @@ -79,7 +85,6 @@ The Server parameter specifies the Mailbox server that holds the source public f Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -89,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -98,7 +106,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -108,13 +115,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -124,13 +133,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-PublicFolderHierarchy.md b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderHierarchy.md similarity index 95% rename from exchange/exchange-ps/exchange/Update-PublicFolderHierarchy.md rename to exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderHierarchy.md index c8bcc1dc98..2902335a2c 100644 --- a/exchange/exchange-ps/exchange/Update-PublicFolderHierarchy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderHierarchy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-publicfolderhierarchy applicable: Exchange Server 2010 -title: Update-PublicFolderHierarchy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-publicfolderhierarchy +schema: 2.0.0 +title: Update-PublicFolderHierarchy --- # Update-PublicFolderHierarchy @@ -43,6 +44,9 @@ This example pipes the output of the Get-MailboxServer command to the Update-Pub ## PARAMETERS ### -Server + +> Applicable: Exchange Server 2010 + The Server parameter specifies the Mailbox server that holds the source public folder database for replication. You can use any value that uniquely identifies the server. For example: - Name @@ -54,7 +58,6 @@ The Server parameter specifies the Mailbox server that holds the source public f Type: ServerIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: True Position: Named @@ -64,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -73,7 +79,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010 Required: False Position: Named @@ -83,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 Required: False Position: Named @@ -99,13 +106,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderMailbox.md similarity index 88% rename from exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderMailbox.md index cfef60bbfd..3980dd3f42 100644 --- a/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-PublicFolderMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-publicfoldermailbox applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Update-PublicFolderMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.WebClient-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-publicfoldermailbox +schema: 2.0.0 +title: Update-PublicFolderMailbox --- # Update-PublicFolderMailbox @@ -68,6 +69,9 @@ This example updates all public folder mailboxes. ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the public folder mailbox that you want to update. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -85,7 +89,6 @@ The Identity parameter specifies the public folder mailbox that you want to upda Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -95,13 +98,15 @@ Accept wildcard characters: False ``` ### -FolderId + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The FolderId parameter specifies the GUID or name of the public folder that you want to synchronize. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. ```yaml Type: PublicFolderIdParameter Parameter Sets: InvokeSingleFolderSynchronizer Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -111,15 +116,17 @@ Accept wildcard characters: False ``` ### -InvokeSynchronizer + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The InvokeSynchronizer switch can only be used on secondary hierarchy public folder mailboxes and triggers hierarchy synchronization from the primary public folder mailbox to the specified secondary public folder mailbox. You don't need to specify a value with this switch. This switch should only be used for troubleshooting purposes. ```yaml Type: SwitchParameter -Parameter Sets: InvokeSingleFolderSynchronizer +Parameter Sets: InvokeSingleFolderSynchronizer, InvokeSynchronizer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -128,20 +135,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: InvokeSynchronizer -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -151,7 +148,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -161,13 +157,15 @@ Accept wildcard characters: False ``` ### -CreateAssociatedDumpster + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The CreateAssociatedDumpster switch specifies whether to create the associated dumpster before synchronizing the folder. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: InvokeSingleFolderSynchronizer Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -177,6 +175,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -185,7 +186,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -195,13 +195,15 @@ Accept wildcard characters: False ``` ### -ForceOnlineSync + +> Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + The ForceOnlineSync switch specifies whether to force the secondary public folder mailbox to synchronize with the primary public folder mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: InvokeSynchronizer Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -211,13 +213,15 @@ Accept wildcard characters: False ``` ### -FullSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The FullSync switch specifies that you want to perform a full synchronization of the public folder mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: InvokeSynchronizer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -227,6 +231,9 @@ Accept wildcard characters: False ``` ### -ReconcileFolders + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The ReconcileFolders switch specifies whether to look closely for differences in the folder hierarchy between the primary public folder mailbox and the secondary public folder mailbox. Folders that exist in the primary public folder mailbox and not in the secondary will be recreated. You don't need to specify a value with this switch. In on-premises Exchange, folders that exist in the secondary public folder mailbox and not in the primary will be deleted. @@ -249,7 +256,6 @@ This example restores the public folder named "Documents" from LOST_AND_FOUND to Type: SwitchParameter Parameter Sets: InvokeSynchronizer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -259,6 +265,9 @@ Accept wildcard characters: False ``` ### -SuppressStatus + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + 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. @@ -269,7 +278,6 @@ If you don't use this switch, the output will display status messages every 3 se Type: SwitchParameter Parameter Sets: InvokeSynchronizer Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -279,13 +287,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-Recipient.md b/exchange/exchange-ps/ExchangePowerShell/Update-Recipient.md similarity index 90% rename from exchange/exchange-ps/exchange/Update-Recipient.md rename to exchange/exchange-ps/ExchangePowerShell/Update-Recipient.md index c4b96b4b18..3e39709f1d 100644 --- a/exchange/exchange-ps/exchange/Update-Recipient.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-Recipient.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-recipient applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online -title: Update-Recipient -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-recipient +schema: 2.0.0 +title: Update-Recipient --- # Update-Recipient @@ -57,6 +58,9 @@ In on-premises Exchange, this example updates all contacts in a specific organiz ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Identity parameter specifies the recipient that you want to update. You can use any value that uniquely identifies the recipient. For example: - Name @@ -70,7 +74,6 @@ The Identity parameter specifies the recipient that you want to update. You can Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -89,7 +95,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The Credential parameter specifies the username and password to use to access Active Directory. A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). @@ -107,7 +115,6 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -125,7 +135,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-RoleGroupMember.md b/exchange/exchange-ps/ExchangePowerShell/Update-RoleGroupMember.md similarity index 90% rename from exchange/exchange-ps/exchange/Update-RoleGroupMember.md rename to exchange/exchange-ps/ExchangePowerShell/Update-RoleGroupMember.md index 8c47b09f10..8bb7860a0c 100644 --- a/exchange/exchange-ps/exchange/Update-RoleGroupMember.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-RoleGroupMember.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-rolegroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection -title: Update-RoleGroupMember -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-rolegroupmember +schema: 2.0.0 +title: Update-RoleGroupMember --- # Update-RoleGroupMember @@ -75,13 +76,15 @@ Mail-enabled security group: If you want to add or remove a mail-enabled securit ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Identity parameter specifies the role group whose membership you want to modify. If the name of the role group contains spaces, enclose the name in quotation marks ("). ```yaml Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: @@ -102,7 +108,6 @@ If you aren't defined in the ManagedBy property of the group, you need to use th Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -121,7 +129,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -139,7 +149,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The Members parameter specifies the mailboxes or mail-enabled USGs to add as a member of the role group. You can identify the user or group by the name, DN, or primary SMTP address value. You can specify multiple members separated by commas (`Value1,Value2,...ValueN`). If the value contains spaces, enclose the value in quotation marks (`"Value 1","Value 2",..."Value N"`). By default, the values that you specify overwrite the existing membership list of the role group. To add or remove multiple members without replacing the entire membership list, see the Examples section. @@ -157,7 +169,6 @@ By default, the values that you specify overwrite the existing membership list o Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -167,6 +178,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + The WhatIf switch doesn't work in Security & Compliance PowerShell. The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -175,7 +189,6 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-SafeList.md b/exchange/exchange-ps/ExchangePowerShell/Update-SafeList.md similarity index 91% rename from exchange/exchange-ps/exchange/Update-SafeList.md rename to exchange/exchange-ps/ExchangePowerShell/Update-SafeList.md index 9b052ebd8b..df0c3abf32 100644 --- a/exchange/exchange-ps/exchange/Update-SafeList.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-SafeList.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-safelist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-SafeList -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-safelist +schema: 2.0.0 +title: Update-SafeList --- # Update-SafeList @@ -59,6 +60,9 @@ This example updates safelist data for all user mailboxes in your Exchange organ ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox from which you want to collect safelist aggregation data. You can use any value that uniquely identifies the mailbox. For example: - Name @@ -76,7 +80,6 @@ The Identity parameter specifies the mailbox from which you want to collect safe Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -95,7 +101,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -EnsureJunkEmailRule + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The EnsureJunkEmailRule switch forces the junk email rule to be turned on for the mailbox if the rule isn't turned on already. You don't need to specify a value with this switch. The junk email rule can only be created after the user logs on to the mailbox. If the user has never logged on to the mailbox, this parameter can't turn on the junk email rule. @@ -129,7 +139,6 @@ The junk email rule can only be created after the user logs on to the mailbox. I Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -IncludeDomains + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The IncludeDomains switch specifies whether to include the sender domains specified by users in Outlook in the safelist aggregation data. You don't need to specify a value with this switch. By default, domains specified by the senders aren't included. @@ -149,7 +161,6 @@ In most cases, we don't recommend that you include domains because users may inc Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,6 +170,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Type parameter specifies which user-generated list is updated to the user object. Valid values for this parameter are SafeSenders, SafeRecipients, and Both. The default value is SafeSenders. The safelist aggregation feature doesn't act on Safe Recipients List data. We don't recommend running the Type parameter with the SafeRecipients or Both values. @@ -167,7 +181,6 @@ The safelist aggregation feature doesn't act on Safe Recipients List data. We do Type: UpdateType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-SiteMailbox.md b/exchange/exchange-ps/ExchangePowerShell/Update-SiteMailbox.md similarity index 90% rename from exchange/exchange-ps/exchange/Update-SiteMailbox.md rename to exchange/exchange-ps/ExchangePowerShell/Update-SiteMailbox.md index e56a3a732f..8c732c49eb 100644 --- a/exchange/exchange-ps/exchange/Update-SiteMailbox.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-SiteMailbox.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-sitemailbox applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-SiteMailbox -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-sitemailbox +schema: 2.0.0 +title: Update-SiteMailbox --- # Update-SiteMailbox @@ -58,6 +59,9 @@ This example updates the site mailbox WinterHoliday@tailspintoys.com and perform ## PARAMETERS ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the site mailbox that you want to update. You can use any value that uniquely identifies the site mailbox. For example: - Name @@ -71,7 +75,6 @@ The Identity parameter specifies the site mailbox that you want to update. You c Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -BypassOwnerCheck + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. @@ -89,7 +95,6 @@ If you don't use this switch, and you aren't a member or owner of the site mailb Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -108,7 +116,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -FullSync + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The FullSync switch specifies full sync is expensive and will have a performance impact on the Exchange system. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Server parameter specifies the fully qualified domain name (FQDN) or the Microsoft SharePoint server on which the site mailbox is located. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Target parameter specifies whether to update the SharePoint documents, the site mailbox's membership list or both. This parameter accepts the following values: - All @@ -178,7 +194,6 @@ If you don't specify this parameter when you run the cmdlet, this parameter valu Type: TargetType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-StoreMailboxState.md b/exchange/exchange-ps/ExchangePowerShell/Update-StoreMailboxState.md similarity index 94% rename from exchange/exchange-ps/exchange/Update-StoreMailboxState.md rename to exchange/exchange-ps/ExchangePowerShell/Update-StoreMailboxState.md index d586e3c49e..4af3a76895 100644 --- a/exchange/exchange-ps/exchange/Update-StoreMailboxState.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-StoreMailboxState.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-storemailboxstate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -title: Update-StoreMailboxState -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-storemailboxstate +schema: 2.0.0 +title: Update-StoreMailboxState --- # Update-StoreMailboxState @@ -58,6 +59,9 @@ This example updates the mailbox state for all disconnected mailboxes on the mai ## PARAMETERS ### -Database + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Database parameter specifies the mailbox database that contains the mailbox. You can use any value that uniquely identifies the database. For example: - Name @@ -68,7 +72,6 @@ The Database parameter specifies the mailbox database that contains the mailbox. Type: DatabaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Identity parameter specifies the mailbox that you want to update. Use the mailbox GUID as the value for this parameter. Run the following command to obtain the mailbox GUID and other information for all mailboxes in your organization: Get-MailboxDatabase | Get-MailboxStatistics | Format-List DisplayName,MailboxGuid,Database,DisconnectReason,DisconnectDate. @@ -86,7 +92,6 @@ Run the following command to obtain the mailbox GUID and other information for a Type: StoreMailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -105,7 +113,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/ExchangePowerShell/Update-VivaModuleFeaturePolicy.md similarity index 96% rename from exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md rename to exchange/exchange-ps/ExchangePowerShell/Update-VivaModuleFeaturePolicy.md index f8a3ee84e0..aebd5b6c89 100644 --- a/exchange/exchange-ps/exchange/Update-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-VivaModuleFeaturePolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://learn.microsoft.com/powershell/module/exchange/update-vivamodulefeaturepolicy applicable: Exchange Online -title: Update-VivaModuleFeaturePolicy -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-vivamodulefeaturepolicy +schema: 2.0.0 +title: Update-VivaModuleFeaturePolicy --- # Update-VivaModuleFeaturePolicy @@ -19,7 +19,7 @@ Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a f - You can't update a policy for a particular user or group to include the entire tenant if a policy for the entire tenant already exists for the feature. Only one tenant-wide policy is supported. - Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies. -- Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature) cmdlet. +- Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchangepowershell/get-vivamodulefeature) cmdlet. Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for. @@ -108,6 +108,9 @@ This example updates a policy for the ShowAISkills feature in Viva Skills. The p ## PARAMETERS ### -FeatureId + +> Applicable: Exchange Online + The FeatureId parameter specifies the feature in the Viva module of the policy that you want to update. To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. @@ -116,7 +119,6 @@ To view details about the features in a Viva module that support feature access Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -126,13 +128,15 @@ Accept wildcard characters: False ``` ### -ModuleId + +> Applicable: Exchange Online + The ModuleId parameter specifies the Viva module of the policy that you want to update. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -142,6 +146,9 @@ Accept wildcard characters: False ``` ### -PolicyId + +> Applicable: Exchange Online + The PolicyId parameter specifies the policy for the feature in the Viva module that you want to update. To view details about the policies for a feature in a Viva module, use the Get-VivaModuleFeaturePolicy cmdlet. The PolicyId value is returned in the output of the cmdlet. @@ -150,7 +157,6 @@ To view details about the policies for a feature in a Viva module, use the Get-V Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: Named @@ -160,6 +166,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -169,7 +178,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online Required: False Position: Named @@ -179,6 +187,9 @@ Accept wildcard characters: False ``` ### -Everyone + +> Applicable: Exchange Online + The Everyone parameter specifies that the updated policy applies to all users in the organization. Valid values are: - $true: The policy applies to all users. This is the only useful value for this parameter. @@ -192,7 +203,6 @@ Don't use this parameter with the GroupIds or UserIds parameters. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -202,6 +212,9 @@ Accept wildcard characters: False ``` ### -GroupIds + +> Applicable: Exchange Online + The GroupIds parameter specifies the email addresses or security group object IDs (GUIDs) of groups that the updated policy applies to. Both [Mail-enabled and non-mail-enabled Microsoft Entra groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. You can enter multiple values separated by commas. If you don't want to update who the policy applies to, don't use this parameter. @@ -218,7 +231,6 @@ To have the updated policy apply to all users in the organization, use the Every Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -227,6 +239,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -IsFeatureEnabled + +> Applicable: Exchange Online + The IsFeatureEnabled parameter specifies whether the feature is enabled by the updated policy. Valid values are: - $true: The feature is enabled by the policy. @@ -238,7 +253,6 @@ If you don't want to update whether the feature is enabled by the policy, don't Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -248,6 +262,9 @@ Accept wildcard characters: False ``` ### -IsUserControlEnabled + +> Applicable: Exchange Online + **Note**: This parameter is available in version 3.3.0 or later of the module. If the feature supports user controls for opting out, make sure you set the *IsUserControlEnabled* parameter when you create the policy. Otherwise, user controls for the policy use the default state for the feature. The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: @@ -263,7 +280,6 @@ If you don't want to update whether the user control is enabled by the policy, d Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -273,6 +289,9 @@ Accept wildcard characters: False ``` ### -IsUserOptedInByDefault + +> Applicable: Exchange Online + This parameter is available in version 3.8.0-Preview2 or later of the module. The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are: @@ -288,7 +307,6 @@ This parameter can be set only when the IsUserControlEnabled parameter is set to Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -298,6 +316,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Exchange Online + The Name parameter specifies the updated name for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). Valid characters are English letters, numbers, commas, periods, and spaces. @@ -308,7 +329,6 @@ If you don't want to update the name of the policy, don't use this parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -318,13 +338,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Exchange Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -334,6 +356,9 @@ Accept wildcard characters: False ``` ### -UserIds + +> Applicable: Exchange Online + The UserIds parameter specifies the user principal names (UPNs) of users that the updated policy applies to. You can enter multiple values separated by commas. If you don't want to update who the policy applies to, don't use this parameter. @@ -348,7 +373,6 @@ To have the updated policy apply to all users in the organization, use the Every Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: False Position: Named @@ -358,13 +382,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/ExchangePowerShell/Update-eDiscoveryCaseAdmin.md similarity index 95% rename from exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md rename to exchange/exchange-ps/ExchangePowerShell/Update-eDiscoveryCaseAdmin.md index bd36987193..1ee6f8a622 100644 --- a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/ExchangePowerShell/Update-eDiscoveryCaseAdmin.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/update-ediscoverycaseadmin applicable: Security & Compliance -title: Update-eDiscoveryCaseAdmin -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/update-ediscoverycaseadmin +schema: 2.0.0 +title: Update-eDiscoveryCaseAdmin --- # Update-eDiscoveryCaseAdmin @@ -46,6 +47,9 @@ This example replaces the existing eDiscovery Administrators with new users. ## PARAMETERS ### -Users + +> Applicable: Security & Compliance + 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 @@ -59,7 +63,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Required: True Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Security & Compliance + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -78,7 +84,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Security & Compliance + The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md b/exchange/exchange-ps/ExchangePowerShell/Upgrade-DistributionGroup.md similarity index 92% rename from exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md rename to exchange/exchange-ps/ExchangePowerShell/Upgrade-DistributionGroup.md index d0092da6bc..1545b8ffa2 100644 --- a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md +++ b/exchange/exchange-ps/ExchangePowerShell/Upgrade-DistributionGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/upgrade-distributiongroup applicable: Exchange Online, Exchange Online Protection -title: Upgrade-DistributionGroup -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/upgrade-distributiongroup +schema: 2.0.0 +title: Upgrade-DistributionGroup --- # Upgrade-DistributionGroup @@ -45,6 +46,9 @@ This example upgrades the specified distribution groups to Microsoft 365 Groups. ## PARAMETERS ### -DlIdentities + +> Applicable: Exchange Online + The DlIdentities parameter specifies the email address of the distribution group that you want to upgrade to a Microsoft 365 Group. You can specify multiple values separated by commas. @@ -53,7 +57,6 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online Required: True Position: 1 @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -ActionType + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -ExecutingUser + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -95,13 +102,15 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Exchange Online, Exchange Online Protection + This parameter is reserved for internal Microsoft use. ```yaml Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Validate-OutboundConnector.md b/exchange/exchange-ps/ExchangePowerShell/Validate-OutboundConnector.md similarity index 93% rename from exchange/exchange-ps/exchange/Validate-OutboundConnector.md rename to exchange/exchange-ps/ExchangePowerShell/Validate-OutboundConnector.md index e096f825c2..a68eaf0cde 100644 --- a/exchange/exchange-ps/exchange/Validate-OutboundConnector.md +++ b/exchange/exchange-ps/ExchangePowerShell/Validate-OutboundConnector.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/validate-outboundconnector applicable: Exchange Online, Exchange Online Protection -title: Validate-OutboundConnector -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/validate-outboundconnector +schema: 2.0.0 +title: Validate-OutboundConnector --- # Validate-OutboundConnector @@ -49,6 +50,9 @@ This example tests the Outbound connector named Contoso.com Outbound Connector. ## PARAMETERS ### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + The Identity parameter specifies the Outbound connector that you want to test. You can use any value that uniquely identifies the connector. For example: - Name @@ -59,7 +63,6 @@ The Identity parameter specifies the Outbound connector that you want to test. Y Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -Recipients + +> Applicable: Exchange Online, Exchange Online Protection + The Recipients parameter specifies one or more email addresses to send a test message to. The email addresses need to be in the domain that's configured on the connector. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -77,7 +83,6 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -96,7 +104,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md b/exchange/exchange-ps/ExchangePowerShell/Validate-RetentionRuleQuery.md similarity index 94% rename from exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md rename to exchange/exchange-ps/ExchangePowerShell/Validate-RetentionRuleQuery.md index c4a8ee7175..51538b1dbf 100644 --- a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md +++ b/exchange/exchange-ps/ExchangePowerShell/Validate-RetentionRuleQuery.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/validate-retentionrulequery applicable: Exchange Online, Security & Compliance -title: Validate-RetentionRuleQuery -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/validate-retentionrulequery +schema: 2.0.0 +title: Validate-RetentionRuleQuery --- # Validate-RetentionRuleQuery @@ -40,6 +41,9 @@ This example validates the specified KQL content search filter. ## PARAMETERS ### -KqlQueryString + +> Applicable: Exchange Online, Security & Compliance + The KqlQueryString parameter specifies the KQL text search string that you want to validate. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). @@ -48,7 +52,6 @@ This parameter uses a text search string or a query that's formatted by using th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Write-AdminAuditLog.md b/exchange/exchange-ps/ExchangePowerShell/Write-AdminAuditLog.md similarity index 88% rename from exchange/exchange-ps/exchange/Write-AdminAuditLog.md rename to exchange/exchange-ps/ExchangePowerShell/Write-AdminAuditLog.md index 3545297054..71ab87ec02 100644 --- a/exchange/exchange-ps/exchange/Write-AdminAuditLog.md +++ b/exchange/exchange-ps/ExchangePowerShell/Write-AdminAuditLog.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/write-adminauditlog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection -title: Write-AdminAuditLog -schema: 2.0.0 author: chrisda +external help file: Microsoft.Exchange.RecordsandEdge-Help.xml +Locale: en-US +Module Name: ExchangePowerShell ms.author: chrisda -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/write-adminauditlog +schema: 2.0.0 +title: Write-AdminAuditLog --- # Write-AdminAuditLog @@ -47,6 +48,9 @@ This example adds a comment to the administrator audit log. ## PARAMETERS ### -Comment + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Comment parameter specifies the comment to add to the administrator audit log. The maximum length is 500 characters. If the comment you specify contains spaces, enclose the comment in quotation marks ("). @@ -55,7 +59,6 @@ If the comment you specify contains spaces, enclose the comment in quotation mar Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. @@ -74,7 +80,6 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -92,7 +100,6 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md index 5f8470dadc..e03059b3f9 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md @@ -12,7 +12,9 @@ ms.reviewer: # Get-OfficeWebAppsExcelBIServer ## SYNOPSIS -Returns the server ID of the instance of Analysis Services that has been configured as a data model server in Office Online Server. + +Returns the server ID of the instance of Analysis Services that has been configured as a data model +server in Office Online Server. ## SYNTAX @@ -21,12 +23,15 @@ Get-OfficeWebAppsExcelBIServer ``` ## DESCRIPTION -Returns the server ID of the instance of Analysis Services that has been configured as a data model server in Office Online Server. + +Returns the server ID of the instance of Analysis Services that has been configured as a data model +server in Office Online Server. ## EXAMPLES ### Example 1 -``` + +```powershell Get-OfficeWebAppsExcelBIServer ``` diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md index 1af1fd7bb1..dee6470e64 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Returns a list of currently configured UDF definitions. ## SYNTAX @@ -21,24 +22,27 @@ Get-OfficeWebAppsExcelUserDefinedFunction [[-Identity] ] ``` ## DESCRIPTION + Returns a list of currently configured UDF definitions. ## EXAMPLES ### This example returns a list of currently configured UDF definitions from c:\myudf.dll. -``` + +```powershell Get-OfficeWebAppsExcelUserDefinedFunction -Identity c:\myudf.dll ``` ## PARAMETERS ### -Identity + The path and filename of the UDF. ```yaml Type: UserDefinedFunction Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md index 0d27a73bb7..168bf69836 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsFarm ## SYNOPSIS + Returns details about the OfficeWebAppsFarm object that the current server is a member of. ## SYNTAX @@ -21,21 +22,25 @@ Get-OfficeWebAppsFarm ``` ## DESCRIPTION -The Get-OfficeWebAppsFarm cmdlet returns details about the OfficeWebAppsFarm object that the current server is a member of. -This object represents a group of servers that work as a unit to provide web-based editing and viewing of Office documents. -No parameters are used with the Get-OfficeWebAppsFarm cmdlet. + +The `Get-OfficeWebAppsFarm` cmdlet returns details about the OfficeWebAppsFarm object that the +current server is a member of. This object represents a group of servers that work as a unit to +provide web-based editing and viewing of Office documents. No parameters are used with the +`Get-OfficeWebAppsFarm` cmdlet. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Get-OfficeWebAppsFarm ``` This example returns details about the OfficeWebAppsFarm object. ### EXAMPLE 2 -``` + +```powershell (Get-OfficeWebAppsFarm).Machines ``` diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md index 034526892b..d034e6df00 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsHost ## SYNOPSIS + Returns the list of host domains that are on the Allow List for an Office Online Server farm. ## SYNTAX @@ -21,34 +22,41 @@ Get-OfficeWebAppsHost ``` ## DESCRIPTION -The Get-OfficeWebAppsHost cmdlet returns the list of host domains to which Office Online Server allows file operations requests, such as file retrieval, metadata retrieval, and file changes. -This list, known as the Allow List, is a security feature that prevents unwanted hosts from connecting to an Office Online Server farm and using it for file operations without your knowledge. -The wildcard * is assumed for any domain that appears on the Allow List so that requests to all subdomains are also allowed. -For example, if the domain contoso.com is on the Allow List, then Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. +The Get-OfficeWebAppsHost cmdlet returns the list of host domains to which Office Online Server +allows file operations requests, such as file retrieval, metadata retrieval, and file changes. This +list, known as the Allow List, is a security feature that prevents unwanted hosts from connecting to +an Office Online Server farm and using it for file operations without your knowledge. + +The wildcard * is assumed for any domain that appears on the Allow List so that requests to all +subdomains are also allowed. For example, if the domain contoso.com is on the Allow List, then +Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. Requests to other domains (such as fabrikam.com) are not allowed. -If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any domain. -Do not leave this list blank if your Office Online Server farm is accessible from the Internet. -Otherwise anyone can use your Office Online Server farm to view and edit content. +If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any +domain. Do not leave this list blank if your Office Online Server farm is accessible from the +Internet. Otherwise anyone can use your Office Online Server farm to view and edit content. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Get-OfficeWebAppsHost ``` This example returns the host domains that are on the Allow List. ### EXAMPLE 2 + If there are multiple domains in the Allow List, please run the following: -``` +```powershell Get-OfficeWebAppsHost | Select allowList -ExpandProperty allowList ``` -This example returns the host domains that are on the Allow List without ellipsis truncation in the case of multiple domains. +This example returns the host domains that are on the Allow List without ellipsis truncation in the +case of multiple domains. ## PARAMETERS diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md index 034f6f4408..f0588a4a6f 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsMachine ## SYNOPSIS + Returns details about the current server that is in an Office Online Server farm. ## SYNTAX @@ -21,20 +22,24 @@ Get-OfficeWebAppsMachine ``` ## DESCRIPTION -The Get-OfficeWebAppsMachine cmdlet returns details about the current server that is in an Office Online Server farm. -These details include the roles and health status of the current server and the name of the master server for the farm. + +The Get-OfficeWebAppsMachine cmdlet returns details about the current server that is in an Office +Online Server farm. These details include the roles and health status of the current server and the +name of the master server for the farm. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Get-OfficeWebAppsMachine ``` This example returns details about the current server that is in an Office Online Server farm. ### EXAMPLE 2 -``` + +```powershell (Get-OfficeWebAppsFarm).Machines ``` diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md index 0640085f2b..ff4020acb3 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsExcelBIServer ## SYNOPSIS + Configures Analysis Services servers to work with Excel Online. ## SYNTAX @@ -21,24 +22,29 @@ New-OfficeWebAppsExcelBIServer -ServerId ``` ## DESCRIPTION + Configures Analysis Services servers to work with Excel Online. ## EXAMPLES -### This example configures the Analysis Services server named SSAS01 to work with Excel Online. -``` +### Example 1 + +This example configures the Analysis Services server named SSAS01 to work with Excel Online. + +```powershell New-OfficeWebAppsExcelBIServer -ServerID "SSAS01" ``` ## PARAMETERS ### -ServerId + The name of the Analysis Services server. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md index c488ab7775..74ec676b53 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Creates a definition for a UDF binary. ## SYNTAX @@ -22,23 +23,33 @@ New-OfficeWebAppsExcelUserDefinedFunction -Assembly [-AssemblyLocation ``` ## DESCRIPTION + Creates a definition for a UDF binary. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell New-OfficeWebAppsExcelUserDefinedFunction -Assembly c:\myudf.dll -AssemblyLocation LocalFile -Enable:$true -Description "My Server UDFs" ``` ### EXAMPLE 2 -``` -New-OfficeWebAppsExcelUserDefinedFunction -Assembly "CompanyName.Hierarchical.MyUdfNamespace.MyUdfClassName.dll, Version=1.1.0.0, Culture=en, PublicKeyToken=e8123117d7ba9ae38" -AssemblyLocation GAC -Enable:$true -Description "My GAC Server UDFs" + +```powershell +$newOfficeWebAppsExcelUserDefinedFunctionSplat = @{ + Assembly = 'CompanyName.Hierarchical.MyUdfNamespace.MyUdfClassName.dll, Version=1.1.0.0, Culture=en, PublicKeyToken=e8123117d7ba9ae38' + AssemblyLocation = 'GAC' + Enable = $true + Description = "My GAC Server UDFs" +} +New-OfficeWebAppsExcelUserDefinedFunction @newOfficeWebAppsExcelUserDefinedFunctionSplat ``` ## PARAMETERS ### -Assembly + The name of the assembly. ```yaml @@ -54,8 +65,13 @@ Accept wildcard characters: False ``` ### -AssemblyLocation + The location of the assembly. -Values: LocalFile - a local directory; GAC - the Global Assembly Cache. + +Values: + +- LocalFile - a local directory +- GAC - the Global Assembly Cache ```yaml Type: AssemblyLocation @@ -70,8 +86,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -86,6 +102,7 @@ Accept wildcard characters: False ``` ### -Description + Description of the UDF. ```yaml @@ -101,6 +118,7 @@ Accept wildcard characters: False ``` ### -Enable + Enables the UDF. ```yaml @@ -116,8 +134,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md index 627e987140..df9e2f8c8d 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md @@ -12,47 +12,58 @@ ms.reviewer: # New-OfficeWebAppsFarm ## SYNOPSIS + Creates a new Office Online Server farm on the local computer. ## SYNTAX ``` -New-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] [-AllowHttp] - [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] [-S2SCertificateName ] - [-EditingEnabled] [-Proxy ] [-LogLocation ] [-LogRetentionInDays ] - [-LogVerbosity ] [-CacheLocation ] [-MaxMemoryCacheSizeInMB ] - [-DocumentInfoCacheSize ] [-CacheSizeInGB ] [-ClipartEnabled] [-TranslationEnabled] - [-MaxTranslationCharacterCount ] [-TranslationServiceAppId ] - [-TranslationServiceAddress ] [-RenderingLocalCacheLocation ] - [-RecycleActiveProcessCount ] [-AllowCEIP] [-ExcelRequestDurationMax ] - [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] [-ExcelPrivateBytesMax ] - [-ExcelConnectionLifetime ] [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] - [-ExcelUseEffectiveUserName] [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] - [-ExcelMemoryCacheThreshold ] [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] - [-ExcelAbortOnRefreshOnOpenFail] [-ExcelAutomaticVolatileFunctionCacheLifeTime ] - [-ExcelConcurrentDataRequestsPerSessionMax ] [-ExcelDefaultWorkbookCalcMode ] - [-ExcelRestExternalDataEnabled] [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] - [-OpenFromUncEnabled] [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] - [-RemovePersonalInformationFromLogs] [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] +New-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] + [-AllowHttp] [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] + [-S2SCertificateName ] [-EditingEnabled] [-Proxy ] [-LogLocation ] + [-LogRetentionInDays ] [-LogVerbosity ] [-CacheLocation ] + [-MaxMemoryCacheSizeInMB ] [-DocumentInfoCacheSize ] [-CacheSizeInGB ] + [-ClipartEnabled] [-TranslationEnabled] [-MaxTranslationCharacterCount ] + [-TranslationServiceAppId ] [-TranslationServiceAddress ] + [-RenderingLocalCacheLocation ] [-RecycleActiveProcessCount ] [-AllowCEIP] + [-ExcelRequestDurationMax ] [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] + [-ExcelPrivateBytesMax ] [-ExcelConnectionLifetime ] + [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] [-ExcelUseEffectiveUserName] + [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] [-ExcelMemoryCacheThreshold ] + [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] [-ExcelAbortOnRefreshOnOpenFail] + [-ExcelAutomaticVolatileFunctionCacheLifeTime ] + [-ExcelConcurrentDataRequestsPerSessionMax ] + [-ExcelDefaultWorkbookCalcMode ] [-ExcelRestExternalDataEnabled] + [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] [-OpenFromUncEnabled] + [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] [-RemovePersonalInformationFromLogs] + [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The New-OfficeWebAppsFarm cmdlet creates a new Office Online Server farm on the local computer. -You run this cmdlet on the first server in the Office Online Server farm and then add more servers to the farm by using the New-OfficeWebAppsMachine cmdlet. + +The New-OfficeWebAppsFarm cmdlet creates a new Office Online Server farm on the local computer. You +run this cmdlet on the first server in the Office Online Server farm and then add more servers to +the farm by using the New-OfficeWebAppsMachine cmdlet. ## EXAMPLES ### EXAMPLE 1 + ``` New-OfficeWebAppsFarm -ExternalUrl "https://office.contoso.com" -CertificateName "Office Server Cert" -EditingEnabled:$true ``` -This example creates an Office Online Server farm on the local server that has editing enabled for Office in a browser. With this example, only a single URL is used for both internal and external users. The Certificate Name value is the Friendly Name of the certificate as it appears in the Computer's certificate store. +This example creates an Office Online Server farm on the local server that has editing enabled for +Office in a browser. With this example, only a single URL is used for both internal and external +users. The Certificate Name value is the Friendly Name of the certificate as it appears in the +Computer's certificate store. ## PARAMETERS ### -AllowCEIP -Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online Server farm. + +Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online +Server farm. ```yaml Type: SwitchParameter @@ -67,8 +78,10 @@ Accept wildcard characters: False ``` ### -AllowHttp -Indicates that IIS sites should be provisioned on port 80 for HTTP access. -Use AllowHTTP only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. + +Indicates that IIS sites should be provisioned on port 80 for HTTP access. Use AllowHTTP only in +environments where all computers require IPSEC (full encryption) or in test environments that do not +contain sensitive files. Enabled automatically when you enable SSLOffloaded. @@ -85,10 +98,12 @@ Accept wildcard characters: False ``` ### -AllowHttpSecureStoreConnections + Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). The default is False. -Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. +Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full +encryption) or in test environments that do not contain sensitive files. ```yaml Type: SwitchParameter @@ -103,6 +118,7 @@ Accept wildcard characters: False ``` ### -AllowOutboundHttp + Allows outbound HTTP connections from Office Online Server. ```yaml @@ -118,8 +134,9 @@ Accept wildcard characters: False ``` ### -CacheLocation -Specifies the location of the global disk cache that is used to store rendered image files. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\d\. + +Specifies the location of the global disk cache that is used to store rendered image files. The +default location is `%programdata%\Microsoft\OfficeWebApps\Working\d\`. ```yaml Type: String @@ -134,10 +151,11 @@ Accept wildcard characters: False ``` ### -CacheSizeInGB + Specifies the maximum size of the global disk cache in gigabytes. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 15 GB. +The type must be an integer value in the range of 0 to any positive integer. The default size is 15 +GB. ```yaml Type: Int32 @@ -152,14 +170,18 @@ Accept wildcard characters: False ``` ### -CertificateName -Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS bindings. -If the specified certificate is not found or has expired, or if the specified value is associated with more than one certificate, an error is logged and the farm is not created. +Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS +bindings. -This value is used on every server that joins the Office Online Server farm. -Therefore, every server in the farm must have a certificate that has this friendly name. +If the specified certificate is not found or has expired, or if the specified value is associated +with more than one certificate, an error is logged and the farm is not created. -You don't have to specify the CertificateName parameter if you are using either the AllowHttp or SSLOffloaded parameter. +This value is used on every server that joins the Office Online Server farm. Therefore, every server +in the farm must have a certificate that has this friendly name. + +You don't have to specify the CertificateName parameter if you are using either the AllowHttp or +SSLOffloaded parameter. ```yaml Type: String @@ -174,11 +196,12 @@ Accept wildcard characters: False ``` ### -ClipartEnabled -Enables support for inserting Bing images into Office documents. -This feature requires server-to-web communication, configured either directly or by using a proxy that you specify by using the Proxy parameter. -The OpenFromUrlEnabled parameter must be set to True for Bing Images to work.. -The default is False. +Enables support for inserting Bing images into Office documents. This feature requires server-to-web +communication, configured either directly or by using a proxy that you specify by using the Proxy +parameter. + +The OpenFromUrlEnabled parameter must be set to True for Bing Images to work.. The default is False. ```yaml Type: SwitchParameter @@ -193,8 +216,9 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters + +Prompts you for confirmation before executing the command. For more information, type the following +command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -209,6 +233,7 @@ Accept wildcard characters: False ``` ### -DocumentInfoCacheSize + Specifies the maximum number of document conversion records that are stored in a memory cache. The default value is 5000 records. @@ -226,9 +251,9 @@ Accept wildcard characters: False ``` ### -EditingEnabled -Enables support for editing in the browser. -The default is False. -Only set to True if you have the appropriate licensing to use the editing functionality. + +Enables support for editing in the browser. The default is False. Only set to True if you have the +appropriate licensing to use the editing functionality. ```yaml Type: SwitchParameter @@ -243,8 +268,9 @@ Accept wildcard characters: False ``` ### -ExcelAbortOnRefreshOnOpenFail -Prevents a workbook from loading if data refresh fails. -This helps prevent users from seeing out-of-date information or possibly information that they should not have access to. + +Prevents a workbook from loading if data refresh fails. This helps prevent users from seeing +out-of-date information or possibly information that they should not have access to. ```yaml Type: SwitchParameter @@ -259,8 +285,9 @@ Accept wildcard characters: False ``` ### -ExcelAllowExternalData -Enables the refresh of supported external data in Excel workbooks in a browser where workbooks contain connections to external data. -The default is True. + +Enables the refresh of supported external data in Excel workbooks in a browser where workbooks +contain connections to external data. The default is True. ```yaml Type: SwitchParameter @@ -275,10 +302,13 @@ Accept wildcard characters: False ``` ### -ExcelAutomaticVolatileFunctionCacheLifeTime -Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. --1: Calculates once when the workbook loads. -0: Always calculates. -1 to 2073600: Caches 1 second to 24 days. + +Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for +automatic recalculations. + +- -1: Calculates once when the workbook loads. +- 0: Always calculates. +- 1 to 2073600: Caches 1 second to 24 days. ```yaml Type: Int32 @@ -293,6 +323,7 @@ Accept wildcard characters: False ``` ### -ExcelCachingUnusedFiles + Enable caching of files that are no longer in use by Web Excel sessions. ```yaml @@ -308,8 +339,9 @@ Accept wildcard characters: False ``` ### -ExcelChartAndImageSizeMax -Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a browser. -The value must be an integer greater than 0. + +Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a +browser. The value must be an integer greater than 0. ```yaml Type: Int32 @@ -324,8 +356,9 @@ Accept wildcard characters: False ``` ### -ExcelConcurrentDataRequestsPerSessionMax -Specifies the maximum number of concurrent external data requests allowed in each session. -If a session must issue more than this number of requests, additional requests are queued. + +Specifies the maximum number of concurrent external data requests allowed in each session. If a +session must issue more than this number of requests, additional requests are queued. ```yaml Type: Int32 @@ -340,8 +373,9 @@ Accept wildcard characters: False ``` ### -ExcelConnectionLifetime -Specifies the duration, in seconds, of external data connections for Excel in a browser. -The default is 1800 seconds. + +Specifies the duration, in seconds, of external data connections for Excel in a browser. The default +is 1800 seconds. ```yaml Type: Int32 @@ -356,6 +390,7 @@ Accept wildcard characters: False ``` ### -ExcelDefaultWorkbookCalcMode + PARAMVALUE: File | Manual | Auto | AutoDataTables ```yaml @@ -371,8 +406,9 @@ Accept wildcard characters: False ``` ### -ExcelExternalDataCacheLifetime -Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. -The default is 300 seconds. + +Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. The +default is 300 seconds. ```yaml Type: Int32 @@ -387,9 +423,10 @@ Accept wildcard characters: False ``` ### -ExcelMemoryCacheThreshold -The percentage of the Maximum Private Bytes that can be allocated to inactive objects. -When the memory cache threshold is exceeded, cached objects that are not currently in use are released. -Valid values: 0 (disables caching of inactive objects); from 1 through 95. + +The percentage of the Maximum Private Bytes that can be allocated to inactive objects. When the +memory cache threshold is exceeded, cached objects that are not currently in use are released. Valid +values: 0 (disables caching of inactive objects); from 1 through 95. ```yaml Type: Int32 @@ -404,11 +441,11 @@ Accept wildcard characters: False ``` ### -ExcelPrivateBytesMax -Specifies the maximum private bytes, in megabytes, used by Excel in a browser. -When set to -1, the maximum private bytes use 50 percent of physical memory on the computer. -The type must be -1 or any positive integer. -The default value is -1. +Specifies the maximum private bytes, in megabytes, used by Excel in a browser. When set to -1, the +maximum private bytes use 50 percent of physical memory on the computer. + +The type must be -1 or any positive integer. The default value is -1. ```yaml Type: Int32 @@ -423,11 +460,11 @@ Accept wildcard characters: False ``` ### -ExcelRequestDurationMax -Specifies the maximum duration, in seconds, for a single request in a session. -After this time elapses, the request times out. -The type must be -1 (no limit) or an integer in the range of 1 to 2073600. -The default value is 300. +Specifies the maximum duration, in seconds, for a single request in a session. After this time +elapses, the request times out. + +The type must be -1 (no limit) or an integer in the range of 1 to 2073600. The default value is 300. ```yaml Type: Int32 @@ -442,10 +479,9 @@ Accept wildcard characters: False ``` ### -ExcelRestExternalDataEnabled -Allow requests from the REST API to refresh external data connections. -This setting has no effect if Allow External Data is set to None. -Check box Bool. -Default is False. + +Allow requests from the REST API to refresh external data connections. This setting has no effect if +Allow External Data is set to None. Check box Bool. Default is False. ```yaml Type: SwitchParameter @@ -460,14 +496,14 @@ Accept wildcard characters: False ``` ### -ExcelSessionTimeout -Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no user activity. -Valid values include the following: --1 Session never expires. +Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no +user activity. Valid values include the following: -0 Session expires at the end of a single request. +- -1 Session never expires. +- 0 Session expires at the end of a single request. +- 1 to 2073600Session remains active for 1 second to 24 days. -1 to 2073600Session remains active for 1 second to 24 days. The default value is 450. ```yaml @@ -483,8 +519,8 @@ Accept wildcard characters: False ``` ### -ExcelUdfsAllowed -Enables User Defined Functions for Excel in a browser. -The default is False. + +Enables User Defined Functions for Excel in a browser. The default is False. ```yaml Type: SwitchParameter @@ -499,9 +535,15 @@ Accept wildcard characters: False ``` ### -ExcelUnusedObjectAgeMax -The maximum time (in minutes) that inactive objects remain in the memory cache. -Inactive objects are objects that are not used in a session. -Valid values: -1 (no maximum); from 1 through 34560 (24 days). + +The maximum time (in minutes) that inactive objects remain in the memory cache. Inactive objects are +objects that are not used in a session. + +Valid values: + +- -1 (no maximum) +- 1 through 34560 (24 days). + Default is -1. ```yaml @@ -517,8 +559,9 @@ Accept wildcard characters: False ``` ### -ExcelUseEffectiveUserName -Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. -The default is False. + +Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. The +default is False. ```yaml Type: SwitchParameter @@ -533,6 +576,7 @@ Accept wildcard characters: False ``` ### -ExcelWarnOnDataRefresh + Turns off or on the warning dialog displayed when data refreshes in Excel in a browser. ```yaml @@ -548,10 +592,10 @@ Accept wildcard characters: False ``` ### -ExcelWorkbookSizeMax + Specifies the maximum size, in megabytes, of a workbook that can be loaded. -The type must be an integer value in the range of 1 to 2000. -The default value is 10. +The type must be an integer value in the range of 1 to 2000. The default value is 10. ```yaml Type: Int32 @@ -566,8 +610,10 @@ Accept wildcard characters: False ``` ### -ExternalURL + Specifies the URL root that clients use to access the Office Online Server farm from the Internet. -In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to the IP address of the external-facing load balancer. +In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to +the IP address of the external-facing load balancer. An Office Online Server farm requires at least one URL, set using either ExternalURL or InternalURL. You can also set both internal and external URLs. @@ -585,8 +631,10 @@ Accept wildcard characters: False ``` ### -FarmOU -Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of to join the Office Online Server farm. -Use this parameter to prevent unauthorized servers (that is, servers that are not in the OU) from joining an Office Online Server farm. + +Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of +to join the Office Online Server farm. Use this parameter to prevent unauthorized servers (that is, +servers that are not in the OU) from joining an Office Online Server farm. ```yaml Type: String @@ -601,6 +649,7 @@ Accept wildcard characters: False ``` ### -Force + Suppresses any user prompts by answering Yes. ```yaml @@ -616,6 +665,7 @@ Accept wildcard characters: False ``` ### -InternalURL + Specifies the URL root that clients use to access the Office Online Server farm from the intranet. An Office Online Server farm requires at least one URL, set using either ExternalURL or InternalURL. @@ -634,10 +684,11 @@ Accept wildcard characters: False ``` ### -LogLocation + Specifies the location on the local computer where activity logs are stored. The location applies for every server in the farm and cannot be customized on a per-server basis. -The default location is %programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\`. Be sure to allow sufficient disk space on the drive on which logs are stored. @@ -654,11 +705,10 @@ Accept wildcard characters: False ``` ### -LogRetentionInDays -Specifies the number of days that log entries are stored. -Log entries older than the configured date are trimmed. -The type must be an integer value in the range of 0 to 365. -The default value is 7 days. +Specifies the number of days that log entries are stored. Log entries older than the configured date +are trimmed. The type must be an integer value in the range of 0 to 365. The default value is 7 +days. ```yaml Type: UInt32 @@ -673,25 +723,22 @@ Accept wildcard characters: False ``` ### -LogVerbosity -Specifies how much information is stored in the trace log files. -The values are as follows: - -VerboseEX writes low-level detail to the trace log file. -Useful for traces that are likely to be high volume. - -Verbose writes low-level detail to the trace log file. - -Medium writes medium-level detail to the trace log file. - -High writes high-level detail to the trace log file. -Monitorable writes traces that represent an unusual code path and actions that should be monitored. +Specifies how much information is stored in the trace log files. The values are as follows: -Unexpected writes traces that represent an unexpected code path and actions that should be monitored. +- VerboseEX writes low-level detail to the trace log file. Useful for traces that are likely to be + high volume. +- Verbose writes low-level detail to the trace log file. +- Medium writes medium-level detail to the trace log file. +- High writes high-level detail to the trace log file. +- Monitorable writes traces that represent an unusual code path and actions that should be + monitored. +- Unexpected writes traces that represent an unexpected code path and actions that should be + monitored. +- None writes no trace information to the trace log file. -None writes no trace information to the trace log file. - -Leaving the LogVerbosity at a low level for an extended period of time will negatively impact performance. +Leaving the LogVerbosity at a low level for an extended period of time will negatively impact +performance. ```yaml Type: String @@ -706,10 +753,9 @@ Accept wildcard characters: False ``` ### -MaxMemoryCacheSizeInMB -Specifies, in megabytes, the maximum amount of memory that the rendering cache can use. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 75 MB. +Specifies, in megabytes, the maximum amount of memory that the rendering cache can use. The type +must be an integer value in the range of 0 to any positive integer. The default size is 75 MB. ```yaml Type: Int32 @@ -724,11 +770,10 @@ Accept wildcard characters: False ``` ### -MaxTranslationCharacterCount -Specifies the maximum amount of characters a document can have in order to be translated. -The type must be an integer value. -The value can be set to 0 to indicate no limit or a value from 2000 to 2,000,000. -The default value is 125,000. +Specifies the maximum amount of characters a document can have in order to be translated. The type +must be an integer value. The value can be set to 0 to indicate no limit or a value from 2000 to +2,000,000. The default value is 125,000. ```yaml Type: Int32 @@ -743,9 +788,9 @@ Accept wildcard characters: False ``` ### -OpenFromUncEnabled -Turns on or off the ability to use Online Viewers to view Office files from a UNC path. -You must first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths. +Turns on or off the ability to use Online Viewers to view Office files from a UNC path. You must +first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths. ```yaml Type: SwitchParameter @@ -760,10 +805,9 @@ Accept wildcard characters: False ``` ### -OpenFromUrlEnabled -Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path. -The default is False. -You must set this parameter to True when you use ClipartEnabled. +Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path. The +default is False. You must set this parameter to True when you use ClipartEnabled. ```yaml Type: SwitchParameter @@ -778,8 +822,10 @@ Accept wildcard characters: False ``` ### -OpenFromUrlThrottlingEnabled -Throttles the number of Open From URL requests from any given server in a time period. -The default throttling values, which are not configurable, make sure that an Office Online Server farm will not overwhelm a single server with requests for content to be viewed in the Online Viewers. + +Throttles the number of Open From URL requests from any given server in a time period. The default +throttling values, which are not configurable, make sure that an Office Online Server farm will not +overwhelm a single server with requests for content to be viewed in the Online Viewers. ```yaml Type: SwitchParameter @@ -794,9 +840,10 @@ Accept wildcard characters: False ``` ### -PicturePasteDisabled -Turns off the ability for users to paste images from a web page into Office in a browser. -The default is False. -If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to False, users can paste images into Office in a browser. + +Turns off the ability for users to paste images from a web page into Office in a browser. The +default is False. If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to +False, users can paste images into Office in a browser. ```yaml Type: SwitchParameter @@ -811,6 +858,7 @@ Accept wildcard characters: False ``` ### -Proxy + Specifies the URL of the proxy server that is configured to allow HTTP requests to external sites. Typically configured in conjunction with the ClipartEnabled and TranslationEnabled parameters. @@ -827,10 +875,9 @@ Accept wildcard characters: False ``` ### -RecycleActiveProcessCount -Specifies the number of files that a single Word or PowerPoint process can render before the process is recycled. -The type must be an integer value in the range of 1 to 1000. -The default value is 5. +Specifies the number of files that a single Word or PowerPoint process can render before the process +is recycled. The type must be an integer value in the range of 1 to 1000. The default value is 5. ```yaml Type: UInt32 @@ -845,19 +892,17 @@ Accept wildcard characters: False ``` ### -RemovePersonalInformationFromLogs -Provides a best effort scrub of personal information from Office Online Server logs and replaces values with a SHA256 hash. -Potentially scrubbed information can be: - -Document names and URLs - -IP addresses -Email addresses +Provides a best effort scrub of personal information from Office Online Server logs and replaces +values with a SHA256 hash. Potentially scrubbed information can be: -User names +- Document names and URLs +- IP addresses +- Email addresses +- User names -The default is False. -Note that enabling this parameter doesn't guarantee that personal information won't be logged to the Office Online Server logs. +The default is False. Note that enabling this parameter doesn't guarantee that personal information +won't be logged to the Office Online Server logs. ```yaml Type: SwitchParameter @@ -872,9 +917,10 @@ Accept wildcard characters: False ``` ### -RenderingLocalCacheLocation + Specifies the location of the temporary cache for use by the Word and PowerPoint Viewing Services. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\waccache\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Working\waccache\`. ```yaml Type: String @@ -889,7 +935,9 @@ Accept wildcard characters: False ``` ### -S2SCertificateName -The friendly name of the certificate to use for server-to-server authentication with SharePoint Server. + +The friendly name of the certificate to use for server-to-server authentication with SharePoint +Server. ```yaml Type: String @@ -904,9 +952,11 @@ Accept wildcard characters: False ``` ### -SSLOffloaded -Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load balancer. -When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local server. -However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for those references. + +Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load +balancer. When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local +server. However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for +those references. ```yaml Type: SwitchParameter @@ -921,9 +971,11 @@ Accept wildcard characters: False ``` ### -TranslationEnabled -Enables support for automatic document translation using Microsoft Translator, an online service that translates text between languages. -The translated file is shown in Word. -Because Microsoft Translator is an online service, you must enable server-to-web communication directly or by using a proxy that you specify by using the Proxy parameter. + +Enables support for automatic document translation using Microsoft Translator, an online service +that translates text between languages. The translated file is shown in Word. Because Microsoft +Translator is an online service, you must enable server-to-web communication directly or by using a +proxy that you specify by using the Proxy parameter. Microsoft Translator may collect data to improve the quality of translations. @@ -940,9 +992,10 @@ Accept wildcard characters: False ``` ### -TranslationServiceAddress -Specifies the URL of the translation server that translation requests are sent to. -The default is the Microsoft Translator online service. -Typically you will not use this parameter unless you must change translation services. + +Specifies the URL of the translation server that translation requests are sent to. The default is +the Microsoft Translator online service. Typically you will not use this parameter unless you must +change translation services. ```yaml Type: String @@ -957,9 +1010,11 @@ Accept wildcard characters: False ``` ### -TranslationServiceAppId -Specifies the application ID for the translation service. -The default is the public application ID for Office in a browser. -Typically you will not use this parameter unless you have negotiated with Microsoft Translator for additional services and they have provided you with a private application ID. + +Specifies the application ID for the translation service. The default is the public application ID +for Office in a browser. Typically you will not use this parameter unless you have negotiated with +Microsoft Translator for additional services and they have provided you with a private application +ID. ```yaml Type: String @@ -974,8 +1029,9 @@ Accept wildcard characters: False ``` ### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters + +Displays a message that describes the effect of the command instead of executing the command. For +more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md index 4a20df4902..a0f6c9701d 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsHost ## SYNOPSIS + Adds a host domain to the Allow List for an Office Online Server farm. ## SYNTAX @@ -21,35 +22,41 @@ New-OfficeWebAppsHost -Domain ``` ## DESCRIPTION -The New-OfficeWebAppsHost cmdlet adds a host domain to the list of host domains to which Office Online Server allows file operations requests, such as file retrieval, metadata retrieval, and file changes. -This list, known as the Allow List, is a security feature that prevents unwanted hosts from connecting to an Office Online Server farm and using it for file operations without your knowledge. -You may any domain type including: Public, Pool, Farm, and Active Directory domain names. -Just make sure that the domain you're granting access to meets your security requirements. +The New-OfficeWebAppsHost cmdlet adds a host domain to the list of host domains to which Office +Online Server allows file operations requests, such as file retrieval, metadata retrieval, and file +changes. This list, known as the Allow List, is a security feature that prevents unwanted hosts from +connecting to an Office Online Server farm and using it for file operations without your knowledge. + +You may any domain type including: Public, Pool, Farm, and Active Directory domain names. Just make +sure that the domain you're granting access to meets your security requirements. -The wildcard * is assumed for any domain that is added to the Allow List so that requests to all subdomains are also allowed. -For example, if you add the domain contoso.com to the Allow List, Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. +The wildcard * is assumed for any domain that is added to the Allow List so that requests to all +subdomains are also allowed. For example, if you add the domain contoso.com to the Allow List, +Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. Requests to other domains (such as fabrikam.com) are not allowed. -If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any domain. -Do not leave this list blank if your Office Online Server farm is accessible from the Internet. -Otherwise anyone can use your Office Online Server farm to view and edit content. +If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any +domain. Do not leave this list blank if your Office Online Server farm is accessible from the +Internet. Otherwise anyone can use your Office Online Server farm to view and edit content. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell New-OfficeWebAppsHost -domain "contoso.com" ``` This example adds the domain contoso.com to the Allow List. -You cannot add multiple host domains to the Allow List all at the same time. -You must run the New-OfficeWebAppsHost cmdlet for each host domain that you want to add to the Allow List. +You cannot add multiple host domains to the Allow List all at the same time. You must run the +New-OfficeWebAppsHost cmdlet for each host domain that you want to add to the Allow List. ## PARAMETERS ### -Domain + Specifies the domain to add to the Allow List. Do not specify an asterisk or start it with a period. diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md index 7499d63f1c..a3fe411c10 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsMachine ## SYNOPSIS + Adds the current server to an existing Office Online Server farm. ## SYNTAX @@ -21,20 +22,25 @@ New-OfficeWebAppsMachine [-Force] [-MachineToJoin] [-Roles ] ``` ## DESCRIPTION -The New-OfficeWebAppsMachine cmdlet adds the current server to an existing Office Online Server farm and optionally sets one or more roles on the new server. + +The New-OfficeWebAppsMachine cmdlet adds the current server to an existing Office Online Server farm +and optionally sets one or more roles on the new server. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell New-OfficeWebAppsMachine -MachineToJoin server1.contoso.com ``` -This example adds the current server to the Office Online Server farm that is running on the server named server1.contoso.com. +This example adds the current server to the Office Online Server farm that is running on the server +named server1.contoso.com. ## PARAMETERS ### -MachineToJoin + Specifies the name of any server that is already a member of the Office Online Server farm. ```yaml @@ -50,8 +56,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -66,6 +72,7 @@ Accept wildcard characters: False ``` ### -Force + Assumes the answer to any user prompt is Yes. ```yaml @@ -81,18 +88,16 @@ Accept wildcard characters: False ``` ### -Roles -Specifies one or more server roles, separated by commas, to assign to the new server. -If no roles are specified, then the server is assigned all roles. - -The role types are as follows: -FrontEnd +Specifies one or more server roles, separated by commas, to assign to the new server. If no roles +are specified, then the server is assigned all roles. -WordBackEnd - -ExcelBackEnd +The role types are as follows: -PowerPointBackEnd +- FrontEnd +- WordBackEnd +- ExcelBackEnd +- PowerPointBackEnd As a best practice, we recommend that all servers in an Office Online Server farm run all roles. Assigning roles is not useful until the Office Online Server farm contains approximately 50 servers. @@ -110,8 +115,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md index a77ac79a21..3c771412ea 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md @@ -12,7 +12,9 @@ ms.reviewer: # Remove-OfficeWebAppsExcelBIServer ## SYNOPSIS -Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel Online. + +Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel +Online. ## SYNTAX @@ -21,24 +23,30 @@ Remove-OfficeWebAppsExcelBIServer -ServerId ``` ## DESCRIPTION -Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel Online. + +Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel +Online. ## EXAMPLES -### This example removes the server named SSAS01 from the Allow List. -``` +### Example 1 + +This example removes the server named SSAS01 from the Allow List. + +```powershell Remove-OfficeWebAppsExcelBIServer -ServerID "SSAS01" ``` ## PARAMETERS ### -ServerId + The name of the Analysis Services server. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md index 6fb132b9ed..2548862222 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # Remove-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Removes an existing UDF definition. ## SYNTAX @@ -21,24 +22,29 @@ Remove-OfficeWebAppsExcelUserDefinedFunction [-Identity] [ ``` ## DESCRIPTION + Removes an existing UDF definition. ## EXAMPLES -### This example removes the UDF c:\myudf.dll. -``` +### Example 1 + +This example removes the UDF c:\myudf.dll. + +```powershell Remove-OfficeWebAppsExcelUserDefinedFunction -Identity c:\myudf.dll ``` ## PARAMETERS ### -Identity + The path and filename of the UDF. ```yaml Type: UserDefinedFunction Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -48,8 +54,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -64,8 +70,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md index f1e314a029..bf5d6e8f6c 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md @@ -12,6 +12,7 @@ ms.reviewer: # Remove-OfficeWebAppsHost ## SYNOPSIS + Removes a host domain from the Allow List for an Office Online Server farm. ## SYNTAX @@ -21,17 +22,19 @@ Remove-OfficeWebAppsHost -Domain ``` ## DESCRIPTION -The Remove-OfficeWebAppsHost cmdlet removes the specified host domain from the Allow List. -The Allow List contains the host domains to which Office Online Server allows file operations requests. -If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any domain. -Do not leave this list blank if your Office Online Server farm is accessible from the Internet. -Otherwise anyone can use your Office Online Server farm to view and edit content. +The Remove-OfficeWebAppsHost cmdlet removes the specified host domain from the Allow List. The Allow +List contains the host domains to which Office Online Server allows file operations requests. + +If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any +domain. Do not leave this list blank if your Office Online Server farm is accessible from the +Internet. Otherwise anyone can use your Office Online Server farm to view and edit content. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Remove-OfficeWebAppsHost -domain "contoso.com" ``` @@ -40,6 +43,7 @@ This example removes the domain contoso.com from the Allow List. ## PARAMETERS ### -Domain + Specifies the host domain to remove from the Allow List. ```yaml diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md index 2abe880dfe..1b256e19b4 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # Remove-OfficeWebAppsMachine ## SYNOPSIS + Removes the current server from the Office Online Server farm. ## SYNTAX @@ -21,16 +22,22 @@ Remove-OfficeWebAppsMachine [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The Remove-OfficeWebAppsMachine cmdlet removes the current server from the Office Online Server farm. -As part of this process, the cmdlet removes the web applications and shuts down the services that are related to Office Online Server. -If you cannot run the Remove-OfficeWebAppsMachine cmdlet from the server that you want to remove, use the Repair-OfficeWebAppsFarm cmdlet from any other server in the Office Online farm. -If the local server is designated as the master server in the Office Online Server farm, you cannot remove it from the farm until you assign a different server as master by using the Set-OfficeWebAppsMachine cmdlet, or until you remove all other servers from the farm. +The Remove-OfficeWebAppsMachine cmdlet removes the current server from the Office Online Server +farm. As part of this process, the cmdlet removes the web applications and shuts down the services +that are related to Office Online Server. If you cannot run the Remove-OfficeWebAppsMachine cmdlet +from the server that you want to remove, use the Repair-OfficeWebAppsFarm cmdlet from any other +server in the Office Online farm. + +If the local server is designated as the master server in the Office Online Server farm, you cannot +remove it from the farm until you assign a different server as master by using the +Set-OfficeWebAppsMachine cmdlet, or until you remove all other servers from the farm. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Remove-OfficeWebAppsMachine ``` @@ -39,8 +46,8 @@ This example removes the current server from the Office Online Server farm. ## PARAMETERS ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -55,8 +62,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md index e2f822e3bb..b30252119d 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md @@ -12,6 +12,7 @@ ms.reviewer: # Repair-OfficeWebAppsFarm ## SYNOPSIS + Removes all servers flagged as unhealthy from an Office Online Server farm. ## SYNTAX @@ -21,25 +22,30 @@ Repair-OfficeWebAppsFarm [-Force] [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The Repair-OfficeWebAppsFarm cmdlet removes all servers flagged as unhealthy from an Office Online Server farm. -This cmdlet updates the farm topology but does not clean up services and web applications on the servers that are removed. -For this reason, we recommend making every effort to run the Remove-OfficeWebAppsMachine cmdlet from the unhealthy servers so that they are cleanly removed from the farm. -Use the Repair-OfficeWebAppsFarm cmdlet only if the unhealthy servers have failed and you cannot run the Remove-OfficeWebAppsMachine cmdlet directly on them. -If there are multiple unhealthy servers, you are prompted before each server is removed. -If there are no unhealthy servers, this cmdlet does nothing. +The Repair-OfficeWebAppsFarm cmdlet removes all servers flagged as unhealthy from an Office Online +Server farm. This cmdlet updates the farm topology but does not clean up services and web +applications on the servers that are removed. For this reason, we recommend making every effort to +run the Remove-OfficeWebAppsMachine cmdlet from the unhealthy servers so that they are cleanly +removed from the farm. Use the Repair-OfficeWebAppsFarm cmdlet only if the unhealthy servers have +failed and you cannot run the Remove-OfficeWebAppsMachine cmdlet directly on them. + +If there are multiple unhealthy servers, you are prompted before each server is removed. If there +are no unhealthy servers, this cmdlet does nothing. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell (Get-OfficeWebAppsFarm).Machines ``` This example displays the health status of all servers in the Office Online Server farm. ### EXAMPLE 2 -``` + +```powershell Repair-OfficeWebAppsFarm ``` @@ -48,8 +54,8 @@ This example removes all unhealthy servers from the Office Online Server farm. ## PARAMETERS ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -64,6 +70,7 @@ Accept wildcard characters: False ``` ### -Force + Assumes the answer to any user prompt is Yes. ```yaml @@ -79,8 +86,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md index 3f8b966834..cdbf52285b 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # Set-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Sets properties on existing UDF definitions. ## SYNTAX @@ -22,24 +23,29 @@ Set-OfficeWebAppsExcelUserDefinedFunction [-Identity] [-As ``` ## DESCRIPTION + Sets properties on existing UDF definitions. ## EXAMPLES -### This example disables the UDF at c:\myudf.dll. -``` +### Example 1 + +This example disables the UDF at c:\myudf.dll. + +```powershell Set-OfficeWebAppsExcelUserDefinedFunction -Identity c:\myudf.dll -Enable:$false ``` ## PARAMETERS ### -Identity + The path and filename of the UDF. ```yaml Type: UserDefinedFunction Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -49,12 +55,13 @@ Accept wildcard characters: False ``` ### -Assembly + The name of the assembly. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -64,13 +71,18 @@ Accept wildcard characters: False ``` ### -AssemblyLocation + The location of the assembly. -Values: LocalFile - a local directory; GAC - the Global Assembly Cache. + +Values: + +- LocalFile - a local directory +- GAC - the Global Assembly Cache ```yaml Type: AssemblyLocation Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -80,8 +92,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -96,12 +108,13 @@ Accept wildcard characters: False ``` ### -Description + A description of the assembly. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -111,12 +124,13 @@ Accept wildcard characters: False ``` ### -Enable + Enables the UDF. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -126,8 +140,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md index 9f29a6748d..68a1b316c3 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md @@ -12,51 +12,58 @@ ms.reviewer: # Set-OfficeWebAppsFarm ## SYNOPSIS + Configures the settings of an existing Office Online Server farm. ## SYNTAX ``` -Set-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] [-AllowHttp] - [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] [-S2SCertificateName ] - [-EditingEnabled] [-Proxy ] [-LogLocation ] [-LogRetentionInDays ] - [-LogVerbosity ] [-CacheLocation ] [-MaxMemoryCacheSizeInMB ] - [-DocumentInfoCacheSize ] [-CacheSizeInGB ] [-ClipartEnabled] [-TranslationEnabled] - [-MaxTranslationCharacterCount ] [-TranslationServiceAppId ] - [-TranslationServiceAddress ] [-RenderingLocalCacheLocation ] - [-RecycleActiveProcessCount ] [-AllowCEIP] [-ExcelRequestDurationMax ] - [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] [-ExcelPrivateBytesMax ] - [-ExcelConnectionLifetime ] [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] - [-ExcelUseEffectiveUserName] [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] - [-ExcelMemoryCacheThreshold ] [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] - [-ExcelAbortOnRefreshOnOpenFail] [-ExcelAutomaticVolatileFunctionCacheLifeTime ] - [-ExcelConcurrentDataRequestsPerSessionMax ] [-ExcelDefaultWorkbookCalcMode ] - [-ExcelRestExternalDataEnabled] [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] - [-OpenFromUncEnabled] [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] - [-RemovePersonalInformationFromLogs] [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] +Set-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] + [-AllowHttp] [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] + [-S2SCertificateName ] [-EditingEnabled] [-Proxy ] [-LogLocation ] + [-LogRetentionInDays ] [-LogVerbosity ] [-CacheLocation ] + [-MaxMemoryCacheSizeInMB ] [-DocumentInfoCacheSize ] [-CacheSizeInGB ] + [-ClipartEnabled] [-TranslationEnabled] [-MaxTranslationCharacterCount ] + [-TranslationServiceAppId ] [-TranslationServiceAddress ] + [-RenderingLocalCacheLocation ] [-RecycleActiveProcessCount ] [-AllowCEIP] + [-ExcelRequestDurationMax ] [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] + [-ExcelPrivateBytesMax ] [-ExcelConnectionLifetime ] + [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] [-ExcelUseEffectiveUserName] + [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] [-ExcelMemoryCacheThreshold ] + [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] [-ExcelAbortOnRefreshOnOpenFail] + [-ExcelAutomaticVolatileFunctionCacheLifeTime ] + [-ExcelConcurrentDataRequestsPerSessionMax ] + [-ExcelDefaultWorkbookCalcMode ] [-ExcelRestExternalDataEnabled] + [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] [-OpenFromUncEnabled] + [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] [-RemovePersonalInformationFromLogs] + [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] ``` ## DESCRIPTION + The Set-OfficeWebAppsFarm cmdlet configures the settings of an existing Office Online Server farm. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Set-OfficeWebAppsFarm -ClipartEnabled:$true ``` This example enables insertion of clip art from Office.com. ### EXAMPLE 2 -``` + +```powershell Set-OfficeWebAppsFarm -EditingEnabled:$true ``` This example enables edit functionality for Office in a browser. ### EXAMPLE 3 -``` + +```powershell Set-OfficeWebAppsFarm -OpenFromUncEnabled:$false ``` @@ -65,7 +72,9 @@ This example turns off the ability to view any Office file from a UNC path. ## PARAMETERS ### -AllowCEIP -Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online Server farm. + +Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online +Server farm. You must restart every server in the Office Online Server farm for this change to take effect. @@ -82,8 +91,10 @@ Accept wildcard characters: False ``` ### -AllowHttp -Indicates that IIS sites should be provisioned on port 80 for HTTP access. -Use AllowHTTP only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. + +Indicates that IIS sites should be provisioned on port 80 for HTTP access. Use AllowHTTP only in +environments where all computers require IPSEC (full encryption) or in test environments that do not +contain sensitive files. Enabled automatically when you enable SSLOffloaded. @@ -102,10 +113,12 @@ Accept wildcard characters: False ``` ### -AllowHttpSecureStoreConnections -Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). -The default is False. -Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. +Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). The +default is False. + +Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full +encryption) or in test environments that do not contain sensitive files. ```yaml Type: SwitchParameter @@ -120,6 +133,7 @@ Accept wildcard characters: False ``` ### -AllowOutboundHttp + Allows outbound HTTP connections from Office Online Server. ```yaml @@ -135,8 +149,9 @@ Accept wildcard characters: False ``` ### -CacheLocation + Specifies the location of the global disk cache that is used to store rendered image files. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\d\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Working\d\`. ```yaml Type: String @@ -151,10 +166,9 @@ Accept wildcard characters: False ``` ### -CacheSizeInGB -Specifies the maximum size of the global disk cache in gigabytes. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 15 GB. +Specifies the maximum size of the global disk cache in gigabytes. The type must be an integer value +in the range of 0 to any positive integer. The default size is 15 GB. ```yaml Type: Int32 @@ -169,14 +183,18 @@ Accept wildcard characters: False ``` ### -CertificateName -Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS bindings. -If the specified certificate is not found or has expired, or if the specified value is associated with more than one certificate, an error is logged and the farm is not created. +Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS +bindings. -This value is used on every server that joins the Office Online Server farm. -Therefore, every server in the farm must have a certificate that has this friendly name. +If the specified certificate is not found or has expired, or if the specified value is associated +with more than one certificate, an error is logged and the farm is not created. -You don't have to specify the CertificateName parameter if you are using either the AllowHttp or SSLOffloaded parameter. +This value is used on every server that joins the Office Online Server farm. Therefore, every server +in the farm must have a certificate that has this friendly name. + +You don't have to specify the CertificateName parameter if you are using either the AllowHttp or +SSLOffloaded parameter. You must restart every server in the farm for this change to take effect. @@ -193,8 +211,10 @@ Accept wildcard characters: False ``` ### -ClipartEnabled -Enables support for inserting clip art from Office.com into Office documents. -This feature requires server-to-web communication, configured either directly or by using a proxy that you specify by using the Proxy parameter. + +Enables support for inserting clip art from Office.com into Office documents. This feature requires +server-to-web communication, configured either directly or by using a proxy that you specify by +using the Proxy parameter. ```yaml Type: SwitchParameter @@ -209,8 +229,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters. ```yaml Type: SwitchParameter @@ -225,6 +245,7 @@ Accept wildcard characters: False ``` ### -DocumentInfoCacheSize + Specifies the maximum number of document conversion records that are stored in a memory cache. The default value is 5000 records. @@ -242,9 +263,9 @@ Accept wildcard characters: False ``` ### -EditingEnabled -Enables support for editing in the browser. -The default is False. -Only set to True if you have the appropriate licensing to use the edit functionality. + +Enables support for editing in the browser. The default is False. Only set to True if you have the +appropriate licensing to use the edit functionality. ```yaml Type: SwitchParameter @@ -259,8 +280,9 @@ Accept wildcard characters: False ``` ### -ExcelAbortOnRefreshOnOpenFail -Prevents a workbook from loading if data refresh fails. -This helps prevent users from seeing out-of-date information or possibly information that they should not have access to. + +Prevents a workbook from loading if data refresh fails. This helps prevent users from seeing +out-of-date information or possibly information that they should not have access to. ```yaml Type: SwitchParameter @@ -275,8 +297,9 @@ Accept wildcard characters: False ``` ### -ExcelAllowExternalData -Enables the refresh of supported external data in Excel workbooks in a browser where workbooks contain connections to external data. -The default is True. + +Enables the refresh of supported external data in Excel workbooks in a browser where workbooks +contain connections to external data. The default is True. ```yaml Type: SwitchParameter @@ -291,10 +314,13 @@ Accept wildcard characters: False ``` ### -ExcelAutomaticVolatileFunctionCacheLifeTime -Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. --1: Calculates once when the workbook loads. -0: Always calculates. -1 to 2073600: Caches 1 second to 24 days. + +Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for +automatic recalculations. + +- -1: Calculates once when the workbook loads. +- 0: Always calculates. +- 1 to 2073600: Caches 1 second to 24 days. ```yaml Type: Int32 @@ -309,6 +335,7 @@ Accept wildcard characters: False ``` ### -ExcelCachingUnusedFiles + Enable caching of files that are no longer in use by Web Excel sessions. ```yaml @@ -324,8 +351,9 @@ Accept wildcard characters: False ``` ### -ExcelChartAndImageSizeMax -Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a browser. -The value must be an integer greater than 0. + +Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a +browser. The value must be an integer greater than 0. ```yaml Type: Int32 @@ -340,8 +368,9 @@ Accept wildcard characters: False ``` ### -ExcelConcurrentDataRequestsPerSessionMax -Specifies the maximum number of concurrent external data requests allowed in each session. -If a session must issue more than this number of requests, additional requests are queued. + +Specifies the maximum number of concurrent external data requests allowed in each session. If a +session must issue more than this number of requests, additional requests are queued. ```yaml Type: Int32 @@ -356,8 +385,9 @@ Accept wildcard characters: False ``` ### -ExcelConnectionLifetime -Specifies the duration, in seconds, of external data connections for Excel in a browser. -The default is 1800 seconds. + +Specifies the duration, in seconds, of external data connections for Excel in a browser. The default +is 1800 seconds. ```yaml Type: Int32 @@ -372,6 +402,7 @@ Accept wildcard characters: False ``` ### -ExcelDefaultWorkbookCalcMode + PARAMVALUE: File | Manual | Auto | AutoDataTables ```yaml @@ -387,8 +418,9 @@ Accept wildcard characters: False ``` ### -ExcelExternalDataCacheLifetime -Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. -The default is 300 seconds. + +Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. The +default is 300 seconds. ```yaml Type: Int32 @@ -403,9 +435,10 @@ Accept wildcard characters: False ``` ### -ExcelMemoryCacheThreshold -The percentage of the Maximum Private Bytes that can be allocated to inactive objects. -When the memory cache threshold is exceeded, cached objects that are not currently in use are released. -Valid values: 0 (disables caching of inactive objects); from 1 through 95. + +The percentage of the Maximum Private Bytes that can be allocated to inactive objects. When the +memory cache threshold is exceeded, cached objects that are not currently in use are released. Valid +values: 0 (disables caching of inactive objects); from 1 through 95. ```yaml Type: Int32 @@ -420,11 +453,11 @@ Accept wildcard characters: False ``` ### -ExcelPrivateBytesMax -Specifies the maximum private bytes, in megabytes, used by Excel in a browser. -When set to -1, the maximum private bytes use 50 percent of physical memory on the computer. -The type must be -1 or any positive integer. -The default value is -1. +Specifies the maximum private bytes, in megabytes, used by Excel in a browser. When set to -1, the +maximum private bytes use 50 percent of physical memory on the computer. + +The type must be -1 or any positive integer. The default value is -1. You must restart every server in the farm for this change to take effect. @@ -441,11 +474,11 @@ Accept wildcard characters: False ``` ### -ExcelRequestDurationMax -Specifies the maximum duration, in seconds, for a single request in a session. -After this time elapses, the request times out. -The type must be -1 (no limit) or an integer in the range of 1 to 2073600. -The default value is 300. +Specifies the maximum duration, in seconds, for a single request in a session. After this time +elapses, the request times out. + +The type must be -1 (no limit) or an integer in the range of 1 to 2073600. The default value is 300. ```yaml Type: Int32 @@ -460,10 +493,9 @@ Accept wildcard characters: False ``` ### -ExcelRestExternalDataEnabled -Allow requests from the REST API to refresh external data connections. -This setting has no effect if Allow External Data is set to None. -Check box Bool. -Default is False. + +Allow requests from the REST API to refresh external data connections. This setting has no effect if +Allow External Data is set to None. Check box Bool. Default is False. ```yaml Type: SwitchParameter @@ -478,14 +510,14 @@ Accept wildcard characters: False ``` ### -ExcelSessionTimeout -Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no user activity. -Valid values include the following: --1 Session never expires. +Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no +user activity. Valid values include the following: -0 Session expires at the end of a single request. +- -1 Session never expires. +- 0 Session expires at the end of a single request. +- 1 to 2073600 Session remains active for 1 second to 24 days. -1 to 2073600 Session remains active for 1 second to 24 days. The default value is 450. ```yaml @@ -501,8 +533,8 @@ Accept wildcard characters: False ``` ### -ExcelUdfsAllowed -Enables User Defined Functions for Excel in a browser. -The default is False. + +Enables User Defined Functions for Excel in a browser. The default is False. ```yaml Type: SwitchParameter @@ -517,9 +549,15 @@ Accept wildcard characters: False ``` ### -ExcelUnusedObjectAgeMax -The maximum time (in minutes) that inactive objects remain in the memory cache. -Inactive objects are objects that are not used in a session. -Valid values: -1 (no maximum); from 1 through 34560 (24 days). + +The maximum time (in minutes) that inactive objects remain in the memory cache. Inactive objects are +objects that are not used in a session. + +Valid values: + +- -1 (no maximum) +- 1 through 34560 (24 days). + Default is -1. ```yaml @@ -535,8 +573,9 @@ Accept wildcard characters: False ``` ### -ExcelUseEffectiveUserName -Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. -The default is False. + +Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. The +default is False. ```yaml Type: SwitchParameter @@ -551,6 +590,7 @@ Accept wildcard characters: False ``` ### -ExcelWarnOnDataRefresh + Turns off or on the warning dialog box that is displayed when data refreshes in Excel in a browser. ```yaml @@ -566,10 +606,10 @@ Accept wildcard characters: False ``` ### -ExcelWorkbookSizeMax + Specifies the maximum size, in megabytes, of a workbook that can be loaded. -The type must be an integer value in the range of 1 to 2000. -The default value is 10. +The type must be an integer value in the range of 1 to 2000. The default value is 10. ```yaml Type: Int32 @@ -584,11 +624,13 @@ Accept wildcard characters: False ``` ### -ExternalURL + Specifies the URL root that clients use to access the Office Online Server farm from the Internet. -In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to the IP address of the external-facing load balancer. +In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to +the IP address of the external-facing load balancer. -An Office Online Server farm requires at least one URL,that isset by using either ExternalURL or InternalURL. -You can also set both internal and external URLs. +An Office Online Server farm requires at least one URL,that isset by using either ExternalURL or +InternalURL. You can also set both internal and external URLs. ```yaml Type: String @@ -603,8 +645,10 @@ Accept wildcard characters: False ``` ### -FarmOU -Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of to join the Office Online Server farm. -Use this parameter to prevent unauthorized servers (that is, servers that are not in the OU) from joining an Office Online Server farm. + +Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of +to join the Office Online Server farm. Use this parameter to prevent unauthorized servers (that is, +servers that are not in the OU) from joining an Office Online Server farm. ```yaml Type: String @@ -619,6 +663,7 @@ Accept wildcard characters: False ``` ### -Force + Suppresses any user prompts by answering "Yes." ```yaml @@ -634,11 +679,12 @@ Accept wildcard characters: False ``` ### -InternalURL -Specifies the URL root that clients must use to access the Office Online Server farm from the intranet. -An Office Online Server farm requires at least one URL. -It is set using either ExternalURL or InternalURL. -You can also set both internal and external URLs. +Specifies the URL root that clients must use to access the Office Online Server farm from the +intranet. + +An Office Online Server farm requires at least one URL. It is set using either ExternalURL or +InternalURL. You can also set both internal and external URLs. ```yaml Type: String @@ -653,10 +699,11 @@ Accept wildcard characters: False ``` ### -LogLocation + Specifies the location on the local computer where activity logs are stored. The location applies for every server in the farm and cannot be customized on a per-server basis. -The default location is %programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\`. Be sure to allow sufficient disk space on the drive where logs are stored. @@ -675,11 +722,11 @@ Accept wildcard characters: False ``` ### -LogRetentionInDays -Specifies the number of days that log entries are stored. -Log entries older than the configured date are trimmed. -The type must be an integer value in the range of 0 to 365. -The default value is 7 days. +Specifies the number of days that log entries are stored. Log entries older than the configured date +are trimmed. + +The type must be an integer value in the range of 0 to 365. The default value is 7 days. You must restart every server in the farm for this change to take effect. @@ -696,23 +743,19 @@ Accept wildcard characters: False ``` ### -LogVerbosity -Specifies how much information is stored in the trace log files. -The values are as follows: - -VerboseEX writes low-level detail to the trace log file. -Useful for traces that are likely to be high volume. - -Verbose writes low-level detail to the trace log file. - -Medium writes medium-level detail to the trace log file. - -High writes high-level detail to the trace log file. - -Monitorable writes traces that represent an unusual code path and actions that should be monitored. -Unexpected writes traces that represent an unexpected code path and actions that should be monitored. +Specifies how much information is stored in the trace log files. The values are as follows: -None writes no trace information to the trace log file. +- VerboseEX writes low-level detail to the trace log file. Useful for traces that are likely to be + high volume. +- Verbose writes low-level detail to the trace log file. +- Medium writes medium-level detail to the trace log file. +- High writes high-level detail to the trace log file. +- Monitorable writes traces that represent an unusual code path and actions that should be + monitored. +- Unexpected writes traces that represent an unexpected code path and actions that should be + monitored. +- None writes no trace information to the trace log file. Leaving the LogVerbosity at a low level for a long time will adversely affect performance. @@ -731,10 +774,11 @@ Accept wildcard characters: False ``` ### -MaxMemoryCacheSizeInMB + Specifies, in megabytes, the maximum amount of memory that the rendering cache can use. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 1024 MB. +The type must be an integer value in the range of 0 to any positive integer. The default size is +1024 MB. ```yaml Type: Int32 @@ -749,11 +793,11 @@ Accept wildcard characters: False ``` ### -MaxTranslationCharacterCount + Specifies the maximum number of characters a document can have in order to be translated. -The type must be an integer value. -The value can be set to 0 to indicate no limit or a value from 2000 to 2,000,000. -The default value is 125,000. +The type must be an integer value. The value can be set to 0 to indicate no limit or a value from +2000 to 2,000,000. The default value is 125,000. ```yaml Type: Int32 @@ -768,6 +812,7 @@ Accept wildcard characters: False ``` ### -OpenFromUncEnabled + Turns on or off the ability to use Online Viewers to view Office files from a UNC path. You must first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths. @@ -785,6 +830,7 @@ Accept wildcard characters: False ``` ### -OpenFromUrlEnabled + Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path. ```yaml @@ -800,8 +846,10 @@ Accept wildcard characters: False ``` ### -OpenFromUrlThrottlingEnabled -Throttles the number of Open From URL requests from any given server in a time period. -The default throttling values, which are not configurable, make sure that an Office Online Server farm will not overwhelm a single server with requests for content to be viewed in the Online Viewers. + +Throttles the number of Open From URL requests from any given server in a time period. The default +throttling values, which are not configurable, make sure that an Office Online Server farm will not +overwhelm a single server with requests for content to be viewed in the Online Viewers. ```yaml Type: SwitchParameter @@ -816,9 +864,10 @@ Accept wildcard characters: False ``` ### -PicturePasteDisabled -Turns off the ability for users to paste images from a web page into Office in a browser. -The default is False. -If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to False, users can paste images into Office in a browser. + +Turns off the ability for users to paste images from a web page into Office in a browser. The +default is False. If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to +False, users can paste images into Office in a browser. ```yaml Type: SwitchParameter @@ -833,6 +882,7 @@ Accept wildcard characters: False ``` ### -Proxy + Specifies the URL of the proxy server that is configured to allow HTTP requests to external sites. Typically configured together with the ClipartEnabled and TranslationEnabled parameters. @@ -849,10 +899,9 @@ Accept wildcard characters: False ``` ### -RecycleActiveProcessCount -Specifies the number of files that a single Word or PowerPoint process can render before the process is recycled. -The type must be an integer value in the range of 1 to 1000. -The default value is 5. +Specifies the number of files that a single Word or PowerPoint process can render before the process +is recycled. The type must be an integer value in the range of 1 to 1000. The default value is 5. You must restart every server in the farm for this change to take effect. @@ -869,19 +918,17 @@ Accept wildcard characters: False ``` ### -RemovePersonalInformationFromLogs -Provides a best effort scrub of personal information from Office Online Server logs and replaces values with a SHA256 hash. -Potentially scrubbed information can be: - -Document names and URLs -IP addresses +Provides a best effort scrub of personal information from Office Online Server logs and replaces +values with a SHA256 hash. Potentially scrubbed information can be: -Email addresses +- Document names and URLs +- IP addresses +- Email addresses +- User names -User names - -The default is False. -Note that enabling this parameter doesn't guarantee that personal information won't be logged to the Office Online Server logs. +The default is False. Note that enabling this parameter doesn't guarantee that personal information +won't be logged to the Office Online Server logs. ```yaml Type: SwitchParameter @@ -896,9 +943,10 @@ Accept wildcard characters: False ``` ### -RenderingLocalCacheLocation + Specifies the location of the temporary cache for use by the Word and PowerPoint Viewing Services. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\waccache\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Working\waccache\`. ```yaml Type: String @@ -913,7 +961,9 @@ Accept wildcard characters: False ``` ### -S2SCertificateName -The friendly name of the certificate to use for server-to-server authentication with SharePoint Server. + +The friendly name of the certificate to use for server-to-server authentication with SharePoint +Server. ```yaml Type: String @@ -928,9 +978,11 @@ Accept wildcard characters: False ``` ### -SSLOffloaded -Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load balancer. -When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local server. -However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for those references. + +Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load +balancer. When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local +server. However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for +those references. You must restart every server in the farm for this change to take effect. @@ -947,9 +999,11 @@ Accept wildcard characters: False ``` ### -TranslationEnabled -Enables support for automatic document translation using Microsoft Translator, an online service that translates text between languages. -The translated file is shown in Word. -Because Microsoft Translator is an online service, you must enable server-to-web communication directly or by using a proxy that you specify by using the Proxy parameter. + +Enables support for automatic document translation using Microsoft Translator, an online service +that translates text between languages. The translated file is shown in Word. Because Microsoft +Translator is an online service, you must enable server-to-web communication directly or by using a +proxy that you specify by using the Proxy parameter. Microsoft Translator may collect data to improve the quality of translations. @@ -966,9 +1020,10 @@ Accept wildcard characters: False ``` ### -TranslationServiceAddress -Specifies the URL of the translation server that translation requests are sent to. -The default is the Microsoft Translator online service. -Typically you will not use this parameter unless you must change translation services. + +Specifies the URL of the translation server that translation requests are sent to. The default is +the Microsoft Translator online service. Typically you will not use this parameter unless you must +change translation services. You must restart every server in the Office Online Server farm for this change to take effect. @@ -985,9 +1040,11 @@ Accept wildcard characters: False ``` ### -TranslationServiceAppId -Specifies the application ID for the translation service. -The default is the public application ID for Office in a browser. -Typically you will not use this parameter unless you have negotiated with Microsoft Translator for additional services and they have provided you with a private application ID. + +Specifies the application ID for the translation service. The default is the public application ID +for Office in a browser. Typically you will not use this parameter unless you have negotiated with +Microsoft Translator for additional services and they have provided you with a private application +ID. ```yaml Type: String @@ -1002,8 +1059,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md index 80b34fc95b..8ecdea8977 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # Set-OfficeWebAppsMachine ## SYNOPSIS + Changes the settings of the current server that is in an Office Online Server farm. ## SYNTAX @@ -21,27 +22,32 @@ Set-OfficeWebAppsMachine [-Master ] [-Roles ] [-WhatIf] [-Conf ``` ## DESCRIPTION -The Set-OfficeWebAppsMachine cmdlet changes the settings of the current server that is in an Office Online Server farm. -The settings include the roles held by the current server and the designated master server for the farm. + +The Set-OfficeWebAppsMachine cmdlet changes the settings of the current server that is in an Office +Online Server farm. The settings include the roles held by the current server and the designated +master server for the farm. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell (Get-OfficeWebAppsFarm).Machines ``` This example shows the roles held by each server in the Office Online Server farm. ### EXAMPLE 2 -``` + +```powershell Set-OfficeWebAppsMachine -Roles FrontEnd ``` This example configures the current server as a Front End server. ### EXAMPLE 3 -``` + +```powershell Set-OfficeWebAppsMachine -Roles All ``` @@ -50,8 +56,8 @@ This example configures the current server to host all roles. ## PARAMETERS ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -66,9 +72,10 @@ Accept wildcard characters: False ``` ### -Master -Specifies the server that stores the master farm configuration files. -If you set the local server as the master, you must run Set-OfficeWebAppsMachine -Master on all of the remaining servers in the Office Online Server farm to point them to the new master. +Specifies the server that stores the master farm configuration files. If you set the local server as +the master, you must run Set-OfficeWebAppsMachine -Master on all of the remaining servers in the +Office Online Server farm to point them to the new master. ```yaml Type: String @@ -83,19 +90,15 @@ Accept wildcard characters: False ``` ### -Roles -Specifies the list of server roles to assign to the local server, separated by commas. - -The role types are as follows: - -All -FrontEnd +Specifies the list of server roles to assign to the local server, separated by commas. The role +types are as follows: -WordBackEnd - -ExcelBackEnd - -PowerPointBackEnd +- All +- FrontEnd +- WordBackEnd +- ExcelBackEnd +- PowerPointBackEnd As a best practice, we recommend that all servers in an Office Online Server farm run all roles. Assigning roles is not useful until the Office Online Server farm contains approximately 50 servers. @@ -113,8 +116,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/skype/skype-ps/SkypeForBusiness/Add-CsSlaDelegates.md b/skype/skype-ps/SkypeForBusiness/Add-CsSlaDelegates.md index bd4a959bcf..be0cefe134 100644 --- a/skype/skype-ps/SkypeForBusiness/Add-CsSlaDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Add-CsSlaDelegates.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/add-cssladelegates +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/add-cssladelegates schema: 2.0.0 title: Add-CsSlaDelegates --- diff --git a/skype/skype-ps/SkypeForBusiness/Approve-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Approve-CsDeviceUpdateRule.md index 2c7415810d..b85028736b 100644 --- a/skype/skype-ps/SkypeForBusiness/Approve-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Approve-CsDeviceUpdateRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/approve-csdeviceupdaterule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/approve-csdeviceupdaterule schema: 2.0.0 title: Approve-CsDeviceUpdateRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Backup-CsPool.md b/skype/skype-ps/SkypeForBusiness/Backup-CsPool.md index 152b6e8178..fc2172aa7a 100644 --- a/skype/skype-ps/SkypeForBusiness/Backup-CsPool.md +++ b/skype/skype-ps/SkypeForBusiness/Backup-CsPool.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/backup-cspool +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/backup-cspool schema: 2.0.0 title: Backup-CsPool --- diff --git a/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateFile.md b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateFile.md index be8ee46bae..c5123b079c 100644 --- a/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateFile.md +++ b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateFile.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/clear-csdeviceupdatefile +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/clear-csdeviceupdatefile schema: 2.0.0 title: Clear-CsDeviceUpdateFile --- diff --git a/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateLog.md b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateLog.md index f1970237e4..9fadfc9d99 100644 --- a/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateLog.md +++ b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateLog.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/clear-csdeviceupdatelog +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/clear-csdeviceupdatelog schema: 2.0.0 title: Clear-CsDeviceUpdateLog --- diff --git a/skype/skype-ps/SkypeForBusiness/Clear-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Clear-CsPersistentChatRoom.md index 9ff0083198..177d0d4e67 100644 --- a/skype/skype-ps/SkypeForBusiness/Clear-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Clear-CsPersistentChatRoom.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/clear-cspersistentchatroom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/clear-cspersistentchatroom schema: 2.0.0 title: Clear-CsPersistentChatRoom --- diff --git a/skype/skype-ps/SkypeForBusiness/Convert-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Convert-CsUserData.md index 51a720b703..64b6cc5e73 100644 --- a/skype/skype-ps/SkypeForBusiness/Convert-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Convert-CsUserData.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/convert-csuserdata +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/convert-csuserdata schema: 2.0.0 title: Convert-CsUserData --- diff --git a/skype/skype-ps/SkypeForBusiness/ConvertTo-JsonForPSWS.md b/skype/skype-ps/SkypeForBusiness/ConvertTo-JsonForPSWS.md index d9f32a0ac2..d79e55099a 100644 --- a/skype/skype-ps/SkypeForBusiness/ConvertTo-JsonForPSWS.md +++ b/skype/skype-ps/SkypeForBusiness/ConvertTo-JsonForPSWS.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/convertto-jsonforpsws +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/convertto-jsonforpsws schema: 2.0.0 title: ConvertTo-JsonForPSWS --- diff --git a/skype/skype-ps/SkypeForBusiness/Copy-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Copy-CsVoicePolicy.md index 4ca7fe1c67..5fc590f362 100644 --- a/skype/skype-ps/SkypeForBusiness/Copy-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Copy-CsVoicePolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/copy-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/copy-csvoicepolicy schema: 2.0.0 title: Copy-CsVoicePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Debug-CsAddressBookReplication.md b/skype/skype-ps/SkypeForBusiness/Debug-CsAddressBookReplication.md index a1e08a42d8..74b1b4802d 100644 --- a/skype/skype-ps/SkypeForBusiness/Debug-CsAddressBookReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsAddressBookReplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/debug-csaddressbookreplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csaddressbookreplication schema: 2.0.0 title: Debug-CsAddressBookReplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Debug-CsDataConference.md b/skype/skype-ps/SkypeForBusiness/Debug-CsDataConference.md index 459fed005a..abf65669b9 100644 --- a/skype/skype-ps/SkypeForBusiness/Debug-CsDataConference.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsDataConference.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/debug-csdataconference +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csdataconference schema: 2.0.0 title: Debug-CsDataConference --- diff --git a/skype/skype-ps/SkypeForBusiness/Debug-CsInterPoolReplication.md b/skype/skype-ps/SkypeForBusiness/Debug-CsInterPoolReplication.md index 0637412f12..9ca4675a41 100644 --- a/skype/skype-ps/SkypeForBusiness/Debug-CsInterPoolReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsInterPoolReplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/debug-csinterpoolreplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csinterpoolreplication schema: 2.0.0 title: Debug-CsInterPoolReplication --- @@ -227,7 +227,7 @@ Debug-CsInterPoolReplication does not accept pipelined data. ## OUTPUTS -### String +### String ## NOTES diff --git a/skype/skype-ps/SkypeForBusiness/Debug-CsIntraPoolReplication.md b/skype/skype-ps/SkypeForBusiness/Debug-CsIntraPoolReplication.md index 4428f88621..d2a3c557ff 100644 --- a/skype/skype-ps/SkypeForBusiness/Debug-CsIntraPoolReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsIntraPoolReplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/debug-csintrapoolreplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csintrapoolreplication schema: 2.0.0 title: Debug-CsIntraPoolReplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Debug-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Debug-CsLisConfiguration.md index 068d86b1e0..f473e54e7e 100644 --- a/skype/skype-ps/SkypeForBusiness/Debug-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsLisConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/debug-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-cslisconfiguration schema: 2.0.0 title: Debug-CsLisConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Debug-CsStorageServiceFailures.md b/skype/skype-ps/SkypeForBusiness/Debug-CsStorageServiceFailures.md index 81dbd7b696..7779f3ee67 100644 --- a/skype/skype-ps/SkypeForBusiness/Debug-CsStorageServiceFailures.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsStorageServiceFailures.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/debug-csstorageservicefailures +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csstorageservicefailures schema: 2.0.0 title: Debug-CsStorageServiceFailures --- diff --git a/skype/skype-ps/SkypeForBusiness/Debug-CsUnifiedContactStore.md b/skype/skype-ps/SkypeForBusiness/Debug-CsUnifiedContactStore.md index 0589de5b92..a9acc3120d 100644 --- a/skype/skype-ps/SkypeForBusiness/Debug-CsUnifiedContactStore.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsUnifiedContactStore.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/debug-csunifiedcontactstore +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/debug-csunifiedcontactstore schema: 2.0.0 title: Debug-CsUnifiedContactStore --- diff --git a/skype/skype-ps/SkypeForBusiness/Disable-CsAdDomain.md b/skype/skype-ps/SkypeForBusiness/Disable-CsAdDomain.md index ed7d781f8e..5a931440a2 100644 --- a/skype/skype-ps/SkypeForBusiness/Disable-CsAdDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsAdDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/disable-csaddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-csaddomain schema: 2.0.0 title: Disable-CsAdDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Disable-CsAdForest.md b/skype/skype-ps/SkypeForBusiness/Disable-CsAdForest.md index 32d51bdf41..c8d4d7cb4b 100644 --- a/skype/skype-ps/SkypeForBusiness/Disable-CsAdForest.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsAdForest.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/disable-csadforest +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-csadforest schema: 2.0.0 title: Disable-CsAdForest --- diff --git a/skype/skype-ps/SkypeForBusiness/Disable-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Disable-CsComputer.md index bdf93e9c97..277d5a7707 100644 --- a/skype/skype-ps/SkypeForBusiness/Disable-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsComputer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/disable-cscomputer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-cscomputer schema: 2.0.0 title: Disable-CsComputer --- @@ -197,7 +197,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### None +### None Instead, Disable-CsComputer disables instances of the Microsoft.Rtc.Management.Deploy.Internal.Machine object. diff --git a/skype/skype-ps/SkypeForBusiness/Disable-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Disable-CsHostingProvider.md index 621e1d5b6e..ebf471ca69 100644 --- a/skype/skype-ps/SkypeForBusiness/Disable-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsHostingProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/disable-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-cshostingprovider schema: 2.0.0 title: Disable-CsHostingProvider --- @@ -190,7 +190,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider The Disable-CsHostingProvider cmdlet accepts pipelined instances of the hosting provider object. ## OUTPUTS diff --git a/skype/skype-ps/SkypeForBusiness/Disable-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Disable-CsMeetingRoom.md index 4dbc72c916..d201290f22 100644 --- a/skype/skype-ps/SkypeForBusiness/Disable-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsMeetingRoom.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/disable-csmeetingroom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-csmeetingroom schema: 2.0.0 title: Disable-CsMeetingRoom --- @@ -176,7 +176,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom ### Microsoft.Rtc.Management.AD.UserIdParameter diff --git a/skype/skype-ps/SkypeForBusiness/Disable-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Disable-CsPublicProvider.md index ede7b6dd53..1156385343 100644 --- a/skype/skype-ps/SkypeForBusiness/Disable-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsPublicProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/disable-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-cspublicprovider schema: 2.0.0 title: Disable-CsPublicProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Disable-CsUser.md b/skype/skype-ps/SkypeForBusiness/Disable-CsUser.md index c850bfdebd..df508074fa 100644 --- a/skype/skype-ps/SkypeForBusiness/Disable-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsUser.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/disable-csuser +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/disable-csuser schema: 2.0.0 title: Disable-CsUser --- diff --git a/skype/skype-ps/SkypeForBusiness/Enable-CsAdDomain.md b/skype/skype-ps/SkypeForBusiness/Enable-CsAdDomain.md index add3c8a6a8..c9f91d501f 100644 --- a/skype/skype-ps/SkypeForBusiness/Enable-CsAdDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsAdDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/enable-csaddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-csaddomain schema: 2.0.0 title: Enable-CsAdDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Enable-CsAdForest.md b/skype/skype-ps/SkypeForBusiness/Enable-CsAdForest.md index a59f2490ee..fd7f390b90 100644 --- a/skype/skype-ps/SkypeForBusiness/Enable-CsAdForest.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsAdForest.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/enable-csadforest +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-csadforest schema: 2.0.0 title: Enable-CsAdForest --- diff --git a/skype/skype-ps/SkypeForBusiness/Enable-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Enable-CsComputer.md index 7357c234ad..b55aa2ea20 100644 --- a/skype/skype-ps/SkypeForBusiness/Enable-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsComputer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/enable-cscomputer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-cscomputer schema: 2.0.0 title: Enable-CsComputer --- diff --git a/skype/skype-ps/SkypeForBusiness/Enable-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Enable-CsHostingProvider.md index 2559c78694..d58604c9b6 100644 --- a/skype/skype-ps/SkypeForBusiness/Enable-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsHostingProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/enable-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-cshostingprovider schema: 2.0.0 title: Enable-CsHostingProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Enable-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Enable-CsMeetingRoom.md index 782d086d89..d3b3d2bc3c 100644 --- a/skype/skype-ps/SkypeForBusiness/Enable-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsMeetingRoom.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/enable-csmeetingroom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-csmeetingroom schema: 2.0.0 title: Enable-CsMeetingRoom --- diff --git a/skype/skype-ps/SkypeForBusiness/Enable-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Enable-CsPublicProvider.md index cf4594e191..2c7d284b10 100644 --- a/skype/skype-ps/SkypeForBusiness/Enable-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsPublicProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/enable-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-cspublicprovider schema: 2.0.0 title: Enable-CsPublicProvider --- @@ -179,7 +179,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider The Enable-CsPublicProvider cmdlet accepts pipelined instances of the public provider object. diff --git a/skype/skype-ps/SkypeForBusiness/Enable-CsReplica.md b/skype/skype-ps/SkypeForBusiness/Enable-CsReplica.md index 7f99fef26d..821da9b2b4 100644 --- a/skype/skype-ps/SkypeForBusiness/Enable-CsReplica.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsReplica.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/enable-csreplica +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-csreplica schema: 2.0.0 title: Enable-CsReplica --- diff --git a/skype/skype-ps/SkypeForBusiness/Enable-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Enable-CsTopology.md index 5f683b1e9f..058dc996bb 100644 --- a/skype/skype-ps/SkypeForBusiness/Enable-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsTopology.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/enable-cstopology +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-cstopology schema: 2.0.0 title: Enable-CsTopology --- diff --git a/skype/skype-ps/SkypeForBusiness/Enable-CsUser.md b/skype/skype-ps/SkypeForBusiness/Enable-CsUser.md index 8014aa2f70..ae74f423eb 100644 --- a/skype/skype-ps/SkypeForBusiness/Enable-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsUser.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/enable-csuser +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-csuser schema: 2.0.0 title: Enable-CsUser --- diff --git a/skype/skype-ps/SkypeForBusiness/Export-CsArchivingData.md b/skype/skype-ps/SkypeForBusiness/Export-CsArchivingData.md index 2f6392b199..c4da017c34 100644 --- a/skype/skype-ps/SkypeForBusiness/Export-CsArchivingData.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsArchivingData.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/export-csarchivingdata +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-csarchivingdata schema: 2.0.0 title: Export-CsArchivingData --- diff --git a/skype/skype-ps/SkypeForBusiness/Export-CsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Export-CsConfiguration.md index 44c9c232e8..583fd51e63 100644 --- a/skype/skype-ps/SkypeForBusiness/Export-CsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/export-csconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-csconfiguration schema: 2.0.0 title: Export-CsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Export-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Export-CsLisConfiguration.md index d481723ba9..ae1b34d559 100644 --- a/skype/skype-ps/SkypeForBusiness/Export-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsLisConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/export-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-cslisconfiguration schema: 2.0.0 title: Export-CsLisConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Export-CsPersistentChatData.md b/skype/skype-ps/SkypeForBusiness/Export-CsPersistentChatData.md index 6138af84ad..d2b7982107 100644 --- a/skype/skype-ps/SkypeForBusiness/Export-CsPersistentChatData.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsPersistentChatData.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/export-cspersistentchatdata +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-cspersistentchatdata schema: 2.0.0 title: Export-CsPersistentChatData --- diff --git a/skype/skype-ps/SkypeForBusiness/Export-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Export-CsRgsConfiguration.md index b0ece41a50..231ce56828 100644 --- a/skype/skype-ps/SkypeForBusiness/Export-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsRgsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/export-csrgsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-csrgsconfiguration schema: 2.0.0 title: Export-CsRgsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Export-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Export-CsUserData.md index a4961125d3..338ab0c4f4 100644 --- a/skype/skype-ps/SkypeForBusiness/Export-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsUserData.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/export-csuserdata +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/export-csuserdata schema: 2.0.0 title: Export-CsUserData --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAVEdgeConfiguration.md index ddd00426b5..2cee24268d 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAVEdgeConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csavedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csavedgeconfiguration schema: 2.0.0 title: Get-CsAVEdgeConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAccessEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAccessEdgeConfiguration.md index ed018d04a8..8def73a465 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAccessEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAccessEdgeConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csaccessedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaccessedgeconfiguration schema: 2.0.0 title: Get-CsAccessEdgeConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAdContact.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdContact.md index ec7766caeb..3c3a0f433f 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAdContact.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdContact.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csadcontact +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadcontact schema: 2.0.0 title: Get-CsAdContact --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAdDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdDomain.md index 4ab1141e44..d8b73df760 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAdDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaddomain schema: 2.0.0 title: Get-CsAdDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAdForest.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdForest.md index 1d7038bb66..4c65ba0df4 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAdForest.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdForest.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csadforest +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadforest schema: 2.0.0 title: Get-CsAdForest --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAdPrincipal.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdPrincipal.md index f172ce5769..aa7db5f198 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAdPrincipal.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdPrincipal.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csadprincipal +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadprincipal schema: 2.0.0 title: Get-CsAdPrincipal --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAdServerSchema.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdServerSchema.md index ed0dbdc5be..a683ce6d08 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAdServerSchema.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdServerSchema.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csadserverschema +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadserverschema schema: 2.0.0 title: Get-CsAdServerSchema --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAdUser.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdUser.md index 6c342dad43..f793dda3e0 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAdUser.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdUser.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csaduser +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaduser schema: 2.0.0 title: Get-CsAdUser --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAdditionalInternalDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdditionalInternalDomain.md index 9538208c0a..cd3f6eacd7 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdditionalInternalDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadditionalinternaldomain schema: 2.0.0 title: Get-CsAdditionalInternalDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookConfiguration.md index 0210f37d72..25ade65d2b 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbookconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaddressbookconfiguration schema: 2.0.0 title: Get-CsAddressBookConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationConfiguration.md index ac202d9c5a..975fde866f 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaddressbooknormalizationconfiguration schema: 2.0.0 title: Get-CsAddressBookNormalizationConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationRule.md index 591a8c2770..046ca6401f 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaddressbooknormalizationrule schema: 2.0.0 title: Get-CsAddressBookNormalizationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRole.md index 3b2336d91e..42c55397f9 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRole.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csadminrole +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadminrole schema: 2.0.0 title: Get-CsAdminRole --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAdminRoleAssignment.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRoleAssignment.md index 56d953fe88..6c0eedc3c8 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAdminRoleAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRoleAssignment.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csadminroleassignment +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadminroleassignment schema: 2.0.0 title: Get-CsAdminRoleAssignment --- @@ -119,7 +119,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### String +### String The Get-CsAdminRoleAssignment cmdlet accepts a pipelined string value representing the SamAccountName of a user. diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsAllowedDomain.md index e4c6fff5c5..255892d051 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAllowedDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csalloweddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csalloweddomain schema: 2.0.0 title: Get-CsAllowedDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Get-CsAnalogDevice.md index f50c21942b..fb2abe18a0 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAnalogDevice.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csanalogdevice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csanalogdevice schema: 2.0.0 title: Get-CsAnalogDevice --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/Get-CsAnnouncement.md index cbcf29f92c..e49c1c84a0 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAnnouncement.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csannouncement +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csannouncement schema: 2.0.0 title: Get-CsAnnouncement --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsApplicationEndpoint.md index b62ddbae28..62ca279973 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsApplicationEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csapplicationendpoint schema: 2.0.0 title: Get-CsApplicationEndpoint --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingConfiguration.md index 36a35bb482..25286cbfa6 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csarchivingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csarchivingconfiguration schema: 2.0.0 title: Get-CsArchivingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingPolicy.md index d47ea6b291..000217e372 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csarchivingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csarchivingpolicy schema: 2.0.0 title: Get-CsArchivingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAudioConferencingProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsAudioConferencingProvider.md index 16334fbcc5..0a446e5e6d 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAudioConferencingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAudioConferencingProvider.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/get-csaudioconferencingprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaudioconferencingprovider schema: 2.0.0 title: Get-CsAudioConferencingProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAudioTestServiceApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsAudioTestServiceApplication.md index c9611cfdb6..aba13f0ecd 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAudioTestServiceApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAudioTestServiceApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csaudiotestserviceapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csaudiotestserviceapplication schema: 2.0.0 title: Get-CsAudioTestServiceApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAuthConfig.md b/skype/skype-ps/SkypeForBusiness/Get-CsAuthConfig.md index c9a293a28f..6830ed2e0c 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAuthConfig.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAuthConfig.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csauthconfig +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csauthconfig schema: 2.0.0 title: Get-CsAuthConfig --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAutodiscoverConfiguration.md index 6d7bae8898..ab67cc43f7 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAutodiscoverConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csautodiscoverconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csautodiscoverconfiguration schema: 2.0.0 title: Get-CsAutodiscoverConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceConfiguration.md index c3b0acbf34..c0a962595a 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csbackupserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbackupserviceconfiguration schema: 2.0.0 title: Get-CsBackupServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceStatus.md index b1a78d9221..4c6847c6b9 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceStatus.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csbackupservicestatus +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbackupservicestatus schema: 2.0.0 title: Get-CsBackupServiceStatus --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsBandwidthPolicyServiceConfiguration.md index f02225a05a..327a4e8ba7 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBandwidthPolicyServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csbandwidthpolicyserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbandwidthpolicyserviceconfiguration schema: 2.0.0 title: Get-CsBandwidthPolicyServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsBlockedDomain.md index 4ee223ec1b..c876209b6a 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBlockedDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csblockeddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csblockeddomain schema: 2.0.0 title: Get-CsBlockedDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingConfiguration.md index cfbc17d9c1..3e7868801d 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/get-csbroadcastmeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbroadcastmeetingconfiguration schema: 2.0.0 title: Get-CsBroadcastMeetingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingPolicy.md index f3b3f83093..ec0428e9ee 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/get-csbroadcastmeetingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbroadcastmeetingpolicy schema: 2.0.0 title: Get-CsBroadcastMeetingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsBusyOptions.md b/skype/skype-ps/SkypeForBusiness/Get-CsBusyOptions.md index d9b4394a19..b60869040c 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsBusyOptions.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBusyOptions.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbusyoptions schema: 2.0.0 title: Get-CsBusyOptions --- @@ -98,6 +98,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) +[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csbusyoptions?view=skype-ps) -[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) +[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/Get-CsCallParkOrbit.md index 9048383a95..b9aa584c25 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCallParkOrbit.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cscallparkorbit +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscallparkorbit schema: 2.0.0 title: Get-CsCallParkOrbit --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsCallViaWorkPolicy.md index c45e422c97..aa5c397b59 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCallViaWorkPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cscallviaworkpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscallviaworkpolicy schema: 2.0.0 title: Get-CsCallViaWorkPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsCdrConfiguration.md index 2a16c870ab..37fb8c3e2a 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCdrConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cscdrconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscdrconfiguration schema: 2.0.0 title: Get-CsCdrConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Get-CsCertificate.md index a5ce49063b..324f27dd20 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCertificate.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cscertificate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscertificate schema: 2.0.0 title: Get-CsCertificate --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClientAccessLicense.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientAccessLicense.md index de7c82fddf..82bb8832c5 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClientAccessLicense.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientAccessLicense.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientaccesslicense +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientaccesslicense schema: 2.0.0 title: Get-CsClientAccessLicense --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClientCertificate.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientCertificate.md index cc91f49b05..d01dbc9556 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClientCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientCertificate.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientcertificate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientcertificate schema: 2.0.0 title: Get-CsClientCertificate --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClientPinInfo.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientPinInfo.md index e8611b2f06..7b518d1899 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClientPinInfo.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientPinInfo.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientpininfo +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientpininfo schema: 2.0.0 title: Get-CsClientPinInfo --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientPolicy.md index c5454eb694..e4f11b0f42 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientpolicy schema: 2.0.0 title: Get-CsClientPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionConfiguration.md index 56cf81f7db..a79a7093b6 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientversionconfiguration schema: 2.0.0 title: Get-CsClientVersionConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicy.md index ddaeb4af53..358edac7aa 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientversionpolicy schema: 2.0.0 title: Get-CsClientVersionPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicyRule.md index 7bb962de56..96555755c1 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicyRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionpolicyrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclientversionpolicyrule schema: 2.0.0 title: Get-CsClientVersionPolicyRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnector.md b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnector.md index 6384869d65..393205b598 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnector.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnector.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudcalldataconnector +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscloudcalldataconnector schema: 2.0.0 title: Get-CsCloudCallDataConnector --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnectorConfiguration.md index 09f31f994c..de302491b6 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnectorConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudcalldataconnectorconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscloudcalldataconnectorconfiguration schema: 2.0.0 title: Get-CsCloudCallDataConnectorConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsCloudMeetingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsCloudMeetingPolicy.md index 622d027149..9a294345b0 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsCloudMeetingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCloudMeetingPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudmeetingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscloudmeetingpolicy schema: 2.0.0 title: Get-CsCloudMeetingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClsAgentStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsAgentStatus.md index 0a4d096971..9e6324a1cd 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClsAgentStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsAgentStatus.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsagentstatus +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclsagentstatus schema: 2.0.0 title: Get-CsClsAgentStatus --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsConfiguration.md index 07fad4b30b..d8d00c976f 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclsconfiguration schema: 2.0.0 title: Get-CsClsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsRegion.md index cc64c832df..b11594aa62 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsRegion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsregion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclsregion schema: 2.0.0 title: Get-CsClsRegion --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsScenario.md index 52531b94bb..9c137c2734 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsScenario.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsscenario +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclsscenario schema: 2.0.0 title: Get-CsClsScenario --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClsSearchTerm.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsSearchTerm.md index 04f2ac31d7..f3583b541c 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClsSearchTerm.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsSearchTerm.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclssearchterm +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclssearchterm schema: 2.0.0 title: Get-CsClsSearchTerm --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsSecurityGroup.md index 3a9852a7c4..49ac35cf81 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsSecurityGroup.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csclssecuritygroup +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csclssecuritygroup schema: 2.0.0 title: Get-CsClsSecurityGroup --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Get-CsCommonAreaPhone.md index 1ee123d288..8e8d01d122 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCommonAreaPhone.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cscommonareaphone +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscommonareaphone schema: 2.0.0 title: Get-CsCommonAreaPhone --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Get-CsComputer.md index 093d9727ac..bb007895da 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsComputer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cscomputer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscomputer schema: 2.0.0 title: Get-CsComputer --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDirectory.md index df088d1429..0adf558721 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDirectory.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencedirectory +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconferencedirectory schema: 2.0.0 title: Get-CsConferenceDirectory --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDisclaimer.md index 8514eca701..50c1e86fdc 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDisclaimer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencedisclaimer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconferencedisclaimer schema: 2.0.0 title: Get-CsConferenceDisclaimer --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingConfiguration.md index a168b5a68b..48b1e89149 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconferencingconfiguration schema: 2.0.0 title: Get-CsConferencingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingPolicy.md index 6d7be65e0c..8561063bda 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconferencingpolicy schema: 2.0.0 title: Get-CsConferencingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsConfigurationStoreLocation.md b/skype/skype-ps/SkypeForBusiness/Get-CsConfigurationStoreLocation.md index 7465101e31..a458ace3cb 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConfigurationStoreLocation.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csconfigurationstorelocation +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconfigurationstorelocation schema: 2.0.0 title: Get-CsConfigurationStoreLocation --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsConversationHistoryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsConversationHistoryConfiguration.md index c8acde4688..9b0b492d8a 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConversationHistoryConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csconversationhistoryconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csconversationhistoryconfiguration schema: 2.0.0 title: Get-CsConversationHistoryConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsCpsConfiguration.md index cdf9fb0879..623d57c397 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCpsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cscpsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cscpsconfiguration schema: 2.0.0 title: Get-CsCpsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsDatabaseMirrorState.md b/skype/skype-ps/SkypeForBusiness/Get-CsDatabaseMirrorState.md index 2bd1eb0f1b..9ff2c9d852 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsDatabaseMirrorState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDatabaseMirrorState.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csdatabasemirrorstate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdatabasemirrorstate schema: 2.0.0 title: Get-CsDatabaseMirrorState --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateConfiguration.md index 6bc9e83a26..9167cbbc26 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csdeviceupdateconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdeviceupdateconfiguration schema: 2.0.0 title: Get-CsDeviceUpdateConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateRule.md index 35795da63c..2f6c51ed61 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csdeviceupdaterule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdeviceupdaterule schema: 2.0.0 title: Get-CsDeviceUpdateRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticConfiguration.md index 3d1af085bd..8cbbe00cba 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csdiagnosticconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdiagnosticconfiguration schema: 2.0.0 title: Get-CsDiagnosticConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticHeaderConfiguration.md index 6b1fca5bdd..3626c1153c 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticHeaderConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csdiagnosticheaderconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdiagnosticheaderconfiguration schema: 2.0.0 title: Get-CsDiagnosticHeaderConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingAccessNumber.md index d1c92eb424..2c48363823 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingAccessNumber.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingaccessnumber +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdialinconferencingaccessnumber schema: 2.0.0 title: Get-CsDialInConferencingAccessNumber --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingConfiguration.md index 26c0cfa460..c630811964 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdialinconferencingconfiguration schema: 2.0.0 title: Get-CsDialInConferencingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingDtmfConfiguration.md index c5ddf7d9fe..fab4581867 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingDtmfConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingdtmfconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdialinconferencingdtmfconfiguration schema: 2.0.0 title: Get-CsDialInConferencingDtmfConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingLanguageList.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingLanguageList.md index f53a2f370a..18e8140ed5 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingLanguageList.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingLanguageList.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencinglanguagelist +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdialinconferencinglanguagelist schema: 2.0.0 title: Get-CsDialInConferencingLanguageList --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialPlan.md index a36027dcb4..cd3f145794 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialPlan.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialplan +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csdialplan schema: 2.0.0 title: Get-CsDialPlan --- @@ -179,7 +179,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile ## NOTES diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsEffectivePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsEffectivePolicy.md index 0492c3e4a7..eb5470453e 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsEffectivePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsEffectivePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cseffectivepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cseffectivepolicy schema: 2.0.0 title: Get-CsEffectivePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Get-CsEnhancedEmergencyServiceDisclaimer.md index dea8f2265d..9532259e03 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsEnhancedEmergencyServiceDisclaimer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csenhancedemergencyservicedisclaimer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csenhancedemergencyservicedisclaimer schema: 2.0.0 title: Get-CsEnhancedEmergencyServiceDisclaimer --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Get-CsExUmContact.md index 9a090c35e2..37be55352d 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsExUmContact.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csexumcontact +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csexumcontact schema: 2.0.0 title: Get-CsExUmContact --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsExternalAccessPolicy.md index 190dc44063..00ff93f3ba 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsExternalAccessPolicy.md @@ -6,7 +6,7 @@ Locale: en-US Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csexternalaccesspolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csexternalaccesspolicy schema: 2.0.0 title: Get-CsExternalAccessPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsExternalUserCommunicationPolicy.md index 82394896f7..4497bfb2be 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsExternalUserCommunicationPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csexternalusercommunicationpolicy schema: 2.0.0 title: Get-CsExternalUserCommunicationPolicy --- @@ -152,10 +152,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy?view=skype-ps) +[New-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csexternalusercommunicationpolicy?view=skype-ps) -[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) +[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csexternalusercommunicationpolicy?view=skype-ps) -[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) +[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csexternalusercommunicationpolicy?view=skype-ps) -[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) +[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csexternalusercommunicationpolicy?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsFIPSConfiguration.md index 8376382b76..e28597d116 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsFIPSConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csfipsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csfipsconfiguration schema: 2.0.0 title: Get-CsFIPSConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsFileTransferFilterConfiguration.md index 6e35a7af5e..bb683fd7f7 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsFileTransferFilterConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csfiletransferfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csfiletransferfilterconfiguration schema: 2.0.0 title: Get-CsFileTransferFilterConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsGraphPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsGraphPolicy.md index 154a57f4ef..5c2cd76bad 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsGraphPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsGraphPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/get-csgraphpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csgraphpolicy schema: 2.0.0 title: Get-CsGraphPolicy --- @@ -132,4 +132,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Grant-CsGraphPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csgraphpolicy?view=skype-ps) +[Grant-CsGraphPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csgraphpolicy?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/Get-CsGroupPickupUserOrbit.md index abf8eb78ee..934d36657f 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsGroupPickupUserOrbit.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csgrouppickupuserorbit +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csgrouppickupuserorbit schema: 2.0.0 title: Get-CsGroupPickupUserOrbit --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsHealthMonitoringConfiguration.md index 7662cca761..602413f717 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHealthMonitoringConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cshealthmonitoringconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshealthmonitoringconfiguration schema: 2.0.0 title: Get-CsHealthMonitoringConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsHostedVoicemailPolicy.md index 98aeaefd14..1daa76f755 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHostedVoicemailPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-cshostedvoicemailpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshostedvoicemailpolicy schema: 2.0.0 title: Get-CsHostedVoicemailPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsHostingProvider.md index c2e6080cbb..49b18f3616 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHostingProvider.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshostingprovider schema: 2.0.0 title: Get-CsHostingProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridApplicationEndpoint.md index 5061321cf0..42d35dd115 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridApplicationEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint schema: 2.0.0 title: Get-CsHybridApplicationEndpoint --- @@ -209,8 +209,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsHybridMediationServer.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridMediationServer.md index fd38bd26e3..915e1bc8b6 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsHybridMediationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridMediationServer.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridmediationserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridmediationserver schema: 2.0.0 title: Get-CsHybridMediationServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNAppliance.md index 6a0c011f06..a7b0e1e9df 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNAppliance.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridpstnappliance +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridpstnappliance schema: 2.0.0 title: Get-CsHybridPSTNAppliance --- @@ -195,8 +195,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/set-cshybridpstnappliance?view=skype-ps) +[Set-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridpstnappliance?view=skype-ps) -[Register-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/register-cshybridpstnappliance?view=skype-ps) +[Register-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skypeforbusiness/register-cshybridpstnappliance?view=skype-ps) -[Unregister-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance?view=skype-ps) +[Unregister-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skypeforbusiness/unregister-cshybridpstnappliance?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNSite.md index 8da19c3995..0c17909c6f 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNSite.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridpstnsite +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridpstnsite schema: 2.0.0 title: Get-CsHybridPSTNSite --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsIPPhonePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsIPPhonePolicy.md index e43e70482e..90adfbbc0b 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsIPPhonePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsIPPhonePolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/get-csipphonepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csipphonepolicy schema: 2.0.0 title: Get-CsIPPhonePolicy --- @@ -126,6 +126,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skype/grant-csipphonepolicy?view=skype-ps) +[Grant-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csipphonepolicy?view=skype-ps) -[Set-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skype/set-csipphonepolicy?view=skype-ps) +[Set-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csipphonepolicy?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsImConfiguration.md index cd94b8d5cf..343fb5dc55 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsImConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimconfiguration schema: 2.0.0 title: Get-CsImConfiguration --- @@ -131,8 +131,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsImFilterConfiguration.md index 0877573ff1..f615e9e92d 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsImFilterConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csimfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimfilterconfiguration schema: 2.0.0 title: Get-CsImFilterConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsImTranslationConfiguration.md index 4cce44ad49..989d51a5ed 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsImTranslationConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csimtranslationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimtranslationconfiguration schema: 2.0.0 title: Get-CsImTranslationConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Get-CsKerberosAccountAssignment.md index 5be7e6aa13..12c60eedb4 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsKerberosAccountAssignment.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cskerberosaccountassignment +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cskerberosaccountassignment schema: 2.0.0 title: Get-CsKerberosAccountAssignment --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsLisCivicAddress.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisCivicAddress.md index 6c0655889e..aa5e7e491b 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsLisCivicAddress.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisCivicAddress.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csliscivicaddress +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csliscivicaddress schema: 2.0.0 title: Get-CsLisCivicAddress --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsLisLocation.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisLocation.md index d32a8a25aa..0a47e181b7 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsLisLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisLocation.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cslislocation +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslislocation schema: 2.0.0 title: Get-CsLisLocation --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsLisPort.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisPort.md index c1858bed1e..d4506c2443 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsLisPort.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisPort.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cslisport +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslisport schema: 2.0.0 title: Get-CsLisPort --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsLisServiceProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisServiceProvider.md index 3f27b8d9d6..8908eda271 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsLisServiceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisServiceProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cslisserviceprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslisserviceprovider schema: 2.0.0 title: Get-CsLisServiceProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsLisSubnet.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisSubnet.md index 6b3fd067a9..bc6be383e8 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsLisSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisSubnet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cslissubnet +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslissubnet schema: 2.0.0 title: Get-CsLisSubnet --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsLisSwitch.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisSwitch.md index 941e41d5dd..367b13af80 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsLisSwitch.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisSwitch.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cslisswitch +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslisswitch schema: 2.0.0 title: Get-CsLisSwitch --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsLisWirelessAccessPoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisWirelessAccessPoint.md index e5f0deb14b..587398d70e 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisWirelessAccessPoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csliswirelessaccesspoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csliswirelessaccesspoint schema: 2.0.0 title: Get-CsLisWirelessAccessPoint --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsLocationPolicy.md index 1997327a22..b3d22d64f4 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLocationPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cslocationpolicy schema: 2.0.0 title: Get-CsLocationPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsManagementConnection.md b/skype/skype-ps/SkypeForBusiness/Get-CsManagementConnection.md index 16291f1a88..4687a41c9d 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsManagementConnection.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsManagementConnection.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csmanagementconnection +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmanagementconnection schema: 2.0.0 title: Get-CsManagementConnection --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsManagementStoreReplicationStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsManagementStoreReplicationStatus.md index db73ab42d6..920430ffbc 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsManagementStoreReplicationStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsManagementStoreReplicationStatus.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csmanagementstorereplicationstatus +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmanagementstorereplicationstatus schema: 2.0.0 title: Get-CsManagementStoreReplicationStatus --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsMcxConfiguration.md index af369bb85c..12fffd2b5e 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMcxConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csmcxconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmcxconfiguration schema: 2.0.0 title: Get-CsMcxConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsMediaConfiguration.md index c15f6e72b6..89dcc63754 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMediaConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csmediaconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmediaconfiguration schema: 2.0.0 title: Get-CsMediaConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingConfiguration.md index 767643f840..51a5a0357d 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingConfiguration.md @@ -10,7 +10,7 @@ ms.author: tomkau ms.localizationpriority: medium ms.reviewer: rogupta ms.topic: reference -online version: https://learn.microsoft.com/powershell/module/skype/get-csmeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmeetingconfiguration schema: 2.0.0 title: Get-CsMeetingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingRoom.md index b71238345b..4da389d1cb 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingRoom.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csmeetingroom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmeetingroom schema: 2.0.0 title: Get-CsMeetingRoom --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsMobilityPolicy.md index f22671fdfd..cfa30d7966 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMobilityPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csmobilitypolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csmobilitypolicy schema: 2.0.0 title: Get-CsMobilityPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkBandwidthPolicyProfile.md index c1e422d1af..aa829b2055 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkBandwidthPolicyProfile.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkbandwidthpolicyprofile +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkbandwidthpolicyprofile schema: 2.0.0 title: Get-CsNetworkBandwidthPolicyProfile --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkConfiguration.md index 5e390e6370..0be2037370 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkconfiguration schema: 2.0.0 title: Get-CsNetworkConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterRegionRoute.md index 1322f9b4fe..02beecac2f 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterRegionRoute.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkinterregionroute +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkinterregionroute schema: 2.0.0 title: Get-CsNetworkInterRegionRoute --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterSitePolicy.md index 3fcea915b3..21f59828ff 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterSitePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkintersitepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkintersitepolicy schema: 2.0.0 title: Get-CsNetworkInterSitePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterface.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterface.md index c5a10c1dc2..962ae9f4c7 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterface.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterface.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkinterface +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkinterface schema: 2.0.0 title: Get-CsNetworkInterface --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegion.md index 82d5aa6d3c..4ed8aaee59 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkregion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkregion schema: 2.0.0 title: Get-CsNetworkRegion --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegionLink.md index cd5d855566..0f03c02672 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegionLink.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkregionlink +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworkregionlink schema: 2.0.0 title: Get-CsNetworkRegionLink --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSite.md index e7523784b6..109d52d820 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSite.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworksite +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworksite schema: 2.0.0 title: Get-CsNetworkSite --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSubnet.md index 454f6c3919..290f7be6ff 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSubnet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworksubnet +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csnetworksubnet schema: 2.0.0 title: Get-CsNetworkSubnet --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsOAuthConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthConfiguration.md index c7cb34d9a0..c5826254af 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsOAuthConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csoauthconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csoauthconfiguration schema: 2.0.0 title: Get-CsOAuthConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthServer.md index c95a5a12ca..6b6eebe275 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csoauthserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csoauthserver schema: 2.0.0 title: Get-CsOAuthServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundCallingNumberTranslationRule.md index 3dcb2c38cd..d83fea3bef 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundCallingNumberTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csoutboundcallingnumbertranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csoutboundcallingnumbertranslationrule schema: 2.0.0 title: Get-CsOutboundCallingNumberTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundTranslationRule.md index 2d793c2d88..96b1ba29a5 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csoutboundtranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csoutboundtranslationrule schema: 2.0.0 title: Get-CsOutboundTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsPartnerApplication.md index 973036641a..0742207f0c 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPartnerApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspartnerapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspartnerapplication schema: 2.0.0 title: Get-CsPartnerApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatAddin.md index 72efa06771..a7a9afa8ab 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatAddin.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchataddin +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchataddin schema: 2.0.0 title: Get-CsPersistentChatAddin --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatCategory.md index af379d0685..e27b9541eb 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatCategory.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatcategory +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatcategory schema: 2.0.0 title: Get-CsPersistentChatCategory --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatComplianceConfiguration.md index 87f6621c0f..27b163aafd 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatComplianceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatcomplianceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatcomplianceconfiguration schema: 2.0.0 title: Get-CsPersistentChatComplianceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatConfiguration.md index 437d32cd97..7b93fd6c02 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatconfiguration schema: 2.0.0 title: Get-CsPersistentChatConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEligiblePrincipal.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEligiblePrincipal.md index a441059408..cabdf2a2fb 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEligiblePrincipal.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEligiblePrincipal.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchateligibleprincipal +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchateligibleprincipal schema: 2.0.0 title: Get-CsPersistentChatEligiblePrincipal --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEndpoint.md index ba737482aa..920b5aded6 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatendpoint schema: 2.0.0 title: Get-CsPersistentChatEndpoint --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatPolicy.md index 8619285d1e..925da87467 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatpolicy schema: 2.0.0 title: Get-CsPersistentChatPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatRoom.md index 01eada4708..8d0e58466d 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatRoom.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatroom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatroom schema: 2.0.0 title: Get-CsPersistentChatRoom --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatState.md index cfc1b966a4..7901d8d630 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatState.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatstate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspersistentchatstate schema: 2.0.0 title: Get-CsPersistentChatState --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsPinPolicy.md index 088c368b47..c52b31b0ec 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPinPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspinpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspinpolicy schema: 2.0.0 title: Get-CsPinPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/Get-CsPlatformServiceSettings.md index b667c37195..60673b9b8d 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPlatformServiceSettings.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csplatformservicesettings schema: 2.0.0 title: Get-CsPlatformServiceSettings --- @@ -117,8 +117,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csplatformservicesettings?view=skype-ps) -[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPool.md b/skype/skype-ps/SkypeForBusiness/Get-CsPool.md index 1aa8e945cc..26ea317632 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPool.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPool.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspool +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspool schema: 2.0.0 title: Get-CsPool --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPoolBackupRelationship.md b/skype/skype-ps/SkypeForBusiness/Get-CsPoolBackupRelationship.md index 4bfce89855..b7eef6416c 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPoolBackupRelationship.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPoolBackupRelationship.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolbackuprelationship +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspoolbackuprelationship schema: 2.0.0 title: Get-CsPoolBackupRelationship --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPoolFabricState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPoolFabricState.md index a34a431763..55b4b14c1b 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPoolFabricState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPoolFabricState.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolfabricstate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspoolfabricstate schema: 2.0.0 title: Get-CsPoolFabricState --- @@ -21,31 +21,27 @@ This cmdlet was introduced in Lync Server 2013. ## SYNTAX -### (Default) -``` -Get-CsPoolFabricState -PoolFqdn [-Confirm] [-Force] [-Type ] [-WhatIf] - [] -``` - -### PoolFqdn -``` -Get-CsPoolFabricState [-PoolFqdn] [-Confirm] [-Force] [-HealthState ] - [-OutputCsvFile ] [-ServiceName ] [-ShowAll] [-WhatIf] [-Type ] [] -``` - ### RoutingGroup ``` -Get-CsPoolFabricState [-RoutingGroup] [-Confirm] [-Force] [-WhatIf] [] +Get-CsPoolFabricState [-RoutingGroup] [-ReplicaBuildProgress] [-Force] [-MinutesToPoll ] + [-PollInterval ] [-ReplicaBuildProgressTimeout ] [-WhatIf] [-Confirm] [] ``` ### Tenant ``` -Get-CsPoolFabricState [-Tenant] [-Confirm] [-Force] [-WhatIf] [] +Get-CsPoolFabricState [-Tenant] [-Force] [-WhatIf] [-Confirm] [] ``` ### User ``` -Get-CsPoolFabricState [-UserUri] [-Confirm] [-Force] [-WhatIf] [] +Get-CsPoolFabricState [-UserUri] [-Force] [-WhatIf] [-Confirm] [] +``` + +### PoolFqdn +``` +Get-CsPoolFabricState -PoolFqdn [-HealthState ] [-ShowAll] [-OutputCsvFile ] + [-ServiceName ] [-Force] [-Type ] [-QueryTimeout ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -54,7 +50,6 @@ This includes information about Windows Fabric replica instances for any (or all The functions carried out by the Get-CsPoolFabricState cmdlet are not available in Skype for Business Server Control Panel. - ## EXAMPLES ### Example 1 @@ -83,13 +78,13 @@ This is done by including the Type parameter and the parameter value "MCU". Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -101,7 +96,7 @@ Accept wildcard characters: False PARAMVALUE: String ```yaml -Type: String +Type: System.String Parameter Sets: PoolFqdn Aliases: @@ -112,6 +107,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MinutesToPoll +Max number of minutes for which the cmdlet will poll cluster manager for replica build progress + +```yaml +Type: System.Int32 +Parameter Sets: RoutingGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OutputCsvFile > Applicable: Skype for Business Server 2015, Skype for Business Server 2019 @@ -130,6 +140,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PollInterval +Interval in seconds between cluster manager polls for replica build progress + +```yaml +Type: System.Int32 +Parameter Sets: RoutingGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PoolFqdn > Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 @@ -140,12 +165,57 @@ You must supply the FQDN of a pool when calling this cmdlet; for example: `-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: String +Type: System.String Parameter Sets: PoolFqdn Aliases: Required: True -Position: 1 +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryTimeout +Query timeout period in minutes to retrieve the state of fabric services. + +```yaml +Type: System.Int32 +Parameter Sets: PoolFqdn +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaBuildProgress +If a replica is being built for the given RG, polls for the status of the build + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RoutingGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaBuildProgressTimeout +The number of seconds for which no replica build progress has been made before considering progress to be stuck + +```yaml +Type: System.Int32 +Parameter Sets: RoutingGroup +Aliases: + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -159,7 +229,7 @@ Globally unique identifier (GUID) of the Windows Fabric routing group to be retu Routing groups are used to specify the servers that users log onto. ```yaml -Type: String +Type: System.String Parameter Sets: RoutingGroup Aliases: @@ -177,7 +247,7 @@ Accept wildcard characters: False PARAMVALUE: String ```yaml -Type: String +Type: System.String Parameter Sets: PoolFqdn Aliases: @@ -195,13 +265,13 @@ Accept wildcard characters: False PARAMVALUE: SwitchParameter ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: PoolFqdn Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -220,7 +290,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants `Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: Guid +Type: System.Guid Parameter Sets: Tenant Aliases: @@ -247,8 +317,8 @@ LYSS (returns information for the Lync Server Storage service) You can only specify a single type per command. ```yaml -Type: FabricEnumerationType -Parameter Sets: (All), PoolFqdn +Type: System.String +Parameter Sets: PoolFqdn Aliases: Required: False @@ -270,7 +340,7 @@ For example, to check the Windows fabric state for the user Ken Myer use this sy Note that you can only specify one user URI per command. ```yaml -Type: UserIdParameter +Type: Microsoft.Rtc.Management.AD.UserIdParameter Parameter Sets: User Aliases: @@ -288,13 +358,13 @@ Accept wildcard characters: False Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -306,33 +376,29 @@ Accept wildcard characters: False Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### String String value representing the fabric state. - ## NOTES - ## RELATED LINKS diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPoolUpgradeReadinessState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPoolUpgradeReadinessState.md index 453c843f74..7bf4f2987b 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPoolUpgradeReadinessState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPoolUpgradeReadinessState.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolupgradereadinessstate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspoolupgradereadinessstate schema: 2.0.0 title: Get-CsPoolUpgradeReadinessState --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPresenceManagementState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceManagementState.md index a426aef51b..5bd1c76402 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPresenceManagementState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceManagementState.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspresencemanagementstate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspresencemanagementstate schema: 2.0.0 title: Get-CsPresenceManagementState --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsPresencePolicy.md index 05410e5438..98e95ef9a9 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPresencePolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-cspresencepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspresencepolicy schema: 2.0.0 title: Get-CsPresencePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceProvider.md index e1e2328865..ca019ef1f6 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspresenceprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspresenceprovider schema: 2.0.0 title: Get-CsPresenceProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPrivacyConfiguration.md index 84b2781792..c7ae94a499 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPrivacyConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csprivacyconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csprivacyconfiguration schema: 2.0.0 title: Get-CsPrivacyConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsProxyConfiguration.md index 468053803d..a1a81b9d9c 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsProxyConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csproxyconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csproxyconfiguration schema: 2.0.0 title: Get-CsProxyConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPstnUsage.md b/skype/skype-ps/SkypeForBusiness/Get-CsPstnUsage.md index 120359142d..ecd927a965 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPstnUsage.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPstnUsage.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspstnusage +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspstnusage schema: 2.0.0 title: Get-CsPstnUsage --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsPublicProvider.md index 29ac757812..dab30f22b4 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPublicProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspublicprovider schema: 2.0.0 title: Get-CsPublicProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPushNotificationConfiguration.md index 580c605952..e13e143fbc 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPushNotificationConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspushnotificationconfiguration schema: 2.0.0 title: Get-CsPushNotificationConfiguration --- @@ -221,8 +221,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration?view=skype-ps) -[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) +[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspushnotificationconfiguration?view=skype-ps) -[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) +[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsQoEConfiguration.md index eb9fce4d99..4f79f5c84b 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsQoEConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csqoeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csqoeconfiguration schema: 2.0.0 title: Get-CsQoEConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsRegistrarConfiguration.md index 591c212bdb..8d0992a2da 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRegistrarConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csregistrarconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csregistrarconfiguration schema: 2.0.0 title: Get-CsRegistrarConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsReportingConfiguration.md index e598155cdb..f506d40a04 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsReportingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csreportingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csreportingconfiguration schema: 2.0.0 title: Get-CsReportingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsAgentGroup.md index e8f3721061..5f130ac2d1 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsAgentGroup.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsagentgroup +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgsagentgroup schema: 2.0.0 title: Get-CsRgsAgentGroup --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsConfiguration.md index 3019907f6b..c7e990e0dc 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgsconfiguration schema: 2.0.0 title: Get-CsRgsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHolidaySet.md index 91ba05fdcf..d6bbb7114d 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHolidaySet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsholidayset +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgsholidayset schema: 2.0.0 title: Get-CsRgsHolidaySet --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHoursOfBusiness.md index c5cffefeb1..b620ba4c19 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHoursOfBusiness.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgshoursofbusiness +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgshoursofbusiness schema: 2.0.0 title: Get-CsRgsHoursOfBusiness --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsQueue.md index 5467636ce1..0842e2f4d8 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsQueue.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsqueue +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgsqueue schema: 2.0.0 title: Get-CsRgsQueue --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsWorkflow.md index bcd41be0dd..7b4a16108e 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsWorkflow.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsworkflow +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csrgsworkflow schema: 2.0.0 title: Get-CsRgsWorkflow --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsRoutingConfiguration.md index 7f54442604..430986aab9 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRoutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csroutingconfiguration schema: 2.0.0 title: Get-CsRoutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsServerApplication.md index d1ab8b49e6..ed93f964b4 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsServerApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csserverapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csserverapplication schema: 2.0.0 title: Get-CsServerApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsServerPatchVersion.md b/skype/skype-ps/SkypeForBusiness/Get-CsServerPatchVersion.md index edd0ef20ce..05178f93e2 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsServerPatchVersion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsServerPatchVersion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csserverpatchversion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csserverpatchversion schema: 2.0.0 title: Get-CsServerPatchVersion --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsServerVersion.md b/skype/skype-ps/SkypeForBusiness/Get-CsServerVersion.md index b1200356d5..8e61e94ed9 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsServerVersion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsServerVersion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csserverversion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csserverversion schema: 2.0.0 title: Get-CsServerVersion --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsService.md b/skype/skype-ps/SkypeForBusiness/Get-CsService.md index 4ecfc54541..4ec3a7f8f5 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsService.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsService.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csservice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csservice schema: 2.0.0 title: Get-CsService --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsSimpleUrlConfiguration.md index 199e940b89..0fa6b6d36f 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSimpleUrlConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cssimpleurlconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cssimpleurlconfiguration schema: 2.0.0 title: Get-CsSimpleUrlConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsSipDomain.md index cbcdd63297..70e53dafb9 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSipDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cssipdomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cssipdomain schema: 2.0.0 title: Get-CsSipDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsSipResponseCodeTranslationRule.md index cbaa86af09..bef4da9658 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSipResponseCodeTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cssipresponsecodetranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cssipresponsecodetranslationrule schema: 2.0.0 title: Get-CsSipResponseCodeTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsSite.md b/skype/skype-ps/SkypeForBusiness/Get-CsSite.md index 0de299322a..13b45d02a7 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsSite.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSite.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-cssite +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cssite schema: 2.0.0 title: Get-CsSite --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsSlaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsSlaConfiguration.md index 11dd5ebdc1..6cbadeb256 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsSlaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSlaConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csslaconfiguration schema: 2.0.0 title: Get-CsSlaConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsStaticRoutingConfiguration.md index 8e393013e2..af24fc6008 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsStaticRoutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csstaticroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csstaticroutingconfiguration schema: 2.0.0 title: Get-CsStaticRoutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsStorageServiceConfiguration.md index 5e7dcc3af7..6d209364e1 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsStorageServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/get-csstorageserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csstorageserviceconfiguration schema: 2.0.0 title: Get-CsStorageServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradeConfiguration.md index 8e1f2eb84d..523d97838a 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradeConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csteamsupgradeconfiguration schema: 2.0.0 title: Get-CsTeamsUpgradeConfiguration --- @@ -33,14 +33,14 @@ Get-CsTeamsUpgradeConfiguration [-Tenant ] [-Filter ] [-LocalStore ## DESCRIPTION TeamsUpgradeConfiguration is used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download the Teams app. It also allows administrators to determine which application Office 365 users should use to join Skype for Business meetings. -Separate instances of TeamsUpgradeConfiguration exist in Office 365 and Skype for Business Server. +Separate instances of TeamsUpgradeConfiguration exist in Office 365 and Skype for Business Server. - TeamsUpgradeConfiguration in Office 365 applies to any user who does not have an on-premises Skype for Business account. - TeamsUpgradeConfiguration in Skype for Business Server can used to manage on-premises users in a hybrid environment. In on-premises, only the DownloadTeams property is available. -The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download the Teams app in the background. This setting is only honored for users on Windows clients, and only if TeamsUpgradePolicy for the user meets either of these conditions: - - NotifySfbUser=true, or +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download the Teams app in the background. This setting is only honored for users on Windows clients, and only if TeamsUpgradePolicy for the user meets either of these conditions: + - NotifySfbUser=true, or - Mode=TeamsOnly - Otherwise, this setting is ignored. + Otherwise, this setting is ignored. The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: SkypeMeetingsApp and NativeLimitedClient. "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. This property is only available when configuring TeamsUpgradeConfiguration in Office 365. It is not honored for users homed on-premises in Skype for Business Server. @@ -66,7 +66,7 @@ The above cmdlet lists the properties of TeamsUpgradeConfiguration. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -84,7 +84,7 @@ Do not use ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -102,7 +102,7 @@ Accept wildcard characters: False ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradePolicy.md index 75295a9c17..33b3eaced3 100644 --- a/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradePolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csteamsupgradepolicy schema: 2.0.0 title: Get-CsTeamsUpgradePolicy --- @@ -34,10 +34,10 @@ Get-CsTeamsUpgradePolicy [-Tenant ] [-Filter ] [-LocalStore] [ Applicable: Microsoft Teams + Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. @@ -61,7 +64,6 @@ Valid inputs for this parameter are either the fully qualified domain name (FQDN Type: Fqdn Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -71,13 +73,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + Specifies the identity of the user who will be granted the graph policy. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -87,13 +91,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams + Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -103,6 +109,9 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Microsoft Teams + Specifies the name of the graph policy to grant to the tenant or user. The two options are: @@ -116,7 +125,6 @@ For example, `Grant-CsGraphPolicy -PolicyName "Graph Disabled"`. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -126,13 +134,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -142,13 +152,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -158,6 +170,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -165,7 +180,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsHostedVoicemailPolicy.md index c9d1065561..82cb8b3da0 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsHostedVoicemailPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/grant-cshostedvoicemailpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cshostedvoicemailpolicy schema: 2.0.0 title: Grant-CsHostedVoicemailPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsIPPhonePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsIPPhonePolicy.md index aa3d9bd679..443226329b 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsIPPhonePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsIPPhonePolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/grant-csipphonepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csipphonepolicy schema: 2.0.0 title: Grant-CsIPPhonePolicy, Skype for Business Server 2019 --- @@ -60,13 +60,15 @@ This collection of users is piped to the Grant-CsIPPhonePolicy cmdlet, which ass ## PARAMETERS ### -DomainController + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -76,6 +78,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + Specifies the identity of the target user. Acceptable values include: @@ -89,7 +94,6 @@ Example: 98403f08-577c-46dd-851a-f0460a13b03d Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: 1 @@ -99,6 +103,9 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + Including this switch enables you to pass a user object through the pipeline that represents the user account being assigned the voice routing policy. By default, the Grant-CsIPPhonePolicy cmdlet does not pass objects through the pipeline. @@ -106,7 +113,6 @@ By default, the Grant-CsIPPhonePolicy cmdlet does not pass objects through the p Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -116,6 +122,9 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + Specifies the name of the policy to be assigned. The PolicyName is the policy Identity minus the policy scope ("tag:"). For example, a policy that has the identity "tag:Redmond" has a PolicyName equal to "Redmond". @@ -126,7 +135,6 @@ For example: `Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName $Null` Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: 2 @@ -136,13 +144,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -152,13 +162,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -168,6 +180,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams, Skype for Business Server 2019 + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -175,7 +190,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsLocationPolicy.md index 2b39c52cb3..408f04ad56 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsLocationPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/grant-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cslocationpolicy schema: 2.0.0 title: Grant-CsLocationPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsMobilityPolicy.md index f63feaab5e..b6fb757e37 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsMobilityPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/grant-csmobilitypolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csmobilitypolicy schema: 2.0.0 title: Grant-CsMobilityPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsOUPermission.md b/skype/skype-ps/SkypeForBusiness/Grant-CsOUPermission.md index af92b0cd07..7dc547d5e1 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsOUPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsOUPermission.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/grant-csoupermission +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csoupermission schema: 2.0.0 title: Grant-CsOUPermission --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsPersistentChatPolicy.md index 403eeb9f36..c01595ad38 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsPersistentChatPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/grant-cspersistentchatpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cspersistentchatpolicy schema: 2.0.0 title: Grant-CsPersistentChatPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsPinPolicy.md index 5be543f393..1023e41e3c 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsPinPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/grant-cspinpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cspinpolicy schema: 2.0.0 title: Grant-CsPinPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsPresencePolicy.md index ac8a3f704b..de73bc50c6 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsPresencePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/grant-cspresencepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cspresencepolicy schema: 2.0.0 title: Grant-CsPresencePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsSetupPermission.md b/skype/skype-ps/SkypeForBusiness/Grant-CsSetupPermission.md index 3d8397be39..2462c8078c 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsSetupPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsSetupPermission.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/grant-cssetuppermission +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-cssetuppermission schema: 2.0.0 title: Grant-CsSetupPermission --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsTeamsUpgradePolicy.md index 228b9e229b..6372ed2925 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsTeamsUpgradePolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csteamsupgradepolicy schema: 2.0.0 title: Grant-CsTeamsUpgradePolicy --- @@ -41,11 +41,11 @@ Grant-CsTeamsUpgradePolicy [-MigrateMeetingsToTeams ] [-PassThru] [[-Po ## DESCRIPTION -TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. As an organization with Skype for Business starts to adopt Teams, administrators can manage the user experience in their organization using the concept of coexistence "mode". Mode defines in which client incoming chats and calls land as well as in what service (Teams or Skype for Business) new meetings are scheduled in. Mode also governs what functionality is available in the Teams client. Finally, prior to upgrading to TeamsOnly mode administrators can use TeamsUpgradePolicy to trigger notifications in the Skype for Business client to inform users of the pending upgrade. +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. As an organization with Skype for Business starts to adopt Teams, administrators can manage the user experience in their organization using the concept of coexistence "mode". Mode defines in which client incoming chats and calls land as well as in what service (Teams or Skype for Business) new meetings are scheduled in. Mode also governs what functionality is available in the Teams client. Finally, prior to upgrading to TeamsOnly mode administrators can use TeamsUpgradePolicy to trigger notifications in the Skype for Business client to inform users of the pending upgrade. -This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. +This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. -**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in later versions of the module. Tenants must run Start-CsExMeetingMigration. See [Start-CsExMeetingMigrationService](/powershell/module/skype/start-csexmeetingmigration). +**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in later versions of the module. Tenants must run Start-CsExMeetingMigration. See [Start-CsExMeetingMigrationService](/powershell/module/skypeforbusiness/start-csexmeetingmigration). Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are as follows: @@ -68,20 +68,20 @@ Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built- > [!NOTE] -> - TeamsUpgradePolicy is available in both Office 365 and in on-premises versions of Skype for Business Server, but there are differences: -> -> - In Office 365, admins can specify both coexistence mode and whether to trigger notifications of pending upgrade. -> +> - TeamsUpgradePolicy is available in both Office 365 and in on-premises versions of Skype for Business Server, but there are differences: +> +> - In Office 365, admins can specify both coexistence mode and whether to trigger notifications of pending upgrade. +> > - In on-premises with Skype for Business Server, the only available option is to trigger notifications. Skype for Business Server 2015 with CU8 or Skype for Business Server 2019 are required. -> +> > - TeamsUpgradePolicy in Office 365 can be granted to users homed on-premises in hybrid deployments of Skype for Business as follows: -> -> - Coexistence mode is honored by users homed on-premises, however on-premises users cannot be granted the UpgradeToTeams instance (mode=TeamsOnly) of TeamsUpgradePolicy. To be upgraded to TeamsOnly mode, users must be either homed in Skype for Business Online or have no Skype account anywhere. -> -> - The NotifySfBUsers setting of Office 365 TeamsUpgradePolicy is not honored by users homed on-premises. Instead, the on-premises version of TeamsUpgradePolicy must be used. -> +> +> - Coexistence mode is honored by users homed on-premises, however on-premises users cannot be granted the UpgradeToTeams instance (mode=TeamsOnly) of TeamsUpgradePolicy. To be upgraded to TeamsOnly mode, users must be either homed in Skype for Business Online or have no Skype account anywhere. +> +> - The NotifySfBUsers setting of Office 365 TeamsUpgradePolicy is not honored by users homed on-premises. Instead, the on-premises version of TeamsUpgradePolicy must be used. +> > - In Office 365, all relevant instances of TeamsUpgradePolicy are built into the system, so there is no corresponding New cmdlet available. In contrast, Skype for Business Server does not contain built-in instances, so the New cmdlet is available on-premises. Only NotifySfBUsers property is available in on-premises. -> +> > - When granting a user a policy with mode=TeamsOnly or mode=SfBWithTeamsCollabAndMeetings, by default, meetings organized by that user will be migrated to Teams. For details, see [Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). @@ -104,7 +104,7 @@ The `Grant-CsTeamsUpgradePolicy` cmdlet checks the configuration of the correspo PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName UpgradeToTeams -Identity mike@contoso.com ``` -The above cmdlet assigns the "UpgradeToTeams" policy to user Mike@contoso.com. This effectively upgrades the user to Teams only mode. This command will only succeed if the user does not have an on-premises Skype for Business account. +The above cmdlet assigns the "UpgradeToTeams" policy to user Mike@contoso.com. This effectively upgrades the user to Teams only mode. This command will only succeed if the user does not have an on-premises Skype for Business account. ### Example 2: Remove Policy for an individual user @@ -112,9 +112,9 @@ The above cmdlet assigns the "UpgradeToTeams" policy to user Mike@contoso.com. PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName $null -Identity mike@contoso.com ``` -The above cmdlet removes any policy changes made to user Mike@contoso.com and effectively Inherits the global tenant setting for teams Upgrade. +The above cmdlet removes any policy changes made to user Mike@contoso.com and effectively Inherits the global tenant setting for teams Upgrade. -### Example 3: Grant Policy to the entire tenant +### Example 3: Grant Policy to the entire tenant ```powershell PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName SfBOnly -Global @@ -193,7 +193,7 @@ Use this switch if you want to grant the specified policy to be the default poli ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -226,7 +226,7 @@ The user you want to grant policy to. This can be specified as SIP address, User ```yaml Type: UserIdParameter Parameter Sets: Identity -Aliases: +Aliases: Required: False Position: 0 @@ -276,7 +276,7 @@ The name of the policy instance. ```yaml Type: Object Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -309,7 +309,7 @@ Do not use. ```yaml Type: Object Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsThirdPartyVideoSystemPolicy.md index 3a8c775ff4..e17c24a9c7 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsThirdPartyVideoSystemPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/grant-csthirdpartyvideosystempolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csthirdpartyvideosystempolicy schema: 2.0.0 title: Grant-CsThirdPartyVideoSystemPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsUserServicesPolicy.md index 3a5e074823..b373c680f0 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsUserServicesPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/grant-csuserservicespolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csuserservicespolicy schema: 2.0.0 title: Grant-CsUserServicesPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsVoicePolicy.md index 1b0d990881..cb81b4ba9c 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsVoicePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/grant-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csvoicepolicy schema: 2.0.0 title: Grant-CsVoicePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Grant-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsVoiceRoutingPolicy.md index 71867779da..c7832e9d92 100644 --- a/skype/skype-ps/SkypeForBusiness/Grant-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsVoiceRoutingPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/grant-csvoiceroutingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csvoiceroutingpolicy schema: 2.0.0 title: Grant-CsVoiceRoutingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CSAnnouncementFile.md b/skype/skype-ps/SkypeForBusiness/Import-CSAnnouncementFile.md index 1862ba5836..36aee95683 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CSAnnouncementFile.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CSAnnouncementFile.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-csannouncementfile +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csannouncementfile schema: 2.0.0 title: Import-CSAnnouncementFile --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Import-CsCertificate.md index b9634dd6a6..f083e4ec22 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsCertificate.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-cscertificate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cscertificate schema: 2.0.0 title: Import-CsCertificate --- @@ -23,23 +23,16 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### Local (Default) ``` -Import-CsCertificate -Path [-Password ] [-PrivateKeyExportable ] [-Force] - [-Report ] [-WhatIf] [-Confirm] [] +Import-CsCertificate -Path [-Password ] [-PrivateKeyExportable ] + [-EffectiveDate ] [-Roll] [-Force] [-Report ] [-WhatIf] [-Confirm] [] ``` ### CMS ``` -Import-CsCertificate [-Identity] -Path -Type [-Confirm] - [-EffectiveDate ] [-Force] [-Password ] [-Report ] [-Roll] [-WhatIf] - [] -``` - -### Local -``` -Import-CsCertificate -Path [-Confirm] [-EffectiveDate ] [-Force] [-Password ] - [-PrivateKeyExportable ] [-Report ] [-Roll] [-WhatIf] [] +Import-CsCertificate [-Identity] -Path [-Password ] -Type + [-EffectiveDate ] [-Roll] [-Force] [-Report ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -79,8 +72,8 @@ For example, to configure a certificate for first use at 8:00 AM on July 31, 201 `-EffectiveTime "7/31/2012 8:00 AM"` ```yaml -Type: DateTime -Parameter Sets: CMS, Local +Type: System.DateTime +Parameter Sets: (All) Aliases: EffectiveTime Required: False @@ -97,13 +90,13 @@ Accept wildcard characters: False Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -116,7 +109,7 @@ When set to Global, enables the certificate to function at the global scope. Global certificates will automatically be copied and distributed to the appropriate computers. ```yaml -Type: XdsIdentity +Type: Microsoft.Rtc.Management.Xds.XdsIdentity Parameter Sets: CMS Aliases: @@ -134,7 +127,7 @@ Accept wildcard characters: False Password associated with the certificate file. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -153,7 +146,7 @@ Full path to the certificate file to be imported. For example: `-Path "C:\Certificates\WebServer.cer".` ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -171,8 +164,8 @@ Accept wildcard characters: False When set to True, ensures that the private key portion of the certificate can be read by the Network Service account. ```yaml -Type: Boolean -Parameter Sets: (All), Local +Type: System.Boolean +Parameter Sets: Local Aliases: Required: False @@ -190,7 +183,7 @@ Enables you to specify a file path for the log file created when the cmdlet runs For example: `-Report "C:\Logs\Certificates.html"` ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -209,13 +202,13 @@ Enables you to update the specified certificate at the date and time specified b Note that your command will fail if you specify the Roll parameter without including the EffectiveDate parameter. ```yaml -Type: SwitchParameter -Parameter Sets: CMS, Local +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -227,50 +220,29 @@ Accept wildcard characters: False Type of certificate being requested. Certificate types include, but are not limited to, the following: -AccessEdgeExternal - -AudioVideoAuthentication - -DataEdgeExternal - -Default - -External - -Internal - -iPadAPNService - -iPhoneAPNService - -LogRetentionService - -MPNService - -OAuthTokenIssuer - -PICWebService - -ProvisionService - -SMPDNSWebService - -TenantAdmin - -UpgradeEngineService - -WebServicesExternal - -WebServicesInternal - -WsFedTokenTransfer - -XMPPServer - - +- AccessEdgeExternal +- AudioVideoAuthentication +- DataEdgeExternal +- Default +- External +- Internal +- iPadAPNService +- iPhoneAPNService +- LogRetentionService +- MPNService +- OAuthTokenIssuer +- PICWebService +- ProvisionService +- SMPDNSWebService +- TenantAdmin +- UpgradeEngineService +- WebServicesExternal +- WebServicesInternal +- WsFedTokenTransfer +- XMPPServer ```yaml -Type: CertType[] +Type: Microsoft.Rtc.Management.Deployment.CertType[] Parameter Sets: CMS Aliases: @@ -288,13 +260,13 @@ Accept wildcard characters: False Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -306,19 +278,19 @@ Accept wildcard characters: False Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsCompanyPhoneNormalizationRules.md b/skype/skype-ps/SkypeForBusiness/Import-CsCompanyPhoneNormalizationRules.md index 396297431c..9d98d022c7 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsCompanyPhoneNormalizationRules.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsCompanyPhoneNormalizationRules.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-cscompanyphonenormalizationrules +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cscompanyphonenormalizationrules schema: 2.0.0 title: Import-CsCompanyPhoneNormalizationRules --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsConfiguration.md index 6fe53880c2..d1c19492f1 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-csconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csconfiguration schema: 2.0.0 title: Import-CsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsDeviceUpdate.md b/skype/skype-ps/SkypeForBusiness/Import-CsDeviceUpdate.md index b1d5e62a98..7cb14051a4 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsDeviceUpdate.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsDeviceUpdate.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-csdeviceupdate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csdeviceupdate schema: 2.0.0 title: Import-CsDeviceUpdate --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConferenceDirectory.md index 0bcaa26f6b..27392e0c86 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConferenceDirectory.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-cslegacyconferencedirectory +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cslegacyconferencedirectory schema: 2.0.0 title: Import-CsLegacyConferenceDirectory --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConfiguration.md index 00b74e153a..44ca95194f 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-cslegacyconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cslegacyconfiguration schema: 2.0.0 title: Import-CsLegacyConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsLisConfiguration.md index cbcfbea3a4..ab7e2c6734 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsLisConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cslisconfiguration schema: 2.0.0 title: Import-CsLisConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsPersistentChatData.md b/skype/skype-ps/SkypeForBusiness/Import-CsPersistentChatData.md index c1f070b50d..5baf53598f 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsPersistentChatData.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsPersistentChatData.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-cspersistentchatdata +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-cspersistentchatdata schema: 2.0.0 title: Import-CsPersistentChatData --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsRgsAudioFile.md b/skype/skype-ps/SkypeForBusiness/Import-CsRgsAudioFile.md index fdab9b58e3..9e75832851 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsRgsAudioFile.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsRgsAudioFile.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-csrgsaudiofile +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csrgsaudiofile schema: 2.0.0 title: Import-CsRgsAudioFile --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsRgsConfiguration.md index 6474a9db95..812b6ad4e6 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsRgsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-csrgsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csrgsconfiguration schema: 2.0.0 title: Import-CsRgsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Import-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Import-CsUserData.md index 1a6ebe9d5b..18ad46d95b 100644 --- a/skype/skype-ps/SkypeForBusiness/Import-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsUserData.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/import-csuserdata +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/import-csuserdata schema: 2.0.0 title: Import-CsUserData --- diff --git a/skype/skype-ps/SkypeForBusiness/Install-CsAdServerSchema.md b/skype/skype-ps/SkypeForBusiness/Install-CsAdServerSchema.md index f3d696c34f..2af92daaec 100644 --- a/skype/skype-ps/SkypeForBusiness/Install-CsAdServerSchema.md +++ b/skype/skype-ps/SkypeForBusiness/Install-CsAdServerSchema.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/install-csadserverschema +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/install-csadserverschema schema: 2.0.0 title: Install-CsAdServerSchema --- diff --git a/skype/skype-ps/SkypeForBusiness/Install-CsDatabase.md b/skype/skype-ps/SkypeForBusiness/Install-CsDatabase.md index 62c86dc998..9ee4fa1d42 100644 --- a/skype/skype-ps/SkypeForBusiness/Install-CsDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Install-CsDatabase.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/install-csdatabase +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/install-csdatabase schema: 2.0.0 title: Install-CsDatabase --- diff --git a/skype/skype-ps/SkypeForBusiness/Install-CsMirrorDatabase.md b/skype/skype-ps/SkypeForBusiness/Install-CsMirrorDatabase.md index d6ad4951a4..45d5af9ec1 100644 --- a/skype/skype-ps/SkypeForBusiness/Install-CsMirrorDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Install-CsMirrorDatabase.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/install-csmirrordatabase +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/install-csmirrordatabase schema: 2.0.0 title: Install-CsMirrorDatabase --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsArchivingDatabasePurge.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsArchivingDatabasePurge.md index 0ae14fe708..f36b95f89d 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsArchivingDatabasePurge.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsArchivingDatabasePurge.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csarchivingdatabasepurge +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csarchivingdatabasepurge schema: 2.0.0 title: Invoke-CsArchivingDatabasePurge --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsBackupServiceSync.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsBackupServiceSync.md index badaf35899..e68a427b48 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsBackupServiceSync.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsBackupServiceSync.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csbackupservicesync +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csbackupservicesync schema: 2.0.0 title: Invoke-CsBackupServiceSync --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsCdrDatabasePurge.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsCdrDatabasePurge.md index c30677de57..184d913498 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsCdrDatabasePurge.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsCdrDatabasePurge.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscdrdatabasepurge +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-cscdrdatabasepurge schema: 2.0.0 title: Invoke-CsCdrDatabasePurge --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailBack.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailBack.md index e55abec0b1..26594423a2 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailBack.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailBack.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscomputerfailback +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-cscomputerfailback schema: 2.0.0 title: Invoke-CsComputerFailBack --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailOver.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailOver.md index 895195df4a..9b6c2a4d82 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailOver.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailOver.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscomputerfailover +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-cscomputerfailover schema: 2.0.0 title: Invoke-CsComputerFailOver --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsDatabaseFailover.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsDatabaseFailover.md index 3c8707e526..6bf0a475fd 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsDatabaseFailover.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsDatabaseFailover.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csdatabasefailover +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csdatabasefailover schema: 2.0.0 title: Invoke-CsDatabaseFailover --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementServerFailover.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementServerFailover.md index 69d725a599..74d8ffdb34 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementServerFailover.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementServerFailover.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csmanagementserverfailover +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csmanagementserverfailover schema: 2.0.0 title: Invoke-CsManagementServerFailover --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementStoreReplication.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementStoreReplication.md index b30733dc33..5e9761f390 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementStoreReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementStoreReplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csmanagementstorereplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csmanagementstorereplication schema: 2.0.0 title: Invoke-CsManagementStoreReplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailBack.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailBack.md index 18f91e8113..aa80db5c7d 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailBack.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailBack.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cspoolfailback +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-cspoolfailback schema: 2.0.0 title: Invoke-CsPoolFailBack --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailOver.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailOver.md index fd708e6be8..644dffd905 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailOver.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailOver.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cspoolfailover +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-cspoolfailover schema: 2.0.0 title: Invoke-CsPoolFailOver --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsQoEDatabasePurge.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsQoEDatabasePurge.md index 183d210fda..f09e0b15e7 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsQoEDatabasePurge.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsQoEDatabasePurge.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csqoedatabasepurge +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csqoedatabasepurge schema: 2.0.0 title: Invoke-CsQoEDatabasePurge --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsRgsStoreReplicateData.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsRgsStoreReplicateData.md index 756ab11e04..edcfdd3f7a 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsRgsStoreReplicateData.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsRgsStoreReplicateData.md @@ -6,12 +6,12 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csrgsstorereplicatedata +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csrgsstorereplicatedata schema: 2.0.0 -title: Invoke-CsRGSStoreReplicateData +title: Invoke-CsRgsStoreReplicateData --- -# Invoke-CsRGSStoreReplicateData +# Invoke-CsRgsStoreReplicateData ## SYNOPSIS Replicate existing RGS data present on the specified pool to the backup tables so that data can be picked up by RGSBackupService. @@ -19,11 +19,11 @@ Replicate existing RGS data present on the specified pool to the backup tables s ## SYNTAX ``` -Invoke-CsRGSStoreReplicateData -PoolFqdn [-Force] [] +Invoke-CsRgsStoreReplicateData -PoolFqdn [-Force] [] ``` ## DESCRIPTION -The Invoke-CsRGSStoreReplicateData cmdlet enables administrators to replicate existing RGS data(RGS entities created before CU1 installation) present on the specified pool to the backup tables so that data can be picked by backupservice. Backup service will sync RGS data to the paired pool if RGSBackupSerice in enabled. +The Invoke-CsRgsStoreReplicateData cmdlet enables administrators to replicate existing RGS data(RGS entities created before CU1 installation) present on the specified pool to the backup tables so that data can be picked by backupservice. Backup service will sync RGS data to the paired pool if RGSBackupSerice in enabled. Skype for Business Server Control Panel: The functions carried out by the Invoke- CsRGSStoreReplicateData cmdlet are not available in the Skype for Business Server Control Panel. @@ -31,7 +31,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ### Example 1 ``` -Invoke-CsRGSStoreReplicateData -PoolFqdn "atl-cs-001.litwareinc.com" +Invoke-CsRgsStoreReplicateData -PoolFqdn "atl-cs-001.litwareinc.com" ``` The command shown in Example 1 replicates the RGS data for the pool atl-cs-001.litwareinc.com to the back up table. @@ -80,7 +80,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None. The Invoke-CsRGSStoreReplicateData cmdlet does not accept pipelined data. +### None. The Invoke-CsRgsStoreReplicateData cmdlet does not accept pipelined data. ## OUTPUTS diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsStorageServiceFlush.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsStorageServiceFlush.md index 7c667e19f6..e99d0c107b 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsStorageServiceFlush.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsStorageServiceFlush.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csstorageserviceflush +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csstorageserviceflush schema: 2.0.0 title: Invoke-CsStorageServiceFlush --- diff --git a/skype/skype-ps/SkypeForBusiness/Invoke-CsUcsRollback.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsUcsRollback.md index 143652e5f4..03518eb58d 100644 --- a/skype/skype-ps/SkypeForBusiness/Invoke-CsUcsRollback.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsUcsRollback.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csucsrollback +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/invoke-csucsrollback schema: 2.0.0 title: Invoke-CsUcsRollback --- diff --git a/skype/skype-ps/SkypeForBusiness/Lock-CsClientPin.md b/skype/skype-ps/SkypeForBusiness/Lock-CsClientPin.md index 0e36ee93c3..26255993b9 100644 --- a/skype/skype-ps/SkypeForBusiness/Lock-CsClientPin.md +++ b/skype/skype-ps/SkypeForBusiness/Lock-CsClientPin.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/lock-csclientpin +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/lock-csclientpin schema: 2.0.0 title: Lock-CsClientPin --- diff --git a/skype/skype-ps/SkypeForBusiness/Merge-CsLegacyTopology.md b/skype/skype-ps/SkypeForBusiness/Merge-CsLegacyTopology.md index 5af8dfbd90..d6c67daeb3 100644 --- a/skype/skype-ps/SkypeForBusiness/Merge-CsLegacyTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Merge-CsLegacyTopology.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/merge-cslegacytopology +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/merge-cslegacytopology schema: 2.0.0 title: Merge-CsLegacyTopology --- diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Move-CsAnalogDevice.md index 6a07a096cc..b18f28a8ea 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsAnalogDevice.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-csanalogdevice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csanalogdevice schema: 2.0.0 title: Move-CsAnalogDevice --- @@ -23,25 +23,18 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### Identity (Default) ``` -Move-CsAnalogDevice [-Identity] [-Target] [-DomainController ] - [-ProxyPool ] [-Force] [-PassThru] [-WhatIf] [-Confirm] [-IgnoreBackendStoreException] - [] -``` - -### Identity -``` -Move-CsAnalogDevice [-Identity] [-Target] [-Confirm] [-DomainController ] - [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] [-Report ] [-WhatIf] - [] +Move-CsAnalogDevice [-Target] [-Report ] [-Force] [-UseLegacyMode] + [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-Identity] + [-PassThru] [-WhatIf] [-Confirm] [] ``` ### Users ``` -Move-CsAnalogDevice [-Target] -UserList [-ConcurrentMovesPerFE ] [-Confirm] - [-DomainController ] [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] - [-Report ] [-WhatIf] [] +Move-CsAnalogDevice [-Target] -UserList [-Report ] [-Force] [-UseLegacyMode] + [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -57,7 +50,6 @@ After a device has been associated with a contact object, you can then manage th The Move-CsAnalogDevice cmdlet provides a way for you to move an existing analog device to a new Registrar pool. - ## EXAMPLES ### EXAMPLE 1 @@ -95,24 +87,6 @@ The filtered collection is then piped to the Move-CsAnalogDevice cmdlet, which m ## PARAMETERS -### -ConcurrentMovesPerFE - -> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - -PARAMVALUE: Int32 - -```yaml -Type: Int32 -Parameter Sets: Users -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -DomainController > Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 @@ -140,13 +114,13 @@ If present, moves the analog device but deletes any associated data (such as pol If not present, the device is moved along with any associated data. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -160,8 +134,8 @@ Analog devices are identified by using the Active Directory distinguished name o By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. ```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity +Type: Microsoft.Rtc.Management.AD.UserIdParameter +Parameter Sets: Identity Aliases: Required: True @@ -178,13 +152,13 @@ Accept wildcard characters: False When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the common area phone despite those errors. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -197,13 +171,13 @@ Enables you to pass a user object through the pipeline that represents the user By default, the Move-CsAnalogDevice cmdlet does not pass objects through the pipeline. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -218,7 +192,7 @@ It should not be used with an on-premises implementation of Skype for Business S ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: @@ -236,8 +210,8 @@ Accept wildcard characters: False PARAMVALUE: String ```yaml -Type: String -Parameter Sets: Identity, Users +Type: System.String +Parameter Sets: (All) Aliases: Required: False @@ -255,7 +229,7 @@ The fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com) In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: @@ -266,6 +240,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseLegacyMode +{{ Fill UseLegacyMode Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UserList > Applicable: Skype for Business Server 2015, Skype for Business Server 2019 @@ -273,7 +262,7 @@ Accept wildcard characters: False PARAMVALUE: String ```yaml -Type: String +Type: System.String Parameter Sets: Users Aliases: @@ -291,13 +280,13 @@ Accept wildcard characters: False Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -309,19 +298,19 @@ Accept wildcard characters: False Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Move-CsApplicationEndpoint.md index 0388a31e34..8a2190362f 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsApplicationEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-csapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csapplicationendpoint schema: 2.0.0 title: Move-CsApplicationEndpoint --- diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Move-CsCommonAreaPhone.md index 7e44731e2f..7c5968f18f 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsCommonAreaPhone.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-cscommonareaphone +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-cscommonareaphone schema: 2.0.0 title: Move-CsCommonAreaPhone --- @@ -22,25 +22,18 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### Identity (Default) ``` -Move-CsCommonAreaPhone [-Identity] [-Target] [-DomainController ] - [-ProxyPool ] [-Force] [-PassThru] [-WhatIf] [-Confirm] [-IgnoreBackendStoreException] - [] -``` - -### Identity -``` -Move-CsCommonAreaPhone [-Identity] [-Target] [-Confirm] [-DomainController ] - [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] [-Report ] [-WhatIf] - [] +Move-CsCommonAreaPhone [-Target] [-Report ] [-Force] [-UseLegacyMode] + [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-Identity] + [-PassThru] [-WhatIf] [-Confirm] [] ``` ### Users ``` -Move-CsCommonAreaPhone [-Target] -UserList [-ConcurrentMovesPerFE ] [-Confirm] - [-DomainController ] [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] - [-Report ] [-WhatIf] [] +Move-CsCommonAreaPhone [-Target] -UserList [-Report ] [-Force] [-UseLegacyMode] + [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -59,7 +52,6 @@ For example, if you do not want people to have the ability to transfer or park c The Move-CsCommonAreaPhone cmdlet enables you to move an existing common area phone to a new Registrar pool. - ## EXAMPLES ### EXAMPLE 1 @@ -105,24 +97,6 @@ To do this, the PassThru parameter is included when calling the Move-CsCommonAre ## PARAMETERS -### -ConcurrentMovesPerFE - -> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - -PARAMVALUE: Int32 - -```yaml -Type: Int32 -Parameter Sets: Users -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -DomainController > Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 @@ -131,7 +105,7 @@ Enables you to connect to the specified domain controller in order to move the c To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (for example, atl-cs-001.litwareinc.com). ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: @@ -150,13 +124,13 @@ If present, moves the common area phone but deletes any associated data (such as If not present, the phone is moved along with any associated data. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -170,8 +144,8 @@ Common area phones are identified using the Active Directory distinguished name By default, common area phones use a globally unique identifier (GUID) as their common name, which means that phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. ```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity +Type: Microsoft.Rtc.Management.AD.UserIdParameter +Parameter Sets: Identity Aliases: Required: True @@ -188,13 +162,13 @@ Accept wildcard characters: False When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the common area phone despite those errors. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -207,13 +181,13 @@ Enables you to pass a user object through the pipeline that represents the user By default, the Move-CsCommonAreaPhone cmdlet does not pass objects through the pipeline. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -228,7 +202,7 @@ It should not be used with an on-premises implementation of Skype for Business S ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: @@ -246,8 +220,8 @@ Accept wildcard characters: False PARAMVALUE: String ```yaml -Type: String -Parameter Sets: Identity, Users +Type: System.String +Parameter Sets: (All) Aliases: Required: False @@ -265,7 +239,7 @@ The fully qualified domain name (FQDN) of the Registrar pool where the common ar In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: @@ -276,6 +250,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseLegacyMode +{{ Fill UseLegacyMode Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UserList > Applicable: Skype for Business Server 2015, Skype for Business Server 2019 @@ -283,7 +272,7 @@ Accept wildcard characters: False PARAMVALUE: String ```yaml -Type: String +Type: System.String Parameter Sets: Users Aliases: @@ -301,13 +290,13 @@ Accept wildcard characters: False Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -319,13 +308,13 @@ Accept wildcard characters: False Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Move-CsConferenceDirectory.md index e45852a7cd..fd92131772 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsConferenceDirectory.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-csconferencedirectory +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csconferencedirectory schema: 2.0.0 title: Move-CsConferenceDirectory --- diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Move-CsExUmContact.md index 1229d5fa86..951916a929 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsExUmContact.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-csexumcontact +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csexumcontact schema: 2.0.0 title: Move-CsExUmContact --- @@ -22,24 +22,18 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### Identity (Default) ``` -Move-CsExUmContact [-Identity] [-Target] [-Confirm] [-DomainController ] - [-Force] [-PassThru] [-ProxyPool ] [-WhatIf] [-IgnoreBackendStoreException] [] -``` - -### Identity -``` -Move-CsExUmContact [-Identity] [-Target] [-Confirm] [-DomainController ] - [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] [-Report ] [-WhatIf] +Move-CsExUmContact [-Target] [-Report ] [-Force] [-UseLegacyMode] [-IgnoreBackendStoreException] + [-ProxyPool ] [-DomainController ] [-Identity] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### Users ``` -Move-CsExUmContact [-Target] -UserList [-ConcurrentMovesPerFE ] [-Confirm] - [-DomainController ] [-Force] [-IgnoreBackendStoreException] [-PassThru] [-ProxyPool ] - [-Report ] [-WhatIf] [] +Move-CsExUmContact [-Target] -UserList [-Report ] [-Force] [-UseLegacyMode] + [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -81,24 +75,6 @@ As in Example 1, you will be prompted for confirmation when running this command ## PARAMETERS -### -ConcurrentMovesPerFE - -> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - -PARAMVALUE: Int32 - -```yaml -Type: Int32 -Parameter Sets: Users -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -DomainController > Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 @@ -107,7 +83,7 @@ Enables you to connect to the specified domain controller. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its FQDN (for example, atl-mcs-001.litwareinc.com). ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: @@ -125,7 +101,7 @@ Accept wildcard characters: False Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -144,8 +120,8 @@ The unique identifier of the contact object you want to move. Contact identities can be specified by using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant). ```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity +Type: Microsoft.Rtc.Management.AD.UserIdParameter +Parameter Sets: Identity Aliases: Required: True @@ -162,13 +138,13 @@ Accept wildcard characters: False When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the contact despite those errors. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -181,13 +157,13 @@ Enables you to pass a contact object through the pipeline that represents the co By default, the Move-CsExUmContact cmdlet does not pass objects through the pipeline. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -202,7 +178,7 @@ It should not be used with an on-premises implementation of Skype for Business S ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: @@ -220,8 +196,8 @@ Accept wildcard characters: False PARAMVALUE: String ```yaml -Type: String -Parameter Sets: Identity, Users +Type: System.String +Parameter Sets: (All) Aliases: Required: False @@ -238,7 +214,7 @@ Accept wildcard characters: False The fully qualified domain name (FQDN) of the Registrar pool to which the contact is being moved. ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: @@ -249,6 +225,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseLegacyMode +{{ Fill UseLegacyMode Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UserList > Applicable: Skype for Business Server 2015, Skype for Business Server 2019 @@ -256,7 +247,7 @@ Accept wildcard characters: False PARAMVALUE: String ```yaml -Type: String +Type: System.String Parameter Sets: Users Aliases: @@ -274,13 +265,13 @@ Accept wildcard characters: False Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -292,19 +283,19 @@ Accept wildcard characters: False Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsLegacyUser.md b/skype/skype-ps/SkypeForBusiness/Move-CsLegacyUser.md index 2ff47ec8f5..b7235c61b5 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsLegacyUser.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsLegacyUser.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-cslegacyuser +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-cslegacyuser schema: 2.0.0 title: Move-CsLegacyUser --- diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsManagementServer.md b/skype/skype-ps/SkypeForBusiness/Move-CsManagementServer.md index 4d1302df58..929a8b740e 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsManagementServer.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsManagementServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-csmanagementserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csmanagementserver schema: 2.0.0 title: Move-CsManagementServer --- @@ -22,16 +22,34 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### FromBackup (Default) ``` -Move-CsManagementServer [-ConfigurationFileName ] [-LisConfigurationFileName ] [-Force] - [-Report ] [-WhatIf] [-Confirm] [] +Move-CsManagementServer [-ConfigurationFileName ] [-LisConfigurationFileName ] + [-TargetFqdn ] [-Force] [-Report ] [-WhatIf] [-Confirm] [] ``` -### FromBackup +### UseSqlBackup ``` -Move-CsManagementServer [-ConfigurationFileName ] [-Confirm] [-Force] - [-LisConfigurationFileName ] [-Report ] [-TargetFqdn ] [-WhatIf] [] +Move-CsManagementServer [-TargetFqdn ] [-Force] [-Report ] [-WhatIf] [-Confirm] + [] +``` + +### DisasterMode +``` +Move-CsManagementServer [-TargetFqdn ] [-Force] [-Report ] [-WhatIf] [-Confirm] + [] +``` + +### NonUserPool +``` +Move-CsManagementServer [-TargetFqdn ] [-Force] [-Report ] [-WhatIf] [-Confirm] + [] +``` + +### NonUserPoolDisasterMode +``` +Move-CsManagementServer [-TargetFqdn ] [-Force] [-Report ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -121,8 +139,8 @@ This parameter should only be used in a disaster recovery scenario. ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: FromBackup Aliases: CsConfiguration Required: False @@ -144,13 +162,13 @@ The Force parameter can also be used if your previous attempts at calling the Mo ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -163,8 +181,8 @@ Full path to the E9-1-1 backup file created by running the Export-CsLisConfigura This parameter should only be used in a disaster recovery scenario. ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: FromBackup Aliases: CsLisConfiguration Required: False @@ -182,7 +200,7 @@ Enables you to specify a file path for the log file created when the cmdlet runs For example: `-Report "C:\Logs\MoveManagementServer.html"` ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -218,13 +236,13 @@ Accept wildcard characters: False Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -236,13 +254,13 @@ Accept wildcard characters: False Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Move-CsMeetingRoom.md index a03f3df92e..87720f64b5 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsMeetingRoom.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-csmeetingroom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csmeetingroom schema: 2.0.0 title: Move-CsMeetingRoom --- diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Move-CsRgsConfiguration.md index 278c1b3317..8415a632bf 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsRgsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-csrgsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csrgsconfiguration schema: 2.0.0 title: Move-CsRgsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Move-CsThirdPartyVideoSystem.md index 06fbd97f0c..89d073182a 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsThirdPartyVideoSystem.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-csthirdpartyvideosystem +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csthirdpartyvideosystem schema: 2.0.0 title: Move-CsThirdPartyVideoSystem --- diff --git a/skype/skype-ps/SkypeForBusiness/Move-CsUser.md b/skype/skype-ps/SkypeForBusiness/Move-CsUser.md index 6621d6074f..af6e71552d 100644 --- a/skype/skype-ps/SkypeForBusiness/Move-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsUser.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/move-csuser +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/move-csuser schema: 2.0.0 title: Move-CsUser --- @@ -15,33 +15,39 @@ title: Move-CsUser ## SYNOPSIS -Moves one or more user accounts enabled for Skype for Business Server to TeamsOnly (or the reverse). This cmdlet also can be used to move on-premises users from one pool to another. - -**PRE-REQUISITES steps for running Move-CsUser** -- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later - -**PRE-REQUISITES steps for** [Office 365 operated by 21Vianet](/microsoft-365/admin/services-in-china/services-in-china?view=o365-21vianet) -- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later -- Run Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina - -For more information, see [Set-TeamsEnvironmentConfig](/powershell/module/teams/set-teamsenvironmentconfig). +Moves one or more user accounts enabled for Skype for Business Server to TeamsOnly (or the reverse). This cmdlet also can be used to move on-premises users from one pool to another. ## SYNTAX -### (Default) - +### Identity (Default) ``` -Move-CsUser [-Identity] [-Target] [-Credential ] [-UseOAuth] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-ProxyPool ] [-MoveConferenceData] [-Report ] [-DomainController ] [-Confirm] [-Force] [-PassThru] [-WhatIf] [] +Move-CsUser [-Identity] [-Credential ] [-Target] [-MoveToTeams] + [-HostedMigrationOverrideUrl ] [-TenantAdminUserName ] [-BypassAudioConferencingCheck] + [-BypassEnterpriseVoiceCheck] [-AccessTokens ] [-MoveConferenceData] [-Report ] [-Force] + [-UseLegacyMode] [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-PassThru] + [-WhatIf] [-Confirm] [] ``` -### UserList - +### Users ``` -Move-CsUser -UserList [-Target] [-Credential ] [-UseOAuth] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-ProxyPool ] [-MoveConferenceData] [-Report ] [-DomainController ] [-Confirm] [-Force] [-PassThru] [-WhatIf] [] +Move-CsUser [-Credential ] [-Target] [-MoveToTeams] [-HostedMigrationOverrideUrl ] + [-TenantAdminUserName ] [-BypassAudioConferencingCheck] [-BypassEnterpriseVoiceCheck] + [-AccessTokens ] [-MoveConferenceData] -UserList [-Report ] [-Force] + [-UseLegacyMode] [-IgnoreBackendStoreException] [-ProxyPool ] [-DomainController ] [-PassThru] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION +**PRE-REQUISITES steps for running Move-CsUser** +- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later + +**PRE-REQUISITES steps for** [Office 365 operated by 21Vianet](/microsoft-365/admin/services-in-china/services-in-china?view=o365-21vianet) +- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later +- Run Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina + +For more information, see [Set-TeamsEnvironmentConfig](/powershell/module/teams/set-teamsenvironmentconfig). + The Move-CsUser cmdlet enables you to move a user account enabled for Skype for Business in the following scenarios: - from an on-premises Skype for Business deployment to Teams-only in Microsoft 365 (or the reverse) @@ -59,11 +65,11 @@ When moving a user to the Microsoft 365 cloud to become TeamsOnly (or the revers > [!NOTE] > -> - Moving users from On-Premises to Teams requires TLS 1.2. TLS 1.0 and TLS 1.1 have been deprecated. Please visit [Disabling TLS 1.0 and 1.1 for Microsoft 365](/microsoft-365/compliance/tls-1.0-and-1.1-deprecation-for-office-365?view=o365-worldwide) and [Preparing for TLS 1.2 in Office 365 and Office 365 GCC](/microsoft-365/compliance/prepare-tls-1.2-in-office-365?view=o365-worldwide) for details. +> - Moving users from On-Premises to Teams requires TLS 1.2. TLS 1.0 and TLS 1.1 have been deprecated. Please visit [Disabling TLS 1.0 and 1.1 for Microsoft 365](/microsoft-365/compliance/tls-1.0-and-1.1-deprecation-for-office-365?view=o365-worldwide) and [Preparing for TLS 1.2 in Office 365 and Office 365 GCC](/microsoft-365/compliance/prepare-tls-1.2-in-office-365?view=o365-worldwide) for details. > - To use Multi-Factor Authentication (MFA) with Move-CsUser requires either Skype for Business Server 2015 CU12 or any version of Skype for Business Server 2019. When using MFA do not specify the -Credential parameter. If you are using an earlier version of Skype for Business Server, you should either disable MFA and use the credential parameter, or obtain a newer version of the administrative tools for Skype for Business Server that supports MFA. > [!NOTE] -> As of November 10, 2023, moving users from Teams to On-Premises will no longer migrate their contacts. This is mainly due to our continuous efforts to tighten security and protect customers' data. After carefully analyzing the usage patterns and performing risk assessments with the legacy infrastructure, we decided to deprecate this feature. +> As of November 10, 2023, moving users from Teams to On-Premises will no longer migrate their contacts. This is mainly due to our continuous efforts to tighten security and protect customers' data. After carefully analyzing the usage patterns and performing risk assessments with the legacy infrastructure, we decided to deprecate this feature. **MINIMUM REQUIRED SERVER VERSIONS**: @@ -91,36 +97,55 @@ $cred=get-credential Move-CsUser -Identity "PilarA@contoso.com" -Target "sipfed.online.lync.com" -Credential $cred ``` -In Example 1, the Move-CsUser cmdlet is used to move the user account with sip address PilarA@contoso.com to Teams. This user will now be a Teams only user. If -Credential parameter is not specified, the admin will be prompted for credentials. It no longer matters whether the `-MoveToTeams` switch is specified. +In Example 1, the Move-CsUser cmdlet is used to move the user account with sip address PilarA@contoso.com to Teams. +This user will now be a Teams only user. +If -Credential parameter is not specified, the admin will be prompted for credentials. +It no longer matters whether the `-MoveToTeams` switch is specified. +NOTE: The MoveToTeams switch is only available on Skype for Business Server 2019. +Organizations using other versions of Skype for Business Server must first move the user to Skype for Business Online, and then apply TeamsUpgradePolicy. -### EXAMPLE 2: Move a user to another on-premises pool +### EXAMPLE 2: Move a user to Skype for Business Online +``` +$cred=get-credential +Move-CsUser -Identity PilarA@contoso.com -Target "sipfed.online.lync.com" -Credential $cred +``` -```powershell +In Example 2, the Move-CsUser cmdlet is used to move the user account with sip address PilarA@contoso.com to Skype for Business Online. +This is the same cmdlet usage as example 1, except the MoveToTeams switch is not specified. + +### EXAMPLE 3: Move a user to another on-premises pool +``` Move-CsUser -Identity "Pilar Ackerman" -Target "atl-cs-001.litwareinc.com" ``` In Example 3, the Move-CsUser cmdlet is used to move the user account with the Identity Pilar Ackerman to the Registrar pool atl-cs-001.litwareinc.com. -### EXAMPLE 3: Move multiple users - -```powershell +### EXAMPLE 4: Move multiple users +``` Get-CsUser -OU "ou=Finance,dc=litwareinc,dc=com" | Move-CsUser -Target "atl-cs-001.litwareinc.com" ``` -In Example 4, all the user accounts in the Finance organizational unit (OU) are moved to the Registrar pool atl-cs-001.litwareinc.com in on-premises. -To carry out this task, the command first uses the Get-CsUser cmdlet and the OU parameter to retrieve a collection of all the user accounts in the Finance OU. After the data has been retrieved, the information is piped to the Move-CsUser cmdlet, which moves each account in the collection to the Registrar pool atl-cs-001.litwareinc.com. +In Example 4, all the user accounts in the Finance organizational unit (OU) are moved to the Registrar pool atl-cs-001.litwareinc.com. +To carry out this task, the command first uses the Get-CsUser cmdlet and the OU parameter to retrieve a collection of all the user accounts in the Finance OU. +After the data has been retrieved, the information is piped to the Move-CsUser cmdlet, which moves each account in the collection to the Registrar pool atl-cs-001.litwareinc.com. -### EXAMPLE 4: Move multiple users listed in a file +## PARAMETERS -```powershell -Move-CsUser -UserList C:\Folder1\Folder2\file1.txt -Target "atl-cs-001.litwareinc.com" -Report C:\Folder1\Folder2\out.csv -``` +### -AccessTokens +{{ Fill AccessTokens Description }} -In Example 5, all the users listed in file1.txt are moved to the Registrar pool atl-cs-001.litwareinc.com. -Also, a detailed report is created in the out.csv file. +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: -## PARAMETERS +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -BypassAudioConferencingCheck @@ -129,12 +154,12 @@ Also, a detailed report is created in the out.csv file. This parameter has been deprecated and should not be used. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -143,7 +168,8 @@ Accept wildcard characters: False > Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -This parameter has been deprecated and should not be used. +By default, if the on-premise user is configured for Enteprise Voice, moving the user to Office 365 will provision the user for Microsoft Phone System, for an additional license is required. +If you want to move such a user to Office 365 but do not want to configure them for Phone System, specify this switch to by-pass the license check. ```yaml Type: SwitchParameter @@ -160,10 +186,12 @@ Accept wildcard characters: False > Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Enables you to run the Move-CsUser cmdlet under alternate credentials, which is typically required when moving to Office 365. To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. For details, see the Get-Credential cmdlet help topic. +Enables you to run the Move-CsUser cmdlet under alternate credentials, which is typically required when moving to Office 365. +To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. +For details, see the Get-Credential cmdlet help topic. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -181,7 +209,7 @@ Accept wildcard characters: False The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: @@ -200,7 +228,24 @@ If present, moves the user account without moving contacts or meetings. Contacts If not present, both the account and the associated data are moved. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedMigrationOverrideUrl +The hosted migration service is the service in Office 365 that performs user moves. +By default, there is no need to specify a value for this parameter, as long as the hosting provider has its AutoDiscover URL properly configured. +However, a specific URL can be specified if required. + +```yaml +Type: System.String Parameter Sets: (All) Aliases: @@ -223,8 +268,8 @@ You can use the asterisk (*) wildcard character when using the Display Name as t For example, the Identity "* Smith" returns all the users with who have a display name that ends with the string value " Smith". ```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity +Type: Microsoft.Rtc.Management.AD.UserIdParameter +Parameter Sets: Identity Aliases: Required: True @@ -234,6 +279,21 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -IgnoreBackendStoreException +{{ Fill IgnoreBackendStoreException Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MoveConferenceData > Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 @@ -243,7 +303,7 @@ Note that you should only use the MoveConferenceData parameter if you are moving Instead, you should rely on the backup service for moving conference data as part of a disaster recovery procedure. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False @@ -253,6 +313,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MoveToTeams +If specified, the user will be moved to Office 365 as a Teams-only user. +This will ensure incoming chats and calls land in the user's Teams client. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru > Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 @@ -261,13 +337,13 @@ Enables you to pass a user object through the pipeline that represents the user By default, the Move-CsUser cmdlet does not pass objects through the pipeline. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -279,9 +355,9 @@ Accept wildcard characters: False This is an optional parameter that can be used to specify the front-end pool for user migration. ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -297,8 +373,8 @@ Accept wildcard characters: False A CSV file to be created with detailed information about the move. You can supply the file name if you want to create the file in the current folder, or an absolute path. ```yaml -Type: String -Parameter Sets: Identity, Users +Type: System.String +Parameter Sets: (All) Aliases: Required: False @@ -317,7 +393,7 @@ If moving to an on-premises pool (either from another pool or from Microsoft 365 If moving to Microsoft 365, this must be set to the ProxyFqdn value of the hosting provider. In most cases this is sipfed.online.lync.com. The value of the ProxyFqdn can be obtained using Get-CsHostingProvider ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: (All) Aliases: @@ -335,7 +411,8 @@ Accept wildcard characters: False This is an optional parameter that if, specified, pre-populates the username of the tenant admin when moving users to or from Office 365. This can be useful for scenarios involving smart card authentication or 2 factor auth. This parameter is only available with Skype for Business Server 2019 and CU8 for Skype for Business Server 2015. When specifying this parameter on Skype for Business Server 2015 with CU8, you must also specify the UseOAuth parameter. ```yaml -Type: UserIdParameter +Type: System.String +Parameter Sets: (All) Aliases: Required: False Position: Named @@ -344,16 +421,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseOAuth - -> Applicable: Skype for Business Server 2015 - -This switch is no longer relevant. Previously, this switch ensured authentication between on-premises and the cloud. This switch also ensured Skype for Business Server 2015 CU8 to CU11 used the OAuth protocol (supported in those versions, but not used by default). All currently supported versions for migration to Teams (see the list earlier in this article) automatically use OAuth, so this switch is no longer required. +### -UseLegacyMode +{{ Fill UseLegacyMode Description }} ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -368,7 +443,7 @@ Accept wildcard characters: False A text file with a list of users to be moved, in the following format example: "sip:user1@contoso.com,sip:user2@contoso.com,sip:user3@contoso.com". You can supply the file name if it's located in the current folder, or the absolute path to the file. ```yaml -Type: String +Type: System.String Parameter Sets: Users Aliases: @@ -393,13 +468,13 @@ If you would prefer to have the confirmation prompt then use this syntax: `-Confirm` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -411,20 +486,20 @@ Accept wildcard characters: False Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/SkypeForBusiness/New-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAVEdgeConfiguration.md index 4121e90a47..9ef6f986cf 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAVEdgeConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csavedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csavedgeconfiguration schema: 2.0.0 title: New-CsAVEdgeConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsAdditionalInternalDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsAdditionalInternalDomain.md index 1e7538c90e..2d50d1658e 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAdditionalInternalDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csadditionalinternaldomain schema: 2.0.0 title: New-CsAdditionalInternalDomain --- @@ -171,6 +171,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Remove-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain?view=skype-ps) +[Remove-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csadditionalinternaldomain?view=skype-ps) -[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) +[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadditionalinternaldomain?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/New-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookConfiguration.md index 43513c3cac..ac1f1add23 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbookconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csaddressbookconfiguration schema: 2.0.0 title: New-CsAddressBookConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationConfiguration.md index b838122d3e..81bd405570 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csaddressbooknormalizationconfiguration schema: 2.0.0 title: New-CsAddressBookNormalizationConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationRule.md index af4481d8e4..5afc3c08e9 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csaddressbooknormalizationrule schema: 2.0.0 title: New-CsAddressBookNormalizationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/New-CsAdminRole.md index bf777aebb9..769c1f6c1d 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAdminRole.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csadminrole +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csadminrole schema: 2.0.0 title: New-CsAdminRole --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsAllowedDomain.md index 42440248ed..0a78fdc77b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAllowedDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csalloweddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csalloweddomain schema: 2.0.0 title: New-CsAllowedDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/New-CsAnalogDevice.md index 51e467a44a..0ec191412f 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAnalogDevice.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csanalogdevice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csanalogdevice schema: 2.0.0 title: New-CsAnalogDevice --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/New-CsAnnouncement.md index b7cf6cc4a7..fdd9081a57 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAnnouncement.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csannouncement +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csannouncement schema: 2.0.0 title: New-CsAnnouncement --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsArchivingConfiguration.md index f4d63d2dc9..a5d58262d1 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsArchivingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csarchivingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csarchivingconfiguration schema: 2.0.0 title: New-CsArchivingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsArchivingPolicy.md index 8f224e2ef9..b10bea8433 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsArchivingPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csarchivingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csarchivingpolicy schema: 2.0.0 title: New-CsArchivingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAutodiscoverConfiguration.md index d116d1b9a2..ae3c47995c 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAutodiscoverConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csautodiscoverconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csautodiscoverconfiguration schema: 2.0.0 title: New-CsAutodiscoverConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsBandwidthPolicyServiceConfiguration.md index 8506904706..99c9d65747 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsBandwidthPolicyServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csbandwidthpolicyserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csbandwidthpolicyserviceconfiguration schema: 2.0.0 title: New-CsBandwidthPolicyServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsBlockedDomain.md index 9a40f8ec08..1ec03640d5 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsBlockedDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csblockeddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csblockeddomain schema: 2.0.0 title: New-CsBlockedDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/New-CsCallParkOrbit.md index 7349e80414..da290a9e16 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCallParkOrbit.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cscallparkorbit +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscallparkorbit schema: 2.0.0 title: New-CsCallParkOrbit --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsCallViaWorkPolicy.md index bb13e3fda7..0f98d2be99 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCallViaWorkPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cscallviaworkpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscallviaworkpolicy schema: 2.0.0 title: New-CsCallViaWorkPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsCdrConfiguration.md index 23248b0fe6..c2c4d6877f 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCdrConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cscdrconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscdrconfiguration schema: 2.0.0 title: New-CsCdrConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicy.md index 2793275139..f883a84825 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclientpolicy schema: 2.0.0 title: New-CsClientPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsClientPolicyEntry.md b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicyEntry.md index d8ba17567d..55da53e8e9 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsClientPolicyEntry.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicyEntry.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientpolicyentry +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclientpolicyentry schema: 2.0.0 title: New-CsClientPolicyEntry --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionConfiguration.md index 05afa9bf27..0b90809a27 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclientversionconfiguration schema: 2.0.0 title: New-CsClientVersionConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicy.md index 3a9bfe6142..d4502b3f65 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclientversionpolicy schema: 2.0.0 title: New-CsClientVersionPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicyRule.md index 1287ad4b80..3c954a243b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicyRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionpolicyrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclientversionpolicyrule schema: 2.0.0 title: New-CsClientVersionPolicyRule --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsCloudCallDataConnectorConfiguration.md index ca597b0ac9..145a1ae495 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCloudCallDataConnectorConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cscloudcalldataconnectorconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscloudcalldataconnectorconfiguration schema: 2.0.0 title: New-CsCloudCallDataConnectorConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsClsConfiguration.md index bbe0b89ed2..734c8bc7b6 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclsconfiguration schema: 2.0.0 title: New-CsClsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsClsProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsClsProvider.md index 40c3123438..ffdedae2bb 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsClsProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclsprovider schema: 2.0.0 --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/New-CsClsRegion.md index 88863d80a0..0b9437b4a9 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsRegion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsregion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclsregion schema: 2.0.0 --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/New-CsClsScenario.md index 9e260f7a32..a4f0bc7a01 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsScenario.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsscenario +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclsscenario schema: 2.0.0 --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/New-CsClsSecurityGroup.md index 236480e69c..69a7df709d 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsSecurityGroup.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csclssecuritygroup +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csclssecuritygroup schema: 2.0.0 --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/New-CsCommonAreaPhone.md index e0999c3120..e15952adf6 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCommonAreaPhone.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cscommonareaphone +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscommonareaphone schema: 2.0.0 --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/New-CsConferenceDirectory.md index 13d43adccf..01805b0390 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsConferenceDirectory.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencedirectory +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csconferencedirectory schema: 2.0.0 --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsConferencingConfiguration.md index c28db76dba..42a528785b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsConferencingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csconferencingconfiguration schema: 2.0.0 --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsConferencingPolicy.md index a9bf4651ab..2b5c568eb7 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsConferencingPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csconferencingpolicy schema: 2.0.0 --- @@ -102,7 +102,7 @@ However, the user can participate in other conferences where annotations are all ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -127,7 +127,7 @@ However, the user can take part in other conferences where anonymous participant ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -157,7 +157,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -180,7 +180,7 @@ This setting applies to all users taking part in the conference. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -203,7 +203,7 @@ That means that some users in a session might be allowed to give up control of a ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -229,7 +229,7 @@ Note that this setting takes effect only if the AllowConferenceRecording propert ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -254,7 +254,7 @@ However, the user can take part in other conferences where external users are al ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -272,7 +272,7 @@ When set to True ($True), allows federated meeting participants to join the meet ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -295,7 +295,7 @@ However, the user can take part in other conferences where IP audio is allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -319,7 +319,7 @@ However, the user can take part in other conferences where IP video is allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -340,7 +340,7 @@ The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -361,7 +361,7 @@ However, the user can participate in other conferences where multiview is allowe ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -387,7 +387,7 @@ The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -405,7 +405,7 @@ When set to False, prevents users from using Office content in their conferences ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -429,7 +429,7 @@ However, the user can take part in other conferences where participant control i ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -453,7 +453,7 @@ However, the user can take part in other conferences where polls are allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -475,7 +475,7 @@ However, the user can make use of the Questions and Answers Manager in other con ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -496,7 +496,7 @@ When set to True (the default value) any open OneNote notebooks linked to the co ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -520,7 +520,7 @@ However, the user can take part in other conferences where application sharing i ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -538,7 +538,7 @@ Determines the protocol used for screen sharing - VbSS vs RDP. This parameter i ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -558,7 +558,7 @@ The default value is 50000. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -581,7 +581,7 @@ This setting is enforced at the per-user level, and for both conferences and pee ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -599,7 +599,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: CloudRecordingServiceSupport Parameter Sets: (All) -Aliases: +Aliases: Accepted values: NotSupported, Supported, Required Required: False @@ -621,7 +621,7 @@ For example, the Description might indicate the users the policy should be assig ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -642,7 +642,7 @@ The default value is False, meaning that PowerPoint annotations are allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -676,7 +676,7 @@ The default value is Desktop. ```yaml Type: EnableAppDesktopSharing Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -699,7 +699,7 @@ However, the user can take part in other conferences where data collaboration is ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -722,7 +722,7 @@ However, the user can take part in other conferences where dial-in conferencing ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -746,7 +746,7 @@ However, the user can take part in other conferences where file transfers are al ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -769,7 +769,7 @@ That means that some users in a session might be allowed to have multiple video ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -788,7 +788,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -812,7 +812,7 @@ That means that one user in a peer-to-peer communication session might be allowe ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -834,7 +834,7 @@ That means that one user in a peer-to-peer communication session might be allowe ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -858,7 +858,7 @@ That means that one user in a peer-to-peer communication session might be allowe ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -876,7 +876,7 @@ PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -897,7 +897,7 @@ The default value is 50000. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -916,7 +916,7 @@ Suppresses the display of any non-fatal error message that might occur when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -937,7 +937,7 @@ To create a per-user policy, use syntax similar to this: `-Identity SalesConfere ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -958,7 +958,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -985,7 +985,7 @@ However, the user can take part in other conferences where additional participan ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1015,7 +1015,7 @@ The default value is VGA. ```yaml Type: MaxVideoConferenceResolution Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1040,7 +1040,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1061,7 +1061,7 @@ The default value is 50000 kilobytes per second. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1072,7 +1072,7 @@ Accept wildcard characters: False ### -VideoBitRateKb -> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, Bit rate (in kilobits) used for video transmissions. The default value is 400. @@ -1086,7 +1086,7 @@ This setting is enforced at the per-user level, and for both conferences and pee ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1141,17 +1141,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### None - -### -None. The New-CsConferencingPolicy cmdlet does not accept pipelined input. ## OUTPUTS ### System.Object -### -The New-CsConferencingPolicy cmdlet creates a new instance of the Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy ## NOTES diff --git a/skype/skype-ps/SkypeForBusiness/New-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsCpsConfiguration.md index 89c6f06c20..ec1eba0cc1 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCpsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cscpsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cscpsconfiguration schema: 2.0.0 --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDeviceUpdateConfiguration.md index de47343c5e..d2ff1f42c4 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDeviceUpdateConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csdeviceupdateconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdeviceupdateconfiguration schema: 2.0.0 title: New-CsDeviceUpdateConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticConfiguration.md index 26d1974178..a11ad277a6 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdiagnosticconfiguration schema: 2.0.0 title: New-CsDiagnosticConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticHeaderConfiguration.md index cc779bbdff..76c24848bf 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticHeaderConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticheaderconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdiagnosticheaderconfiguration schema: 2.0.0 title: New-CsDiagnosticHeaderConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticsFilter.md b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticsFilter.md index 03fb932d37..e5f3100d81 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticsFilter.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticsFilter.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticsfilter +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdiagnosticsfilter schema: 2.0.0 title: New-CsDiagnosticsFilter --- @@ -97,7 +97,7 @@ The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -116,7 +116,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -150,7 +150,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -169,7 +169,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -190,7 +190,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -210,7 +210,7 @@ Instead, only information about unsuccessful requests will be saved. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -246,7 +246,7 @@ You can have more than one domain in a single filter. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -273,7 +273,7 @@ You can include multiple URIs in a single filter. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -287,15 +287,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsDiagnosticsFilter cmdlet does not accept pipelined input. ## OUTPUTS - -### -The New-CsDiagnosticsFilter cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.Filter object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.Filter ## NOTES diff --git a/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingAccessNumber.md index 0be2af9703..51f7e7e4d5 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingAccessNumber.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingaccessnumber +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdialinconferencingaccessnumber schema: 2.0.0 title: New-CsDialInConferencingAccessNumber --- @@ -23,31 +23,22 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX -### (Default) +### Onprem (Default) ``` -New-CsDialInConferencingAccessNumber -PrimaryUri [-DisplayName ] -DisplayNumber - -LineURI -Regions - -Pool -PrimaryLanguage +New-CsDialInConferencingAccessNumber -PrimaryUri -DisplayNumber -LineURI + -PrimaryLanguage [-SecondaryLanguages ] - [-ScopeToSite] [-PassThru] [-WhatIf] [-Confirm] [-Tenant ] [] + -Pool -Regions + [-ScopeToSite] [-Tenant ] [-DisplayName ] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### Hosting ``` -New-CsDialInConferencingAccessNumber -DisplayNumber -HostingProviderProxyFqdn -LineURI - -PrimaryLanguage -PrimaryUri [-Confirm] [-DisplayName ] [-PassThru] [-ScopeToSite] +New-CsDialInConferencingAccessNumber -PrimaryUri -DisplayNumber -LineURI + -PrimaryLanguage [-SecondaryLanguages ] - [-Tenant ] [-WhatIf] [] -``` - -### Onprem -``` -New-CsDialInConferencingAccessNumber -DisplayNumber -LineURI -Pool - -PrimaryLanguage -PrimaryUri - -Regions [-Confirm] - [-DisplayName ] [-PassThru] [-ScopeToSite] - [-SecondaryLanguages ] - [-Tenant ] [-WhatIf] [] + [-ScopeToSite] -HostingProviderProxyFqdn [-Tenant ] [-DisplayName ] [-PassThru] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -115,7 +106,7 @@ This is the name that will also be displayed in Skype for Business. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -134,7 +125,7 @@ Phone number as displayed in meeting invitations and on the dial-in conferencing The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -152,7 +143,7 @@ Accept wildcard characters: False Fully qualified domain name of the hosting provider that hosts your dial-in conferencing service. ```yaml -Type: Fqdn +Type: Microsoft.Rtc.Management.Deploy.Fqdn Parameter Sets: Hosting Aliases: HostingProvider @@ -175,7 +166,7 @@ Note that spaces, hyphens, parentheses and other characters are not allowed. LineURIs must be unique throughout Active Directory. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -194,13 +185,13 @@ Enables you to pass a contact object through the pipeline that represents the ne By default, the New-CsDialInConferencingAccessNumber cmdlet does not pass objects through the pipeline. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -212,8 +203,8 @@ Accept wildcard characters: False Home pool for the new contact object. ```yaml -Type: Fqdn -Parameter Sets: (All), Onprem +Type: Microsoft.Rtc.Management.Deploy.Fqdn +Parameter Sets: Onprem Aliases: Required: True @@ -235,7 +226,7 @@ To return a list of the available language codes, type the following command at `Get-CsDialInConferencingLanguageList | Select-Object -ExpandProperty Languages.` ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -259,7 +250,7 @@ Note that the sip: prefix must be entered in all lowercase letters. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -280,7 +271,7 @@ To specify multiple regions, use a comma-separated list: `-Regions "Northwest", ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] -Parameter Sets: (All), Onprem +Parameter Sets: Onprem Aliases: Required: True @@ -298,13 +289,13 @@ If present, the new number will be scoped to the same site as the contact object If the ScopeToSite parameter is not included, the new number will be assigned to the global scope. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -346,7 +337,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml -Type: Guid +Type: System.Nullable`1[System.Guid] Parameter Sets: (All) Aliases: @@ -364,13 +355,13 @@ Accept wildcard characters: False Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -382,19 +373,19 @@ Accept wildcard characters: False Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingConfiguration.md index bb22fd50d0..f591124b88 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdialinconferencingconfiguration schema: 2.0.0 title: New-CsDialInConferencingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingDtmfConfiguration.md index dcca03b1fd..9ea7630918 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingDtmfConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingdtmfconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdialinconferencingdtmfconfiguration schema: 2.0.0 title: New-CsDialInConferencingDtmfConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/New-CsDialPlan.md index 7e4d45af5a..594511a004 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialPlan.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialplan +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csdialplan schema: 2.0.0 title: New-CsDialPlan --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsEmergencyNumber.md b/skype/skype-ps/SkypeForBusiness/New-CsEmergencyNumber.md index 4fb895fe5f..5d9149fd86 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsEmergencyNumber.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsEmergencyNumber.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csemergencynumber +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csemergencynumber schema: 2.0.0 title: New-CsEmergencyNumber --- @@ -103,6 +103,6 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[New-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skype/new-cslocationpolicy?view=skype-ps) +[New-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cslocationpolicy?view=skype-ps) -[Set-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skype/set-cslocationpolicy?view=skype-ps) +[Set-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslocationpolicy?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/New-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/New-CsExUmContact.md index e0b7600df8..2bc51dc65b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExUmContact.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csexumcontact +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csexumcontact schema: 2.0.0 title: New-CsExUmContact --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsExtendedTest.md b/skype/skype-ps/SkypeForBusiness/New-CsExtendedTest.md index 9bc75f4f37..00c3e2135d 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsExtendedTest.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExtendedTest.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csextendedtest +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csextendedtest schema: 2.0.0 title: New-CsExtendedTest --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsExternalAccessPolicy.md index 74ff892329..725ef00909 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExternalAccessPolicy.md @@ -6,7 +6,7 @@ Locale: en-US Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/new-csexternalaccesspolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csexternalaccesspolicy schema: 2.0.0 title: New-CsExternalAccessPolicy --- @@ -54,7 +54,7 @@ This enables your users to use Skype for Business and log on to Skype for Busine 4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. -5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skype/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skypeforbusiness/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. When you install Skype for Business Server, a global external access policy is automatically created for you. In addition to the global policy, you can also create custom external access policies at either the site or the per-user scope. diff --git a/skype/skype-ps/SkypeForBusiness/New-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsExternalUserCommunicationPolicy.md index e5032dbdcf..d8d8249f5d 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExternalUserCommunicationPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csexternalusercommunicationpolicy schema: 2.0.0 title: New-CsExternalUserCommunicationPolicy --- @@ -32,7 +32,7 @@ This cmdlet allows you to block P2P file transfer with Federated partners only. ## EXAMPLES -### Example 1 +### Example 1 ``` PS C:\> New-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer -EnableP2PFileTransfer $False ``` @@ -95,7 +95,7 @@ Indicates whether file transfers to Federated partners are allowed. The default ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -128,7 +128,7 @@ Unique identifier for the external user communication policy to be created. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -169,7 +169,7 @@ If you are using a remote session of Windows PowerShell and are connected only t ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -225,10 +225,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) +[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csexternalusercommunicationpolicy?view=skype-ps) -[Get-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy?view=skype-ps) +[Get-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csexternalusercommunicationpolicy?view=skype-ps) -[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) +[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csexternalusercommunicationpolicy?view=skype-ps) -[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) +[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skypeforbusiness/grant-csexternalusercommunicationpolicy?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/New-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsFIPSConfiguration.md index 11d9866850..22fa7439d0 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsFIPSConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csfipsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csfipsconfiguration schema: 2.0.0 title: New-CsFIPSConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsFileTransferFilterConfiguration.md index eb3c3f0f9d..cd582f0fa2 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsFileTransferFilterConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csfiletransferfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csfiletransferfilterconfiguration schema: 2.0.0 title: New-CsFileTransferFilterConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/New-CsGroupPickupUserOrbit.md index 499eb5d270..490ee280df 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsGroupPickupUserOrbit.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csgrouppickupuserorbit +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csgrouppickupuserorbit schema: 2.0.0 title: New-CsGroupPickupUserOrbit --- @@ -74,7 +74,7 @@ Accept wildcard characters: False Specifies the group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. -For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). +For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skypeforbusiness/New-CsCallParkOrbit). Values for the Orbit parameter must match the regular expression (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). diff --git a/skype/skype-ps/SkypeForBusiness/New-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsHealthMonitoringConfiguration.md index ac37fc1801..52bf89df98 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHealthMonitoringConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cshealthmonitoringconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshealthmonitoringconfiguration schema: 2.0.0 title: New-CsHealthMonitoringConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsHostedVoicemailPolicy.md index 6d1f6f04b7..903062e995 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHostedVoicemailPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cshostedvoicemailpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshostedvoicemailpolicy schema: 2.0.0 title: New-CsHostedVoicemailPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsHostingProvider.md index 3de5cebe95..5b00236148 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHostingProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshostingprovider schema: 2.0.0 title: New-CsHostingProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/New-CsHybridApplicationEndpoint.md index d6c42e2a20..7128a5bd6e 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHybridApplicationEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint schema: 2.0.0 title: New-CsHybridApplicationEndpoint --- @@ -207,8 +207,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/New-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/New-CsHybridPSTNSite.md index 9d8e17bb7b..638495cc18 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHybridPSTNSite.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/new-cshybridpstnsite +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshybridpstnsite schema: 2.0.0 title: New-CsHybridPSTNSite --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsImConfiguration.md index 782bf2461b..22bf9e2b05 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsImConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimconfiguration schema: 2.0.0 title: New-CsImConfiguration --- @@ -178,8 +178,8 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/New-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsImFilterConfiguration.md index 0235223a0f..e0aecce531 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsImFilterConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csimfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimfilterconfiguration schema: 2.0.0 title: New-CsImFilterConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsImTranslationConfiguration.md index 2d55540669..4f613cea18 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsImTranslationConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csimtranslationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimtranslationconfiguration schema: 2.0.0 title: New-CsImTranslationConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsIssuedCertId.md b/skype/skype-ps/SkypeForBusiness/New-CsIssuedCertId.md index c3386abeae..8de607e56e 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsIssuedCertId.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsIssuedCertId.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csissuedcertid +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csissuedcertid schema: 2.0.0 title: New-CsIssuedCertId --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccount.md b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccount.md index 3c48527970..bc296cbff5 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccount.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccount.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cskerberosaccount +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cskerberosaccount schema: 2.0.0 title: New-CsKerberosAccount --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccountAssignment.md index 85cf3c1866..5cbc13c650 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccountAssignment.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cskerberosaccountassignment +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cskerberosaccountassignment schema: 2.0.0 title: New-CsKerberosAccountAssignment --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsLocationPolicy.md index 98c7f4e45a..e35f93eed7 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsLocationPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cslocationpolicy schema: 2.0.0 title: New-CsLocationPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsMcxConfiguration.md index ef269628dd..1afda57100 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMcxConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csmcxconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csmcxconfiguration schema: 2.0.0 title: New-CsMcxConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsMediaConfiguration.md index 48602e92db..0ac8357ad0 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMediaConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csmediaconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csmediaconfiguration schema: 2.0.0 title: New-CsMediaConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsMeetingConfiguration.md index 420c30ffd7..dd15560ce8 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMeetingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csmeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csmeetingconfiguration schema: 2.0.0 title: New-CsMeetingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsMobilityPolicy.md index 6193dba00c..3729806fa0 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMobilityPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/new-csmobilitypolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csmobilitypolicy schema: 2.0.0 title: New-CsMobilityPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWAlternatePath.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWAlternatePath.md index e49bcbf84e..75a9e44419 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWAlternatePath.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWAlternatePath.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbwalternatepath +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkbwalternatepath schema: 2.0.0 title: New-CsNetworkBWAlternatePath --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWPolicy.md index 92a3e8289e..d027e2020c 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbwpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkbwpolicy schema: 2.0.0 title: New-CsNetworkBWPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBandwidthPolicyProfile.md index f714ee4e02..4955cc7fc9 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBandwidthPolicyProfile.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbandwidthpolicyprofile +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkbandwidthpolicyprofile schema: 2.0.0 title: New-CsNetworkBandwidthPolicyProfile --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterRegionRoute.md index 100dbfcc95..cc4f4719c4 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterRegionRoute.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkinterregionroute +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkinterregionroute schema: 2.0.0 title: New-CsNetworkInterRegionRoute --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterSitePolicy.md index 6778cfe687..8cc5fc86b0 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterSitePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkintersitepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkintersitepolicy schema: 2.0.0 title: New-CsNetworkInterSitePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsNetworkMediaBypassConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkMediaBypassConfiguration.md index 1c4f116ee6..846d8be409 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsNetworkMediaBypassConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkMediaBypassConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkmediabypassconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkmediabypassconfiguration schema: 2.0.0 title: New-CsNetworkMediaBypassConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegion.md index 6018ec3e03..54aa830319 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkregion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkregion schema: 2.0.0 title: New-CsNetworkRegion --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegionLink.md index a279a8e184..3d622da848 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegionLink.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkregionlink +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworkregionlink schema: 2.0.0 title: New-CsNetworkRegionLink --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSite.md index d5b9f42425..7d083d20e8 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSite.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworksite +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworksite schema: 2.0.0 title: New-CsNetworkSite --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSubnet.md index 5729d09d6b..2d6ea0f494 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSubnet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworksubnet +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csnetworksubnet schema: 2.0.0 title: New-CsNetworkSubnet --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/New-CsOAuthServer.md index b7ddae2b5b..5fd412151e 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsOAuthServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csoauthserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csoauthserver schema: 2.0.0 title: New-CsOAuthServer --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsOutboundCallingNumberTranslationRule.md index ae11cd6aea..7479ea4838 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsOutboundCallingNumberTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csoutboundcallingnumbertranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csoutboundcallingnumbertranslationrule schema: 2.0.0 title: New-CsOutboundCallingNumberTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsOutboundTranslationRule.md index 2acb8309e2..f67d9fdc10 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsOutboundTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csoutboundtranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csoutboundtranslationrule schema: 2.0.0 title: New-CsOutboundTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/New-CsPartnerApplication.md index b4e88264ae..43772db63f 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPartnerApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspartnerapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspartnerapplication schema: 2.0.0 title: New-CsPartnerApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatAddin.md index e1a61e3991..221af9acbe 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatAddin.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchataddin +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchataddin schema: 2.0.0 title: New-CsPersistentChatAddin --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatCategory.md index f7c5017c01..fa822cfd9e 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatCategory.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatcategory +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatcategory schema: 2.0.0 title: New-CsPersistentChatCategory --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatComplianceConfiguration.md index ec29ab1949..ebf55e5526 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatComplianceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatcomplianceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatcomplianceconfiguration schema: 2.0.0 title: New-CsPersistentChatComplianceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatConfiguration.md index 2d97d2805e..e647faf83c 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatconfiguration schema: 2.0.0 title: New-CsPersistentChatConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatEndpoint.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatEndpoint.md index b612890b7c..588b1393a2 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatendpoint schema: 2.0.0 title: New-CsPersistentChatEndpoint --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatPolicy.md index 0376bb141b..f4e345e4e0 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatpolicy schema: 2.0.0 title: New-CsPersistentChatPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatRoom.md index 510a6fdebc..17cf3e47de 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatRoom.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatroom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspersistentchatroom schema: 2.0.0 title: New-CsPersistentChatRoom --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsPinPolicy.md index c9309c51ab..3f5da09609 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPinPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspinpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspinpolicy schema: 2.0.0 title: New-CsPinPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/New-CsPlatformServiceSettings.md index 23511ac752..223b84ddae 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPlatformServiceSettings.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csplatformservicesettings schema: 2.0.0 title: New-CsPlatformServiceSettings --- @@ -326,8 +326,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsPresencePolicy.md index 198bd818ca..18c6a6033b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPresencePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspresencepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspresencepolicy schema: 2.0.0 title: New-CsPresencePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsPresenceProvider.md index 3efdea4348..a1348d9178 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPresenceProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspresenceprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspresenceprovider schema: 2.0.0 title: New-CsPresenceProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPrivacyConfiguration.md index 6728dfded2..cc569bfb5f 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPrivacyConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csprivacyconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csprivacyconfiguration schema: 2.0.0 title: New-CsPrivacyConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsProxyConfiguration.md index 48fb0e66fb..b6f4e42f3c 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsProxyConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csproxyconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csproxyconfiguration schema: 2.0.0 title: New-CsProxyConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsPublicProvider.md index 25d0cc553c..6b3ff1c9ff 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPublicProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspublicprovider schema: 2.0.0 title: New-CsPublicProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPushNotificationConfiguration.md index cbb9d2a236..f77adc63bc 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPushNotificationConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspushnotificationconfiguration schema: 2.0.0 title: New-CsPushNotificationConfiguration --- @@ -275,8 +275,8 @@ The New-CsPushNotificationConfiguration cmdlet creates new instances of the Micr ## NOTES ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration?view=skype-ps) -[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) +[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspushnotificationconfiguration?view=skype-ps) -[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) +[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/New-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsQoEConfiguration.md index b5f3af49d3..9ced62415a 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsQoEConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csqoeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csqoeconfiguration schema: 2.0.0 title: New-CsQoEConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsRegistrarConfiguration.md index 2db1b34936..a78ff2f052 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRegistrarConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csregistrarconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csregistrarconfiguration schema: 2.0.0 title: New-CsRegistrarConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsReportingConfiguration.md index 1e7a0e79f4..d0eff10eb1 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsReportingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csreportingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csreportingconfiguration schema: 2.0.0 title: New-CsReportingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsAgentGroup.md index 45358287a0..d2f9ed1228 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsAgentGroup.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsagentgroup +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsagentgroup schema: 2.0.0 title: New-CsRgsAgentGroup --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsAnswer.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsAnswer.md index 292a521822..fc7ce4688c 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsAnswer.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsAnswer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsanswer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsanswer schema: 2.0.0 title: New-CsRgsAnswer --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsCallAction.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsCallAction.md index 0f9a7498a6..e5f69b3565 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsCallAction.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsCallAction.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgscallaction +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgscallaction schema: 2.0.0 title: New-CsRgsCallAction --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsHoliday.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoliday.md index 85172cdc34..587fb8058b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsHoliday.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoliday.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsholiday +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsholiday schema: 2.0.0 title: New-CsRgsHoliday --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsHolidaySet.md index 6f3f900ca4..7f3736a22a 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsHolidaySet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsholidayset +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsholidayset schema: 2.0.0 title: New-CsRgsHolidaySet --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoursOfBusiness.md index 84d623be97..712416ba06 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoursOfBusiness.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgshoursofbusiness +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgshoursofbusiness schema: 2.0.0 title: New-CsRgsHoursOfBusiness --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsPrompt.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsPrompt.md index 8b26c8a938..5f04c8674c 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsPrompt.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsPrompt.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsprompt +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsprompt schema: 2.0.0 title: New-CsRgsPrompt --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsQuestion.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsQuestion.md index 7a7e26c6e4..87c1e1b85b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsQuestion.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsQuestion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsquestion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsquestion schema: 2.0.0 title: New-CsRgsQuestion --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsQueue.md index 35c593b182..81c364e828 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsQueue.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsqueue +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsqueue schema: 2.0.0 title: New-CsRgsQueue --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsTimeRange.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsTimeRange.md index 39efc7ea13..32bf1da90f 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsTimeRange.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsTimeRange.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgstimerange +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgstimerange schema: 2.0.0 title: New-CsRgsTimeRange --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsWorkflow.md index f0f8f17943..132b05b862 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsWorkflow.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsworkflow +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csrgsworkflow schema: 2.0.0 title: New-CsRgsWorkflow --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsRoutingConfiguration.md index cd236c07f6..cc61d28dfd 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRoutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csroutingconfiguration schema: 2.0.0 title: New-CsRoutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/New-CsServerApplication.md index 8ff4b30f9d..a7eab23cf2 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsServerApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csserverapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csserverapplication schema: 2.0.0 title: New-CsServerApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrl.md b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrl.md index 0b50babf82..5a685c1c1b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrl.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrl.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurl +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssimpleurl schema: 2.0.0 title: New-CsSimpleUrl --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlConfiguration.md index abd78d3016..703170baa3 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurlconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssimpleurlconfiguration schema: 2.0.0 title: New-CsSimpleUrlConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlEntry.md b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlEntry.md index 7a6ff50a2c..2f9e850afb 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlEntry.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlEntry.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurlentry +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssimpleurlentry schema: 2.0.0 title: New-CsSimpleUrlEntry --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsSipDomain.md index 12c75c512e..70ad4b3151 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipdomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipdomain schema: 2.0.0 title: New-CsSipDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyCustom.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyCustom.md index b2601410ed..a050f4e734 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyCustom.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyCustom.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxycustom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxycustom schema: 2.0.0 title: New-CsSipProxyCustom --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyRealm.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyRealm.md index 90e2622da5..d337191b26 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyRealm.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyRealm.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyrealm +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxyrealm schema: 2.0.0 title: New-CsSipProxyRealm --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTCP.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTCP.md index 4948b44f86..3e40591f16 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTCP.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTCP.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytcp +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxytcp schema: 2.0.0 title: New-CsSipProxyTCP --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTLS.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTLS.md index 5554fd0e24..73f8147ce9 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTLS.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTLS.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytls +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxytls schema: 2.0.0 title: New-CsSipProxyTLS --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTransport.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTransport.md index 60488ac653..29fc29778b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTransport.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTransport.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytransport +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxytransport schema: 2.0.0 title: New-CsSipProxyTransport --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefault.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefault.md index 392556b6ed..ac656386a6 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefault.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefault.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyusedefault +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxyusedefault schema: 2.0.0 title: New-CsSipProxyUseDefault --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefaultCert.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefaultCert.md index 13a2d68315..27130ad504 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefaultCert.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefaultCert.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyusedefaultcert +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipproxyusedefaultcert schema: 2.0.0 title: New-CsSipProxyUseDefaultCert --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsSipResponseCodeTranslationRule.md index 3697822a34..5279411e43 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipResponseCodeTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipresponsecodetranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cssipresponsecodetranslationrule schema: 2.0.0 title: New-CsSipResponseCodeTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsStaticRoute.md b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoute.md index 18f98af6b5..14f6ec2ce5 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsStaticRoute.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoute.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csstaticroute +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csstaticroute schema: 2.0.0 title: New-CsStaticRoute --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoutingConfiguration.md index b1b42b1db2..8420d95040 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csstaticroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csstaticroutingconfiguration schema: 2.0.0 title: New-CsStaticRoutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsStorageServiceConfiguration.md index c9a4bf4389..9ece5b6e06 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsStorageServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csstorageserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csstorageserviceconfiguration schema: 2.0.0 title: New-CsStorageServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsTeamsUpgradePolicy.md index 28a08eb08c..6d121fd2ea 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTeamsUpgradePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csteamsupgradepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csteamsupgradepolicy schema: 2.0.0 title: New-CsTeamsUpgradePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsTelemetryConfiguration.md index d42a99a67f..dcbf5fdff4 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTelemetryConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cstelemetryconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstelemetryconfiguration schema: 2.0.0 title: New-CsTelemetryConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/New-CsTenantUpdateTimeWindow.md index 40e0dad5e0..7fe75be3ec 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTenantUpdateTimeWindow.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/new-cstenantupdatetimewindow +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstenantupdatetimewindow schema: 2.0.0 title: New-CsTenantUpdateTimeWindow --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/New-CsTestDevice.md index 59e2c77180..d42996a9c5 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTestDevice.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cstestdevice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstestdevice schema: 2.0.0 title: New-CsTestDevice --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystem.md index cc69b51b22..1d7ee7ac6a 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystem.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystem +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csthirdpartyvideosystem schema: 2.0.0 title: New-CsThirdPartyVideoSystem --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystemPolicy.md index 24533bdf4e..bd4445810b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystemPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystempolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csthirdpartyvideosystempolicy schema: 2.0.0 title: New-CsThirdPartyVideoSystemPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsTrunkConfiguration.md index 2ec916c89a..4a85482b3c 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrunkConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstrunkconfiguration schema: 2.0.0 title: New-CsTrunkConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplication.md index 35164616ee..b290679449 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstrustedapplication schema: 2.0.0 title: New-CsTrustedApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationComputer.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationComputer.md index e40f9aee2e..9b39db4d3f 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationComputer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationcomputer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstrustedapplicationcomputer schema: 2.0.0 title: New-CsTrustedApplicationComputer --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationEndpoint.md index 0aab130d2d..1d988dd154 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstrustedapplicationendpoint schema: 2.0.0 title: New-CsTrustedApplicationEndpoint --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationPool.md index 89a6004802..77d1433fd8 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationPool.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationpool +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cstrustedapplicationpool schema: 2.0.0 title: New-CsTrustedApplicationPool --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsUCPhoneConfiguration.md index 1ddbc403d8..dd777d583b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUCPhoneConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csucphoneconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csucphoneconfiguration schema: 2.0.0 title: New-CsUCPhoneConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/New-CsUnassignedNumber.md index dc36abb242..42e4c0e189 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUnassignedNumber.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csunassignednumber +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csunassignednumber schema: 2.0.0 title: New-CsUnassignedNumber --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsUserReplicatorConfiguration.md index ba185645bd..d39dfcced5 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUserReplicatorConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csuserreplicatorconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csuserreplicatorconfiguration schema: 2.0.0 title: New-CsUserReplicatorConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesConfiguration.md index 20d36c66d9..7398a80b2b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csuserservicesconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csuserservicesconfiguration schema: 2.0.0 title: New-CsUserServicesConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesPolicy.md index 7309f4bfea..71aee732ed 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csuserservicespolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csuserservicespolicy schema: 2.0.0 title: New-CsUserServicesPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerConfiguration.md index 135c85f2dc..6d37cf7e9b 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csvideointeropserverconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvideointeropserverconfiguration schema: 2.0.0 title: New-CsVideoInteropServerConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerSyntheticTransactionConfiguration.md index bc031afd71..febf093c0e 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csvideointeropserversynthetictransactionconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvideointeropserversynthetictransactionconfiguration schema: 2.0.0 title: New-CsVideoInteropServerSyntheticTransactionConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVideoTrunkConfiguration.md index a48739df63..13c80df66f 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVideoTrunkConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csvideotrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvideotrunkconfiguration schema: 2.0.0 title: New-CsVideoTrunkConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceNormalizationRule.md index 160efe931c..4f8361741f 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceNormalizationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: bulenteg Module Name: SkypeForBusiness ms.author: serdars -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicenormalizationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoicenormalizationrule schema: 2.0.0 title: New-CsVoiceNormalizationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsVoicePolicy.md index f328cba6f1..256ec3d70c 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoicePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoicepolicy schema: 2.0.0 title: New-CsVoicePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsVoiceRegex.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRegex.md index 5a3ea6561b..883418e4be 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsVoiceRegex.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRegex.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceregex +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoiceregex schema: 2.0.0 title: New-CsVoiceRegex --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoute.md index 5c260353cd..b3e460d9b9 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoute.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceroute +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoiceroute schema: 2.0.0 title: New-CsVoiceRoute --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoutingPolicy.md index 8d47d8111d..167abe7182 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoutingPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceroutingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoiceroutingpolicy schema: 2.0.0 title: New-CsVoiceRoutingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceTestConfiguration.md index 9698676445..8f05db245e 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceTestConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicetestconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoicetestconfiguration schema: 2.0.0 title: New-CsVoiceTestConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVoicemailReroutingConfiguration.md index e3cedde889..b0daf21b70 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoicemailReroutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicemailreroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csvoicemailreroutingconfiguration schema: 2.0.0 title: New-CsVoicemailReroutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsWatcherNodeConfiguration.md index 6981271010..c00bfab531 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWatcherNodeConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cswatchernodeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cswatchernodeconfiguration schema: 2.0.0 title: New-CsWatcherNodeConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsWebLink.md b/skype/skype-ps/SkypeForBusiness/New-CsWebLink.md index 604d29e32f..f76582aeba 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsWebLink.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebLink.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csweblink +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csweblink schema: 2.0.0 title: New-CsWebLink --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsWebOrigin.md b/skype/skype-ps/SkypeForBusiness/New-CsWebOrigin.md index 60d4ca406e..06ac4c6969 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsWebOrigin.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebOrigin.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csweborigin +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csweborigin schema: 2.0.0 title: New-CsWebOrigin --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsWebServiceConfiguration.md index 43cfcbab70..c0f2c96b00 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cswebserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cswebserviceconfiguration schema: 2.0.0 title: New-CsWebServiceConfiguration --- @@ -135,7 +135,7 @@ When set to True (the default value), anonymous users will be allowed to attend ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -153,7 +153,7 @@ When set to True (the default value), OAuth authentication can be used to authen ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -176,7 +176,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -195,7 +195,7 @@ The signing key length can be set to any integer value between 2048 and 16384 by ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -219,7 +219,7 @@ This parameter was introduced in the February, 2013 release of Lync Server 2013. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -241,7 +241,7 @@ The default value is 4320 (180 days). ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -261,7 +261,7 @@ Certificates will not be accepted for authentication unless the certificate's CA ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -282,7 +282,7 @@ When a group has been expanded, users can see all the individual members of a gr ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -300,7 +300,7 @@ PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -319,7 +319,7 @@ The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -337,7 +337,7 @@ Suppresses the display of any non-fatal error message that might occur when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -357,7 +357,7 @@ The default is 315,360,000 (one year.) ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -385,7 +385,7 @@ Note that any settings created at the service scope must be assigned to the Web ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -404,7 +404,7 @@ Certificates will not be accepted for authentication unless the certificate's CA ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -424,7 +424,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -445,7 +445,7 @@ MAC resolution is used by the Enhanced 9-1-1 service. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -465,7 +465,7 @@ The default value is 16384. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -487,7 +487,7 @@ The default value is 100. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -509,7 +509,7 @@ The default value is 8760. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -529,7 +529,7 @@ The default value is 16384. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -551,7 +551,7 @@ The default value is 8. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -591,7 +591,7 @@ WebTicketServiceAuth ```yaml Type: MobilePreferredAuthType Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -604,18 +604,18 @@ Accept wildcard characters: False > Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. -Supported applications are Android, iPhone, iPad, Macintosh, Windows. -To support all applications you can give All as input. -For example: -- To support Android and Macintosh - Android;Macintosh; -- To support all devices - All; +Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. +Supported applications are Android, iPhone, iPad, Macintosh, Windows. +To support all applications you can give All as input. +For example: +- To support Android and Macintosh - Android;Macintosh; +- To support all devices - All; The default value is None. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -628,14 +628,14 @@ Accept wildcard characters: False > Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. -The value can be specified in between 5 to 15 minutes (both inclusive). +Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. +The value can be specified in between 5 to 15 minutes (both inclusive). The default value is 15 minutes. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -654,7 +654,7 @@ This service is typically used only when location requests cannot be resolved lo ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -676,7 +676,7 @@ When set to False (the default value) these options will be available, but the u ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -697,7 +697,7 @@ If set to True (the default value), users joining a meeting by using a client ap ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -719,7 +719,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -740,7 +740,7 @@ This collection is not used if the InferCertChainFromSSL property is set to True ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -759,7 +759,7 @@ Set this value to False ($False) to disable certificate authentication. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -777,7 +777,7 @@ When set to True, domain authentication can be employed as a way to authenticate ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -796,7 +796,7 @@ Set this value to False ($False) to disable PIN authentication. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -816,7 +816,7 @@ The default is false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -841,7 +841,7 @@ None - Windows authentication will not be allowed. ```yaml Type: UseWindowsAuth Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -860,7 +860,7 @@ The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -878,7 +878,7 @@ URI used by the WS-federation Web requestor protocol. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -928,14 +928,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsWebServiceConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### -The `New-CsWebServiceConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings ## NOTES diff --git a/skype/skype-ps/SkypeForBusiness/New-CsWebTrustedCACertificate.md b/skype/skype-ps/SkypeForBusiness/New-CsWebTrustedCACertificate.md index 50e7f40803..6733384478 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsWebTrustedCACertificate.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebTrustedCACertificate.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-cswebtrustedcacertificate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cswebtrustedcacertificate schema: 2.0.0 title: New-CsWebTrustedCACertificate --- diff --git a/skype/skype-ps/SkypeForBusiness/New-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/New-CsXmppAllowedPartner.md index 9b60859d65..2932966534 100644 --- a/skype/skype-ps/SkypeForBusiness/New-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsXmppAllowedPartner.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/new-csxmppallowedpartner +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csxmppallowedpartner schema: 2.0.0 title: New-CsXmppAllowedPartner --- diff --git a/skype/skype-ps/SkypeForBusiness/Publish-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Publish-CsLisConfiguration.md index c63745e70f..0a76f4c99a 100644 --- a/skype/skype-ps/SkypeForBusiness/Publish-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Publish-CsLisConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/publish-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/publish-cslisconfiguration schema: 2.0.0 title: Publish-CsLisConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Publish-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Publish-CsTopology.md index 8db97250ee..e708f35eeb 100644 --- a/skype/skype-ps/SkypeForBusiness/Publish-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Publish-CsTopology.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/publish-cstopology +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/publish-cstopology schema: 2.0.0 title: Publish-CsTopology --- diff --git a/skype/skype-ps/SkypeForBusiness/Register-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Register-CsHybridPSTNAppliance.md index e7f3dcf1e9..8dea417205 100644 --- a/skype/skype-ps/SkypeForBusiness/Register-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Register-CsHybridPSTNAppliance.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/register-cshybridpstnappliance +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/register-cshybridpstnappliance schema: 2.0.0 title: Register-CsHybridPSTNAppliance --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAVEdgeConfiguration.md index 474e19d830..1ab68fc50c 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAVEdgeConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csavedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csavedgeconfiguration schema: 2.0.0 title: Remove-CsAVEdgeConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsAdditionalInternalDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAdditionalInternalDomain.md index 3fd74591d2..3459b55f9f 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAdditionalInternalDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csadditionalinternaldomain schema: 2.0.0 title: Remove-CsAdditionalInternalDomain --- @@ -129,6 +129,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain?view=skype-ps) +[New-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csadditionalinternaldomain?view=skype-ps) -[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) +[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csadditionalinternaldomain?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookConfiguration.md index 206c467c91..882fcda3cc 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbookconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csaddressbookconfiguration schema: 2.0.0 title: Remove-CsAddressBookConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationConfiguration.md index e9973f09fe..5c84425888 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csaddressbooknormalizationconfiguration schema: 2.0.0 title: Remove-CsAddressBookNormalizationConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationRule.md index 057f79cb71..b48ff0a503 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csaddressbooknormalizationrule schema: 2.0.0 title: Remove-CsAddressBookNormalizationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAdminRole.md index 29483b4fe9..b427334395 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAdminRole.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csadminrole +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csadminrole schema: 2.0.0 title: Remove-CsAdminRole --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAllowedDomain.md index edecd7b258..49d8195faa 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAllowedDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csalloweddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csalloweddomain schema: 2.0.0 title: Remove-CsAllowedDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAnalogDevice.md index 5f3a4f1d71..18c7691e40 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAnalogDevice.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csanalogdevice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csanalogdevice schema: 2.0.0 title: Remove-CsAnalogDevice --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAnnouncement.md index 1d23fd3c2c..bcc1e36145 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAnnouncement.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csannouncement +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csannouncement schema: 2.0.0 title: Remove-CsAnnouncement --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingConfiguration.md index 26d9aa540d..4af1375389 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csarchivingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csarchivingconfiguration schema: 2.0.0 title: Remove-CsArchivingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingPolicy.md index 0f47cd2e5e..806ac5cc4e 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csarchivingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csarchivingpolicy schema: 2.0.0 title: Remove-CsArchivingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAutodiscoverConfiguration.md index 4672130163..b651dcb0fb 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAutodiscoverConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csautodiscoverconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csautodiscoverconfiguration schema: 2.0.0 title: Remove-CsAutodiscoverConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsBackupServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBackupServiceConfiguration.md index 443be0b04a..f280ceb02e 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBackupServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csbackupserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csbackupserviceconfiguration schema: 2.0.0 title: Remove-CsBackupServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBandwidthPolicyServiceConfiguration.md index a3c714bb6b..24e63a04d8 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBandwidthPolicyServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csbandwidthpolicyserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csbandwidthpolicyserviceconfiguration schema: 2.0.0 title: Remove-CsBandwidthPolicyServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBlockedDomain.md index 4d2a56293b..3fa9d1468b 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBlockedDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csblockeddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csblockeddomain schema: 2.0.0 title: Remove-CsBlockedDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsBusyOptions.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBusyOptions.md index cf0f6041f8..129298a72f 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsBusyOptions.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBusyOptions.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csbusyoptions schema: 2.0.0 title: Remove-CsBusyOptions --- @@ -127,6 +127,6 @@ This cmdlet does not return any objects. ## NOTES ## RELATED LINKS -[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions?view=skype-ps) +[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbusyoptions?view=skype-ps) -[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) +[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCallParkOrbit.md index 0f62924d0c..8ac726c896 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCallParkOrbit.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscallparkorbit +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscallparkorbit schema: 2.0.0 title: Remove-CsCallParkOrbit --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCallViaWorkPolicy.md index 9c58841b9b..164657d59c 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCallViaWorkPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscallviaworkpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscallviaworkpolicy schema: 2.0.0 title: Remove-CsCallViaWorkPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCdrConfiguration.md index 22acce957f..a983e5d9ca 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCdrConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscdrconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscdrconfiguration schema: 2.0.0 title: Remove-CsCdrConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCertificate.md index 5f2b90bb26..e3513ed5d5 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCertificate.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscertificate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscertificate schema: 2.0.0 title: Remove-CsCertificate --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientPolicy.md index 00e8a54633..f90e1569d1 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclientpolicy schema: 2.0.0 title: Remove-CsClientPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionConfiguration.md index 946fa11a75..5470a8ad36 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclientversionconfiguration schema: 2.0.0 title: Remove-CsClientVersionConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicy.md index c694397d9d..17273cf9fe 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclientversionpolicy schema: 2.0.0 title: Remove-CsClientVersionPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicyRule.md index 014562693c..a004c6d66a 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicyRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionpolicyrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclientversionpolicyrule schema: 2.0.0 title: Remove-CsClientVersionPolicyRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsConfiguration.md index 0dccfd628b..aea857c78e 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclsconfiguration schema: 2.0.0 title: Remove-CsClsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsRegion.md index ab43a9799e..295987e11d 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsRegion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsregion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclsregion schema: 2.0.0 title: Remove-CsClsRegion --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsScenario.md index 185779e160..203a7097e2 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsScenario.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsscenario +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclsscenario schema: 2.0.0 title: Remove-CsClsScenario --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsSecurityGroup.md index 7384efae2f..26bcbdee04 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsSecurityGroup.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclssecuritygroup +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csclssecuritygroup schema: 2.0.0 title: Remove-CsClsSecurityGroup --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCommonAreaPhone.md index 428d529bb5..1a910a9919 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCommonAreaPhone.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscommonareaphone +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscommonareaphone schema: 2.0.0 title: Remove-CsCommonAreaPhone --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDirectory.md index 9a766946b3..52b0682a68 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDirectory.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencedirectory +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconferencedirectory schema: 2.0.0 title: Remove-CsConferenceDirectory --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDisclaimer.md index 4adfc59359..a04afdc406 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDisclaimer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencedisclaimer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconferencedisclaimer schema: 2.0.0 title: Remove-CsConferenceDisclaimer --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingConfiguration.md index b1d5deedd5..2dc1d69b3d 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconferencingconfiguration schema: 2.0.0 title: Remove-CsConferencingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingPolicy.md index 65f02c1ee0..cb4af72de7 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconferencingpolicy schema: 2.0.0 title: Remove-CsConferencingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsConfigurationStoreLocation.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConfigurationStoreLocation.md index 5decd0d21d..048b5b0daa 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConfigurationStoreLocation.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconfigurationstorelocation +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconfigurationstorelocation schema: 2.0.0 title: Remove-CsConfigurationStoreLocation --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsConversationHistoryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConversationHistoryConfiguration.md index bf0819e70f..e43ea4d7b1 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConversationHistoryConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconversationhistoryconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csconversationhistoryconfiguration schema: 2.0.0 title: Remove-CsConversationHistoryConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCpsConfiguration.md index fa8f3cdf87..10086060d2 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCpsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscpsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cscpsconfiguration schema: 2.0.0 title: Remove-CsCpsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateConfiguration.md index 8eab03c315..074ffecb83 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdeviceupdateconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdeviceupdateconfiguration schema: 2.0.0 title: Remove-CsDeviceUpdateConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateRule.md index 3d0a83c5e0..c37e2cecd6 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdeviceupdaterule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdeviceupdaterule schema: 2.0.0 title: Remove-CsDeviceUpdateRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticConfiguration.md index 4444cb5ce9..dbff4aefcb 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdiagnosticconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdiagnosticconfiguration schema: 2.0.0 title: Remove-CsDiagnosticConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticHeaderConfiguration.md index ceb14e2c26..d43515515d 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticHeaderConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdiagnosticheaderconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdiagnosticheaderconfiguration schema: 2.0.0 title: Remove-CsDiagnosticHeaderConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingAccessNumber.md index 9ec35e442a..271343f38c 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingAccessNumber.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingaccessnumber +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdialinconferencingaccessnumber schema: 2.0.0 title: Remove-CsDialInConferencingAccessNumber --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingConfiguration.md index d713fe98a1..da3d98b21e 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdialinconferencingconfiguration schema: 2.0.0 title: Remove-CsDialInConferencingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingDtmfConfiguration.md index f9b95d7458..30dc774091 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingDtmfConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingdtmfconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdialinconferencingdtmfconfiguration schema: 2.0.0 title: Remove-CsDialInConferencingDtmfConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialPlan.md index 20d55ef7e7..140ea40e80 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialPlan.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialplan +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csdialplan schema: 2.0.0 title: Remove-CsDialPlan --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsEnhancedEmergencyServiceDisclaimer.md index abb0cd685b..a96e0584fd 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsEnhancedEmergencyServiceDisclaimer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csenhancedemergencyservicedisclaimer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csenhancedemergencyservicedisclaimer schema: 2.0.0 title: Remove-CsEnhancedEmergencyServiceDisclaimer --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Remove-CsExUmContact.md index 08343dfd49..9547ed50f7 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsExUmContact.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csexumcontact +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csexumcontact schema: 2.0.0 title: Remove-CsExUmContact --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalAccessPolicy.md index aaad09ae2a..8c9e86fd3c 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalAccessPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/remove-csexternalaccesspolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csexternalaccesspolicy schema: 2.0.0 title: Remove-CsExternalAccessPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalUserCommunicationPolicy.md index bad39de2f4..237ba287e9 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalUserCommunicationPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csexternalusercommunicationpolicy schema: 2.0.0 title: Remove-CsExternalUserCommunicationPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsFIPSConfiguration.md index be10e4a004..e5f29655d2 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsFIPSConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csfipsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csfipsconfiguration schema: 2.0.0 title: Remove-CsFIPSConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsFileTransferFilterConfiguration.md index d1b5d53c95..cd81be59cd 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsFileTransferFilterConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csfiletransferfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csfiletransferfilterconfiguration schema: 2.0.0 title: Remove-CsFileTransferFilterConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/Remove-CsGroupPickupUserOrbit.md index 790f68f6e6..f9c1ddbe5a 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsGroupPickupUserOrbit.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csgrouppickupuserorbit +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csgrouppickupuserorbit schema: 2.0.0 title: Remove-CsGroupPickupUserOrbit --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHealthMonitoringConfiguration.md index f2f9267421..409c07d416 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHealthMonitoringConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshealthmonitoringconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshealthmonitoringconfiguration schema: 2.0.0 title: Remove-CsHealthMonitoringConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHostedVoicemailPolicy.md index b7d9315686..1e1bf3bb71 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHostedVoicemailPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshostedvoicemailpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshostedvoicemailpolicy schema: 2.0.0 title: Remove-CsHostedVoicemailPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHostingProvider.md index b6fdae0a1b..2d74e150fc 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHostingProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshostingprovider schema: 2.0.0 title: Remove-CsHostingProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridApplicationEndpoint.md index 52df57a218..899fedc75a 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridApplicationEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint schema: 2.0.0 title: Remove-CsHybridApplicationEndpoint --- @@ -108,8 +108,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint?view=skype-ps) -[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridPSTNSite.md index 6498cf191a..661ccd0d64 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridPSTNSite.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshybridpstnsite +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshybridpstnsite schema: 2.0.0 title: Remove-CsHybridPSTNSite --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsImConfiguration.md index 0bbc4025f2..648737338a 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsImConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimconfiguration schema: 2.0.0 title: Remove-CsImConfiguration --- @@ -141,8 +141,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimconfiguration?view=skype-ps) -[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsImFilterConfiguration.md index 2225f80fd4..2fc626cfb1 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsImFilterConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csimfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimfilterconfiguration schema: 2.0.0 title: Remove-CsImFilterConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsImTranslationConfiguration.md index 86c501c333..c1adf0646b 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsImTranslationConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csimtranslationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimtranslationconfiguration schema: 2.0.0 title: Remove-CsImTranslationConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Remove-CsKerberosAccountAssignment.md index 29f724d492..f539bfc8ad 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsKerberosAccountAssignment.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cskerberosaccountassignment +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cskerberosaccountassignment schema: 2.0.0 title: Remove-CsKerberosAccountAssignment --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsLisLocation.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisLocation.md index edd1eb47f2..d9372beda3 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsLisLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisLocation.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslislocation +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslislocation schema: 2.0.0 title: Remove-CsLisLocation --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsLisPort.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisPort.md index 03f90a2a94..482e98b123 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsLisPort.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisPort.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisport +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslisport schema: 2.0.0 title: Remove-CsLisPort --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsLisServiceProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisServiceProvider.md index 6448c9c76b..2bae110582 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsLisServiceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisServiceProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisserviceprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslisserviceprovider schema: 2.0.0 title: Remove-CsLisServiceProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsLisSubnet.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSubnet.md index 094b852c16..f045080bee 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsLisSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSubnet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslissubnet +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslissubnet schema: 2.0.0 title: Remove-CsLisSubnet --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsLisSwitch.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSwitch.md index 489a9e8fbd..1a0542f488 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsLisSwitch.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSwitch.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisswitch +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslisswitch schema: 2.0.0 title: Remove-CsLisSwitch --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsLisWirelessAccessPoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisWirelessAccessPoint.md index 8e66321086..baa16b074d 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisWirelessAccessPoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csliswirelessaccesspoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csliswirelessaccesspoint schema: 2.0.0 title: Remove-CsLisWirelessAccessPoint --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLocationPolicy.md index c06fe6833a..8f7612a3d6 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLocationPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cslocationpolicy schema: 2.0.0 title: Remove-CsLocationPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsManagementConnection.md b/skype/skype-ps/SkypeForBusiness/Remove-CsManagementConnection.md index 2c203c83e7..f3fb47548f 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsManagementConnection.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsManagementConnection.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmanagementconnection +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csmanagementconnection schema: 2.0.0 title: Remove-CsManagementConnection --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMcxConfiguration.md index fdfe04428c..1e9e9a1a17 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMcxConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmcxconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csmcxconfiguration schema: 2.0.0 title: Remove-CsMcxConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMediaConfiguration.md index 6365d50fec..b4f59d6cb7 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMediaConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmediaconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csmediaconfiguration schema: 2.0.0 title: Remove-CsMediaConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMeetingConfiguration.md index a6d14f9722..fd6a2d0e14 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMeetingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csmeetingconfiguration schema: 2.0.0 title: Remove-CsMeetingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMobilityPolicy.md index 04b38c6434..0c669d59d2 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMobilityPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmobilitypolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csmobilitypolicy schema: 2.0.0 title: Remove-CsMobilityPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkBandwidthPolicyProfile.md index db2ebe9665..0b7eca21ae 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkBandwidthPolicyProfile.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkbandwidthpolicyprofile +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkbandwidthpolicyprofile schema: 2.0.0 title: Remove-CsNetworkBandwidthPolicyProfile --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkConfiguration.md index 0266ade8c6..8a01796d96 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkconfiguration schema: 2.0.0 title: Remove-CsNetworkConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterRegionRoute.md index 1426cfadad..fbbedcfe58 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterRegionRoute.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkinterregionroute +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkinterregionroute schema: 2.0.0 title: Remove-CsNetworkInterRegionRoute --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterSitePolicy.md index f93adff410..2d812a3bbe 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterSitePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkintersitepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkintersitepolicy schema: 2.0.0 title: Remove-CsNetworkInterSitePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegion.md index 438a3ec194..9d0c8b4c1c 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkregion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkregion schema: 2.0.0 title: Remove-CsNetworkRegion --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegionLink.md index 0066fd5907..4dad446e0e 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegionLink.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkregionlink +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworkregionlink schema: 2.0.0 title: Remove-CsNetworkRegionLink --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSite.md index cb5d6f9ad6..ef8101ac63 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSite.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworksite +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworksite schema: 2.0.0 title: Remove-CsNetworkSite --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSubnet.md index 57cccff9cb..9efea2b384 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSubnet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworksubnet +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csnetworksubnet schema: 2.0.0 title: Remove-CsNetworkSubnet --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsOAuthServer.md index fb06c5e6d6..ea253a6da1 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsOAuthServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csoauthserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csoauthserver schema: 2.0.0 title: Remove-CsOAuthServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundCallingNumberTranslationRule.md index 9062a4c281..1753105e4b 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundCallingNumberTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csoutboundcallingnumbertranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csoutboundcallingnumbertranslationrule schema: 2.0.0 title: Remove-CsOutboundCallingNumberTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundTranslationRule.md index 76ec8bbd0f..b1ba48b5fe 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csoutboundtranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csoutboundtranslationrule schema: 2.0.0 title: Remove-CsOutboundTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPartnerApplication.md index 6ec4cb8ac7..f7851f9f5f 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPartnerApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspartnerapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspartnerapplication schema: 2.0.0 title: Remove-CsPartnerApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatAddin.md index 0a0ff2e78b..b6107e3f34 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatAddin.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchataddin +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchataddin schema: 2.0.0 title: Remove-CsPersistentChatAddin --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatCategory.md index 3afcab77ec..4719f0f8b4 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatCategory.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatcategory +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatcategory schema: 2.0.0 title: Remove-CsPersistentChatCategory --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatComplianceConfiguration.md index 99569100e9..838d7744e2 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatComplianceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatcomplianceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatcomplianceconfiguration schema: 2.0.0 title: Remove-CsPersistentChatComplianceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatConfiguration.md index 6455ecf59e..2325cfabd1 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatconfiguration schema: 2.0.0 title: Remove-CsPersistentChatConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatEndpoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatEndpoint.md index 171782a88f..11ae584baa 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatendpoint schema: 2.0.0 title: Remove-CsPersistentChatEndpoint --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatMessage.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatMessage.md index cf1370128c..6f188703de 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatMessage.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatMessage.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatmessage +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatmessage schema: 2.0.0 title: Remove-CsPersistentChatMessage --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatPolicy.md index bd3381de72..458bc8fd84 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatpolicy schema: 2.0.0 title: Remove-CsPersistentChatPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatRoom.md index 3120493ab4..0d1b1c19d0 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatRoom.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatroom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspersistentchatroom schema: 2.0.0 title: Remove-CsPersistentChatRoom --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPinPolicy.md index aa180531b0..aa4b700edc 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPinPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspinpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspinpolicy schema: 2.0.0 title: Remove-CsPinPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPlatformServiceSettings.md index d77fb2327b..ff0303a4f5 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPlatformServiceSettings.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csplatformservicesettings schema: 2.0.0 title: Remove-CsPlatformServiceSettings --- @@ -127,8 +127,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csplatformservicesettings?view=skype-ps) -[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPresencePolicy.md index 4b2bc40885..1eacbf0ff8 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPresencePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspresencepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspresencepolicy schema: 2.0.0 title: Remove-CsPresencePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPresenceProvider.md index f16dc49046..7e5c87ec71 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPresenceProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspresenceprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspresenceprovider schema: 2.0.0 title: Remove-CsPresenceProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPrivacyConfiguration.md index fee0cb94c7..fdf16ce88f 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPrivacyConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csprivacyconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csprivacyconfiguration schema: 2.0.0 title: Remove-CsPrivacyConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsProxyConfiguration.md index f92bd0944f..a9e921c426 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsProxyConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csproxyconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csproxyconfiguration schema: 2.0.0 title: Remove-CsProxyConfiguration --- @@ -83,7 +83,7 @@ Suppresses the display of any non-fatal error message that might occur when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -108,7 +108,7 @@ Instead, the properties within that global collection will all be reset to their ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -158,15 +158,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings The `Remove-CsProxyConfiguration` cmdlet accepts pipelined instances of the proxy settings object. ## OUTPUTS -### -None. -Instead, the `Remove-CsProxyConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object. +### None ## NOTES diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPublicProvider.md index 7ad4baefe9..46fc715d6d 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPublicProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspublicprovider schema: 2.0.0 title: Remove-CsPublicProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPushNotificationConfiguration.md index a2d8dad083..44a3aec3bd 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPushNotificationConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cspushnotificationconfiguration schema: 2.0.0 title: Remove-CsPushNotificationConfiguration --- @@ -206,8 +206,8 @@ This cmdlet does not return a value or object. ## NOTES ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration?view=skype-ps) -[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) +[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cspushnotificationconfiguration?view=skype-ps) -[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) +[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsQoEConfiguration.md index 7b9b2a1820..6e578300a3 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsQoEConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csqoeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csqoeconfiguration schema: 2.0.0 title: Remove-CsQoEConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRegistrarConfiguration.md index bd402a7524..bf14ccb559 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRegistrarConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csregistrarconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csregistrarconfiguration schema: 2.0.0 title: Remove-CsRegistrarConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsReportingConfiguration.md index 788b8c7323..13c161eaff 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsReportingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csreportingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csreportingconfiguration schema: 2.0.0 title: Remove-CsReportingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsAgentGroup.md index bdd29259d2..0c4399dbe5 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsAgentGroup.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsagentgroup +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csrgsagentgroup schema: 2.0.0 title: Remove-CsRgsAgentGroup --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHolidaySet.md index 1a85e329df..d8f890b2d5 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHolidaySet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsholidayset +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csrgsholidayset schema: 2.0.0 title: Remove-CsRgsHolidaySet --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHoursOfBusiness.md index 3307d8c7fb..ca120fa95b 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHoursOfBusiness.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgshoursofbusiness +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csrgshoursofbusiness schema: 2.0.0 title: Remove-CsRgsHoursOfBusiness --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsQueue.md index df56a33879..a702888b7e 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsQueue.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsqueue +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csrgsqueue schema: 2.0.0 title: Remove-CsRgsQueue --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsWorkflow.md index c39f32cda5..4b043dae8d 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsWorkflow.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsworkflow +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csrgsworkflow schema: 2.0.0 title: Remove-CsRgsWorkflow --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRoutingConfiguration.md index fc56301e29..e29a2dd72e 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRoutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csroutingconfiguration schema: 2.0.0 title: Remove-CsRoutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/Remove-CsServerApplication.md index 9c996012ab..65e966bc99 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsServerApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csserverapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csserverapplication schema: 2.0.0 title: Remove-CsServerApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSimpleUrlConfiguration.md index 11165da5eb..36a838cf79 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSimpleUrlConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssimpleurlconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cssimpleurlconfiguration schema: 2.0.0 title: Remove-CsSimpleUrlConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSipDomain.md index 07fbfadcbe..4cb03e46dd 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSipDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssipdomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cssipdomain schema: 2.0.0 title: Remove-CsSipDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSipResponseCodeTranslationRule.md index 15bf7dc7a3..df3fdc1c10 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSipResponseCodeTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssipresponsecodetranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cssipresponsecodetranslationrule schema: 2.0.0 title: Remove-CsSipResponseCodeTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsSlaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaConfiguration.md index c6256398a6..26e29ddb26 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsSlaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csslaconfiguration schema: 2.0.0 title: Remove-CsSlaConfiguration --- @@ -127,6 +127,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration?view=skype-ps) +[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csslaconfiguration?view=skype-ps) -[Set-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration?view=skype-ps) +[Set-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csslaconfiguration?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsSlaDelegates.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaDelegates.md index 285d38a23b..2ff567a456 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsSlaDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaDelegates.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssladelegates +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cssladelegates schema: 2.0.0 title: Remove-CsSlaDelegates --- @@ -152,4 +152,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Add-CsSlaDelegates](https://learn.microsoft.com/powershell/module/skype/add-cssladelegates?view=skype-ps) +[Add-CsSlaDelegates](https://learn.microsoft.com/powershell/module/skypeforbusiness/add-cssladelegates?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsStaticRoutingConfiguration.md index 7749ced793..a1730f2fac 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsStaticRoutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csstaticroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csstaticroutingconfiguration schema: 2.0.0 title: Remove-CsStaticRoutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsStorageServiceConfiguration.md index 56d34f3cd2..2fe7374ec7 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsStorageServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csstorageserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csstorageserviceconfiguration schema: 2.0.0 title: Remove-CsStorageServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTeamsUpgradePolicy.md index 8c35c1db3d..ac40a90455 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTeamsUpgradePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csteamsupgradepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csteamsupgradepolicy schema: 2.0.0 title: Remove-CsTeamsUpgradePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTelemetryConfiguration.md index 7ff8d89008..434dd6ec9e 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTelemetryConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstelemetryconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstelemetryconfiguration schema: 2.0.0 title: Remove-CsTelemetryConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTenantUpdateTimeWindow.md index 2db58f3e4d..39e97e60d3 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTenantUpdateTimeWindow.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstenantupdatetimewindow +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstenantupdatetimewindow schema: 2.0.0 title: Remove-CsTenantUpdateTimeWindow --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTestDevice.md index 111cf9c62a..91ef947c3a 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTestDevice.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstestdevice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstestdevice schema: 2.0.0 title: Remove-CsTestDevice --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsTestUserCredential.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTestUserCredential.md index aa23f7471a..638a865ec2 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsTestUserCredential.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTestUserCredential.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstestusercredential +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstestusercredential schema: 2.0.0 title: Remove-CsTestUserCredential --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystem.md index f617553af4..8e0355cb33 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystem.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystem +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csthirdpartyvideosystem schema: 2.0.0 title: Remove-CsThirdPartyVideoSystem --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystemPolicy.md index 7b1bd11008..4e88a07134 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystemPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystempolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csthirdpartyvideosystempolicy schema: 2.0.0 title: Remove-CsThirdPartyVideoSystemPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrunkConfiguration.md index acffa0be64..0add714c25 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrunkConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstrunkconfiguration schema: 2.0.0 title: Remove-CsTrunkConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplication.md index afdfc8b58c..81a03bd29e 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstrustedapplication schema: 2.0.0 title: Remove-CsTrustedApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationComputer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationComputer.md index 44ecef012d..66d87b18e7 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationComputer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationcomputer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstrustedapplicationcomputer schema: 2.0.0 title: Remove-CsTrustedApplicationComputer --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationEndpoint.md index 96eb6d38d9..f82793a266 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstrustedapplicationendpoint schema: 2.0.0 title: Remove-CsTrustedApplicationEndpoint --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationPool.md index 5af06df656..5ebc018e4a 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationPool.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationpool +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cstrustedapplicationpool schema: 2.0.0 title: Remove-CsTrustedApplicationPool --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUCPhoneConfiguration.md index 2ae8733502..c840780b08 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUCPhoneConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csucphoneconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csucphoneconfiguration schema: 2.0.0 title: Remove-CsUCPhoneConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUnassignedNumber.md index 95289b5a32..2c4fae7d52 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUnassignedNumber.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csunassignednumber +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csunassignednumber schema: 2.0.0 title: Remove-CsUnassignedNumber --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsUserAcp.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserAcp.md index debdde7d26..e6dd5fdc91 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsUserAcp.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserAcp.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuseracp +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csuseracp schema: 2.0.0 title: Remove-CsUserAcp --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserReplicatorConfiguration.md index 016dfebbaa..7ceb608ee8 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserReplicatorConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserreplicatorconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csuserreplicatorconfiguration schema: 2.0.0 title: Remove-CsUserReplicatorConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesConfiguration.md index 9b6f635b1b..91edca6e2a 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserservicesconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csuserservicesconfiguration schema: 2.0.0 title: Remove-CsUserServicesConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesPolicy.md index 38132dae42..0eb4d25373 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserservicespolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csuserservicespolicy schema: 2.0.0 title: Remove-CsUserServicesPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsUserStoreBackupData.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserStoreBackupData.md index 2f9501747c..aa096ba5ce 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsUserStoreBackupData.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserStoreBackupData.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserstorebackupdata +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csuserstorebackupdata schema: 2.0.0 title: Remove-CsUserStoreBackupData --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerConfiguration.md index ec86105396..420ad4a58a 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideointeropserverconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvideointeropserverconfiguration schema: 2.0.0 title: Remove-CsVideoInteropServerConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md index 064d514c8a..3185e93285 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideointeropserversynthetictransactionconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvideointeropserversynthetictransactionconfiguration schema: 2.0.0 title: Remove-CsVideoInteropServerSyntheticTransactionConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoTrunkConfiguration.md index b3583f70e0..63191a39a2 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoTrunkConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideotrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvideotrunkconfiguration schema: 2.0.0 title: Remove-CsVideoTrunkConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceConfiguration.md index 4497dd8e79..feaa482065 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoiceconfiguration schema: 2.0.0 title: Remove-CsVoiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceNormalizationRule.md index be8511a104..c5c76e6026 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceNormalizationRule.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicenormalizationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoicenormalizationrule schema: 2.0.0 title: Remove-CsVoiceNormalizationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicePolicy.md index fb80140a1a..1b3fbebbb7 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoicepolicy schema: 2.0.0 title: Remove-CsVoicePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoute.md index 575325bdab..f352b5f7fe 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoute.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceroute +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoiceroute schema: 2.0.0 title: Remove-CsVoiceRoute --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoutingPolicy.md index c9531ad446..835f61b2e2 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoutingPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceroutingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoiceroutingpolicy schema: 2.0.0 title: Remove-CsVoiceRoutingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceTestConfiguration.md index bb60c78d2a..af6648cb7e 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceTestConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicetestconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoicetestconfiguration schema: 2.0.0 title: Remove-CsVoiceTestConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicemailReroutingConfiguration.md index 0ce4d9d834..1a53386901 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicemailReroutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicemailreroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csvoicemailreroutingconfiguration schema: 2.0.0 title: Remove-CsVoicemailReroutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsWatcherNodeConfiguration.md index f2f856cfaa..d9fb9a2d0d 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsWatcherNodeConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cswatchernodeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cswatchernodeconfiguration schema: 2.0.0 title: Remove-CsWatcherNodeConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsWebServiceConfiguration.md index 87b50bd854..58c9599b15 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsWebServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-cswebserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cswebserviceconfiguration schema: 2.0.0 title: Remove-CsWebServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Remove-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/Remove-CsXmppAllowedPartner.md index e0e4ff92ba..42c62f478b 100644 --- a/skype/skype-ps/SkypeForBusiness/Remove-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsXmppAllowedPartner.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/remove-csxmppallowedpartner +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csxmppallowedpartner schema: 2.0.0 title: Remove-CsXmppAllowedPartner --- diff --git a/skype/skype-ps/SkypeForBusiness/Request-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Request-CsCertificate.md index 1f4ee8c8b5..6bf5aee446 100644 --- a/skype/skype-ps/SkypeForBusiness/Request-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Request-CsCertificate.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/request-cscertificate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/request-cscertificate schema: 2.0.0 title: Request-CsCertificate --- diff --git a/skype/skype-ps/SkypeForBusiness/Reset-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Reset-CsDeviceUpdateRule.md index f8ac59a8cc..24f93a5b06 100644 --- a/skype/skype-ps/SkypeForBusiness/Reset-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsDeviceUpdateRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/reset-csdeviceupdaterule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/reset-csdeviceupdaterule schema: 2.0.0 title: Reset-CsDeviceUpdateRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Reset-CsNotificationQueues.md b/skype/skype-ps/SkypeForBusiness/Reset-CsNotificationQueues.md index 0235a85981..44ad3d7eef 100644 --- a/skype/skype-ps/SkypeForBusiness/Reset-CsNotificationQueues.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsNotificationQueues.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/reset-csnotificationqueues +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/reset-csnotificationqueues schema: 2.0.0 title: Reset-CsNotificationQueues --- diff --git a/skype/skype-ps/SkypeForBusiness/Reset-CsPoolRegistrarState.md b/skype/skype-ps/SkypeForBusiness/Reset-CsPoolRegistrarState.md index e378f46c1c..ab08c9bbe5 100644 --- a/skype/skype-ps/SkypeForBusiness/Reset-CsPoolRegistrarState.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsPoolRegistrarState.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/reset-cspoolregistrarstate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/reset-cspoolregistrarstate schema: 2.0.0 title: Reset-CsPoolRegistrarState --- diff --git a/skype/skype-ps/SkypeForBusiness/Reset-CsRoutingGroup.md b/skype/skype-ps/SkypeForBusiness/Reset-CsRoutingGroup.md index 9eba007488..3e2e20405d 100644 --- a/skype/skype-ps/SkypeForBusiness/Reset-CsRoutingGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsRoutingGroup.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/reset-csroutinggroup +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/reset-csroutinggroup schema: 2.0.0 title: Reset-CsRoutingGroup --- diff --git a/skype/skype-ps/SkypeForBusiness/Restore-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Restore-CsDeviceUpdateRule.md index f97297ef63..f2d40b85ad 100644 --- a/skype/skype-ps/SkypeForBusiness/Restore-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Restore-CsDeviceUpdateRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/restore-csdeviceupdaterule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/restore-csdeviceupdaterule schema: 2.0.0 title: Restore-CsDeviceUpdateRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Revoke-CsClientCertificate.md b/skype/skype-ps/SkypeForBusiness/Revoke-CsClientCertificate.md index daf1fdee14..1550129456 100644 --- a/skype/skype-ps/SkypeForBusiness/Revoke-CsClientCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Revoke-CsClientCertificate.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/revoke-csclientcertificate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/revoke-csclientcertificate schema: 2.0.0 title: Revoke-CsClientCertificate --- diff --git a/skype/skype-ps/SkypeForBusiness/Revoke-CsOUPermission.md b/skype/skype-ps/SkypeForBusiness/Revoke-CsOUPermission.md index 3cbb0f2138..74a6ec3257 100644 --- a/skype/skype-ps/SkypeForBusiness/Revoke-CsOUPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Revoke-CsOUPermission.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/revoke-csoupermission +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/revoke-csoupermission schema: 2.0.0 title: Revoke-CsOUPermission --- diff --git a/skype/skype-ps/SkypeForBusiness/Revoke-CsSetupPermission.md b/skype/skype-ps/SkypeForBusiness/Revoke-CsSetupPermission.md index a5089deb7d..bb9180ddd4 100644 --- a/skype/skype-ps/SkypeForBusiness/Revoke-CsSetupPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Revoke-CsSetupPermission.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/revoke-cssetuppermission +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/revoke-cssetuppermission schema: 2.0.0 title: Revoke-CsSetupPermission --- diff --git a/skype/skype-ps/SkypeForBusiness/Search-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Search-CsClsLogging.md index 14b394d277..4fa5447b51 100644 --- a/skype/skype-ps/SkypeForBusiness/Search-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Search-CsClsLogging.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/search-csclslogging +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/search-csclslogging schema: 2.0.0 title: Search-CsClsLogging --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAVEdgeConfiguration.md index 153620cf8f..3a309d1fc1 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAVEdgeConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csavedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csavedgeconfiguration schema: 2.0.0 title: Set-CsAVEdgeConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAccessEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAccessEdgeConfiguration.md index f3fbc39c79..b2e7c57131 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAccessEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAccessEdgeConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csaccessedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csaccessedgeconfiguration schema: 2.0.0 title: Set-CsAccessEdgeConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookConfiguration.md index f7bf3d7346..bfd68cef79 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbookconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csaddressbookconfiguration schema: 2.0.0 title: Set-CsAddressBookConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationConfiguration.md index 07f428d102..df1a6881fa 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csaddressbooknormalizationconfiguration schema: 2.0.0 title: Set-CsAddressBookNormalizationConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationRule.md index 7ffb08e576..d2656b8be7 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csaddressbooknormalizationrule schema: 2.0.0 title: Set-CsAddressBookNormalizationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Set-CsAdminRole.md index 1a7349bed1..6ce0ef6ffe 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAdminRole.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csadminrole +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csadminrole schema: 2.0.0 title: Set-CsAdminRole --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/Set-CsAllowedDomain.md index b3d401bdaa..fbc9c06638 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAllowedDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csalloweddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csalloweddomain schema: 2.0.0 title: Set-CsAllowedDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Set-CsAnalogDevice.md index ed974a7588..6db113bf1f 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAnalogDevice.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csanalogdevice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csanalogdevice schema: 2.0.0 title: Set-CsAnalogDevice --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/Set-CsAnnouncement.md index 1863bd0ebf..03dcea5b9f 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAnnouncement.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csannouncement +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csannouncement schema: 2.0.0 title: Set-CsAnnouncement --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsApplicationServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsApplicationServer.md index 37b94986aa..a8cf5e8612 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsApplicationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsApplicationServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csapplicationserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csapplicationserver schema: 2.0.0 title: Set-CsApplicationServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingConfiguration.md index e6278cc0dc..ddb0f183b7 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csarchivingconfiguration schema: 2.0.0 title: Set-CsArchivingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingPolicy.md index 7c29b9f75a..9da2eb8a80 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csarchivingpolicy schema: 2.0.0 title: Set-CsArchivingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsArchivingServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingServer.md index 671d19d6f0..1e7eb5d4a1 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsArchivingServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csarchivingserver schema: 2.0.0 title: Set-CsArchivingServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAudioTestServiceApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsAudioTestServiceApplication.md index 6091220223..71f87688ae 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAudioTestServiceApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAudioTestServiceApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csaudiotestserviceapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csaudiotestserviceapplication schema: 2.0.0 title: Set-CsAudioTestServiceApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAuthConfig.md b/skype/skype-ps/SkypeForBusiness/Set-CsAuthConfig.md index a55ea42f1c..939ca2c660 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAuthConfig.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAuthConfig.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csauthconfig +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csauthconfig schema: 2.0.0 title: Set-CsAuthConfig --- @@ -25,11 +25,11 @@ Set-CsAuthConfig [-Scenario] [[-Pool] ] [-WhatIf] [ ## DESCRIPTION Use the Set-CsAuthConfig cmdlet to modify the authentication configuration for your organization. The 5 supported scenarios are described in the following list. Scenario is a required parameter. All other parameters are optional. MA is Modern Authentication and Win is Windows Integrated Authentication in the following list. -- **Scenario 1**: External: MA + Win; Internal: MA + Win; Parameter: AllowAllExternallyAndInternally. This is the default scenario when MA is turned on for Skype for Business Server. In other words, this is the starting point when MA is configured. +- **Scenario 1**: External: MA + Win; Internal: MA + Win; Parameter: AllowAllExternallyAndInternally. This is the default scenario when MA is turned on for Skype for Business Server. In other words, this is the starting point when MA is configured. - **Scenario 2**: External: MA; Internal: MA + Win; Parameter: BlockWindowsAuthExternally. This topology blocks NTLM externally, but allows NTLM or Kerberos (for clients that don't support ADAL) to work internally. If your clients do support ADAL they will use MA internally. -- **Scenario 3**: External: MA; Internal: MA; Parameter: BlockWindowsAuthExternallyAndInternally. This topology requires MA for all users. All your ADAL-capable clients will work in this topology, and passwords will not be leveraged if, for example, you turn off the use of passwords with Certificate-based Auth. +- **Scenario 3**: External: MA; Internal: MA; Parameter: BlockWindowsAuthExternallyAndInternally. This topology requires MA for all users. All your ADAL-capable clients will work in this topology, and passwords will not be leveraged if, for example, you turn off the use of passwords with Certificate-based Auth. - **Scenario 4**: External: MA; Internal: Win; Parameter: BlockWindowsAuthExternallyAndModernAuthInternally. This topology blocks NTLM externally and MA internally. It allows all clients to use legacy authentication methods internally (even ADAL-capable clients). @@ -54,7 +54,7 @@ This example forces all external clients to use MA but allows NTLM or Kerberos ( PS C:\> Set-CsAuthConfig -Scenario BlockWindowsAuthExternalyAndModernAuthInternally ``` -This example blocks NTLM externally and MA internally. It forces all external clients to use MA, but allows all clients to use legacy authentication methods internally (even ADAL-capable clients). +This example blocks NTLM externally and MA internally. It forces all external clients to use MA, but allows all clients to use legacy authentication methods internally (even ADAL-capable clients). > [!NOTE] > Please note that in the current version of the module the parameter value BlockWindowsAuthExternalyAndModernAuthInternally is misspelled and to be able to use it, only one l for Externally should be used. @@ -147,6 +147,6 @@ For more information, see [about_CommonParameters](https://go.microsoft.com/fwli ## NOTES -After changing CsAuthConfig, you must run [Enable-CsComputer](https://learn.microsoft.com/powershell/module/skype/enable-cscomputer?view=skype-ps) on each Skype for Business Server machine before your changes take effect. +After changing CsAuthConfig, you must run [Enable-CsComputer](https://learn.microsoft.com/powershell/module/skypeforbusiness/enable-cscomputer?view=skype-ps) on each Skype for Business Server machine before your changes take effect. ## RELATED LINKS diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAutodiscoverConfiguration.md index 4dbafeae17..e2b1976aaa 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAutodiscoverConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csautodiscoverconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csautodiscoverconfiguration schema: 2.0.0 title: Set-CsAutodiscoverConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsBackupServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsBackupServiceConfiguration.md index ff3bc82614..7620a9b9eb 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBackupServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csbackupserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csbackupserviceconfiguration schema: 2.0.0 title: Set-CsBackupServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsBandwidthPolicyServiceConfiguration.md index 22c68028d3..3ea0c12444 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBandwidthPolicyServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csbandwidthpolicyserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csbandwidthpolicyserviceconfiguration schema: 2.0.0 title: Set-CsBandwidthPolicyServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/Set-CsBlockedDomain.md index 2d172726d4..e960300107 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBlockedDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csblockeddomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csblockeddomain schema: 2.0.0 title: Set-CsBlockedDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsBroadcastMeetingConfiguration.md index 9365c7a479..ebfc086c66 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBroadcastMeetingConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-csbroadcastmeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csbroadcastmeetingconfiguration schema: 2.0.0 title: Set-CsBroadcastMeetingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsBusyOptions.md b/skype/skype-ps/SkypeForBusiness/Set-CsBusyOptions.md index c8fab683d8..2d06ba07e6 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsBusyOptions.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBusyOptions.md @@ -172,6 +172,6 @@ Microsoft.Rtc.Management.AD.UserIdParameter object. ## NOTES ## RELATED LINKS -[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions?view=skype-ps) +[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csbusyoptions?view=skype-ps) -[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) +[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkOrbit.md index 6dd2b2cc87..92a8cbe0a3 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkOrbit.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cscallparkorbit +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscallparkorbit schema: 2.0.0 title: Set-CsCallParkOrbit --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCallParkServiceMusicOnHoldFile.md b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkServiceMusicOnHoldFile.md index 1f34daf009..aeee45c974 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCallParkServiceMusicOnHoldFile.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkServiceMusicOnHoldFile.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cscallparkservicemusiconholdfile +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscallparkservicemusiconholdfile schema: 2.0.0 title: Set-CsCallParkServiceMusicOnHoldFile --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsCallViaWorkPolicy.md index 683f8f3a8a..fd232eb918 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCallViaWorkPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cscallviaworkpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscallviaworkpolicy schema: 2.0.0 title: Set-CsCallViaWorkPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceConfigurationReplicationStatus.md b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceConfigurationReplicationStatus.md index 1d3c31da75..2fbea76b09 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceConfigurationReplicationStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceConfigurationReplicationStatus.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-cscceapplianceconfigurationreplicationstatus +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscceapplianceconfigurationreplicationstatus schema: 2.0.0 title: Set-CsCceApplianceConfigurationReplicationStatus --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceDeploymentStatus.md b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceDeploymentStatus.md index 2719f835d2..ecf067d864 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceDeploymentStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceDeploymentStatus.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-cscceappliancedeploymentstatus +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscceappliancedeploymentstatus schema: 2.0.0 title: Set-CsCceApplianceDeploymentStatus --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceStatus.md b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceStatus.md index 6d00652fe7..5995fd5dc9 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceStatus.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-cscceappliancestatus +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscceappliancestatus schema: 2.0.0 title: Set-CsCceApplianceStatus --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsCdrConfiguration.md index 88ca491349..10f1757784 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCdrConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cscdrconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscdrconfiguration schema: 2.0.0 title: Set-CsCdrConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Set-CsCertificate.md index 63db43849f..d608c0124d 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCertificate.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cscertificate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscertificate schema: 2.0.0 title: Set-CsCertificate --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsClientPin.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientPin.md index a61f23da92..dcff555d58 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsClientPin.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientPin.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientpin +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclientpin schema: 2.0.0 title: Set-CsClientPin --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientPolicy.md index dd169a8c45..64518f3cfa 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclientpolicy schema: 2.0.0 title: Set-CsClientPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionConfiguration.md index 54c43429bb..7fe5245162 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclientversionconfiguration schema: 2.0.0 title: Set-CsClientVersionConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicy.md index 74a4988f97..7b8ecdb235 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclientversionpolicy schema: 2.0.0 title: Set-CsClientVersionPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicyRule.md index 577a00ab02..8e3d47286e 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicyRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionpolicyrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclientversionpolicyrule schema: 2.0.0 title: Set-CsClientVersionPolicyRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnector.md b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnector.md index 32ca4d6200..4008a81250 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnector.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnector.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cscloudcalldataconnector +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscloudcalldataconnector schema: 2.0.0 title: Set-CsCloudCallDataConnector --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnectorConfiguration.md index 255daa0874..f2348d4b65 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnectorConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cscloudcalldataconnectorconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscloudcalldataconnectorconfiguration schema: 2.0.0 title: Set-CsCloudCallDataConnectorConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsConfiguration.md index 4250a9135c..f8f4c5d280 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csclsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclsconfiguration schema: 2.0.0 title: Set-CsClsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsRegion.md index f577f2afe6..0caa65d7db 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsRegion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csclsregion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclsregion schema: 2.0.0 title: Set-CsClsRegion --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsScenario.md index 806484a6eb..a2fd2f1c9f 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsScenario.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csclsscenario +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclsscenario schema: 2.0.0 title: Set-CsClsScenario --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsClsSearchTerm.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsSearchTerm.md index 5a6b4be036..9be8f9017b 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsClsSearchTerm.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsSearchTerm.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csclssearchterm +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclssearchterm schema: 2.0.0 title: Set-CsClsSearchTerm --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsSecurityGroup.md index 85c3266d10..7823290fb5 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsSecurityGroup.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csclssecuritygroup +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csclssecuritygroup schema: 2.0.0 title: Set-CsClsSecurityGroup --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Set-CsCommonAreaPhone.md index a1aecb8556..6ece411f50 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCommonAreaPhone.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cscommonareaphone +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscommonareaphone schema: 2.0.0 title: Set-CsCommonAreaPhone --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsConferenceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceDisclaimer.md index 388fa4825f..a857a327bf 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsConferenceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceDisclaimer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencedisclaimer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconferencedisclaimer schema: 2.0.0 title: Set-CsConferenceDisclaimer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsConferenceServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceServer.md index 921e54ed8d..99debc19ec 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsConferenceServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferenceserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconferenceserver schema: 2.0.0 title: Set-CsConferenceServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingConfiguration.md index cab42bd8de..acc6e66bd0 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconferencingconfiguration schema: 2.0.0 title: Set-CsConferencingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingPolicy.md index 19409e1f0a..aef4c610e3 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconferencingpolicy schema: 2.0.0 title: Set-CsConferencingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsConfigurationStoreLocation.md b/skype/skype-ps/SkypeForBusiness/Set-CsConfigurationStoreLocation.md index 338c6f9bef..8e0c4719a6 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConfigurationStoreLocation.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csconfigurationstorelocation +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconfigurationstorelocation schema: 2.0.0 title: Set-CsConfigurationStoreLocation --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsConversationHistoryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsConversationHistoryConfiguration.md index d5a89ad5cf..02d91e4439 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConversationHistoryConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csconversationhistoryconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csconversationhistoryconfiguration schema: 2.0.0 title: Set-CsConversationHistoryConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsCpsConfiguration.md index 4acc1ce82e..30a9033356 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCpsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cscpsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cscpsconfiguration schema: 2.0.0 title: Set-CsCpsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDeviceUpdateConfiguration.md index 57fea410e4..f38f79b893 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDeviceUpdateConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csdeviceupdateconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdeviceupdateconfiguration schema: 2.0.0 title: Set-CsDeviceUpdateConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticConfiguration.md index b013798581..c7b40bbdef 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csdiagnosticconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdiagnosticconfiguration schema: 2.0.0 title: Set-CsDiagnosticConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticHeaderConfiguration.md index dd3eb63f62..f754ed392a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticHeaderConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csdiagnosticheaderconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdiagnosticheaderconfiguration schema: 2.0.0 title: Set-CsDiagnosticHeaderConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingAccessNumber.md index 70294ecd01..f888c0b9f8 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingAccessNumber.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingaccessnumber +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdialinconferencingaccessnumber schema: 2.0.0 title: Set-CsDialInConferencingAccessNumber --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingConfiguration.md index 3146403aa9..d89baaa921 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdialinconferencingconfiguration schema: 2.0.0 title: Set-CsDialInConferencingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingDtmfConfiguration.md index 0a19c1182a..35381bc35a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingDtmfConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingdtmfconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdialinconferencingdtmfconfiguration schema: 2.0.0 title: Set-CsDialInConferencingDtmfConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialPlan.md index b99503c3d7..27e4239681 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialPlan.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialplan +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdialplan schema: 2.0.0 title: Set-CsDialPlan --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsDirector.md b/skype/skype-ps/SkypeForBusiness/Set-CsDirector.md index c90c6e320b..a5664e412a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsDirector.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDirector.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csdirector +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csdirector schema: 2.0.0 title: Set-CsDirector --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsEdgeServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsEdgeServer.md index 9bd35fd2f8..17e9ab6ec4 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsEdgeServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsEdgeServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csedgeserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csedgeserver schema: 2.0.0 title: Set-CsEdgeServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Set-CsEnhancedEmergencyServiceDisclaimer.md index 456b77d9ce..dd9b7ef0a0 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsEnhancedEmergencyServiceDisclaimer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csenhancedemergencyservicedisclaimer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csenhancedemergencyservicedisclaimer schema: 2.0.0 title: Set-CsEnhancedEmergencyServiceDisclaimer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Set-CsExUmContact.md index 4b2efd1ac3..244cfa2621 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsExUmContact.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csexumcontact +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csexumcontact schema: 2.0.0 title: Set-CsExUmContact --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsExternalAccessPolicy.md index c9a4befb82..af39315f4c 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsExternalAccessPolicy.md @@ -6,7 +6,7 @@ Locale: en-US Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csexternalaccesspolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csexternalaccesspolicy schema: 2.0.0 title: Set-CsExternalAccessPolicy --- @@ -60,7 +60,7 @@ This enables your users to use Skype for Business and log on to Skype for Busine The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, Instance, PipelineVariable, and Tenant -5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skype/set-cstenantfederationconfiguration) or Teams admin center under the External Access setting. +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skypeforbusiness/set-cstenantfederationconfiguration) or Teams admin center under the External Access setting. After an external access policy has been created, you can use the `Set-CsExternalAccessPolicy` cmdlet to change the property values of that policy. For example, by default the global policy does not allow users to communicate with people who have accounts with a federated organization. diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsExternalUserCommunicationPolicy.md index 2843a13b45..b3baa7a8fd 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsExternalUserCommunicationPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csexternalusercommunicationpolicy schema: 2.0.0 title: Set-CsExternalUserCommunicationPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsFIPSConfiguration.md index 7e4281cb24..3ab4a3db18 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsFIPSConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csfipsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csfipsconfiguration schema: 2.0.0 title: Set-CsFIPSConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsFileTransferFilterConfiguration.md index c4b66a58e8..6a01fbdc5f 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsFileTransferFilterConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csfiletransferfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csfiletransferfilterconfiguration schema: 2.0.0 title: Set-CsFileTransferFilterConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/Set-CsGroupPickupUserOrbit.md index 28171a1644..ab9c43a013 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsGroupPickupUserOrbit.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csgrouppickupuserorbit +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csgrouppickupuserorbit schema: 2.0.0 title: Set-CsGroupPickupUserOrbit --- @@ -65,7 +65,7 @@ Accept wildcard characters: False Specifies the new group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. -For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). +For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skypeforbusiness/New-CsCallParkOrbit). Values for the Orbit parameter must match the regular expression (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsHealthMonitoringConfiguration.md index 55f7b22675..65f606934b 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHealthMonitoringConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cshealthmonitoringconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshealthmonitoringconfiguration schema: 2.0.0 title: Set-CsHealthMonitoringConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsHostedVoicemailPolicy.md index e1c323bb30..645efba7ca 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHostedVoicemailPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cshostedvoicemailpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshostedvoicemailpolicy schema: 2.0.0 title: Set-CsHostedVoicemailPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsHostingProvider.md index 0841bd38c1..e446b6def4 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHostingProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshostingprovider schema: 2.0.0 title: Set-CsHostingProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridApplicationEndpoint.md index 56b277fc96..29dda7ffb0 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridApplicationEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint schema: 2.0.0 title: Set-CsHybridApplicationEndpoint --- @@ -179,8 +179,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint?view=skype-ps) -[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsHybridMediationServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridMediationServer.md index 5e774389d3..175b59d3ae 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsHybridMediationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridMediationServer.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridmediationserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridmediationserver schema: 2.0.0 title: Set-CsHybridMediationServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNAppliance.md index 15bc5ac918..7b98d1ac92 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNAppliance.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridpstnappliance +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridpstnappliance schema: 2.0.0 title: Set-CsHybridPSTNAppliance --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNSite.md index decfee55af..55e75550db 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNSite.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridpstnsite +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cshybridpstnsite schema: 2.0.0 title: Set-CsHybridPSTNSite --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsIPPhonePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsIPPhonePolicy.md index 69ea1c9542..212b13a085 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsIPPhonePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsIPPhonePolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-csipphonepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csipphonepolicy schema: 2.0.0 title: Set-CsIPPhonePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsImConfiguration.md index 75b5a3c7aa..76da3e69d0 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsImConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimconfiguration schema: 2.0.0 title: Set-CsImConfiguration --- @@ -184,8 +184,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csimconfiguration?view=skype-ps) -[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsImFilterConfiguration.md index 86a853473c..4f75c4ba86 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsImFilterConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csimfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimfilterconfiguration schema: 2.0.0 title: Set-CsImFilterConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsImTranslationConfiguration.md index 0b81f7662a..a9f1d1172f 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsImTranslationConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csimtranslationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csimtranslationconfiguration schema: 2.0.0 title: Set-CsImTranslationConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountAssignment.md index 59b6ee5a24..6947be3199 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountAssignment.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cskerberosaccountassignment +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cskerberosaccountassignment schema: 2.0.0 title: Set-CsKerberosAccountAssignment --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountPassword.md b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountPassword.md index 791859bd44..4cf9bc4c4a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountPassword.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountPassword.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cskerberosaccountpassword +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cskerberosaccountpassword schema: 2.0.0 title: Set-CsKerberosAccountPassword --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsLisLocation.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisLocation.md index 3d328c4599..5161c4289a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsLisLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisLocation.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cslislocation +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslislocation schema: 2.0.0 title: Set-CsLisLocation --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsLisPort.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisPort.md index b795a92770..858796c5bc 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsLisPort.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisPort.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cslisport +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslisport schema: 2.0.0 title: Set-CsLisPort --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsLisServiceProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisServiceProvider.md index 09a526cb80..a7613cdfdc 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsLisServiceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisServiceProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cslisserviceprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslisserviceprovider schema: 2.0.0 title: Set-CsLisServiceProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsLisSubnet.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisSubnet.md index c676037456..6a2e1d6a40 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsLisSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisSubnet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cslissubnet +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslissubnet schema: 2.0.0 title: Set-CsLisSubnet --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsLisSwitch.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisSwitch.md index c80af3b9cf..188cbe3bbb 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsLisSwitch.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisSwitch.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cslisswitch +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslisswitch schema: 2.0.0 title: Set-CsLisSwitch --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsLisWirelessAccessPoint.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisWirelessAccessPoint.md index 65f1889ab7..072bb2c515 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisWirelessAccessPoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csliswirelessaccesspoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csliswirelessaccesspoint schema: 2.0.0 title: Set-CsLisWirelessAccessPoint --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsLocationPolicy.md index 4c8af2b977..dcad945a92 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLocationPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cslocationpolicy schema: 2.0.0 title: Set-CsLocationPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsManagementConnection.md b/skype/skype-ps/SkypeForBusiness/Set-CsManagementConnection.md index 01cc75579f..63c5b79500 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsManagementConnection.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsManagementConnection.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csmanagementconnection +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmanagementconnection schema: 2.0.0 title: Set-CsManagementConnection --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsManagementServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsManagementServer.md index 92a2c18922..848d3976d3 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsManagementServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsManagementServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csmanagementserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmanagementserver schema: 2.0.0 title: Set-CsManagementServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsMcxConfiguration.md index 7044c4642c..9c220565e4 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMcxConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csmcxconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmcxconfiguration schema: 2.0.0 title: Set-CsMcxConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsMediaConfiguration.md index aa6f312534..f6a2deb736 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMediaConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csmediaconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmediaconfiguration schema: 2.0.0 title: Set-CsMediaConfiguration --- @@ -26,7 +26,7 @@ Set-CsMediaConfiguration [[-Identity] ] [-EnableQoS ] [-En [-EncryptionLevel ] [-MaxVideoRateAllowed ] [-Force] [-WhatIf] [-Confirm] [-EnableAdaptiveBandWidthEstimation ] [-EnableG722StereoCodec ] [-EnableH264Codec ] [-EnableInCallQoS ] [-EnableRtpRtcpMultiplexing ] - [-InCallQoSIntervalSeconds ] [-EnableVideoBasedSharing ] [-EnableDtls ] [-EnableSilkForAudioVideoConferences ] -[EnableServerFecForVideoInterop] [-WaitIceCompletedToAddDialOutUser] [-EnableRtx ] [-EnableAVBundling ] [-EnableReceiveAgc ] + [-InCallQoSIntervalSeconds ] [-EnableVideoBasedSharing ] [-EnableDtls ] [-EnableSilkForAudioVideoConferences ] -[EnableServerFecForVideoInterop] [-WaitIceCompletedToAddDialOutUser] [-EnableRtx ] [-EnableAVBundling ] [-EnableReceiveAgc ] [] ``` @@ -36,7 +36,7 @@ Set-CsMediaConfiguration [-Instance ] [-EnableQoS ] [-EnableS [-EncryptionLevel ] [-MaxVideoRateAllowed ] [-Force] [-WhatIf] [-Confirm] [-EnableAdaptiveBandWidthEstimation ] [-EnableG722StereoCodec ] [-EnableH264Codec ] [-EnableInCallQoS ] [-EnableRtpRtcpMultiplexing ] - [-InCallQoSIntervalSeconds ] [-EnableVideoBasedSharing ] [-EnableDtls ] [-EnableSilkForAudioVideoConferences ] -[EnableServerFecForVideoInterop] [-WaitIceCompletedToAddDialOutUser] [-EnableRtx ] [-EnableAVBundling ] [-EnableReceiveAgc ] + [-InCallQoSIntervalSeconds ] [-EnableVideoBasedSharing ] [-EnableDtls ] [-EnableSilkForAudioVideoConferences ] -[EnableServerFecForVideoInterop] [-WaitIceCompletedToAddDialOutUser] [-EnableRtx ] [-EnableAVBundling ] [-EnableReceiveAgc ] [] ``` @@ -80,7 +80,7 @@ This selection will be based on such factors as the network congestion and the c ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -113,7 +113,7 @@ Enables the use of Datagram Transport Layer Security (DTLS) for ICE ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -132,7 +132,7 @@ G.722 is a standard voice codec commonly used with Voice over IP applications; w ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -151,7 +151,7 @@ H.264 is a standard codec commonly used for recording, compressing and distribut ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -169,7 +169,7 @@ Enables or disables the ability of Skype for Business clients to send the raw da ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -187,7 +187,7 @@ QoS monitors the quality of voice signals over a network. When set to True, enab ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -220,7 +220,7 @@ Enables or disables the use of RTP/RTCP Multiplexing, if enabled, when negotiati ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -253,7 +253,7 @@ Enables the use of server Forward Error Correction for video interoperability ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -271,7 +271,7 @@ Enables the use of SILK codec for A/V conferences ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -291,7 +291,7 @@ If this setting is True, Siren will be included as a possible codec for use betw ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -304,12 +304,12 @@ Accept wildcard characters: False > Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) +Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -341,7 +341,7 @@ Default: RequireEncryption ```yaml Type: EncryptionLevel Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -359,7 +359,7 @@ Suppresses any confirmation prompts that would otherwise be displayed before mak ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -378,7 +378,7 @@ This identifier specifies the scope at which this configuration is applied (glob ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: +Aliases: Required: False Position: 2 @@ -396,7 +396,7 @@ Specifies the interval between call QoS actions. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -417,7 +417,7 @@ You can then assign new values to the properties of that object and then save th ```yaml Type: PSObject Parameter Sets: Instance -Aliases: +Aliases: Required: False Position: Named @@ -448,7 +448,7 @@ Default: VGA600K ```yaml Type: MaxVideoRateAllowed Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -466,7 +466,7 @@ Waits until ICE negotiation is complete to dial out other people ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -516,15 +516,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings Accepts pipelined input of media configuration objects. ## OUTPUTS -### -The `Set-CsMediaConfiguration` cmdlet does not return a value or object. -Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. +### None ## NOTES diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsMediationServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsMediationServer.md index 9b0a1170fb..8f4cdd6b2a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsMediationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMediationServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csmediationserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmediationserver schema: 2.0.0 title: Set-CsMediationServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingConfiguration.md index 1bc6789859..ae6e612e1f 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csmeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmeetingconfiguration schema: 2.0.0 title: Set-CsMeetingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingRoom.md index 7026dc4473..66aea66292 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingRoom.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csmeetingroom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmeetingroom schema: 2.0.0 title: Set-CsMeetingRoom --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsMobilityPolicy.md index c045c58f23..6015b87041 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMobilityPolicy.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csmobilitypolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmobilitypolicy schema: 2.0.0 title: Set-CsMobilityPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsMonitoringServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsMonitoringServer.md index 82b0bef55c..92d1d8cf8a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsMonitoringServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMonitoringServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csmonitoringserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csmonitoringserver schema: 2.0.0 title: Set-CsMonitoringServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkBandwidthPolicyProfile.md index 4912b16ae6..c76fdd8d2c 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkBandwidthPolicyProfile.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkbandwidthpolicyprofile +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkbandwidthpolicyprofile schema: 2.0.0 title: Set-CsNetworkBandwidthPolicyProfile --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkConfiguration.md index 1c9dd7d7e4..7bda1845ce 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkconfiguration schema: 2.0.0 title: Set-CsNetworkConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterRegionRoute.md index 2fad45e2ce..d916c582fe 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterRegionRoute.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkinterregionroute +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkinterregionroute schema: 2.0.0 title: Set-CsNetworkInterRegionRoute --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterSitePolicy.md index 596067b943..3b3753bece 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterSitePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkintersitepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkintersitepolicy schema: 2.0.0 title: Set-CsNetworkInterSitePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegion.md index 1011d7f7b7..38dcaea5e8 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkregion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkregion schema: 2.0.0 title: Set-CsNetworkRegion --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegionLink.md index ef8080fab0..7f0af8f3b4 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegionLink.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkregionlink +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworkregionlink schema: 2.0.0 title: Set-CsNetworkRegionLink --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSite.md index bc01b681ea..afe48b1896 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSite.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworksite +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworksite schema: 2.0.0 title: Set-CsNetworkSite --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSubnet.md index ed77bd6d9e..35ca2806b7 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSubnet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworksubnet +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csnetworksubnet schema: 2.0.0 title: Set-CsNetworkSubnet --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsOAuthConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthConfiguration.md index f9bd2674f3..d94278555a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsOAuthConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csoauthconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csoauthconfiguration schema: 2.0.0 title: Set-CsOAuthConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthServer.md index 6542e6b24c..c3e226867c 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csoauthserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csoauthserver schema: 2.0.0 title: Set-CsOAuthServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundCallingNumberTranslationRule.md index fee61c1917..4c41f8a013 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundCallingNumberTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csoutboundcallingnumbertranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csoutboundcallingnumbertranslationrule schema: 2.0.0 title: Set-CsOutboundCallingNumberTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundTranslationRule.md index 0aa1a4932f..7bd545f536 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csoutboundtranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csoutboundtranslationrule schema: 2.0.0 title: Set-CsOutboundTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsPartnerApplication.md index 96d71f9541..1b49602450 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPartnerApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspartnerapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspartnerapplication schema: 2.0.0 title: Set-CsPartnerApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatActiveServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatActiveServer.md index 8bed65fcff..ad3cf2dc3b 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatActiveServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatActiveServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatactiveserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatactiveserver schema: 2.0.0 title: Set-CsPersistentChatActiveServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatAddin.md index 232f3f5bbd..edd2a224a7 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatAddin.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchataddin +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchataddin schema: 2.0.0 title: Set-CsPersistentChatAddin --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatCategory.md index 396f96ca17..0459112625 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatCategory.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatcategory +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatcategory schema: 2.0.0 title: Set-CsPersistentChatCategory --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatComplianceConfiguration.md index 471869b147..3b9b28584a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatComplianceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatcomplianceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatcomplianceconfiguration schema: 2.0.0 title: Set-CsPersistentChatComplianceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatConfiguration.md index d7ecc0638f..a513b93ebc 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatconfiguration schema: 2.0.0 title: Set-CsPersistentChatConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatPolicy.md index 5349c82010..8e490a72b3 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatpolicy schema: 2.0.0 title: Set-CsPersistentChatPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatRoom.md index 44a4a8cd0c..e1f5c5c575 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatRoom.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatroom +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatroom schema: 2.0.0 title: Set-CsPersistentChatRoom --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatState.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatState.md index 2b1b83f62c..0232705158 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatState.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatState.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatstate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspersistentchatstate schema: 2.0.0 title: Set-CsPersistentChatState --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsPinPolicy.md index f129fe715e..945aa20be8 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPinPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspinpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspinpolicy schema: 2.0.0 title: Set-CsPinPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/Set-CsPlatformServiceSettings.md index 96daca9588..dadeaa28b2 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPlatformServiceSettings.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csplatformservicesettings schema: 2.0.0 title: Set-CsPlatformServiceSettings --- @@ -322,8 +322,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/new-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPresenceManagementState.md b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceManagementState.md index b26d5105c1..3dc2452544 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPresenceManagementState.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceManagementState.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspresencemanagementstate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspresencemanagementstate schema: 2.0.0 title: Set-CsPresenceManagementState --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsPresencePolicy.md index d9a8f70ad2..966b5d3ce1 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPresencePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspresencepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspresencepolicy schema: 2.0.0 title: Set-CsPresencePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceProvider.md index 0cdae0e402..9b2a666796 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspresenceprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspresenceprovider schema: 2.0.0 title: Set-CsPresenceProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPrivacyConfiguration.md index 5f0cb258df..9859e3fded 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPrivacyConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csprivacyconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csprivacyconfiguration schema: 2.0.0 title: Set-CsPrivacyConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsProxyConfiguration.md index 22ecb67e6d..edb0aec77e 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsProxyConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csproxyconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csproxyconfiguration schema: 2.0.0 title: Set-CsProxyConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPstnGateway.md b/skype/skype-ps/SkypeForBusiness/Set-CsPstnGateway.md index 70c0c10e99..c8c22b814b 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPstnGateway.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPstnGateway.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspstngateway +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspstngateway schema: 2.0.0 title: Set-CsPstnGateway --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPstnUsage.md b/skype/skype-ps/SkypeForBusiness/Set-CsPstnUsage.md index a090983307..63684359dc 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPstnUsage.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPstnUsage.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspstnusage +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspstnusage schema: 2.0.0 title: Set-CsPstnUsage --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsPublicProvider.md index 9b4b3593c4..6828b262e5 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPublicProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspublicprovider schema: 2.0.0 title: Set-CsPublicProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPushNotificationConfiguration.md index cf5fd1aa2c..3225199143 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPushNotificationConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration schema: 2.0.0 title: Set-CsPushNotificationConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsQoEConfiguration.md index c4659f38bd..bfc0b02681 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsQoEConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csqoeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csqoeconfiguration schema: 2.0.0 title: Set-CsQoEConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsRegistrar.md b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrar.md index 7726613673..729724b507 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsRegistrar.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrar.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csregistrar +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csregistrar schema: 2.0.0 title: Set-CsRegistrar --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrarConfiguration.md index 256c058a9d..5809c4d24c 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrarConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csregistrarconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csregistrarconfiguration schema: 2.0.0 title: Set-CsRegistrarConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsReportingConfiguration.md index fb7e8bfe1c..043e6a10d7 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsReportingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csreportingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csreportingconfiguration schema: 2.0.0 title: Set-CsReportingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsAgentGroup.md index 2b03965e7a..9241281bce 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsAgentGroup.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsagentgroup +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgsagentgroup schema: 2.0.0 title: Set-CsRgsAgentGroup --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsConfiguration.md index 477cc35c02..4cc736b283 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgsconfiguration schema: 2.0.0 title: Set-CsRgsConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHolidaySet.md index 9078ca5e07..5fa79d175e 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHolidaySet.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsholidayset +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgsholidayset schema: 2.0.0 title: Set-CsRgsHolidaySet --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHoursOfBusiness.md index 00df87bfa3..cdbe0a8494 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHoursOfBusiness.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgshoursofbusiness +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgshoursofbusiness schema: 2.0.0 title: Set-CsRgsHoursOfBusiness --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsQueue.md index 02c5089eb0..a097f04204 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsQueue.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsqueue +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgsqueue schema: 2.0.0 title: Set-CsRgsQueue --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsWorkflow.md index 8aed668970..ffd43fd417 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsWorkflow.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsworkflow +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csrgsworkflow schema: 2.0.0 title: Set-CsRgsWorkflow --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsRoutingConfiguration.md index 1798ba5b6a..a98cacf45d 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRoutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csroutingconfiguration schema: 2.0.0 title: Set-CsRoutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsServerApplication.md index 681731d8f0..352309191e 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsServerApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csserverapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csserverapplication schema: 2.0.0 title: Set-CsServerApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsSimpleUrlConfiguration.md index 4a4c27c552..e4a7bdaca1 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSimpleUrlConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cssimpleurlconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cssimpleurlconfiguration schema: 2.0.0 title: Set-CsSimpleUrlConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/Set-CsSipDomain.md index a80d735b4e..b6211559de 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSipDomain.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cssipdomain +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cssipdomain schema: 2.0.0 title: Set-CsSipDomain --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsSipResponseCodeTranslationRule.md index a25b80dfaa..dde043f572 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSipResponseCodeTranslationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cssipresponsecodetranslationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cssipresponsecodetranslationrule schema: 2.0.0 title: Set-CsSipResponseCodeTranslationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsSite.md b/skype/skype-ps/SkypeForBusiness/Set-CsSite.md index 5ffa0119c0..262b73ad0e 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsSite.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSite.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cssite +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cssite schema: 2.0.0 title: Set-CsSite --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsSlaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsSlaConfiguration.md index 8e13552421..37a46f130e 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsSlaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSlaConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csslaconfiguration schema: 2.0.0 title: Set-CsSlaConfiguration --- @@ -243,6 +243,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration?view=skype-ps) +[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/get-csslaconfiguration?view=skype-ps) -[Remove-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration?view=skype-ps) +[Remove-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skypeforbusiness/remove-csslaconfiguration?view=skype-ps) diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsStaticRoutingConfiguration.md index 3f1ef1899a..3c6c6807ff 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsStaticRoutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csstaticroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csstaticroutingconfiguration schema: 2.0.0 title: Set-CsStaticRoutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsStorageServiceConfiguration.md index ed8ed44b4c..8e3b102839 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsStorageServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csstorageserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csstorageserviceconfiguration schema: 2.0.0 title: Set-CsStorageServiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradeConfiguration.md index 2917bdbd00..fb6d0ba39d 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradeConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsupgradeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csteamsupgradeconfiguration schema: 2.0.0 title: Set-CsTeamsUpgradeConfiguration --- @@ -34,7 +34,7 @@ Set-CsTeamsUpgradeConfiguration [-Tenant ] [-DownloadTeams ] [-Sf ## DESCRIPTION TeamsUpgradeConfiguration is used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. It allows administrators to determine which application end users should use to join Skype for Business meetings. -The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: SkypeMeetingsApp and NativeLimitedClient. "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. @@ -53,12 +53,12 @@ The above cmdlet specifies that users subject to upgrade should download Teams i > Applicable: Skype for Business Online -The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This Boolean setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This Boolean setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -75,7 +75,7 @@ Accept wildcard characters: False ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -93,7 +93,7 @@ Accept wildcard characters: False ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -113,7 +113,7 @@ The SfBMeetingJoinUx property allows admins to specify which app is used to join ```yaml Type: string Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -130,7 +130,7 @@ Accept wildcard characters: False ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradePolicy.md index 20436facda..1b9c6b89c9 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsupgradepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csteamsupgradepolicy schema: 2.0.0 title: Set-CsTeamsUpgradePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTelemetryConfiguration.md index d8ff51fddf..d3409f7bcc 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTelemetryConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cstelemetryconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstelemetryconfiguration schema: 2.0.0 title: Set-CsTelemetryConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTenantHybridConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTenantHybridConfiguration.md index b9885c193c..8c45d576dd 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTenantHybridConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTenantHybridConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-cstenanthybridconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstenanthybridconfiguration schema: 2.0.0 title: Set-CsTenantHybridConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/Set-CsTenantUpdateTimeWindow.md index 586c0fd7b8..335aaeb683 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTenantUpdateTimeWindow.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-cstenantupdatetimewindow +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstenantupdatetimewindow schema: 2.0.0 title: Set-CsTenantUpdateTimeWindow --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/Set-CsTestDevice.md index df4f08d6c0..3314e29471 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTestDevice.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cstestdevice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstestdevice schema: 2.0.0 title: Set-CsTestDevice --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTestUserCredential.md b/skype/skype-ps/SkypeForBusiness/Set-CsTestUserCredential.md index eaf54eac3b..9a06d840cb 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTestUserCredential.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTestUserCredential.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cstestusercredential +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstestusercredential schema: 2.0.0 title: Set-CsTestUserCredential --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystem.md index 600103dd5d..a6c1b487b8 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystem.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystem +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csthirdpartyvideosystem schema: 2.0.0 title: Set-CsThirdPartyVideoSystem --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystemPolicy.md index f0e8476699..f040034cb9 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystemPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystempolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csthirdpartyvideosystempolicy schema: 2.0.0 title: Set-CsThirdPartyVideoSystemPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrunkConfiguration.md index 6313994909..4113e4bd73 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrunkConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstrunkconfiguration schema: 2.0.0 title: Set-CsTrunkConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplication.md index 3b79a8117e..6f727d87dd 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstrustedapplication schema: 2.0.0 title: Set-CsTrustedApplication --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationEndpoint.md index ed9e10f0e2..f686ac803e 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationEndpoint.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstrustedapplicationendpoint schema: 2.0.0 title: Set-CsTrustedApplicationEndpoint --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationPool.md index 9d043c2295..197f4ff565 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationPool.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplicationpool +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cstrustedapplicationpool schema: 2.0.0 title: Set-CsTrustedApplicationPool --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsUCPhoneConfiguration.md index 65b2aea786..35d0a6a56c 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUCPhoneConfiguration.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csucphoneconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csucphoneconfiguration schema: 2.0.0 title: Set-CsUCPhoneConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUICulture.md b/skype/skype-ps/SkypeForBusiness/Set-CsUICulture.md index e8725a2449..507f33bc33 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUICulture.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUICulture.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csuiculture +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuiculture schema: 2.0.0 title: Set-CsUICulture --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/Set-CsUnassignedNumber.md index b49ce1b45e..2c974462fe 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUnassignedNumber.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csunassignednumber +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csunassignednumber schema: 2.0.0 title: Set-CsUnassignedNumber --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUser.md b/skype/skype-ps/SkypeForBusiness/Set-CsUser.md index f666ac652a..51c80c06c1 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUser.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csuser +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuser schema: 2.0.0 title: Set-CsUser --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUserAcp.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserAcp.md index a64d95d181..50083b73ce 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUserAcp.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserAcp.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csuseracp +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuseracp schema: 2.0.0 title: Set-CsUserAcp --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUserCallForwardingSettings.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserCallForwardingSettings.md index 2c97601843..8ab316a983 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUserCallForwardingSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserCallForwardingSettings.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csusercallforwardingsettings +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csusercallforwardingsettings schema: 2.0.0 title: Set-CsUserCallForwardingSettings --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUserDatabaseState.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserDatabaseState.md index 3c682cfdbd..c4174e365f 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUserDatabaseState.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserDatabaseState.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserdatabasestate +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserdatabasestate schema: 2.0.0 title: Set-CsUserDatabaseState --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUserDelegates.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserDelegates.md index 9494402d24..514519fd79 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUserDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserDelegates.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserdelegates +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserdelegates schema: 2.0.0 title: Set-CsUserDelegates --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUserPstnSettings.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserPstnSettings.md index c636f59240..b9eea7de33 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUserPstnSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserPstnSettings.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserpstnsettings +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserpstnsettings schema: 2.0.0 title: Set-CsUserPstnSettings --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserReplicatorConfiguration.md index 36be8c72e1..cfb52db99f 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserReplicatorConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserreplicatorconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserreplicatorconfiguration schema: 2.0.0 title: Set-CsUserReplicatorConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUserServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserServer.md index d00ad130f5..58a639c675 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUserServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserserver schema: 2.0.0 title: Set-CsUserServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesConfiguration.md index d051fb0aa9..b6769179cb 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserservicesconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserservicesconfiguration schema: 2.0.0 title: Set-CsUserServicesConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesPolicy.md index 5a38a616ab..1b01ddfd01 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserservicespolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserservicespolicy schema: 2.0.0 title: Set-CsUserServicesPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsUserTeamMembers.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserTeamMembers.md index 054fb54c27..3c6d0d391a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsUserTeamMembers.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserTeamMembers.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserteammembers +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csuserteammembers schema: 2.0.0 title: Set-CsUserTeamMembers --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVideoGateway.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoGateway.md index c7df66cbd4..065a680be2 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVideoGateway.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoGateway.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideogateway +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvideogateway schema: 2.0.0 title: Set-CsVideoGateway --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServer.md index 631a1087b6..e8646fd0fc 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvideointeropserver schema: 2.0.0 title: Set-CsVideoInteropServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerConfiguration.md index d2a50a004e..0a94c4dc3e 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserverconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvideointeropserverconfiguration schema: 2.0.0 title: Set-CsVideoInteropServerConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md index 98a02cd713..216fec460a 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserversynthetictransactionconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvideointeropserversynthetictransactionconfiguration schema: 2.0.0 title: Set-CsVideoInteropServerSyntheticTransactionConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoTrunkConfiguration.md index 2681ad0bc9..e9e011bb8f 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoTrunkConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideotrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvideotrunkconfiguration schema: 2.0.0 title: Set-CsVideoTrunkConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVoiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceConfiguration.md index d8f32ab875..b8ec218e77 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVoiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoiceconfiguration schema: 2.0.0 title: Set-CsVoiceConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceNormalizationRule.md index 28cf784f1d..d9444a68a3 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceNormalizationRule.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicenormalizationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoicenormalizationrule schema: 2.0.0 title: Set-CsVoiceNormalizationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoicePolicy.md index aee2f11644..43742a7ccc 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoicePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoicepolicy schema: 2.0.0 title: Set-CsVoicePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoute.md index ee996fc344..1b5eea9894 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoute.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceroute +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoiceroute schema: 2.0.0 title: Set-CsVoiceRoute --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoutingPolicy.md index 5f5a817587..bc8cf9ed7d 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoutingPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceroutingpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoiceroutingpolicy schema: 2.0.0 title: Set-CsVoiceRoutingPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceTestConfiguration.md index 6ac20e0312..cbb5016611 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceTestConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicetestconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoicetestconfiguration schema: 2.0.0 title: Set-CsVoiceTestConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoicemailReroutingConfiguration.md index c2ca51150a..7808357d6f 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoicemailReroutingConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicemailreroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csvoicemailreroutingconfiguration schema: 2.0.0 title: Set-CsVoicemailReroutingConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsWatcherNodeConfiguration.md index aab18de104..9fa0dbad12 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsWatcherNodeConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cswatchernodeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cswatchernodeconfiguration schema: 2.0.0 title: Set-CsWatcherNodeConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsWebServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsWebServer.md index 2eb1bdfa1c..d47ed77d5d 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsWebServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsWebServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cswebserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cswebserver schema: 2.0.0 title: Set-CsWebServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsWebServiceConfiguration.md index 577c6cdecb..b4b8685645 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsWebServiceConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-cswebserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-cswebserviceconfiguration schema: 2.0.0 title: Set-CsWebServiceConfiguration --- @@ -643,7 +643,7 @@ Accept wildcard characters: False ### -OverrideAuthTypeForExternalClients -The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). +The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csauthconfig). ```yaml Type: String @@ -659,7 +659,7 @@ Accept wildcard characters: False ### -OverrideAuthTypeForInternalClients -The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). +The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csauthconfig). ```yaml Type: String @@ -677,18 +677,18 @@ Accept wildcard characters: False > Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. -Supported applications are Android, iPhone, iPad, Macintosh, Windows. -To support all applications you can give All as input. -For example: -- To support Android and Macintosh - Android;Macintosh; -- To support all devices - All; +Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. +Supported applications are Android, iPhone, iPad, Macintosh, Windows. +To support all applications you can give All as input. +For example: +- To support Android and Macintosh - Android;Macintosh; +- To support all devices - All; The default value is None. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -701,14 +701,14 @@ Accept wildcard characters: False > Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. -The value can be specified in between 5 to 15 minutes (both inclusive). +Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. +The value can be specified in between 5 to 15 minutes (both inclusive). The default value is 15 minutes. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/Set-CsXmppAllowedPartner.md index 7137d8903d..98999c62e1 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsXmppAllowedPartner.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csxmppallowedpartner +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csxmppallowedpartner schema: 2.0.0 title: Set-CsXmppAllowedPartner --- diff --git a/skype/skype-ps/SkypeForBusiness/Set-CsXmppGatewayConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsXmppGatewayConfiguration.md index f7bab25774..300e90a829 100644 --- a/skype/skype-ps/SkypeForBusiness/Set-CsXmppGatewayConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsXmppGatewayConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/set-csxmppgatewayconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/set-csxmppgatewayconfiguration schema: 2.0.0 title: Set-CsXmppGatewayConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Show-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Show-CsClsLogging.md index 6ccc8abf23..6a821bb970 100644 --- a/skype/skype-ps/SkypeForBusiness/Show-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Show-CsClsLogging.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/show-csclslogging +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/show-csclslogging schema: 2.0.0 title: Show-CsClsLogging --- diff --git a/skype/skype-ps/SkypeForBusiness/Start-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Start-CsClsLogging.md index 66bae02fdd..52b4673fa7 100644 --- a/skype/skype-ps/SkypeForBusiness/Start-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Start-CsClsLogging.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/start-csclslogging +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/start-csclslogging schema: 2.0.0 title: Start-CsClsLogging --- diff --git a/skype/skype-ps/SkypeForBusiness/Start-CsPool.md b/skype/skype-ps/SkypeForBusiness/Start-CsPool.md index e68f0462b9..a8eb6efdcd 100644 --- a/skype/skype-ps/SkypeForBusiness/Start-CsPool.md +++ b/skype/skype-ps/SkypeForBusiness/Start-CsPool.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/start-cspool +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/start-cspool schema: 2.0.0 title: Start-CsPool --- diff --git a/skype/skype-ps/SkypeForBusiness/Start-CsWindowsService.md b/skype/skype-ps/SkypeForBusiness/Start-CsWindowsService.md index e2ef66809d..f211e60d1e 100644 --- a/skype/skype-ps/SkypeForBusiness/Start-CsWindowsService.md +++ b/skype/skype-ps/SkypeForBusiness/Start-CsWindowsService.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/start-cswindowsservice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/start-cswindowsservice schema: 2.0.0 title: Start-CsWindowsService --- diff --git a/skype/skype-ps/SkypeForBusiness/Stop-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Stop-CsClsLogging.md index ef03636766..4e6d5c9e36 100644 --- a/skype/skype-ps/SkypeForBusiness/Stop-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Stop-CsClsLogging.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/stop-csclslogging +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/stop-csclslogging schema: 2.0.0 title: Stop-CsClsLogging --- diff --git a/skype/skype-ps/SkypeForBusiness/Stop-CsWindowsService.md b/skype/skype-ps/SkypeForBusiness/Stop-CsWindowsService.md index f56c048cf6..39b0ed4729 100644 --- a/skype/skype-ps/SkypeForBusiness/Stop-CsWindowsService.md +++ b/skype/skype-ps/SkypeForBusiness/Stop-CsWindowsService.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/stop-cswindowsservice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/stop-cswindowsservice schema: 2.0.0 title: Stop-CsWindowsService --- diff --git a/skype/skype-ps/SkypeForBusiness/Sync-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Sync-CsClsLogging.md index 1bf7f0c450..2b7db886ac 100644 --- a/skype/skype-ps/SkypeForBusiness/Sync-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Sync-CsClsLogging.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/sync-csclslogging +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/sync-csclslogging schema: 2.0.0 title: Sync-CsClsLogging --- diff --git a/skype/skype-ps/SkypeForBusiness/Sync-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Sync-CsUserData.md index b1da8e1da6..4bd8646a03 100644 --- a/skype/skype-ps/SkypeForBusiness/Sync-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Sync-CsUserData.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/sync-csuserdata +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/sync-csuserdata schema: 2.0.0 title: Sync-CsUserData --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsASConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsASConference.md index 4290163b24..ae31c0ed34 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsASConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsASConference.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csasconference +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csasconference schema: 2.0.0 title: Test-CsASConference --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsAVConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsAVConference.md index c151a48269..bf2ab0addf 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsAVConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAVConference.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csavconference +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csavconference schema: 2.0.0 title: Test-CsAVConference --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsAVEdgeConnectivity.md b/skype/skype-ps/SkypeForBusiness/Test-CsAVEdgeConnectivity.md index adfddd3adc..8a6716e1fb 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsAVEdgeConnectivity.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAVEdgeConnectivity.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csavedgeconnectivity +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csavedgeconnectivity schema: 2.0.0 title: Test-CsAVEdgeConnectivity --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookService.md b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookService.md index 23b9e7d11f..2d65633ec2 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookService.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookService.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csaddressbookservice +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csaddressbookservice schema: 2.0.0 title: Test-CsAddressBookService --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookWebQuery.md b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookWebQuery.md index d862260973..fffd3eb2c5 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookWebQuery.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookWebQuery.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csaddressbookwebquery +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csaddressbookwebquery schema: 2.0.0 title: Test-CsAddressBookWebQuery --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsAudioConferencingProvider.md b/skype/skype-ps/SkypeForBusiness/Test-CsAudioConferencingProvider.md index dea13f04d1..85521a40af 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsAudioConferencingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAudioConferencingProvider.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csaudioconferencingprovider +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csaudioconferencingprovider schema: 2.0.0 title: Test-CsAudioConferencingProvider --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsCertificateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsCertificateConfiguration.md index afae693bf9..66e0dec4da 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsCertificateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsCertificateConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cscertificateconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cscertificateconfiguration schema: 2.0.0 title: Test-CsCertificateConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsClientAuth.md b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuth.md index 194e5ceeb2..72f3758e34 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsClientAuth.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuth.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csclientauth +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csclientauth schema: 2.0.0 title: Test-CsClientAuth --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsClientAuthentication.md b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuthentication.md index d7c479b01e..a433d6758f 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsClientAuthentication.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuthentication.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csclientauthentication +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csclientauthentication schema: 2.0.0 title: Test-CsClientAuthentication --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Test-CsComputer.md index 6cfab2ecd5..a0f22f4e93 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsComputer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cscomputer +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cscomputer schema: 2.0.0 title: Test-CsComputer --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsDataConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsDataConference.md index 512696fac9..a7ee094129 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsDataConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDataConference.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csdataconference +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csdataconference schema: 2.0.0 title: Test-CsDataConference --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsDatabase.md b/skype/skype-ps/SkypeForBusiness/Test-CsDatabase.md index faf0730722..d694744ff8 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDatabase.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csdatabase +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csdatabase schema: 2.0.0 title: Test-CsDatabase --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsDialInConferencing.md b/skype/skype-ps/SkypeForBusiness/Test-CsDialInConferencing.md index 3708cc6658..bf6ba98004 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsDialInConferencing.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDialInConferencing.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csdialinconferencing +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csdialinconferencing schema: 2.0.0 title: Test-CsDialInConferencing --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Test-CsDialPlan.md index d23e32e331..e13527ff05 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDialPlan.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csdialplan +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csdialplan schema: 2.0.0 title: Test-CsDialPlan --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsExStorageConnectivity.md b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageConnectivity.md index 546100451b..ad25d505e4 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsExStorageConnectivity.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageConnectivity.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csexstorageconnectivity +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csexstorageconnectivity schema: 2.0.0 title: Test-CsExStorageConnectivity --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsExStorageNotification.md b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageNotification.md index 8bbf4ed4ec..0c4cccbf19 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsExStorageNotification.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageNotification.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csexstoragenotification +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csexstoragenotification schema: 2.0.0 title: Test-CsExStorageNotification --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsExUMConnectivity.md b/skype/skype-ps/SkypeForBusiness/Test-CsExUMConnectivity.md index 221cdc0bc3..08ea21e3a9 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsExUMConnectivity.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExUMConnectivity.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csexumconnectivity +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csexumconnectivity schema: 2.0.0 title: Test-CsExUMConnectivity --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsExUMVoiceMail.md b/skype/skype-ps/SkypeForBusiness/Test-CsExUMVoiceMail.md index d5f532a679..f607fa1ba6 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsExUMVoiceMail.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExUMVoiceMail.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csexumvoicemail +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csexumvoicemail schema: 2.0.0 title: Test-CsExUMVoiceMail --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsFederatedPartner.md b/skype/skype-ps/SkypeForBusiness/Test-CsFederatedPartner.md index 0892028988..7abe4f4400 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsFederatedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsFederatedPartner.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csfederatedpartner +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csfederatedpartner schema: 2.0.0 title: Test-CsFederatedPartner --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsGroupExpansion.md b/skype/skype-ps/SkypeForBusiness/Test-CsGroupExpansion.md index 98a3e13b19..06da932c2d 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsGroupExpansion.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsGroupExpansion.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csgroupexpansion +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csgroupexpansion schema: 2.0.0 title: Test-CsGroupExpansion --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsGroupIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsGroupIM.md index 8e991e621e..e9846c03be 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsGroupIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsGroupIM.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csgroupim +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csgroupim schema: 2.0.0 title: Test-CsGroupIM --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsIM.md index 6df538d3cf..fc50708416 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsIM.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csim +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csim schema: 2.0.0 title: Test-CsIM --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsInterTrunkRouting.md b/skype/skype-ps/SkypeForBusiness/Test-CsInterTrunkRouting.md index 052513b19f..c74d371c8a 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsInterTrunkRouting.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsInterTrunkRouting.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csintertrunkrouting +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csintertrunkrouting schema: 2.0.0 title: Test-CsInterTrunkRouting --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Test-CsKerberosAccountAssignment.md index e5abb73365..ebb7377ef1 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsKerberosAccountAssignment.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cskerberosaccountassignment +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cskerberosaccountassignment schema: 2.0.0 title: Test-CsKerberosAccountAssignment --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsLisCivicAddress.md b/skype/skype-ps/SkypeForBusiness/Test-CsLisCivicAddress.md index 3a41985306..5be5e523ec 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsLisCivicAddress.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsLisCivicAddress.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csliscivicaddress +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csliscivicaddress schema: 2.0.0 title: Test-CsLisCivicAddress --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsLisConfiguration.md index fb39a2563e..b250635d13 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsLisConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cslisconfiguration schema: 2.0.0 title: Test-CsLisConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Test-CsLocationPolicy.md index 25da4f3b0a..ff082b56f6 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsLocationPolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cslocationpolicy schema: 2.0.0 title: Test-CsLocationPolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsManagementServer.md b/skype/skype-ps/SkypeForBusiness/Test-CsManagementServer.md index 9fab82dd28..96f5490331 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsManagementServer.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsManagementServer.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csmanagementserver +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csmanagementserver schema: 2.0.0 title: Test-CsManagementServer --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsMcxConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsMcxConference.md index 2bc90d8807..3036a2481c 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsMcxConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsMcxConference.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxconference +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csmcxconference schema: 2.0.0 title: Test-CsMcxConference --- @@ -90,7 +90,7 @@ Suppresses the display of any non-fatal error message that might occur when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -338,14 +338,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsMcxConference` cmdlet does not accept pipelined input. ## OUTPUTS -### -The `Test-CsMcxConference` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. +### Microsoft.Rtc.SyntheticTransactions.TaskOutput ## NOTES diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsMcxP2PIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsMcxP2PIM.md index 0c81dbce50..094da9b933 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsMcxP2PIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsMcxP2PIM.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxp2pim +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csmcxp2pim schema: 2.0.0 title: Test-CsMcxP2PIM --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsMcxPushNotification.md b/skype/skype-ps/SkypeForBusiness/Test-CsMcxPushNotification.md index 0268b9c325..7c9d5603b4 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsMcxPushNotification.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsMcxPushNotification.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxpushnotification +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csmcxpushnotification schema: 2.0.0 title: Test-CsMcxPushNotification --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsOUPermission.md b/skype/skype-ps/SkypeForBusiness/Test-CsOUPermission.md index 20ebd35390..c07a949a5d 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsOUPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsOUPermission.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csoupermission +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csoupermission schema: 2.0.0 title: Test-CsOUPermission --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsP2PAV.md b/skype/skype-ps/SkypeForBusiness/Test-CsP2PAV.md index 4ff45484c2..b49e14f2bb 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsP2PAV.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsP2PAV.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csp2pav +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csp2pav schema: 2.0.0 title: Test-CsP2PAV --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsP2PVideoInteropServerSipTrunkAV.md b/skype/skype-ps/SkypeForBusiness/Test-CsP2PVideoInteropServerSipTrunkAV.md index 0eb0f5eeda..fd3c39ade1 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsP2PVideoInteropServerSipTrunkAV.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsP2PVideoInteropServerSipTrunkAV.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csp2pvideointeropserversiptrunkav +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csp2pvideointeropserversiptrunkav schema: 2.0.0 title: Test-CsP2PVideoInteropServerSipTrunkAV --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsPersistentChatMessage.md b/skype/skype-ps/SkypeForBusiness/Test-CsPersistentChatMessage.md index 46228b65b9..7870d59840 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsPersistentChatMessage.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPersistentChatMessage.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cspersistentchatmessage +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cspersistentchatmessage schema: 2.0.0 title: Test-CsPersistentChatMessage --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsPhoneBootstrap.md b/skype/skype-ps/SkypeForBusiness/Test-CsPhoneBootstrap.md index a58bae6135..ca12ac8292 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsPhoneBootstrap.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPhoneBootstrap.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csphonebootstrap +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csphonebootstrap schema: 2.0.0 title: Test-CsPhoneBootstrap --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsPresence.md b/skype/skype-ps/SkypeForBusiness/Test-CsPresence.md index e43be2c53c..8abc25f11a 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsPresence.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPresence.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cspresence +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cspresence schema: 2.0.0 title: Test-CsPresence --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsPstnOutboundCall.md b/skype/skype-ps/SkypeForBusiness/Test-CsPstnOutboundCall.md index 94bff31c5a..3a4d6c0851 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsPstnOutboundCall.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPstnOutboundCall.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cspstnoutboundcall +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cspstnoutboundcall schema: 2.0.0 title: Test-CsPstnOutboundCall --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsPstnPeerToPeerCall.md b/skype/skype-ps/SkypeForBusiness/Test-CsPstnPeerToPeerCall.md index b7496968f1..2ccfd540e4 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsPstnPeerToPeerCall.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPstnPeerToPeerCall.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cspstnpeertopeercall +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cspstnpeertopeercall schema: 2.0.0 title: Test-CsPstnPeerToPeerCall --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsRegistration.md b/skype/skype-ps/SkypeForBusiness/Test-CsRegistration.md index 57bc356070..75318592bc 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsRegistration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsRegistration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csregistration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csregistration schema: 2.0.0 title: Test-CsRegistration --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsReplica.md b/skype/skype-ps/SkypeForBusiness/Test-CsReplica.md index ebfa11a00d..d941d04ebb 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsReplica.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsReplica.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csreplica +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csreplica schema: 2.0.0 title: Test-CsReplica --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsSetupPermission.md b/skype/skype-ps/SkypeForBusiness/Test-CsSetupPermission.md index 52243d5279..d90cd98d02 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsSetupPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsSetupPermission.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cssetuppermission +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cssetuppermission schema: 2.0.0 title: Test-CsSetupPermission --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Test-CsTopology.md index c62154b59d..482966bd76 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsTopology.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cstopology +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cstopology schema: 2.0.0 title: Test-CsTopology --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsTrunkConfiguration.md index e8aeb6150e..357a9802a3 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsTrunkConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cstrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cstrunkconfiguration schema: 2.0.0 title: Test-CsTrunkConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsUcwaConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsUcwaConference.md index cd0a4dc098..047357211d 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsUcwaConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsUcwaConference.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csucwaconference +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csucwaconference schema: 2.0.0 title: Test-CsUcwaConference --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsUnifiedContactStore.md b/skype/skype-ps/SkypeForBusiness/Test-CsUnifiedContactStore.md index 3a04ee977c..e40d4669e4 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsUnifiedContactStore.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsUnifiedContactStore.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csunifiedcontactstore +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csunifiedcontactstore schema: 2.0.0 title: Test-CsUnifiedContactStore --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceNormalizationRule.md index ab0ea5b261..cc06a35392 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceNormalizationRule.md @@ -6,7 +6,7 @@ Locale: en-US manager: bulenteg Module Name: SkypeForBusiness ms.author: serdars -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicenormalizationrule +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csvoicenormalizationrule schema: 2.0.0 title: Test-CsVoiceNormalizationRule --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoicePolicy.md index 0c5ee4abc5..5c542a3d7d 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoicePolicy.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csvoicepolicy schema: 2.0.0 title: Test-CsVoicePolicy --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceRoute.md index eb50169153..b73dcadd34 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceRoute.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoiceroute +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csvoiceroute schema: 2.0.0 title: Test-CsVoiceRoute --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceTestConfiguration.md index 7343c7c1fe..3e1ef0a3f0 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceTestConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicetestconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csvoicetestconfiguration schema: 2.0.0 title: Test-CsVoiceTestConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsVoiceUser.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceUser.md index 0b72fce029..0cd1760067 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsVoiceUser.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceUser.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoiceuser +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csvoiceuser schema: 2.0.0 title: Test-CsVoiceUser --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsWatcherNodeConfiguration.md index fc56293ce1..c7d17ead77 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWatcherNodeConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cswatchernodeconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cswatchernodeconfiguration schema: 2.0.0 title: Test-CsWatcherNodeConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsWebApp.md b/skype/skype-ps/SkypeForBusiness/Test-CsWebApp.md index 3205c94c42..03ab6a66fa 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsWebApp.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWebApp.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cswebapp +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cswebapp schema: 2.0.0 title: Test-CsWebApp --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsWebAppAnonymous.md b/skype/skype-ps/SkypeForBusiness/Test-CsWebAppAnonymous.md index 1130a5a1ec..d1bd8271f0 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsWebAppAnonymous.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWebAppAnonymous.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cswebappanonymous +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cswebappanonymous schema: 2.0.0 title: Test-CsWebAppAnonymous --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsWebScheduler.md b/skype/skype-ps/SkypeForBusiness/Test-CsWebScheduler.md index 5ddba063b4..08d0274390 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsWebScheduler.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWebScheduler.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-cswebscheduler +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-cswebscheduler schema: 2.0.0 title: Test-CsWebScheduler --- diff --git a/skype/skype-ps/SkypeForBusiness/Test-CsXmppIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsXmppIM.md index 218298d071..0b364a590b 100644 --- a/skype/skype-ps/SkypeForBusiness/Test-CsXmppIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsXmppIM.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/test-csxmppim +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/test-csxmppim schema: 2.0.0 title: Test-CsXmppIM --- diff --git a/skype/skype-ps/SkypeForBusiness/Uninstall-CsDatabase.md b/skype/skype-ps/SkypeForBusiness/Uninstall-CsDatabase.md index 39ec12dc7d..1f52d8c098 100644 --- a/skype/skype-ps/SkypeForBusiness/Uninstall-CsDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Uninstall-CsDatabase.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/uninstall-csdatabase +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/uninstall-csdatabase schema: 2.0.0 title: Uninstall-CsDatabase --- diff --git a/skype/skype-ps/SkypeForBusiness/Uninstall-CsMirrorDatabase.md b/skype/skype-ps/SkypeForBusiness/Uninstall-CsMirrorDatabase.md index ab3d745906..0059fb2a29 100644 --- a/skype/skype-ps/SkypeForBusiness/Uninstall-CsMirrorDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Uninstall-CsMirrorDatabase.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/uninstall-csmirrordatabase +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/uninstall-csmirrordatabase schema: 2.0.0 title: Uninstall-CsMirrorDatabase --- diff --git a/skype/skype-ps/SkypeForBusiness/Unlock-CsClientPin.md b/skype/skype-ps/SkypeForBusiness/Unlock-CsClientPin.md index 9a30af5d22..b0847356b3 100644 --- a/skype/skype-ps/SkypeForBusiness/Unlock-CsClientPin.md +++ b/skype/skype-ps/SkypeForBusiness/Unlock-CsClientPin.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/unlock-csclientpin +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/unlock-csclientpin schema: 2.0.0 title: Unlock-CsClientPin --- diff --git a/skype/skype-ps/SkypeForBusiness/Unpublish-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Unpublish-CsLisConfiguration.md index e0308a78cd..9e4680c181 100644 --- a/skype/skype-ps/SkypeForBusiness/Unpublish-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Unpublish-CsLisConfiguration.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/unpublish-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/unpublish-cslisconfiguration schema: 2.0.0 title: Unpublish-CsLisConfiguration --- diff --git a/skype/skype-ps/SkypeForBusiness/Unregister-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Unregister-CsHybridPSTNAppliance.md index ffe905ba42..8d94a41739 100644 --- a/skype/skype-ps/SkypeForBusiness/Unregister-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Unregister-CsHybridPSTNAppliance.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/unregister-cshybridpstnappliance schema: 2.0.0 title: Unregister-CsHybridPSTNAppliance --- diff --git a/skype/skype-ps/SkypeForBusiness/Update-CsAddressBook.md b/skype/skype-ps/SkypeForBusiness/Update-CsAddressBook.md index e4b06a6a81..19cea44381 100644 --- a/skype/skype-ps/SkypeForBusiness/Update-CsAddressBook.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsAddressBook.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/update-csaddressbook +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-csaddressbook schema: 2.0.0 title: Update-CsAddressBook --- diff --git a/skype/skype-ps/SkypeForBusiness/Update-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Update-CsAdminRole.md index ed4d9fe5ce..32dc824859 100644 --- a/skype/skype-ps/SkypeForBusiness/Update-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsAdminRole.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/update-csadminrole +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-csadminrole schema: 2.0.0 title: Update-CsAdminRole --- diff --git a/skype/skype-ps/SkypeForBusiness/Update-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Update-CsClsLogging.md index f86b1b65f3..fb89e5bc2c 100644 --- a/skype/skype-ps/SkypeForBusiness/Update-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsClsLogging.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/update-csclslogging +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-csclslogging schema: 2.0.0 title: Update-CsClsLogging --- diff --git a/skype/skype-ps/SkypeForBusiness/Update-CsTenantMeetingUrl.md b/skype/skype-ps/SkypeForBusiness/Update-CsTenantMeetingUrl.md index 929af575e4..7fd0cf7615 100644 --- a/skype/skype-ps/SkypeForBusiness/Update-CsTenantMeetingUrl.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsTenantMeetingUrl.md @@ -7,7 +7,7 @@ manager: bulenteg Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney -online version: https://learn.microsoft.com/powershell/module/skype/update-cstenantmeetingurl +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-cstenantmeetingurl schema: 2.0.0 title: Update-CsTenantMeetingUrl --- diff --git a/skype/skype-ps/SkypeForBusiness/Update-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Update-CsUserData.md index b258d35f8b..5bed3d1baa 100644 --- a/skype/skype-ps/SkypeForBusiness/Update-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsUserData.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/update-csuserdata +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-csuserdata schema: 2.0.0 title: Update-CsUserData --- diff --git a/skype/skype-ps/SkypeForBusiness/Update-CsUserDatabase.md b/skype/skype-ps/SkypeForBusiness/Update-CsUserDatabase.md index 696f72c97e..8f823e0a8a 100644 --- a/skype/skype-ps/SkypeForBusiness/Update-CsUserDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsUserDatabase.md @@ -6,7 +6,7 @@ Locale: en-US manager: rogupta Module Name: SkypeForBusiness ms.author: hirshah -online version: https://learn.microsoft.com/powershell/module/skype/update-csuserdatabase +online version: https://learn.microsoft.com/powershell/module/skypeforbusiness/update-csuserdatabase schema: 2.0.0 title: Update-CsUserDatabase --- diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Add-SPMTTask.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Add-SPMTTask.md index 36e0d71ce7..d84248126f 100644 --- a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Add-SPMTTask.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Add-SPMTTask.md @@ -1,7 +1,7 @@ --- external help file: microsoft.sharepoint.migrationtool.powershell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/add-spmttask +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/add-spmttask applicable: SharePoint Migration Tool title: Add-SPMTTask schema: 2.0.0 diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Get-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Get-SPMTMigration.md index d14bee37b5..8fb2389351 100644 --- a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Get-SPMTMigration.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Get-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/get-spmtmigration +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/get-spmtmigration applicable: SharePoint Migration Tool title: Get-SPMTMigration schema: 2.0.0 diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Register-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Register-SPMTMigration.md index a1c1e2dba7..5cfbe4e478 100644 --- a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Register-SPMTMigration.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Register-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/register-spmtmigration +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/register-spmtmigration applicable: SharePoint Migration Tool title: Register-SPMTMigration schema: 2.0.0 diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Remove-SPMTTask.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Remove-SPMTTask.md index 5a222768d4..62da4980b3 100644 --- a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Remove-SPMTTask.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Remove-SPMTTask.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/remove-spmttask +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/remove-spmttask applicable: SharePoint Migration Tool title: Remove-SPMTTask schema: 2.0.0 diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Show-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Show-SPMTMigration.md index 33b2b3956b..b649121945 100644 --- a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Show-SPMTMigration.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Show-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/show-spmtmigration +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/show-spmtmigration applicable: SharePoint Migration Tool title: Show-SPMTMigration schema: 2.0.0 diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Start-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Start-SPMTMigration.md index 93fd3d7e6c..5bb427b352 100644 --- a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Start-SPMTMigration.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Start-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/start-spmtmigration +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/start-spmtmigration applicable: SharePoint Migration Tool title: Start-SPMTMigration schema: 2.0.0 diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Stop-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Stop-SPMTMigration.md index e4ab322005..ab0835c9a1 100644 --- a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Stop-SPMTMigration.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Stop-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/stop-spmtmigration +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/stop-spmtmigration applicable: SharePoint Migration Tool title: Stop-SPMTMigration schema: 2.0.0 diff --git a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Unregister-SPMTMigration.md b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Unregister-SPMTMigration.md index ec4f692fd6..3a60f64af7 100644 --- a/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Unregister-SPMTMigration.md +++ b/spmt/spmt-ps/Microsoft.SharePoint.MigrationTool.PowerShell/Unregister-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://learn.microsoft.com/powershell/module/spmt/unregister-spmtmigration +online version: https://learn.microsoft.com/powershell/module/microsoft.sharepoint.migrationtool.powershell/unregister-spmtmigration applicable: SharePoint Migration Tool title: Unregister-SPMTMigration schema: 2.0.0 diff --git a/teams/docfx.json b/teams/docfx.json index 401d0beb8b..1b863ef7f6 100644 --- a/teams/docfx.json +++ b/teams/docfx.json @@ -21,18 +21,26 @@ "dest": "teams/teams-ps" }, { - "files": ["**/*.yml"], - "exclude": ["toc.yml"], - "src": "teams-ps", - "version": "teams-ps", - "dest": "module" - }, - { - "files": ["toc.yml"], - "src": "teams-ps", - "version": "teams-ps", - "dest": "module/teams-ps" - } + "files": ["**/*.yml"], + "exclude": ["toc.yml"], + "src": "teams-ps", + "version": "teams-ps", + "dest": "module" + }, + { + "files": ["toc.yml"], + "src": "teams-ps", + "version": "teams-ps", + "dest": "module/teams-ps" + }, + { + "files": [ + "**/*.md" + ], + "src": "virtual-folder", + "version": "teams-ps", + "dest": "module" + } ], "resource": [ { diff --git a/teams/teams-ps/teams/Add-TeamChannelUser.md b/teams/teams-ps/MicrosoftTeams/Add-TeamChannelUser.md similarity index 95% rename from teams/teams-ps/teams/Add-TeamChannelUser.md rename to teams/teams-ps/MicrosoftTeams/Add-TeamChannelUser.md index dcc55539d1..1dd701b38c 100644 --- a/teams/teams-ps/teams/Add-TeamChannelUser.md +++ b/teams/teams-ps/MicrosoftTeams/Add-TeamChannelUser.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/add-teamchanneluser -title: Add-TeamChannelUser +online version: https://learn.microsoft.com/powershell/module/microsoftteams/add-teamchanneluser schema: 2.0.0 +title: Add-TeamChannelUser --- # Add-TeamChannelUser @@ -11,10 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds an owner or member to the private channel. -The command will return immediately, but the Teams application will not reflect the update immediately. To see the update you should refresh the members page. - -Note: Technical limitations of private channels apply. To add a user as a member to a channel, they need to first be a member of the team. To make a user an owner of a channel, they need to first be a member of the channel. - ## SYNTAX ``` @@ -23,6 +20,10 @@ Add-TeamChannelUser -GroupId -DisplayName -User [-Rol ## DESCRIPTION +The command will return immediately, but the Teams application will not reflect the update immediately. To see the update you should refresh the members page. + +Note: Technical limitations of private channels apply. To add a user as a member to a channel, they need to first be a member of the team. To make a user an owner of a channel, they need to first be a member of the channel. + Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). ## EXAMPLES @@ -50,8 +51,8 @@ Adds external user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 to a shared channel. ## PARAMETERS -### -GroupId -GroupId of the parent team +### -DisplayName +Display name of the private channel ```yaml Type: String @@ -65,8 +66,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Display name of the private channel +### -GroupId +GroupId of the parent team ```yaml Type: String @@ -80,24 +81,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -User -User's UPN (user principal name - e.g. -johndoe@example.com) +### -Role +Owner ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Role -Owner +### -TenantId +TenantId of the external user ```yaml Type: String @@ -111,15 +111,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -TenantId -TenantId of the external user +### -User +User's UPN (user principal name - e.g. +johndoe@example.com) ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) @@ -131,7 +132,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, DisplayName, User, Role, TenantId +### GroupId + +### DisplayName + +### User + +### Role + +### TenantId ## OUTPUTS diff --git a/teams/teams-ps/teams/Add-TeamUser.md b/teams/teams-ps/MicrosoftTeams/Add-TeamUser.md similarity index 94% rename from teams/teams-ps/teams/Add-TeamUser.md rename to teams/teams-ps/MicrosoftTeams/Add-TeamUser.md index 91f29ce8bb..e9430a7357 100644 --- a/teams/teams-ps/teams/Add-TeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Add-TeamUser.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/add-teamuser -title: Add-TeamUser -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/add-teamuser +schema: 2.0.0 +title: Add-TeamUser --- # Add-TeamUser @@ -51,32 +51,32 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -User -UPN of a user of the organization (user principal name - e.g. johndoe@example.com). +### -Role +Member or Owner. If Owner is specified then the user is also added as a member to the Team backed by unified group. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: Member Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Role -Member or Owner. If Owner is specified then the user is also added as a member to the Team backed by unified group. +### -User +UPN of a user of the organization (user principal name - e.g. johndoe@example.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: Member +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -86,7 +86,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, User, Role +### GroupId + +### User + +### Role ## OUTPUTS diff --git a/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/Clear-CsOnlineTelephoneNumberOrder.md similarity index 84% rename from teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/Clear-CsOnlineTelephoneNumberOrder.md index 36eee8cbf2..5fda790b62 100644 --- a/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/Clear-CsOnlineTelephoneNumberOrder.md @@ -1,13 +1,14 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: Clear-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder +schema: 2.0.0 +title: Clear-CsOnlineTelephoneNumberOrder --- # Clear-CsOnlineTelephoneNumberOrder @@ -28,7 +29,7 @@ Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telepho ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Clear-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 @@ -89,14 +90,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype) -[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) -[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder) -[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder) -[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md b/teams/teams-ps/MicrosoftTeams/Clear-TeamsEnvironmentConfig.md similarity index 92% rename from teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md rename to teams/teams-ps/MicrosoftTeams/Clear-TeamsEnvironmentConfig.md index 62e51c733c..3ee68e95f8 100644 --- a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/MicrosoftTeams/Clear-TeamsEnvironmentConfig.md @@ -1,13 +1,14 @@ --- +author: VikneshMSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Locale: en-US +manager: vinelap Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/clear-teamsenvironmentconfig -title: Clear-TeamsEnvironmentConfig -schema: 2.0.0 -author: VikneshMSFT ms.author: vimohan ms.reviewer: pbafna -manager: vinelap +online version: https://learn.microsoft.com/powershell/module/microsoftteams/clear-teamsenvironmentconfig +schema: 2.0.0 +title: Clear-TeamsEnvironmentConfig --- # Clear-TeamsEnvironmentConfig diff --git a/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/Complete-CsOnlineTelephoneNumberOrder.md similarity index 85% rename from teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/Complete-CsOnlineTelephoneNumberOrder.md index 8e367470c6..7ebed106c2 100644 --- a/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/Complete-CsOnlineTelephoneNumberOrder.md @@ -1,13 +1,14 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: Complete-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder +schema: 2.0.0 +title: Complete-CsOnlineTelephoneNumberOrder --- # Complete-CsOnlineTelephoneNumberOrder @@ -28,7 +29,7 @@ Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific te ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Complete-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 | fl @@ -89,14 +90,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype) -[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) -[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder) -[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder) -[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Connect-MicrosoftTeams.md b/teams/teams-ps/MicrosoftTeams/Connect-MicrosoftTeams.md similarity index 98% rename from teams/teams-ps/teams/Connect-MicrosoftTeams.md rename to teams/teams-ps/MicrosoftTeams/Connect-MicrosoftTeams.md index c713e2275a..fa2f921c8c 100644 --- a/teams/teams-ps/teams/Connect-MicrosoftTeams.md +++ b/teams/teams-ps/MicrosoftTeams/Connect-MicrosoftTeams.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams -title: Connect-MicrosoftTeams -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/connect-microsoftteams +schema: 2.0.0 +title: Connect-MicrosoftTeams --- # Connect-MicrosoftTeams @@ -338,6 +338,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Login using managed service identity in the current environment. For *-Cs cmdlets, this is supported from version 5.8.1-preview onwards. + +> [!Note] +> This is currently only supported in commercial environments. A few [cmdlets](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication#cmdlets-supported) that don't support application-based authentication are not supported either. + +```yaml +Type: SwitchParameter +Parameter Sets: ManagedServiceLogin +Aliases: MSI, ManagedService +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LogFilePath The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. @@ -375,14 +392,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsAccessToken (Removed from version 2.3.2-preview) -Specifies a Microsoft Graph access token. -> [!WARNING] ->This parameter has been removed from version 2.3.2-preview. +### -ManagedServiceHostName +Host name for managed service login. ```yaml Type: String -Parameter Sets: AccessToken +Parameter Sets: ManagedServiceLogin Aliases: Required: False Position: Named @@ -391,17 +406,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantId -Specifies the ID of a tenant. - -If you do not specify this parameter, the account is authenticated with the home tenant. - -You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. +### -ManagedServicePort +Port number for managed service login. ```yaml -Type: String -Parameter Sets: UserCredential, AccessToken -Aliases: Domain, TenantDomain +Type: Int32 +Parameter Sets: ManagedServiceLogin +Aliases: Required: False Position: Named Default value: None @@ -409,28 +420,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ManagedServiceSecret +Secret, used for some kinds of managed service login. + ```yaml -Type: String -Parameter Sets: ServicePrincipalCertificate -Aliases: Domain, TenantDomain -Required: True +Type: SecureString +Parameter Sets: ManagedServiceLogin +Aliases: +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -MsAccessToken (Removed from version 2.3.2-preview) +Specifies a Microsoft Graph access token. +> [!WARNING] +>This parameter has been removed from version 2.3.2-preview. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: String +Parameter Sets: AccessToken +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -454,30 +469,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Login using managed service identity in the current environment. For *-Cs cmdlets, this is supported from version 5.8.1-preview onwards. - -> [!Note] -> This is currently only supported in commercial environments. A few [cmdlets](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication#cmdlets-supported) that don't support application-based authentication are not supported either. +### -TenantId +Specifies the ID of a tenant. -```yaml -Type: SwitchParameter -Parameter Sets: ManagedServiceLogin -Aliases: MSI, ManagedService -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +If you do not specify this parameter, the account is authenticated with the home tenant. -### -ManagedServiceHostName -Host name for managed service login. +You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. ```yaml Type: String -Parameter Sets: ManagedServiceLogin -Aliases: +Parameter Sets: UserCredential, AccessToken, ServicePrincipalCertificate +Aliases: Domain, TenantDomain Required: False Position: Named Default value: None @@ -485,27 +487,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ManagedServicePort -Port number for managed service login. +### -UseDeviceAuthentication +Use device code authentication instead of a browser control. ```yaml -Type: Int32 -Parameter Sets: ManagedServiceLogin +Type: SwitchParameter +Parameter Sets: UserCredential Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -ManagedServiceSecret -Secret, used for some kinds of managed service login. - -```yaml -Type: SecureString -Parameter Sets: ManagedServiceLogin -Aliases: Required: False Position: Named Default value: None @@ -513,17 +502,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDeviceAuthentication -Use device code authentication instead of a browser control. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter -Parameter Sets: UserCredential -Aliases: - +Parameter Sets: (All) +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md b/teams/teams-ps/MicrosoftTeams/Disable-CsOnlineSipDomain.md similarity index 91% rename from teams/teams-ps/teams/Disable-CsOnlineSipDomain.md rename to teams/teams-ps/MicrosoftTeams/Disable-CsOnlineSipDomain.md index 932a55f2fe..a8cd1e0663 100644 --- a/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md +++ b/teams/teams-ps/MicrosoftTeams/Disable-CsOnlineSipDomain.md @@ -1,20 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain applicable: Microsoft Teams -title: Disable-CsOnlineSipDomain -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/disable-csonlinesipdomain +schema: 2.0.0 +title: Disable-CsOnlineSipDomain --- # Disable-CsOnlineSipDomain ## SYNOPSIS -This cmdlet prevents provisioning of users in Skype for Business Online for the specified domain. This cmdlet allows organizations with multiple on-premises deployments of Skype For Business Server or Lync Server to safely synchronize users from multiple forests into a single Office 365 tenant. +This cmdlet prevents provisioning of users in Skype for Business Online for the specified domain. ## SYNTAX @@ -23,6 +25,8 @@ Disable-CsOnlineSipDomain -Domain [-Force] [-Confirm] [ Applicable: Microsoft Teams + +The SIP domain to be disabled for online provisioning in Skype for Business Online. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf - -Required: False +Aliases: +Required: True Position: Named Default value: None Accept pipeline input: False @@ -93,13 +98,14 @@ Accept wildcard characters: False ### -Force +> Applicable: Microsoft Teams + Suppresses all confirmation prompts that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -125,8 +131,8 @@ This cmdlet is for advanced scenarios only. Organizations that are pure online o ## RELATED LINKS -[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/enable-csonlinesipdomain) +[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/enable-csonlinesipdomain) -[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain) +[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinesipdomain) [Cloud consolidation for Teams and Skype for Business](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation) diff --git a/teams/teams-ps/teams/Disconnect-MicrosoftTeams.md b/teams/teams-ps/MicrosoftTeams/Disconnect-MicrosoftTeams.md similarity index 92% rename from teams/teams-ps/teams/Disconnect-MicrosoftTeams.md rename to teams/teams-ps/MicrosoftTeams/Disconnect-MicrosoftTeams.md index b840da266f..4dbb514d06 100644 --- a/teams/teams-ps/teams/Disconnect-MicrosoftTeams.md +++ b/teams/teams-ps/MicrosoftTeams/Disconnect-MicrosoftTeams.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/disconnect-microsoftteams -title: Disconnect-MicrosoftTeams -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/disconnect-microsoftteams +schema: 2.0.0 +title: Disconnect-MicrosoftTeams --- # Disconnect-MicrosoftTeams @@ -32,13 +32,13 @@ Disconnects from the Microsoft Teams environment. ## PARAMETERS -### -WhatIf -Simulates what would happen if the cmdlet is run. The cmdlet is not run. +### -Confirm +Proactively accepts any confirmation prompts. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -47,13 +47,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Proactively accepts any confirmation prompts. +### -WhatIf +Simulates what would happen if the cmdlet is run. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Enable-CsOnlineSipDomain.md b/teams/teams-ps/MicrosoftTeams/Enable-CsOnlineSipDomain.md similarity index 87% rename from teams/teams-ps/teams/Enable-CsOnlineSipDomain.md rename to teams/teams-ps/MicrosoftTeams/Enable-CsOnlineSipDomain.md index 7356c8e473..c8533c2892 100644 --- a/teams/teams-ps/teams/Enable-CsOnlineSipDomain.md +++ b/teams/teams-ps/MicrosoftTeams/Enable-CsOnlineSipDomain.md @@ -1,21 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/enable-csonlinesipdomain applicable: Microsoft Teams -title: Enable-CsOnlineSipDomain -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/enable-csonlinesipdomain +schema: 2.0.0 +title: Enable-CsOnlineSipDomain --- # Enable-CsOnlineSipDomain ## SYNOPSIS -This cmdlet enables provisioning of users in Skype for Business Online for the specified domain. This cmdlet is only necessary to run if you previously disabled a domain using Disable-CsOnlineSipDomain. Enable-CsOnlineSipDomain is used to facilitate consolidation of separate Skype for Business deployments into a single Office 365 tenant. - +This cmdlet enables provisioning of users in Skype for Business Online for the specified domain. ## SYNTAX ```powershell @@ -23,6 +24,7 @@ Enable-CsOnlineSipDomain -Domain [-Force] [-Confirm] [ Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams -Required: True +Aliases: cf +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Domain -Prompts you for confirmation before running the cmdlet. +> Applicable: Microsoft Teams + +The SIP domain to be enabled for online provisioning in Skype for Business Online. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams -Required: False +Aliases: +Required: True Position: Named Default value: None Accept pipeline input: False @@ -86,13 +90,14 @@ Accept wildcard characters: False ### -Force +> Applicable: Microsoft Teams + Suppresses all confirmation prompts that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -117,6 +122,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain) +[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/disable-csonlinesipdomain) -[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain) +[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinesipdomain) diff --git a/teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md b/teams/teams-ps/MicrosoftTeams/Export-CsAcquiredPhoneNumber.md similarity index 89% rename from teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md rename to teams/teams-ps/MicrosoftTeams/Export-CsAcquiredPhoneNumber.md index 2af9e62f5d..1eb2ce032a 100644 --- a/teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Export-CsAcquiredPhoneNumber.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber applicable: Microsoft Teams -title: Export-CsAcquiredPhoneNumber author: pavellatif -ms.author: pavellatif -ms.reviewer: +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +online version: https://learn.microsoft.com/powershell/module/microsoftteams/export-csacquiredphonenumber schema: 2.0.0 +title: Export-CsAcquiredPhoneNumber --- # Export-CsAcquiredPhoneNumber @@ -23,7 +23,7 @@ Export-CsAcquiredPhoneNumber [-Property ] [] ``` ## DESCRIPTION -This cmdlet exports all the acquired phone numbers by the tenant to a file. The cmdlet is an asynchronus operation and will return an OrderId. [Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) cmdlet can be used to check the status of the OrderId including the download link to exported file. +This cmdlet exports all the acquired phone numbers by the tenant to a file. The cmdlet is an asynchronus operation and will return an OrderId. [Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus) cmdlet can be used to check the status of the OrderId including the download link to exported file. By default, this cmdlet returns all the phone numbers acquired by the tenant with all corresponding properties in the results. The tenant admin may indicate specific properties as an input to get a list with only selected properties in the file. @@ -124,4 +124,4 @@ The cmdlet is available in Teams PowerShell module 6.1.0 or later. The cmdlet is only available in commercial and GCC cloud instances. ## RELATED LINKS -[Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) +[Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus) diff --git a/teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md b/teams/teams-ps/MicrosoftTeams/Export-CsAutoAttendantHolidays.md similarity index 88% rename from teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md rename to teams/teams-ps/MicrosoftTeams/Export-CsAutoAttendantHolidays.md index 610335e471..2223080fd1 100644 --- a/teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/MicrosoftTeams/Export-CsAutoAttendantHolidays.md @@ -1,19 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays applicable: Microsoft Teams -title: Export-CsAutoAttendantHolidays -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/export-csautoattendantholidays +schema: 2.0.0 +title: Export-CsAutoAttendantHolidays --- # Export-CsAutoAttendantHolidays ## SYNOPSIS -Use Export-CsAutoAttendantHolidays cmdlet to export holiday schedules of an existing Auto Attendant (AA). The data is exported as a byte array from the cmdlet, which can be dumped to disk as a CSV file and can later be imported using the Import-CsAutoAttendantHolidays cmdlet. +Use Export-CsAutoAttendantHolidays cmdlet to export holiday schedules of an existing Auto Attendant (AA). ## SYNTAX @@ -42,7 +44,7 @@ where ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $bytes = Export-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 [System.IO.File]::WriteAllBytes("C:\Exports\Holidays.csv", $bytes) @@ -53,13 +55,15 @@ In this example, the Export-CsAutoAttendantHolidays cmdlet is used to export hol ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the AA whose holiday schedules are to be exported. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -70,11 +74,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -99,6 +104,6 @@ The Export-CsAutoAttendantHolidays cmdlet accepts a string as the Identity param ## RELATED LINKS -[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays) +[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/import-csautoattendantholidays) -[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays) +[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantholidays) diff --git a/teams/teams-ps/teams/export-csonlineaudiofile.md b/teams/teams-ps/MicrosoftTeams/Export-CsOnlineAudioFile.md similarity index 78% rename from teams/teams-ps/teams/export-csonlineaudiofile.md rename to teams/teams-ps/MicrosoftTeams/Export-CsOnlineAudioFile.md index f0b747b543..ac593e6fce 100644 --- a/teams/teams-ps/teams/export-csonlineaudiofile.md +++ b/teams/teams-ps/MicrosoftTeams/Export-CsOnlineAudioFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile applicable: Microsoft Teams -title: Export-CsOnlineAudioFile -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/export-csonlineaudiofile +schema: 2.0.0 +title: Export-CsOnlineAudioFile --- # Export-CsOnlineAudioFile @@ -17,8 +18,9 @@ Use the Export-CsOnlineAudioFile cmdlet to download an existing audio file. ## SYNTAX -```powershell -Export-CsOnlineAudioFile [[-Identity] ] [-ApplicationId ] [] +``` +Export-CsOnlineAudioFile -Identity [-ApplicationId ] [-HttpPipelinePrepend ] + [] ``` ## DESCRIPTION @@ -26,7 +28,7 @@ The Export-CsOnlineAudioFile cmdlet downloads an existing Auto Attendant (AA), C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $content=Export-CsOnlineAudioFile -ApplicationId "HuntGroup" -Identity 57f800408f8848548dd1fbc18073fe46 [System.IO.File]::WriteAllBytes('C:\MyWaveFile.wav', $content) @@ -37,6 +39,9 @@ This example exports a Call Queue audio file and saves it as MyWaveFile.wav. ## PARAMETERS ### -ApplicationId + +> Applicable: Microsoft Teams + The ApplicationId parameter is the identifier for the application which will use this audio file. For example, if the audio file is used with an organizational auto attendant, then it needs to be set to "OrgAutoAttendant". If the audio file is used with a hunt group (call queue), then it needs to be set to "HuntGroup". If the audio file is used with Microsoft Teams, then it needs to be set to "TenantGlobal" Supported values: @@ -46,18 +51,32 @@ Supported values: - TenantGlobal ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: TenantGlobal Accept pipeline input: False Accept wildcard characters: False ``` +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The Id of the specific audio file that you would like to export. @@ -66,14 +85,15 @@ Type: System.String Parameter Sets: (All) Aliases: -Required: False +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -90,8 +110,8 @@ Therefore, ensure that the file extension used to store the content is WAV. You are responsible for independently clearing and securing all necessary rights and permissions to use any music or audio file with your Microsoft Teams service, which may include intellectual property and other rights in any music, sound effects, audio, brands, names, and other content in the audio file from all relevant rights holders, which may include artists, actors, performers, musicians, songwriters, composers, record labels, music publishers, unions, guilds, rights societies, collective management organizations and any other parties who own, control or license the music copyrights, sound effects, audio and other intellectual property rights. ## RELATED LINKS -[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineaudiofile) -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) -[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineaudiofile) diff --git a/teams/teams-ps/teams/Find-CsGroup.md b/teams/teams-ps/MicrosoftTeams/Find-CsGroup.md similarity index 90% rename from teams/teams-ps/teams/Find-CsGroup.md rename to teams/teams-ps/MicrosoftTeams/Find-CsGroup.md index 18c265455b..a2447ed431 100644 --- a/teams/teams-ps/teams/Find-CsGroup.md +++ b/teams/teams-ps/MicrosoftTeams/Find-CsGroup.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/find-csgroup applicable: Microsoft Teams -title: Find-CsGroup +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/find-csgroup schema: 2.0.0 +title: Find-CsGroup --- # Find-CsGroup @@ -23,14 +25,14 @@ The Find-CsGroup cmdlet lets you search groups in the Azure Address Book Service ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Find-CsGroup -SearchQuery "Contoso Group" -MaxResults 5 ``` This example finds and displays up to five groups that match the "Contoso Group" search query. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Find-CsGroup -SearchQuery "ed0d1180-169e-47c7-b718-bf9e60543914" -ExactMatchOnly $true ``` @@ -39,30 +41,34 @@ This example finds and displays only those groups that are an exact match to the ## PARAMETERS -### -SearchQuery -The SearchQuery parameter defines a search query to search the display name or the sip address or the GUID of groups. This parameter accepts partial search query. The search is not case sensitive. +### -ExactMatchOnly + +> Applicable: Microsoft Teams + +The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExactMatchOnly -The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false. +### -Force + +> Applicable: Microsoft Teams + +PARAMVALUE: SwitchParameter ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -71,14 +77,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -MailEnabledOnly +Instructs the cmdlet to return mail enabled only groups. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -MaxResults + +> Applicable: Microsoft Teams + The MaxResults parameter identifies the maximum number of results to return. If this parameter is not provided, the default is value is 10. ```yaml Type: UInt32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -103,15 +110,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MailEnabledOnly -Instructs the cmdlet to return mail enabled only groups. +### -SearchQuery + +> Applicable: Microsoft Teams + +The SearchQuery parameter defines a search query to search the display name or the sip address or the GUID of groups. This parameter accepts partial search query. The search is not case sensitive. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -119,13 +129,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Find-CsOnlineApplicationInstance.md similarity index 85% rename from teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Find-CsOnlineApplicationInstance.md index 2744bd46e0..3acb65e43a 100644 --- a/teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Find-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance applicable: Microsoft Teams -title: Find-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance +schema: 2.0.0 +title: Find-CsOnlineApplicationInstance --- # Find-CsOnlineApplicationInstance @@ -28,28 +29,28 @@ If MaxResults is not specified, the number of returned applications instances is ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Find-CsOnlineApplicationInstance -SearchQuery "Test" ``` This example returns up to 10 application instances whose name starts with "Test". -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Find-CsOnlineApplicationInstance -SearchQuery "Test" -MaxResults 5 ``` This example returns up to 5 application instances whose name starts with "Test". -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell Find-CsOnlineApplicationInstance -SearchQuery "Test Auto Attendant" -ExactMatchOnly ``` This example returns up to 10 application instances whose name is "Test Auto Attendant". -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell Find-CsOnlineApplicationInstance -SearchQuery "Test Auto Attendant" -AssociatedOnly ``` @@ -58,16 +59,18 @@ This example returns up to 10 application instances whose name is "Test Auto Att ## PARAMETERS -### -SearchQuery -The SearchQuery parameter defines a query for application instances by display name, telephone number, or GUID of the application instance. This parameter accepts partial queries for display names and telephone numbers. The search is not case sensitive. +### -AssociatedOnly + +> Applicable: Microsoft Teams + +The AssociatedOnly parameter instructs the cmdlet to return only application instances that are associated to a configuration. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -ExactMatchOnly + +> Applicable: Microsoft Teams + The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -90,30 +95,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AssociatedOnly -The AssociatedOnly parameter instructs the cmdlet to return only application instances that are associated to a configuration. +### -Force + +> Applicable: Microsoft Teams + +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -UnAssociatedOnly -The UnAssociatedOnly parameter instructs the cmdlet to return only application instances that are not associated to any configuration. +### -MaxResults + +> Applicable: Microsoft Teams + +The MaxResults parameter identifies the maximum number of results to return. If this parameter is not provided, the default is value is 10. Max allowed value is 20. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -122,34 +131,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxResults -The MaxResults parameter identifies the maximum number of results to return. If this parameter is not provided, the default is value is 10. Max allowed value is 20. +### -SearchQuery + +> Applicable: Microsoft Teams + +The SearchQuery parameter defines a query for application instances by display name, telephone number, or GUID of the application instance. This parameter accepts partial queries for display names and telephone numbers. The search is not case sensitive. ```yaml -Type: UInt32 +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. +### -UnAssociatedOnly + +> Applicable: Microsoft Teams + +The UnAssociatedOnly parameter instructs the cmdlet to return only application instances that are not associated to any configuration. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -169,10 +182,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) -[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Get-ALLM365TeamsApps.md b/teams/teams-ps/MicrosoftTeams/Get-AllM365TeamsApps.md similarity index 93% rename from teams/teams-ps/teams/Get-ALLM365TeamsApps.md rename to teams/teams-ps/MicrosoftTeams/Get-AllM365TeamsApps.md index b3dd4967bb..d4ff36be08 100644 --- a/teams/teams-ps/teams/Get-ALLM365TeamsApps.md +++ b/teams/teams-ps/MicrosoftTeams/Get-AllM365TeamsApps.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Get-ALLM365TeamsApps applicable: Microsoft Teams -title: Get-ALLM365TeamsApps author: lkueter -ms.author: sribagchi +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 04/24/2024 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Get-AllM365TeamsApps schema: 2.0.0 +title: Get-AllM365TeamsApps --- # Get-AllM365TeamsApps @@ -107,5 +108,5 @@ Properties: ## RELATED LINKS -[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-m365teamsapp) -[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-m365teamsapp) +[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/microsoftteams/get-m365teamsapp) +[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/microsoftteams/get-m365teamsapp) diff --git a/teams/teams-ps/teams/Get-AssociatedTeam.md b/teams/teams-ps/MicrosoftTeams/Get-AssociatedTeam.md similarity index 88% rename from teams/teams-ps/teams/Get-AssociatedTeam.md rename to teams/teams-ps/MicrosoftTeams/Get-AssociatedTeam.md index 2bc7566964..897fc289ca 100644 --- a/teams/teams-ps/teams/Get-AssociatedTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Get-AssociatedTeam.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-associatedteam -title: Get-AssociatedTeam -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-associatedteam +schema: 2.0.0 +title: Get-AssociatedTeam --- # Get-AssociatedTeam @@ -77,5 +78,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) -[Get-SharedWithTeam](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-Team](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) +[Get-SharedWithTeam](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) diff --git a/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationAccessPolicy.md similarity index 87% rename from teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsApplicationAccessPolicy.md index a3cd76b4a4..cf598840da 100644 --- a/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csapplicationaccesspolicy applicable: Microsoft Teams -title: Get-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni author: frankpeng7 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csapplicationaccesspolicy +schema: 2.0.0 +title: Get-CsApplicationAccessPolicy --- # Get-CsApplicationAccessPolicy @@ -55,33 +56,33 @@ In the command shown above, information is returned for a single application acc ## PARAMETERS -### -Identity +### -Filter -Unique identifier assigned to the policy when it was created. +A filter that is not expressed in the standard wildcard language. ```yaml -Type: XdsIdentity -Parameter Sets: (All) +Type: String +Parameter Sets: Filter Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter +### -Identity -A filter that is not expressed in the standard wildcard language. +Unique identifier assigned to the policy when it was created. ```yaml -Type: String -Parameter Sets: Filter +Type: XdsIdentity +Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -115,10 +116,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) -[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy) -[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csapplicationaccesspolicy) -[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csapplicationaccesspolicy) +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationMeetingConfiguration.md similarity index 91% rename from teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsApplicationMeetingConfiguration.md index 0980ee7a04..93d753c78c 100644 --- a/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationMeetingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-CsApplicationMeetingConfiguration applicable: Teams -title: Get-CsApplicationMeetingConfiguration -schema: 2.0.0 -manager: zhengni author: jackry6350 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: yoren -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-CsApplicationMeetingConfiguration +schema: 2.0.0 +title: Get-CsApplicationMeetingConfiguration --- # Get-CsApplicationMeetingConfiguration @@ -40,50 +41,54 @@ The command shown above returns application meeting configuration settings that ## PARAMETERS -### -Identity +### -Filter -Unique identifier of the application meeting configuration settings to be returned. -Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsApplicationMeetingConfiguration cmdlet. -However, you can use the following syntax to retrieve the global settings: -Identity global. +> Applicable: Teams + +Enables you to use wildcards when specifying the application meeting configuration settings to be returned. +Because you can only have a single, global instance of these settings there is little reason to use the Filter parameter. +However, if you prefer, you can use syntax similar to this to retrieve the global settings: -Identity "g*". ```yaml -Type: XdsIdentity -Parameter Sets: (All) +Type: String +Parameter Sets: Filter Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the application meeting configuration settings to be returned. -Because you can only have a single, global instance of these settings there is little reason to use the Filter parameter. -However, if you prefer, you can use syntax similar to this to retrieve the global settings: -Identity "g*". +### -Identity + +Unique identifier of the application meeting configuration settings to be returned. +Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsApplicationMeetingConfiguration cmdlet. +However, you can use the following syntax to retrieve the global settings: -Identity global. ```yaml -Type: String -Parameter Sets: Filter +Type: XdsIdentity +Parameter Sets: (All) Aliases: -Applicable: Teams -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Teams + Retrieves the application meeting configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Teams Required: False Position: Named @@ -107,4 +112,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csapplicationmeetingconfiguration) +[Set-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csapplicationmeetingconfiguration) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendant.md similarity index 89% rename from teams/teams-ps/teams/Get-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendant.md index 7fc22623fe..a7566f3443 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendant applicable: Microsoft Teams -title: Get-CsAutoAttendant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant +schema: 2.0.0 +title: Get-CsAutoAttendant --- # Get-CsAutoAttendant @@ -73,33 +75,34 @@ This example skips initial 5 auto attendants and gets the next 10 AAs configured ## PARAMETERS -### -Identity -The identity for the AA to be retrieved. If this parameter is not specified, then all created AAs in the organization are returned. -If you specify this parameter, you can't specify the other parameters. +### -Descending + +> Applicable: Microsoft Teams + +If specified, the retrieved auto attendants would be sorted in descending order. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -First -The First parameter gets the first N auto attendants, up to a maximum of 100 at a time. -When not specified, the default behavior is to return the first 100 auto attendants. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. -If a number greater than 100 is supplied, the request will fail. +### -ExcludeContent + +> Applicable: Microsoft Teams + +If specified, only auto attendants' names, identities and associated application instances will be retrieved. ```yaml -Type: System.UInt32 +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -108,14 +111,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Skip -The Skip parameter skips the first N auto attendants. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. +### -First + +> Applicable: Microsoft Teams + +The First parameter gets the first N auto attendants, up to a maximum of 100 at a time. +When not specified, the default behavior is to return the first 100 auto attendants. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. +If a number greater than 100 is supplied, the request will fail. ```yaml Type: System.UInt32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -124,30 +131,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NameFilter -If specified, only auto attendants whose names match that value would be returned. +### -Identity + +> Applicable: Microsoft Teams + +The identity for the AA to be retrieved. If this parameter is not specified, then all created AAs in the organization are returned. +If you specify this parameter, you can't specify the other parameters. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -SortBy -If specified, the retrieved auto attendants would be sorted by the specified property. +### -IncludeStatus + +> Applicable: Microsoft Teams + +If specified, the status records for each auto attendant in the result set are also retrieved. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -156,14 +168,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Descending -If specified, the retrieved auto attendants would be sorted in descending order. +### -NameFilter + +> Applicable: Microsoft Teams + +If specified, only auto attendants whose names match that value would be returned. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -172,14 +186,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeStatus -If specified, the status records for each auto attendant in the result set are also retrieved. +### -Skip + +> Applicable: Microsoft Teams + +The Skip parameter skips the first N auto attendants. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. ```yaml -Type: SwitchParameter +Type: System.UInt32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -188,14 +204,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeContent -If specified, only auto attendants' names, identities and associated application instances will be retrieved. +### -SortBy + +> Applicable: Microsoft Teams + +If specified, the retrieved auto attendants would be sorted by the specified property. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -206,11 +224,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -235,12 +254,12 @@ The Get-CsAutoAttendant cmdlet accepts a string as the Identity parameter. ## RELATED LINKS -[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus) -[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendant) -[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant) -[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant) -[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/update-csautoattendant) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantHolidays.md similarity index 87% rename from teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantHolidays.md index 92114b548b..413002c8a4 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantHolidays.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays applicable: Microsoft Teams -title: Get-CsAutoAttendantHolidays -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantholidays +schema: 2.0.0 +title: Get-CsAutoAttendantHolidays --- # Get-CsAutoAttendantHolidays @@ -26,28 +28,28 @@ The Get-CsAutoAttendantHolidays provides a convenient way to visualize the infor ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` In this example, the Get-CsAutoAttendantHolidays cmdlet is used to get all holidays in an auto attendant with Identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -Years @(2017) ``` In this example, the Get-CsAutoAttendantHolidays cmdlet is used to get all holidays in year 2017 in an auto attendant with Identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -Years @(2017) -Names @("Christmas") ``` In this example, the Get-CsAutoAttendantHolidays cmdlet is used to get holiday named Christmas in the year 2017 in an auto attendant with Identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` (Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -Years @(2017) -Names @("Christmas")).DateTimeRanges ``` @@ -56,14 +58,33 @@ In this example, the Get-CsAutoAttendantHolidays cmdlet is used to retrieve the ## PARAMETERS +### -Force + +> Applicable: Microsoft Teams + +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Microsoft Teams + Represents the identifier for the auto attendant whose holidays are to be retrieved. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -72,29 +93,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Names -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Years -The Years parameter represents the years for the holidays to be retrieved. If this parameter is not specified, then holidays for all years in the AA are returned. +The Names parameter represents the names for the holidays to be retrieved. If this parameter is not specified, then all holidays in the AA are returned. ```yaml -Type: System.Collections.Generic.List[System.String] +Type: System.Collections.Generic.List[System.Int32] Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -103,14 +111,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Names -The Names parameter represents the names for the holidays to be retrieved. If this parameter is not specified, then all holidays in the AA are returned. +### -Years + +> Applicable: Microsoft Teams + +The Years parameter represents the years for the holidays to be retrieved. If this parameter is not specified, then holidays for all years in the AA are returned. ```yaml -Type: System.Collections.Generic.List[System.Int32] +Type: System.Collections.Generic.List[System.String] Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -136,6 +146,6 @@ The DateTimeRanges parameter in the output needs to be explicitly referenced to ## RELATED LINKS -[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays) +[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/import-csautoattendantholidays) -[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays) +[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/export-csautoattendantholidays) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantStatus.md similarity index 90% rename from teams/teams-ps/teams/Get-CsAutoAttendantStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantStatus.md index 69b5630115..5fa723c624 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus applicable: Microsoft Teams -title: Get-CsAutoAttendantStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus +schema: 2.0.0 +title: Get-CsAutoAttendantStatus --- # Get-CsAutoAttendantStatus @@ -26,14 +28,14 @@ This cmdlet provides a way to return the provisioning status of an auto attendan ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` In Example 1, the Get-CsAutoAttendantStatus cmdlet is used to get status records for all resources of an auto attendant with identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -IncludeResources @("AudioFile") ``` @@ -43,13 +45,15 @@ In Example 2, the Get-CsAutoAttendantStatus cmdlet is used to get status records ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + Represents the identifier for the auto attendant whose provisioning status is to be retrieved. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -80,11 +84,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -109,4 +114,4 @@ The Get-CsAutoAttendantStatus cmdlet accepts a string as the Identity parameter. ## RELATED LINKS -[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant) diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage.md similarity index 87% rename from teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage.md index c6cb4253af..46521c39f0 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage applicable: Microsoft Teams -title: Get-CsAutoAttendantSupportedLanguage -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage +schema: 2.0.0 +title: Get-CsAutoAttendantSupportedLanguage --- # Get-CsAutoAttendantSupportedLanguage @@ -26,14 +28,14 @@ The Get-CsAutoAttendantSupportedLanguage cmdlet gets all languages (and their co ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantSupportedLanguage ``` This example gets all supported languages. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantSupportedLanguage -Identity "en-US" ``` @@ -43,13 +45,15 @@ This example gets the language that the Identity parameter specifies (en-US). ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter designates a specific language to be retrieved. If this parameter is not specified, then all supported languages are returned. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 @@ -60,11 +64,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone.md similarity index 87% rename from teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone.md index 1e0491d7e4..b8658d6121 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone applicable: Microsoft Teams -title: Get-CsAutoAttendantSupportedTimeZone -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone +schema: 2.0.0 +title: Get-CsAutoAttendantSupportedTimeZone --- # Get-CsAutoAttendantSupportedTimeZone @@ -26,14 +28,14 @@ The Get-CsAutoAttendantSupportedTimeZone cmdlet gets all the time zones that the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantSupportedTimeZone ``` This example gets all supported time zones. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantSupportedTimeZone -Identity "Pacific Standard Time" ``` @@ -43,13 +45,15 @@ This example gets the timezone that the Identity parameter specifies (Pacific St ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter specifies a time zone to be retrieved. If this parameter is not used, then all supported time zones are returned. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 @@ -60,11 +64,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantTenantInformation.md similarity index 87% rename from teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantTenantInformation.md index 92a3a9bbc1..cf064e6dfe 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantTenantInformation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendanttenantinformation applicable: Microsoft Teams -title: Get-CsAutoAttendantTenantInformation -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendanttenantinformation +schema: 2.0.0 +title: Get-CsAutoAttendantTenantInformation --- # Get-CsAutoAttendantTenantInformation @@ -26,7 +28,7 @@ The Get-CsAutoAttendantTenantInformation cmdlet gets the default tenant informat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantTenantInformation ``` @@ -37,11 +39,12 @@ Gets the default auto attendant information for the logged in tenant. ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/MicrosoftTeams/Get-CsBatchPolicyAssignmentOperation.md similarity index 97% rename from teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsBatchPolicyAssignmentOperation.md index b9a3895727..cc8cc8ca29 100644 --- a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsBatchPolicyAssignmentOperation.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation -title: Get-CsBatchPolicyAssignmentOperation -schema: 2.0.0 -author: tomkau ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csbatchpolicyassignmentoperation +schema: 2.0.0 +title: Get-CsBatchPolicyAssignmentOperation --- # Get-CsBatchPolicyAssignmentOperation @@ -90,36 +91,6 @@ In this example, the UserState property is expanded to see the status of each us ## PARAMETERS -### -Identity -The ID of a batch policy assignment operation. - -```yaml -Type: String -Parameter Sets: Get1 -Aliases: OperationId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Option filter - -```yaml -Type: String -Parameter Sets: Get -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Break Wait for .NET debugger to attach @@ -165,6 +136,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +The ID of a batch policy assignment operation. + +```yaml +Type: String +Parameter Sets: Get1 +Aliases: OperationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Proxy The URI for the proxy server to use @@ -210,6 +196,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Status +Option filter + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -266,4 +267,4 @@ Contains the status for each user in the batch. ## RELATED LINKS -[New-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation) +[New-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchpolicyassignmentoperation) diff --git a/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsBatchTeamsDeploymentStatus.md similarity index 90% rename from teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsBatchTeamsDeploymentStatus.md index 2fdd9166f2..03cbd6c052 100644 --- a/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsBatchTeamsDeploymentStatus.md @@ -1,85 +1,86 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsBatchTeamsDeploymentStatus -title: Get-CsBatchTeamsDeploymentStatus -schema: 2.0.0 ---- - -# Get-CsBatchTeamsDeploymentStatus - -## SYNOPSIS - -This cmdlet is used to get the status of the batch deployment orchestration. - -## SYNTAX - -```powershell -Get-CsBatchTeamsDeploymentStatus -OrchestrationId - -InputObject - [] -``` - -## DESCRIPTION -After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus. - -To learn more, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id" -``` - -This command provides the status of the specified batch deployment orchestrationId. - -## PARAMETERS - -### OrchestrationId -This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Identity parameter. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Status of the orchestrationId - -Running: The orchestration is running. -Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. - -## NOTES - -## RELATED LINKS - -[New-CsBatchTeamsDeployment](https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsBatchTeamsDeploymentStatus +schema: 2.0.0 +title: Get-CsBatchTeamsDeploymentStatus +--- + +# Get-CsBatchTeamsDeploymentStatus + +## SYNOPSIS + +This cmdlet is used to get the status of the batch deployment orchestration. + +## SYNTAX + +```powershell +Get-CsBatchTeamsDeploymentStatus -OrchestrationId + -InputObject + [] +``` + +## DESCRIPTION +After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus. + +To learn more, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id" +``` + +This command provides the status of the specified batch deployment orchestrationId. + +## PARAMETERS + +### OrchestrationId +This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Status of the orchestrationId + +Running: The orchestration is running. +Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. + +## NOTES + +## RELATED LINKS + +[New-CsBatchTeamsDeployment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchteamsdeployment) diff --git a/teams/teams-ps/teams/Get-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/Get-CsCallQueue.md similarity index 89% rename from teams/teams-ps/teams/Get-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/Get-CsCallQueue.md index 9ea06bec8e..6e72deea7b 100644 --- a/teams/teams-ps/teams/Get-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsCallQueue.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cscallqueue applicable: Microsoft Teams -title: Get-CsCallQueue -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallqueue +schema: 2.0.0 +title: Get-CsCallQueue --- # Get-CsCallQueue @@ -27,14 +28,14 @@ The Get-CsCallQueue cmdlet lets you retrieve information about the Call Queues i ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCallQueue ``` This example gets the first 100 call queues in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCallQueue -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` @@ -43,14 +44,16 @@ This example gets the Call Queue with the identity 5e3a575e-1faa-49ff-83c2-5cf1c ## PARAMETERS -### -Identity -PARAMVALUE: Guid +### -Descending + +> Applicable: Microsoft Teams + +The Descending parameter sorts Call Queues in descending order ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -59,14 +62,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -ExcludeContent + +> Applicable: Microsoft Teams + +The ExcludeContent parameter only displays the Name and Id of the Call Queues ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -76,7 +81,10 @@ Accept wildcard characters: False ``` ### -First -The First parameter gets the first N Call Queues, up to a maximum of 100 at a time. + +> Applicable: Microsoft Teams + +The First parameter gets the first N Call Queues, up to a maximum of 100 at a time. When not specified, the default behavior is to return the first 100 call queues. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. If a number greater than 100 is supplied, the request will fail. @@ -84,7 +92,6 @@ If a number greater than 100 is supplied, the request will fail. Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -93,14 +100,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Skip -The Skip parameter skips the first N call queues. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. +### -Identity + +> Applicable: Microsoft Teams + +PARAMVALUE: Guid ```yaml -Type: Int32 +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -109,64 +118,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeContent -The ExcludeContent parameter only displays the Name and Id of the Call Queues +### -NameFilter + +> Applicable: Microsoft Teams + +The NameFilter parameter returns Call Queues where name contains specified string ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Sort -The Sort parameter specifies the property used to sort. +### -Skip + +> Applicable: Microsoft Teams + +The Skip parameter skips the first N call queues. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. ```yaml -Type: String +Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: Name +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Descending -The Descending parameter sorts Call Queues in descending order +### -Sort + +> Applicable: Microsoft Teams + +The Sort parameter specifies the property used to sort. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: None +Default value: Name Accept pipeline input: False Accept wildcard characters: False ``` -### -NameFilter -The NameFilter parameter returns Call Queues where name contains specified string +### -Tenant + +> Applicable: Microsoft Teams + +PARAMVALUE: Guid ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Get-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Get-CsCallingLineIdentity.md similarity index 83% rename from teams/teams-ps/teams/Get-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Get-CsCallingLineIdentity.md index bbd56f2336..04383ba4ec 100644 --- a/teams/teams-ps/teams/Get-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity applicable: Microsoft Teams -title: Get-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallinglineidentity +schema: 2.0.0 +title: Get-CsCallingLineIdentity --- # Get-CsCallingLineIdentity @@ -48,33 +49,37 @@ The example gets and displays the Caller ID policies with Identity starting with ## PARAMETERS -### -Identity -The Identity parameter identifies the Caller ID policy. +### -Filter + +> Applicable: Microsoft Teams + +The Filter parameter lets you insert a string through which your search results are filtered. ```yaml Type: String -Parameter Sets: (Identity) +Parameter Sets: (Filter) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter lets you insert a string through which your search results are filtered. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter identifies the Caller ID policy. ```yaml Type: String -Parameter Sets: (Filter) +Parameter Sets: (Identity) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -93,10 +98,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cscallinglineidentity) -[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallinglineidentity) -[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallinglineidentity) -[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md b/teams/teams-ps/MicrosoftTeams/Get-CsCloudCallDataConnection.md similarity index 90% rename from teams/teams-ps/teams/Get-CsCloudCallDataConnection.md rename to teams/teams-ps/MicrosoftTeams/Get-CsCloudCallDataConnection.md index f2b7e131f9..2cac377631 100644 --- a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsCloudCallDataConnection.md @@ -1,15 +1,15 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Get-CsCloudCallDataConnection -online version: https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection -schema: 2.0.0 author: 2012ucp1544 +external help file: MicrosoftTeams-help.xml +Locale: en-US +manager: subadjat +Module Name: MicrosoftTeams ms.author: uditagrawal ms.reviewer: pbafna -manager: subadjat - +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cscloudcalldataconnection +schema: 2.0.0 +title: Get-CsCloudCallDataConnection --- # Get-CsCloudCallDataConnection @@ -59,4 +59,4 @@ The Get-CsCloudCallDataConnection cmdlet is only supported in commercial environ ## RELATED LINKS [Configure Call Data Connector](https://learn.microsoft.com/skypeforbusiness/hybrid/configure-call-data-connector) -[New-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection) +[New-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscloudcalldataconnection) diff --git a/teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/Get-CsComplianceRecordingForCallQueueTemplate.md similarity index 89% rename from teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md rename to teams/teams-ps/MicrosoftTeams/Get-CsComplianceRecordingForCallQueueTemplate.md index 9d668b7749..f7e66eeabd 100644 --- a/teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsComplianceRecordingForCallQueueTemplate.md @@ -1,17 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsComplianceRecordingForCallQueueTemplate applicable: Microsoft Teams -title: Get-CsComplianceRecordingForCallQueueTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: Get-CsComplianceRecordingForCallQueueTemplate --- # Get-CsComplianceRecordingForCallQueueTemplate +## SYNOPSIS +Retrieves a Compliance Recording for Call Queues template. + ## SYNTAX ```powershell @@ -26,14 +30,14 @@ Use the Get-CsComplianceRecordingForCallQueueTemplate cmdlet to retrieve a Compl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsComplianceRecordingForCallQueueTemplate ``` This example gets all Compliance Recording for Call Queue Templates in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` @@ -43,13 +47,15 @@ This example gets the Compliance Recording for Call Queue template with the iden ## PARAMETERS ### -Id + +> Applicable: Microsoft Teams + The Id parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Get-CsEffectiveTenantDialPlan.md similarity index 91% rename from teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Get-CsEffectiveTenantDialPlan.md index e7be699f75..711d8ec146 100644 --- a/teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsEffectiveTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cseffectivetenantdialplan applicable: Microsoft Teams -title: Get-CsEffectiveTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cseffectivetenantdialplan +schema: 2.0.0 +title: Get-CsEffectiveTenantDialPlan --- # Get-CsEffectiveTenantDialPlan @@ -28,7 +29,7 @@ the EnterpriseVoice features. The EffectiveTenantDialPlanName is in the form Ten ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsEffectiveTenantDialPlan -Identity Vt1_User1 ``` @@ -37,39 +38,46 @@ This example gets the effective tenant dial plan for the Vt1_User1. ## PARAMETERS -### -Identity -The Identity parameter is the unique identifier of the user for whom to retrieve the effective tenant dial plan. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: UserIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter is the unique identifier of the user for whom to retrieve the effective tenant dial plan. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -OU + +> Applicable: Microsoft Teams + **Note:** This parameter is not supported in Teams PowerShell Module version 3.0.0 or later. The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. @@ -79,7 +87,6 @@ Only objects that exist in the specified location are returned. Type: OUIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -89,6 +96,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + **Note:** This parameter is not supported in Teams PowerShell Module version 3.0.0 or later. Specifies the number of records returned by the cmdlet. @@ -99,7 +109,6 @@ If set to 0, the command will run, but no data will be returned. Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -109,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -116,7 +128,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsExportAcquiredPhoneNumberStatus.md similarity index 77% rename from teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsExportAcquiredPhoneNumberStatus.md index 1571bfb68b..431ad0fee9 100644 --- a/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsExportAcquiredPhoneNumberStatus.md @@ -1,20 +1,20 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus applicable: Microsoft Teams -title: Get-CsExportAcquiredPhoneNumberStatus author: pavellatif -ms.author: pavellatif -ms.reviewer: +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus schema: 2.0.0 +title: Get-CsExportAcquiredPhoneNumberStatus --- # Get-CsExportAcquiredPhoneNumberStatus ## SYNOPSIS -This cmdlet shows the status of the [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) cmdlet. +This cmdlet shows the status of the [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/export-csacquiredphonenumber) cmdlet. ## SYNTAX @@ -24,7 +24,7 @@ Get-CsExportAcquiredPhoneNumberStatus -OrderId [] ``` ## DESCRIPTION -This cmdlet returns OrderId status from the respective [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) operation. The response will include the download link to the file if operation has been completed. +This cmdlet returns OrderId status from the respective [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/export-csacquiredphonenumber) operation. The response will include the download link to the file if operation has been completed. By default, the download link will remain active for 1 hour. @@ -41,7 +41,7 @@ status : Success DownloadLinkExpiry : 2024-08-29 22:51:17Z DownloadLink : ``` -This example displays the status of the export acquired phone numbers operation. The OrderId is the output from [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) cmdlet. The status contains the download link for the file along with expiry date. +This example displays the status of the export acquired phone numbers operation. The OrderId is the output from [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/export-csacquiredphonenumber) cmdlet. The status contains the download link for the file along with expiry date. ### Example 2 ```powershell @@ -68,7 +68,7 @@ status : Success DownloadLinkExpiry : 2024-08-29 22:51:17Z DownloadLink : ``` -This example stores the [Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) cmdlet status for the "orderId" in the variable "order". This will allow a quick view of the order status without typing the cmdlet again. +This example stores the [Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus) cmdlet status for the "orderId" in the variable "order". This will allow a quick view of the order status without typing the cmdlet again. ## PARAMETERS @@ -104,4 +104,4 @@ The cmdlet is available in Teams PowerShell module 6.1.0 or later. The cmdlet is only available in commercial and GCC cloud instances. ## RELATED LINKS -[Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) +[Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus) diff --git a/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsExternalAccessPolicy.md similarity index 92% rename from teams/teams-ps/teams/Get-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsExternalAccessPolicy.md index 6b5e5dfbaa..a316bd1298 100644 --- a/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsExternalAccessPolicy.md @@ -1,21 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy applicable: Microsoft Teams -title: Get-CsExternalAccessPolicy -schema: 2.0.0 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csexternalaccesspolicy +schema: 2.0.0 +title: Get-CsExternalAccessPolicy --- # Get-CsExternalAccessPolicy ## SYNOPSIS Returns information about the external access policies that have been configured for use in your organization. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. - -This cmdlet was introduced in Lync Server 2010. ## SYNTAX @@ -32,6 +31,10 @@ Get-CsExternalAccessPolicy [-Tenant ] [-Include ] [-Applicab ``` ## DESCRIPTION +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. + +This cmdlet was introduced in Lync Server 2010. + When you first configure Skype for Business Online your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Online organization or in your Active Directory Domain Services for on-premises deployments. For on-premises deployments, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. @@ -44,7 +47,7 @@ External access policies can grant (or revoke) the ability of your users to do a Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration). 3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. @@ -55,7 +58,7 @@ The Get-CsExternalAccessPolicy cmdlet provides a way for you to return informati ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-CsExternalAccessPolicy ``` @@ -63,7 +66,7 @@ Get-CsExternalAccessPolicy Example 1 returns a collection of all the external access policies configured for use in your organization. Calling the Get-CsExternalAccessPolicy cmdlet without any additional parameters always returns the complete collection of external access policies. -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Online) +### EXAMPLE 2 (Skype for Business Online) ``` Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" ``` @@ -71,7 +74,7 @@ Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" Example 2 uses the Identity parameter to return the external access policy that has the Identity tag:RedmondExternalAccessPolicy. Because access policy Identities must be unique, this command will never return more than one item. -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 2 (Skype for Business Server 2015) ``` Get-CsExternalAccessPolicy -Identity site:Redmond ``` @@ -79,7 +82,7 @@ Get-CsExternalAccessPolicy -Identity site:Redmond Example 2 uses the Identity parameter to return the external access policy that has the Identity site:Redmond. Because access policy Identities must be unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsExternalAccessPolicy -Filter tag:* ``` @@ -87,7 +90,7 @@ Get-CsExternalAccessPolicy -Filter tag:* The command shown in Example 3 uses the Filter parameter to return all of the external access policies that have been configured at the per-user scope; the parameter value "tag:*" limits returned data to those policies that have an Identity that begins with the string value "tag:". By definition, any policy that has an Identity beginning with "tag:" is a policy that has been configured at the per-user scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} ``` @@ -96,7 +99,7 @@ In Example 4, the Get-CsExternalAccessPolicy cmdlet and the Where-Object cmdlet To do this, the Get-CsExternalAccessPolicy cmdlet is first used to return a collection of all the external access policies currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the EnableFederationAccess property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True} ``` @@ -106,7 +109,7 @@ In order to perform this task, the command first uses the Get-CsExternalAccessPo That collection is then piped to the Where-Object cmdlet, which picks out only those policies that meet two criteria: the EnableFederationAccess property must be equal to True and the EnablePublicCloudAccess property must also be equal to True. Only policies in which both EnableFederationAccess and EnablePublicCloudAccess are True will be returned and displayed on the screen. -### -------------------------- EXAMPLE 6 -------------------------- +### EXAMPLE 6 ``` Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com" ``` @@ -119,25 +122,30 @@ NOTE: This command requires the Office 365 UsageLocation property to be configur ## PARAMETERS -### -Identity -Unique Identity assigned to the policy when it was created. -External access policies can be assigned at the global, site, or per-user scope. -To refer to the global instance use this syntax: -Identity global. -To refer to a policy at the site scope, use this syntax: -Identity site:Redmond. -To refer to a policy at the per-user scope, use syntax similar to this: -Identity RedmondPolicy. +### -ApplicableTo -Note that wildcard characters such as the asterisk (*) cannot be used with the Identity parameter. -To do a wildcard search for policies, use the Filter parameter instead. +> Applicable: Microsoft Teams -If neither the Identity nor Filter parameters are specified, then the Get-CsExternalAccessPolicy cmdlet will bring back a collection of all the external access policies configured for use in the organization. +Returns a list of the external access policies that can be assigned to the specified user. +For example, to return a collection of policies that can be assigned to the user kenmyer@litwareinc.com, use this command: + +`Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com"` + +The ApplicableTo parameter is useful because it's possible that only some of the available per-user external access policies can be assigned to a given user. +This is due to the fact that different licensing agreements and different country/region restrictions might limit the policies that can be assigned to a user. +For example, if Ken Myer works in China, country/region restrictions might limit his access to policies A, B, D, and E, Meanwhile, similar restrictions might limit Pilar Ackerman, who works in the United States, to policies A, B, C, and F. +If you call Get-CsExternalAccessPolicy without using the ApplicableTo parameter you will get back a collection of all the available policies, including any policies that can't actually be assigned to a specific user. + +The ApplicableTo parameter applies only to Skype for Business Online. +This parameter is not intended for use with the on-premises version of Skype for Business Server 2015. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) +Type: UserIdParameter +Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -182,42 +190,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the external access policy data from the local replica of the Central Management store rather than from the Central Management store itself. +### -Identity +Unique Identity assigned to the policy when it was created. +External access policies can be assigned at the global, site, or per-user scope. +To refer to the global instance use this syntax: -Identity global. +To refer to a policy at the site scope, use this syntax: -Identity site:Redmond. +To refer to a policy at the per-user scope, use syntax similar to this: -Identity RedmondPolicy. -NOTE: This parameter is not used with Skype for Business Online. +Note that wildcard characters such as the asterisk (*) cannot be used with the Identity parameter. +To do a wildcard search for policies, use the Filter parameter instead. + +If neither the Identity nor Filter parameters are specified, then the Get-CsExternalAccessPolicy cmdlet will bring back a collection of all the external access policies configured for use in the organization. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity, (All) Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicableTo -Returns a list of the external access policies that can be assigned to the specified user. -For example, to return a collection of policies that can be assigned to the user kenmyer@litwareinc.com, use this command: - -`Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com"` +### -Include -The ApplicableTo parameter is useful because it's possible that only some of the available per-user external access policies can be assigned to a given user. -This is due to the fact that different licensing agreements and different country/region restrictions might limit the policies that can be assigned to a user. -For example, if Ken Myer works in China, country/region restrictions might limit his access to policies A, B, D, and E, Meanwhile, similar restrictions might limit Pilar Ackerman, who works in the United States, to policies A, B, C, and F. -If you call Get-CsExternalAccessPolicy without using the ApplicableTo parameter you will get back a collection of all the available policies, including any policies that can't actually be assigned to a specific user. +> Applicable: Microsoft Teams -The ApplicableTo parameter applies only to Skype for Business Online. -This parameter is not intended for use with the on-premises version of Skype for Business Server 2015. +PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly ```yaml -Type: UserIdParameter +Type: PolicyFilter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -226,14 +232,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Include -PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly +### -LocalStore +Retrieves the external access policy data from the local replica of the Central Management store rather than from the Central Management store itself. + +NOTE: This parameter is not used with Skype for Business Online. ```yaml -Type: PolicyFilter +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -243,13 +250,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -273,10 +282,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/Get-CsGroupPolicyAssignment.md similarity index 95% rename from teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsGroupPolicyAssignment.md index 015cc6cfd9..52014124dc 100644 --- a/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsGroupPolicyAssignment.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment -title: Get-CsGroupPolicyAssignment +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csgrouppolicyassignment schema: 2.0.0 +title: Get-CsGroupPolicyAssignment --- # Get-CsGroupPolicyAssignment @@ -147,8 +148,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment) -[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csgrouppolicyassignment) -[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsHybridTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Get-CsHybridTelephoneNumber.md new file mode 100644 index 0000000000..d7571f2051 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Get-CsHybridTelephoneNumber.md @@ -0,0 +1,219 @@ +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cshybridtelephonenumber +schema: 2.0.0 +title: Get-CsHybridTelephoneNumber +--- + +# Get-CsHybridTelephoneNumber + +## SYNOPSIS +This cmdlet displays information about one or more hybrid telephone numbers. + +## SYNTAX + +### Get1 (Default) +``` +Get-CsHybridTelephoneNumber [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### Get +``` +Get-CsHybridTelephoneNumber -TelephoneNumber [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity +``` +Get-CsHybridTelephoneNumber -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION + +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the **Get-CsPhoneNumberAssignment** cmdlet to display information about one or more phone numbers. Detailed instructions on how to use the new cmdlet can be found at [Get-CsPhoneNumberAssignment](/powershell/module/microsoftteams/get-csphonenumberassignment) + +This cmdlet displays information about one or more hybrid telephone numbers used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + +Returned results are sorted by telephone number in ascending order. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsHybridTelephoneNumber -TelephoneNumber 14025551234 +``` +```output +Id O365Region SourceType TargetType TelephoneNumber UserId +-- ---------- ---------- ---------- --------------- ------ +14025551234 NOAM Hybrid 14025551234 00000000-0000-0000-0000-000000000000 +``` +This example displays information about the phone number +1 (402) 555-1234. + +### Example 2 +```powershell +Get-CsHybridTelephoneNumber +``` +```output +Id O365Region SourceType TargetType TelephoneNumber UserId +-- ---------- ---------- ---------- --------------- ------ +14025551234 Hybrid 14025551234 +14025551235 Hybrid 14025551235 +``` +This example displays information about all hybrid telephone numbers in the tenant. Note that O365Region, TargetType, and UserId will not be populated. + +## PARAMETERS + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The identity parameter. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +Filters the returned results to a specific phone number. The number should be specified without a prefixed "+". The phone number can't have "tel:" prefixed. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES +The cmdlet is available in Teams PowerShell module 4.5.0 or later. + +The cmdlet is only available in GCC High and DoD cloud instances. + +## RELATED LINKS +[New-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/new-cshybridtelephonenumber) + +[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Get-CsInboundBlockedNumberPattern.md similarity index 86% rename from teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Get-CsInboundBlockedNumberPattern.md index bf831c5aa7..013c1438c8 100644 --- a/teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern applicable: Microsoft Teams -title: Get-CsInboundBlockedNumberPattern author: serdarsoysal -ms.author: serdars -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundblockednumberpattern schema: 2.0.0 +title: Get-CsInboundBlockedNumberPattern --- # Get-CsInboundBlockedNumberPattern @@ -89,8 +90,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundblockednumberpattern) -[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundblockednumberpattern) -[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Get-CsInboundExemptNumberPattern.md similarity index 83% rename from teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Get-CsInboundExemptNumberPattern.md index 9f59ffa49a..101c2289d8 100644 --- a/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern applicable: Microsoft Teams -title: Get-CsInboundExemptNumberPattern -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundexemptnumberpattern +schema: 2.0.0 +title: Get-CsInboundExemptNumberPattern --- # Get-CsInboundExemptNumberPattern @@ -96,12 +96,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable You can use Test-CsInboundBlockedNumberPattern to test your call block and exempt phone number ranges. ## RELATED LINKS -[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern) +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundexemptnumberpattern) -[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundexemptnumberpattern) -[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) -[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsMeetingMigrationStatus.md similarity index 88% rename from teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsMeetingMigrationStatus.md index 36129dc3a8..8f62227b79 100644 --- a/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsMeetingMigrationStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csmeetingmigrationstatus applicable: Microsoft Teams -title: Get-CsMeetingMigrationStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csmeetingmigrationstatus +schema: 2.0.0 +title: Get-CsMeetingMigrationStatus --- # Get-CsMeetingMigrationStatus @@ -27,14 +29,14 @@ You can use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of mee ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMeetingMigrationStatus -SummaryOnly ``` This example is used to get a summary status of all MMS migrations. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingMigrationStatus -Identity "ashaw@contoso.com" ``` @@ -43,46 +45,52 @@ This example gets the meeting migration status for user ashaw@contoso.com. ## PARAMETERS -### -Identity -Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. +### -EndTime + +> Applicable: Microsoft Teams + +Specifies the end date of the date range. ```yaml -Type: UserIdParameter +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StartTime -Specifies the start date of the date range. +### -Identity + +> Applicable: Microsoft Teams + +Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. ```yaml -Type: Object +Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EndTime -Specifies the end date of the date range. +### -StartTime + +> Applicable: Microsoft Teams + +Specifies the start date of the date range. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -91,14 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SummaryOnly -Specified that you want a summary status of MMS migrations returned. +### -State + +> Applicable: Microsoft Teams + +With this parameter you can filter by migration state. Possible values are: + +- Pending +- InProgress +- Failed +- Succeeded ```yaml -Type: SwitchParameter +Type: StateType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -107,19 +122,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -State -With this parameter you can filter by migration state. Possible values are: +### -SummaryOnly -- Pending -- InProgress -- Failed -- Succeeded +> Applicable: Microsoft Teams + +Specified that you want a summary status of MMS migrations returned. ```yaml -Type: StateType +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -158,8 +170,8 @@ where **MigrationType** can have the following values: - **AllToTeams** (All types to Teams) ## RELATED LINKS -[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration) +[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantmigrationconfiguration) -[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings) +[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantsettings) -[Start-CsExMeetingMigration](https://learn.microsoft.com/powershell/module/teams/start-csexmeetingmigration) +[Start-CsExMeetingMigration](https://learn.microsoft.com/powershell/module/microsoftteams/start-csexmeetingmigration) diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstance.md similarity index 84% rename from teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstance.md index c153103192..cbf2226874 100644 --- a/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance applicable: Microsoft Teams -title: Get-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstance +schema: 2.0.0 +title: Get-CsOnlineApplicationInstance --- # Get-CsOnlineApplicationInstance @@ -26,27 +27,27 @@ This cmdlet is used to get details of an application instance. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineApplicationInstance -Identity appinstance01@contoso.com ``` This example returns the application instance with identity "appinstance01@contoso.com". -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsOnlineApplicationInstance -Identities appinstance01@contoso.com,appinstance02@contoso.com ``` This example returns the application instance with identities "appinstance01@contoso.com" and "appinstance02@contoso.com". Query with multiple comma separated Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell Get-CsOnlineApplicationInstance -ResultSize 10 ``` This example returns the first 10 application instances. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell Get-CsOnlineApplicationInstance ``` @@ -55,46 +56,52 @@ This example returns the details of all application instances. ## PARAMETERS -### -Identity -The UPN or the object ID of the application instance to retrieve. If this parameter nor parameter Identities are not provided, it will retrieve all application instances in the tenant. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Identities -The UPNs or the object IDs of the application instances to retrieve, separated with comma. If this parameter nor parameter Identity are not provided, it will retrieve all application instances in the tenant. +### -Force + +> Applicable: Microsoft Teams + +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ResultSize -The result size for bulk get. This parameter is currently not working. +### -Identities + +> Applicable: Microsoft Teams + +The UPNs or the object IDs of the application instances to retrieve, separated with comma. If this parameter nor parameter Identity are not provided, it will retrieve all application instances in the tenant. ```yaml -Type: System.Int32 +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,14 +110,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Skip -Skips the first specified number of returned results. The default value is 0. This parameter is currently not working. +### -Identity + +> Applicable: Microsoft Teams + +The UPN or the object ID of the application instance to retrieve. If this parameter nor parameter Identities are not provided, it will retrieve all application instances in the tenant. ```yaml -Type: System.Int32 +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,47 +128,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. +### -ResultSize + +> Applicable: Microsoft Teams + +The result size for bulk get. This parameter is currently not working. ```yaml -Type: SwitchParameter +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Skip + +> Applicable: Microsoft Teams + +Skips the first specified number of returned results. The default value is 0. This parameter is currently not working. ```yaml -Type: SwitchParameter +Type: System.Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -179,10 +194,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) -[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/sync-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation.md similarity index 81% rename from teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation.md index f837f328ee..20eaa4837f 100644 --- a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation applicable: Microsoft Teams -title: Get-CsOnlineApplicationInstanceAssociation -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation +schema: 2.0.0 +title: Get-CsOnlineApplicationInstanceAssociation --- # Get-CsOnlineApplicationInstanceAssociation @@ -26,7 +28,7 @@ Use the Get-CsOnlineApplicationInstanceAssociation cmdlet to get information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineApplicationInstanceAssociation -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` @@ -36,13 +38,15 @@ This example gets the association object for the application instance that has t ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the application instance whose association is to be retrieved. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -53,11 +57,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -82,8 +87,8 @@ The Get-CsOnlineApplicationInstanceAssociation cmdlet accepts a string as the Id ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus) -[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation) -[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus.md similarity index 82% rename from teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus.md index bf4db93e15..6a4565478e 100644 --- a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus applicable: Microsoft Teams -title: Get-CsOnlineApplicationInstanceAssociationStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus +schema: 2.0.0 +title: Get-CsOnlineApplicationInstanceAssociationStatus --- # Get-CsOnlineApplicationInstanceAssociationStatus @@ -26,7 +28,7 @@ Use the Get-CsOnlineApplicationInstanceAssociationStatus cmdlet to get provision ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineApplicationInstanceAssociationStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` @@ -36,13 +38,15 @@ This example gets the provisioning status for the association object of the appl ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the application instance whose association provisioning status is to be retrieved. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -53,11 +57,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -82,8 +87,8 @@ The Get-CsOnlineApplicationInstanceAssociationStatus cmdlet accepts a string as ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation) -[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation) -[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioConferencingRoutingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioConferencingRoutingPolicy.md index e2a5e510e0..2b7bfa2a75 100644 --- a/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,120 +1,121 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudioconferencingroutingpolicy -title: Get-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# Get-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet retrieves all online audio conferencing routing policies for the tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsOnlineAudioConferencingRoutingPolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## DESCRIPTION - -Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. - -To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." - -The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. - -Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsOnlineAudioConferencingRoutingPolicy -``` - -Retrieves all Online Audio Conferencing Routing Policy instances - -## PARAMETERS - -### -Filter - -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the Online Audio Conferencing Routing Policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) -[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) -[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) -[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Get-CsOnlineAudioConferencingRoutingPolicy +--- + +# Get-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet retrieves all online audio conferencing routing policies for the tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +```powershell +Get-CsOnlineAudioConferencingRoutingPolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsOnlineAudioConferencingRoutingPolicy +``` + +Retrieves all Online Audio Conferencing Routing Policy instances + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Get-CsOnlineAudioFile.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioFile.md similarity index 82% rename from teams/teams-ps/teams/Get-CsOnlineAudioFile.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioFile.md index 65d7fc94b4..01c4a767fc 100644 --- a/teams/teams-ps/teams/Get-CsOnlineAudioFile.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioFile.md @@ -1,14 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile applicable: Microsoft Teams -title: Get-CsOnlineAudioFile -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: - +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineaudiofile +schema: 2.0.0 +title: Get-CsOnlineAudioFile --- # Get-CsOnlineAudioFile @@ -18,8 +17,9 @@ Returns information about a specific or all uploaded audio files of a given appl ## SYNTAX -```powershell -Get-CsOnlineAudioFile [[-Identity] ] [-ApplicationId ] [] +``` +Get-CsOnlineAudioFile [-Identity ] [-ApplicationId ] [-HttpPipelinePrepend ] + [] ``` ## DESCRIPTION @@ -81,7 +81,7 @@ Supported values: - TenantGlobal ```yaml -Type: System.string +Type: System.String Parameter Sets: (All) Aliases: @@ -92,6 +92,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The Id of the specific audio file that you would like to see information about. If you are only specifying -Identity, the -ApplicationId it is assumed to be TenantGlobal. @@ -103,13 +118,14 @@ Parameter Sets: (All) Aliases: Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -125,8 +141,8 @@ The cmdlet is available in Teams PS module 2.4.0-preview or later. If you call the cmdlet without having uploaded any audio files, with a non-existing Identity or with an illegal ApplicationId, you will receive a generic error message. In addition, the ApplicationId is case sensitive. ## RELATED LINKS -[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile) +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/export-csonlineaudiofile) -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) -[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineaudiofile) diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge.md index 8668124a9a..0d209da0de 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingBridge -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingBridge --- # Get-CsOnlineDialInConferencingBridge @@ -41,14 +43,14 @@ However, if the PSTN conferencing service status of the tenant is Disabled, no r ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineDialInConferencingBridge | fl ``` This example shows how to return all of the audio conferencing bridges that are being used and returns the results in a formatted list. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsOnlineDialInConferencingBridge -Tenant 26efe125-c070-46f9-8ed0-fc02165a167c ``` @@ -57,30 +59,47 @@ This example shows how to return all of the audio conferencing bridges for the g ## PARAMETERS -### -Identity -Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. +### -DomainController + +> Applicable: Skype for Business Online + +Specifies the domain controller that's used by the cmdlet to read or write the specified data. +Valid inputs for this parameter include: + +Fully qualified domain name (FQDN): + +`-DomainController atl-cs-001.Contoso.com` + +Computer name: + +`-DomainController atl-cs-001` + +This parameter is reserved for internal Microsoft use. ```yaml -Type: Guid +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: DC Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Specifies the name of the audio conferencing bridge. +### -Force + +> Applicable: Skype for Business Online + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -89,43 +108,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter include: - -Fully qualified domain name (FQDN): +### -Identity -`-DomainController atl-cs-001.Contoso.com` +> Applicable: Skype for Business Online -Computer name: - -`-DomainController atl-cs-001` - -This parameter is reserved for internal Microsoft use. +Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. ```yaml -Type: Fqdn +Type: Guid Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Name + +> Applicable: Skype for Business Online + +Specifies the name of the audio conferencing bridge. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -135,13 +145,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -151,13 +163,15 @@ Accept wildcard characters: False ``` ### -TenantDomain + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported.md similarity index 95% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported.md index b8c773dd60..1fefa9da95 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinglanguagessupported applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingLanguagesSupported -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinglanguagessupported +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingLanguagesSupported --- # Get-CsOnlineDialInConferencingLanguagesSupported @@ -30,7 +32,7 @@ When no languages are specified for a dial-in service number it will get the set ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineDialInConferencingLanguagesSupported | fl ``` @@ -40,6 +42,9 @@ This example allows returns the list of supported languages when you are using M ## PARAMETERS ### -DomainController + +> Applicable: Skype for Business Online + Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter include: @@ -51,7 +56,6 @@ Computer name: `-DomainController atl-cs-001` Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online Required: False Position: Named @@ -61,6 +65,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -69,7 +76,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber.md index daa9adb621..8818af882e 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingservicenumber applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingServiceNumber -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingServiceNumber --- # Get-CsOnlineDialInConferencingServiceNumber @@ -54,21 +56,21 @@ A tenant administrator can only retrieve and view information that is associated ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialInConferencingServiceNumber | fl ``` This example returns all of the default service numbers for an organization in a formatted list. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineDialInConferencingServiceNumber -BridgeId 72dfe128-d079-46f8-8tr0-gb12369p167c | fl ``` This example returns all of the default service numbers for a specified audio conferencing bridge in a formatted list. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOnlineDialInConferencingBridge -Name "Conference Bridge" ``` @@ -78,6 +80,9 @@ This example returns all of the default service numbers for the audio conferenci ## PARAMETERS ### -BridgeId + +> Applicable: Microsoft Teams + Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. When it's used it returns all of the service numbers that are configured on the audio conferencing bridge. @@ -85,7 +90,6 @@ When it's used it returns all of the service numbers that are configured on the Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -94,30 +98,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the default dial-in service number string. +### -BridgeName + +> Applicable: Microsoft Teams + +Specifies the name of the audio conferencing bridge. +When it is used it returns all of the service numbers that are configured on the audio conferencing bridge. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -City + +> Applicable: Microsoft Teams + +Specifies the city geocode to be used. +When used it lists all of the service numbers for a specific city geocode. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -126,14 +136,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantDomain -This parameter is reserved for internal Microsoft use. +### -DomainController + +> Applicable: Microsoft Teams + +Specifies the domain controller that's used by the cmdlet to read or write the specified data. +Valid inputs for this parameter include: + +Fully qualified domain name (FQDN): `-DomainController atl-cs-001.Contoso.com.` + +Computer name: `-DomainController atl-cs-001` ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False Position: Named @@ -142,15 +159,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeName -Specifies the name of the audio conferencing bridge. -When it is used it returns all of the service numbers that are configured on the audio conferencing bridge. +### -Force + +> Applicable: Microsoft Teams + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -159,36 +179,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -City -Specifies the city geocode to be used. -When used it lists all of the service numbers for a specific city geocode. +### -Identity + +> Applicable: Microsoft Teams + +Specifies the default dial-in service number string. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter include: +### -ResultSize -Fully qualified domain name (FQDN): `-DomainController atl-cs-001.Contoso.com.` +> Applicable: Microsoft Teams -Computer name: `-DomainController atl-cs-001` +Specifies the number of records returned by the cmdlet. +For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. +Note that there is no way to guarantee which seven users will be returned. + +The result size can be set to any whole number between 0 and 2147483647, inclusive. +If set to 0 the command will run, but no data will be returned. +If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error. ```yaml -Type: Fqdn +Type: Int32 Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -197,16 +221,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Tenant + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -215,20 +239,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResultSize -Specifies the number of records returned by the cmdlet. -For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. -Note that there is no way to guarantee which seven users will be returned. +### -TenantDomain -The result size can be set to any whole number between 0 and 2147483647, inclusive. -If set to 0 the command will run, but no data will be returned. -If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error. +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings.md index 5f1ea406de..7e4eda4d45 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingTenantSettings -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantsettings +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingTenantSettings --- # Get-CsOnlineDialInConferencingTenantSettings @@ -33,7 +35,7 @@ Get-CsOnlineDialInConferencingTenantSettings [-Tenant ] [-Filter ] ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialInConferencingTenantSettings ``` @@ -43,13 +45,15 @@ This example returns the global setting for the tenant administrator's organizat ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -59,13 +63,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -75,13 +81,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Microsoft Teams + Retrieves the settings from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -91,13 +99,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingUser.md similarity index 93% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingUser.md index 7c7a3686cb..c99c0c891a 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingUser.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencinguser applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingUser -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencinguser +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingUser --- # Get-CsOnlineDialInConferencingUser @@ -43,7 +45,7 @@ The see a list of users with conferencing providers other than Microsoft use the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineDialInConferencingUser -Identity Ken.Myer@contoso.com ``` @@ -54,6 +56,8 @@ This example uses the User Principal Name (UPN) to retrieve the BridgeID and Ser ### -BridgeId +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. @@ -62,7 +66,6 @@ Specifies the globally-unique identifier (GUID) for the audio conferencing bridg Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -73,6 +76,8 @@ Accept wildcard characters: False ### -BridgeName +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. Specifies the name for the audio conferencing bridge. @@ -81,7 +86,6 @@ Specifies the name for the audio conferencing bridge. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -90,37 +94,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the user to retrieve. -The user can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -DomainController -### -ServiceNumber +> Applicable: Microsoft Teams *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. -Specifies a service number to serve as a filter for the returned user collection. -Only users who have been assigned the specified number will be returned. -The service number can be specified in the following formats: E.164 number, +\ and tel:\. +This parameter is reserved for internal Microsoft use. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False Position: Named @@ -129,17 +114,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -Force + +> Applicable: Microsoft Teams *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. -This parameter is reserved for internal Microsoft use. +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -148,22 +136,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -Identity -*This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. +> Applicable: Microsoft Teams -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +Specifies the user to retrieve. +The user can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +You can also reference a user account by using the user's Active Directory distinguished name. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -171,6 +158,8 @@ Accept wildcard characters: False ### -LdapFilter +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). @@ -182,7 +171,6 @@ For example, a filter that returns only users who work in the city of Redmond wo Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -192,6 +180,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + Enables you to limit the number of records returned by the cmdlet. For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven users will be returned. @@ -203,7 +194,28 @@ If you set the ResultSize to 7 but you have only three users in your forest, the Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceNumber + +> Applicable: Microsoft Teams + +*This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. + +Specifies a service number to serve as a filter for the returned user collection. +Only users who have been assigned the specified number will be returned. +The service number can be specified in the following formats: E.164 number, +\ and tel:\. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -214,6 +226,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. NOTE: This parameter is reserved for internal Microsoft use. @@ -228,7 +242,6 @@ You can find your tenant ID by running this command: Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -239,6 +252,8 @@ Accept wildcard characters: False ### -TenantDomain +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. This parameter is reserved for internal Microsoft use. @@ -247,7 +262,6 @@ This parameter is reserved for internal Microsoft use. Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -268,4 +282,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineDialInConferencingUser](https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencinguser) +[Set-CsOnlineDialInConferencingUser](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinedialinconferencinguser) diff --git a/teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialOutPolicy.md similarity index 94% rename from teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialOutPolicy.md index 050f8fa643..f111b18c50 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialOutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialoutpolicy applicable: Microsoft Teams -title: Get-CsOnlineDialOutPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialoutpolicy +schema: 2.0.0 +title: Get-CsOnlineDialOutPolicy --- # Get-CsOnlineDialOutPolicy @@ -97,4 +98,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Grant-CsDialoutPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csdialoutpolicy) +[Grant-CsDialoutPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csdialoutpolicy) diff --git a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy.md index 44a0e83fd6..4b32244b79 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingpolicy applicable: Microsoft Teams -title: Get-CsOnlineDialinConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingpolicy +schema: 2.0.0 +title: Get-CsOnlineDialinConferencingPolicy --- # Get-CsOnlineDialinConferencingPolicy @@ -32,7 +34,7 @@ Retrieves the available Dial-in Conferencing policies in the tenant. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialinConferencingPolicy ``` @@ -42,13 +44,15 @@ This example retrieves all the available Dial in Conferencing policies in the te ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -58,13 +62,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + A unique identifier specifying the scope and, in some cases the name, of the policy. If this parameter is omitted, all policies for the organization are returned. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -74,13 +80,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Microsoft Teams + Reserved for Microsoft Internal use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration.md index 7c1dbe713c..3943604e5f 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantconfiguration applicable: Microsoft Teams -title: Get-CsOnlineDialinConferencingTenantConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantconfiguration +schema: 2.0.0 +title: Get-CsOnlineDialinConferencingTenantConfiguration --- # Get-CsOnlineDialinConferencingTenantConfiguration ## SYNOPSIS Use the Get-CsOnlineDialinConferencingTenantConfiguration cmdlet to retrieve the tenant level configuration for dial-in conferencing. -The dial-in conferencing configuration specifies if dial-in conferencing is enabled for the tenant. ## SYNTAX @@ -42,7 +43,7 @@ There is one configuration per tenant. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialinConferencingTenantConfiguration ``` @@ -52,13 +53,15 @@ This example returns the configuration for the tenant administrator's organizati ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Microsoft Teams + Retrieves the configuration from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDirectoryTenant.md similarity index 90% rename from teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDirectoryTenant.md index 35a0ee1afb..62f8a563ef 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDirectoryTenant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedirectorytenant applicable: Microsoft Teams -title: Get-CsOnlineDirectoryTenant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedirectorytenant +schema: 2.0.0 +title: Get-CsOnlineDirectoryTenant --- # Get-CsOnlineDirectoryTenant @@ -28,7 +30,7 @@ Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve tenant parameters like An ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDirectoryTenant -Tenant 7a205197-8e59-487d-b9fa-3fc1b108f1e5 ``` @@ -38,13 +40,15 @@ This example returns the tenant specified by GUID. ## PARAMETERS ### -Confirm + +> Applicable: Microsoft Teams + The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -54,6 +58,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. @@ -61,7 +68,6 @@ Valid inputs for this parameter are either the fully qualified domain name (FQDN Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -71,6 +77,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -79,7 +88,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -89,6 +97,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. For example: @@ -102,7 +113,6 @@ You can find your tenant ID by running this command: Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -112,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -119,7 +132,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named @@ -143,4 +155,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber) +[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md similarity index 87% rename from teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md index 4c7b04e076..104817dfbf 100644 --- a/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineenhancedemergencyservicedisclaimer applicable: Microsoft Teams -title: Get-CsOnlineEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Get-CsOnlineEnhancedEmergencyServiceDisclaimer --- # Get-CsOnlineEnhancedEmergencyServiceDisclaimer @@ -26,7 +28,7 @@ You can use this cmdlet to determine whether your organization has accepted the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion "US" ``` @@ -36,6 +38,9 @@ This example returns your organization's enhanced emergency service terms and co ## PARAMETERS ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies the region or country whose terms and conditions you wish to verify. The United States is currently the only country supported, but it must be specified as "US". @@ -43,7 +48,6 @@ The United States is currently the only country supported, but it must be specif Type: CountryInfo Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -53,13 +57,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -69,6 +75,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -77,7 +86,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -87,13 +95,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +113,15 @@ Accept wildcard characters: False ``` ### -Version + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -132,4 +144,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/teams/set-csonlineenhancedemergencyservicedisclaimer) +[Set-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineenhancedemergencyservicedisclaimer) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisCivicAddress.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisCivicAddress.md index 3a889df518..565c55536e 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisCivicAddress.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress applicable: Microsoft Teams -title: Get-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliscivicaddress +schema: 2.0.0 +title: Get-CsOnlineLisCivicAddress --- # Get-CsOnlineLisCivicAddress @@ -46,6 +47,8 @@ This example returns all the civic addresses in the city of Seattle. ### -AssignmentStatus +> Applicable: Microsoft Teams + **Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. Specifies whether the retrieved addresses have been assigned to users or not. @@ -55,7 +58,6 @@ Valid inputs are "Assigned", or "Unassigned". Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -65,13 +67,15 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Microsoft Teams + Specifies the city of the target civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -81,13 +85,15 @@ Accept wildcard characters: False ``` ### -CivicAddressId + +> Applicable: Microsoft Teams + Specifies the identity of the civic address to return. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -97,13 +103,15 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies the country or region of the target civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -113,13 +121,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the target civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -129,6 +139,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -137,7 +150,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -147,13 +159,15 @@ Accept wildcard characters: False ``` ### -LocationId + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -163,6 +177,9 @@ Accept wildcard characters: False ``` ### -NumberOfResultsToSkip + +> Applicable: Microsoft Teams + Specifies the number of results to skip. If there are a large number of civic addresses, you can limit the number of results by using the ResultSize parameter. If you limited the first cmdlet execution to 25 results, and want to look at the next 25 locations, then you leave ResultSize at 25 and set NumberOfResultsToSkip to 25 to omit the first 25 you've reviewed. @@ -174,7 +191,6 @@ For example the command below will return civic addresses 26-50 for Seattle. Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -184,13 +200,15 @@ Accept wildcard characters: False ``` ### -PopulateNumberOfTelephoneNumbers + +> Applicable: Microsoft Teams + If present, the PopulateNumberOfTelephoneNumbers switch causes the cmdlet to provide the number of phone numbers at the returned addresses. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -200,13 +218,15 @@ Accept wildcard characters: False ``` ### -PopulateNumberOfVoiceUsers + +> Applicable: Microsoft Teams + If present, the PopulateNumberOfVoiceUsers switch causes the cmdlet to provide the number of voice users at the returned addresses. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -216,13 +236,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + Specifies the maximum number of results to return. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -232,6 +254,9 @@ Accept wildcard characters: False ``` ### -ValidationStatus + +> Applicable: Microsoft Teams + Specifies the validation status of the addresses to be returned. Valid inputs are: Valid, Invalid, and Notvalidated. @@ -239,7 +264,6 @@ Valid inputs are: Valid, Invalid, and Notvalidated. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -258,8 +282,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliscivicaddress) -[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineliscivicaddress) -[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisLocation.md similarity index 90% rename from teams/teams-ps/teams/Get-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisLocation.md index 2fb1346e9a..27d43f95e0 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation applicable: Microsoft Teams -title: Get-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelislocation +schema: 2.0.0 +title: Get-CsOnlineLisLocation --- # Get-CsOnlineLisLocation @@ -79,69 +80,57 @@ This example returns the information on one location specified by its unique ide ## PARAMETERS -### -CivicAddressId -Specifies the identification number of the civic address that is associated with the target locations. +### -AssignmentStatus -```yaml -Type: Guid -Parameter Sets: UseCivicAddressId -Aliases: -Applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. -### -Location -Specifies an administrator defined description of the location to retrieve. -For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". +Specifies whether the retrieved locations have been assigned to users or not. +Valid inputs are "Assigned", or "Unassigned". ```yaml Type: String -Parameter Sets: UseLocation +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AssignmentStatus +### -City -**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. +> Applicable: Microsoft Teams -Specifies whether the retrieved locations have been assigned to users or not. -Valid inputs are "Assigned", or "Unassigned". +Specifies the city of the target location. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -City -Specifies the city of the target location. +### -CivicAddressId + +> Applicable: Microsoft Teams + +Specifies the identification number of the civic address that is associated with the target locations. ```yaml -Type: String -Parameter Sets: (All) +Type: Guid +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True @@ -149,13 +138,15 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies the country or region of the target location. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -165,13 +156,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the civic address that is associated with the target locations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -181,6 +174,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -189,7 +185,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -198,14 +193,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Location + +> Applicable: Microsoft Teams + +Specifies an administrator defined description of the location to retrieve. +For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". + +```yaml +Type: String +Parameter Sets: UseLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocationId + +> Applicable: Microsoft Teams + Specifies the unique identifier of the target location. ```yaml Type: Guid Parameter Sets: UseLocationId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -215,6 +231,9 @@ Accept wildcard characters: False ``` ### -NumberOfResultsToSkip + +> Applicable: Microsoft Teams + Specifies the number of results to skip. If there are a large number of locations, you can limit the number of results by using the ResultSize parameter. If you limited the first cmdlet execution to 25 results, and want to look at the next 25 locations, then you leave ResultSize at 25 and set NumberOfResultsToSkip to 25 to omit the first 25 you've reviewed. @@ -226,7 +245,6 @@ For example the command below will return locations 26-50 for Seattle. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -236,13 +254,15 @@ Accept wildcard characters: False ``` ### -PopulateNumberOfTelephoneNumbers + +> Applicable: Microsoft Teams + If present, the PopulateNumberOfTelephoneNumbers switch causes the cmdlet to provide the number of telephone numbers at the returned locations. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -252,13 +272,15 @@ Accept wildcard characters: False ``` ### -PopulateNumberOfVoiceUsers + +> Applicable: Microsoft Teams + If present, the PopulateNumberOfVoiceUsers switch causes the cmdlet to provide the number of voice users at the returned locations. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -268,13 +290,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + Specifies the maximum number of results to return. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -284,6 +308,9 @@ Accept wildcard characters: False ``` ### -ValidationStatus + +> Applicable: Microsoft Teams + Specifies the validation status of the addresses to be returned. Valid inputs are: Validated, Invalid, and Notvalidated. @@ -291,7 +318,6 @@ Valid inputs are: Validated, Invalid, and Notvalidated. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -309,14 +335,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Returns an instance, or instances of emergency location objects. +### PSObject +Returns an instance, or instances of emergency location objects. ## NOTES ## RELATED LINKS -[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelislocation) -[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinelislocation) -[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelislocation) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisPort.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisPort.md similarity index 85% rename from teams/teams-ps/teams/Get-CsOnlineLisPort.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisPort.md index 190850463c..e08da26adc 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisPort.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisPort.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport applicable: Microsoft Teams -title: Get-CsOnlineLisPort -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisport +schema: 2.0.0 +title: Get-CsOnlineLisPort --- # Get-CsOnlineLisPort ## SYNOPSIS -Retrieves one or more ports from the location configuration database. Each port can be associated with a location, in which case this cmdlet will also retrieve the location information of the ports. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. +Retrieves one or more ports from the location configuration database. ## SYNTAX @@ -21,6 +22,8 @@ Get-CsOnlineLisPort [[-ChassisID] ] [-Force] [-IsDebug ] [-NCSApiU ``` ## DESCRIPTION +Each port can be associated with a location, in which case this cmdlet will also retrieve the location information of the ports. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + Enhanced 9-1-1 allows an emergency operator to identify the location of a caller without having to ask the caller for that information. In the case where a caller is calling from a Voice over Internet Protocol (VoIP) connection, that information must be extracted based on various connection factors. The VoIP administrator must configure a location map (called a wiremap) that will determine a caller's location. This cmdlet retrieves information on associations between physical locations and the port through which the client is connected. ## EXAMPLES @@ -53,13 +56,15 @@ Example 2 retrieves the location information for port G1/0/30 with ChassisID B8- ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -69,6 +74,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -77,7 +85,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -87,13 +94,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +112,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +130,15 @@ Accept wildcard characters: False ``` ### -PortID + +> Applicable: Microsoft Teams + This parameter identifies the ID of the port. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -135,13 +148,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -167,6 +182,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport) +[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisport) -[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport) +[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisport) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSubnet.md similarity index 82% rename from teams/teams-ps/teams/Get-CsOnlineLisSubnet.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSubnet.md index 7aff6725b1..a0afbc412e 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSubnet.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelissubnet applicable: Microsoft Teams -title: Get-CsOnlineLisSubnet -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelissubnet +schema: 2.0.0 +title: Get-CsOnlineLisSubnet --- # Get-CsOnlineLisSubnet ## SYNOPSIS -Retrieves one or more subnets from the location configuration database. Each subnet can be associated with a location, in which case this cmdlet will also retrieve the location information of the subnets. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. +Retrieves one or more subnets from the location configuration database. ## SYNTAX @@ -22,27 +23,29 @@ Get-CsOnlineLisSubnet [[-TenantId] ] [[-Subnet] ] [-IsDebug Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -60,7 +66,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -70,13 +75,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -86,13 +93,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -102,13 +111,15 @@ Accept wildcard characters: False ``` ### -Subnet + +> Applicable: Microsoft Teams + The IP address of the subnet. This value can be either IPv4 or IPv6 format. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -118,13 +129,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -134,13 +147,15 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 diff --git a/teams/teams-ps/teams/Get-CsOnlineLisSwitch.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSwitch.md similarity index 84% rename from teams/teams-ps/teams/Get-CsOnlineLisSwitch.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSwitch.md index c5be65a3ec..02432b310f 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisSwitch.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSwitch.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch applicable: Microsoft Teams -title: Get-CsOnlineLisSwitch -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisswitch +schema: 2.0.0 +title: Get-CsOnlineLisSwitch --- # Get-CsOnlineLisSwitch ## SYNOPSIS -Retrieves one or more network switches from the location configuration database. Each switch can be associated with a location, in which case this cmdlet will also retrieve the location information of the switches. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. +Retrieves one or more network switches from the location configuration database. ## SYNTAX @@ -21,6 +22,8 @@ Get-CsOnlineLisSwitch [[-ChassisID] ] [-Force] [-IsDebug ] [-NCSAp ``` ## DESCRIPTION +Each switch can be associated with a location, in which case this cmdlet will also retrieve the location information of the switches. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + Enhanced 9-1-1 allows an emergency operator to identify the location of a caller without having to ask the caller for that information. In the case where a caller is calling from a Voice over Internet Protocol (VoIP) connection, that information must be extracted based on various connection factors. The VoIP administrator must configure a location map (called a wiremap) that will determine a caller's location. This cmdlet retrieves information on associations between physical locations and the network switch through which the client is connected. ## EXAMPLES @@ -53,13 +56,15 @@ Example 2 retrieves Location Information Server (LIS) switch "B8-BE-BF-4A-A3-00" ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -69,6 +74,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -77,7 +85,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -87,13 +94,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +112,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +130,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -151,6 +164,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch) +[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisswitch) -[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch) +[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisswitch) diff --git a/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint.md similarity index 87% rename from teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint.md index a8526f7ab2..2151a67375 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint applicable: Microsoft Teams -title: Get-CsOnlineLisWirelessAccessPoint -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliswirelessaccesspoint +schema: 2.0.0 +title: Get-CsOnlineLisWirelessAccessPoint --- # Get-CsOnlineLisWirelessAccessPoint ## SYNOPSIS -Retrieves one or more wireless access points (WAPs) from the location configuration database. Each WAP can be associated with a location, in which case this cmdlet will also retrieve the location information of the WAPs. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. +Retrieves one or more wireless access points (WAPs) from the location configuration database. ## SYNTAX @@ -21,6 +22,8 @@ Get-CsOnlineLisWirelessAccessPoint [[-BSSID] ] [-Force] [-IsDebug ``` ## DESCRIPTION +Each WAP can be associated with a location, in which case this cmdlet will also retrieve the location information of the WAPs. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + Enhanced 9-1-1 allows an emergency operator to identify the location of a caller without having to ask the caller for that information. In the case where a caller is calling from a Voice over Internet Protocol (VoIP) connection, that information must be extracted based on various connection factors. The VoIP administrator must configure a location map (called a wiremap) that will determine a caller's location. This cmdlet retrieves information on associations between physical locations and the WAP through which the client is connected. The BSSID (Basic Service Set Identifiers) is used to describe sections of a wireless local area network. It is the MAC of the 802.11 side of the access point. The BSSID parameter in this command also supports the wildcard format to cover all BSSIDs in the range which are sharing the same description and Location ID. The wildcard '*' can be on either the last one or two character(s). @@ -82,13 +85,15 @@ Example 4 retrieves Location Information Server (LIS) wireless access point "F0- ## PARAMETERS ### -BSSID + +> Applicable: Microsoft Teams + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. It can be presented in wildcard format. The wildcard '*' can be on either the last one or two character(s). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -106,7 +114,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -178,6 +191,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint) +[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliswirelessaccesspoint) -[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint) +[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliswirelessaccesspoint) diff --git a/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePSTNGateway.md similarity index 88% rename from teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlinePSTNGateway.md index c7574f56ce..5ac8b1b2a6 100644 --- a/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePSTNGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway applicable: Microsoft Teams -title: Get-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstngateway +schema: 2.0.0 +title: Get-CsOnlinePSTNGateway --- # Get-CsOnlinePSTNGateway @@ -50,11 +51,12 @@ This example selects all SBCs with identities matching the pattern *.contoso.com ### -Filter +> Applicable: Microsoft Teams + ```yaml Type: String Parameter Sets: Filter Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -63,13 +65,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The parameter is optional for the cmdlet. If not set all SBCs paired to the tenant are listed. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -92,8 +96,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstngateway) -[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinepstngateway) -[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinepstngateway) diff --git a/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePstnUsage.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlinePstnUsage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlinePstnUsage.md index c70a50caf0..ce8422aba9 100644 --- a/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePstnUsage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstnusage applicable: Microsoft Teams -title: Get-CsOnlinePstnUsage -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstnusage +schema: 2.0.0 +title: Get-CsOnlinePstnUsage --- # Get-CsOnlinePstnUsage @@ -34,7 +35,7 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CSOnlinePSTNUsage ``` @@ -87,4 +88,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstnusage) +[Set-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstnusage) diff --git a/teams/teams-ps/teams/Get-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSchedule.md similarity index 83% rename from teams/teams-ps/teams/Get-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineSchedule.md index 9b0227da05..0e9015c94b 100644 --- a/teams/teams-ps/teams/Get-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule applicable: Microsoft Teams -title: Get-CsOnlineSchedule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineschedule +schema: 2.0.0 +title: Get-CsOnlineSchedule --- # Get-CsOnlineSchedule @@ -26,14 +28,14 @@ The Get-CsOnlineSchedule cmdlet returns information about the schedules in your ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineSchedule ``` This example retrieves all schedules that belong to your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineSchedule -Id "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` @@ -43,13 +45,15 @@ This example gets the schedules that has the Id of f7a821dc-2d69-5ae8-8525-bcb4a ## PARAMETERS ### -Id + +> Applicable: Microsoft Teams + The Id for the schedule to be retrieved. If this parameter is not specified, then all schedules in the organization are returned. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 @@ -74,8 +78,8 @@ The Get-CsOnlineSchedule cmdlet accepts a string as the Id parameter. ## RELATED LINKS -[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange) +[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetimerange) -[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange) +[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedatetimerange) -[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) diff --git a/teams/teams-ps/teams/Get-CsOnlineSipDomain.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSipDomain.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlineSipDomain.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineSipDomain.md index 0627f86a2a..961b5276b3 100644 --- a/teams/teams-ps/teams/Get-CsOnlineSipDomain.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSipDomain.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain applicable: Microsoft Teams -title: Get-CsOnlineSipDomain -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinesipdomain +schema: 2.0.0 +title: Get-CsOnlineSipDomain --- # Get-CsOnlineSipDomain @@ -43,13 +45,15 @@ List all disabled online SIP domains in the tenant. ## PARAMETERS ### -Domain + +> Applicable: Microsoft Teams + A specific domain to get the status of. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -88,8 +92,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain) +[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/disable-csonlinesipdomain) -[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/enable-csonlinesipdomain) +[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/microsoftteams/enable-csonlinesipdomain) [Cloud consolidation for Teams and Skype for Business](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumber.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumber.md index 0fced81daf..f0d5299be4 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber applicable: Microsoft Teams -title: Get-CsOnlineTelephoneNumber -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumber +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumber --- # Get-CsOnlineTelephoneNumber @@ -15,8 +16,6 @@ ms.reviewer: ## SYNOPSIS Use the `Get-CsOnlineTelephoneNumber` to retrieve telephone numbers from the Business Voice Directory. -**Note**: This cmdlet has been deprecated. Use the new [Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) cmdlet instead. For Microsoft 365 GCC High and DoD cloud instances use the new [Get-CshybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber) cmdlet instead. - ## SYNTAX ``` @@ -24,19 +23,22 @@ Get-CsOnlineTelephoneNumber [-ActivationState ] [-Assigned Get-CsOnlineTelephoneNumber -TelephoneNumber 19294450177 ``` This example gets the attributes of a specific phone number. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineTelephoneNumber -CapitalOrMajorCity NOAM-US-NY-NY ``` @@ -82,13 +84,15 @@ This example gets the phone numbers with the city code designating New York, New ## PARAMETERS ### -ActivationState + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -Assigned + +> Applicable: Microsoft Teams + Specifies the function of the telephone number. The acceptable values are: @@ -111,7 +118,6 @@ The values for the Assigned parameter are case-sensitive. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -121,6 +127,9 @@ Accept wildcard characters: False ``` ### -CapitalOrMajorCity + +> Applicable: Microsoft Teams + Specifies the city by a concatenated string in the form: region-country-area-city. For example, "NOAM-US-OR-PO" would specify Portland, Oregon. @@ -130,7 +139,6 @@ The values for the CapitalOrMajorCity parameter are case-sensitive. Type: String Parameter Sets: (All) Aliases: CityCode -applicable: Microsoft Teams Required: False Position: Named @@ -140,13 +148,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -156,13 +166,15 @@ Accept wildcard characters: False ``` ### -ExpandLocation + +> Applicable: Microsoft Teams + Displays the location parameter with its value. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -172,6 +184,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -180,7 +195,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -190,6 +204,9 @@ Accept wildcard characters: False ``` ### -InventoryType + +> Applicable: Microsoft Teams + Specifies the target telephone number type for the cmdlet. Acceptable values are: @@ -203,7 +220,6 @@ The values for the InventoryType parameter are case-sensitive. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -213,13 +229,15 @@ Accept wildcard characters: False ``` ### -IsNotAssigned + +> Applicable: Microsoft Teams + Specifying this switch parameter will return only telephone numbers which are not assigned. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -229,6 +247,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + Specifies the number of records returned by the cmdlet. The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0, the command will run, but no data will be returned. @@ -237,7 +258,6 @@ If set to 0, the command will run, but no data will be returned. Type: UInt32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -247,6 +267,9 @@ Accept wildcard characters: False ``` ### -TelephoneNumber + +> Applicable: Microsoft Teams + Specifies the target telephone number. For example: @@ -256,7 +279,6 @@ For example: Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -266,6 +288,9 @@ Accept wildcard characters: False ``` ### -TelephoneNumberGreaterThan + +> Applicable: Microsoft Teams + Specifies a telephone number used by the cmdlet as the lower boundary of the telephone numbers returned. The telephone numbers returned will all be greater than the number provided. The telephone number should be in E.164 format. @@ -274,7 +299,6 @@ The telephone number should be in E.164 format. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -284,6 +308,9 @@ Accept wildcard characters: False ``` ### -TelephoneNumberLessThan + +> Applicable: Microsoft Teams + Specifies a telephone number used by the cmdlet as the upper boundary of the telephone numbers returned. The telephone numbers returned will all be less than the number provided. The telephone number should be in E.164 format. @@ -292,7 +319,6 @@ The telephone number should be in E.164 format. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -302,6 +328,9 @@ Accept wildcard characters: False ``` ### -TelephoneNumberStartsWith + +> Applicable: Microsoft Teams + Specifies the digits that the returned telephone numbers must begin with. To return numbers in the North American Numbering Plan 425 area code, use this syntax: -TelephoneNumberStartsWith 1425. To return numbers that are in the 206 area code and that begin with 88, use this syntax: -TelephoneNumberStartsWith 120688. @@ -311,7 +340,6 @@ You can use up to nine digits. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -321,13 +349,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -351,4 +381,4 @@ An instance or array of the objects. ## NOTES ## RELATED LINKS -[Remove-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-csonlinetelephonenumber) +[Remove-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinetelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberCountry.md similarity index 75% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberCountry.md index e2731e0eed..f3c8f360a2 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberCountry.md @@ -1,32 +1,33 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry -Module Name: MicrosoftTeams -title: Get-CsOnlineTelephoneNumberCountry -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumberCountry --- # Get-CsOnlineTelephoneNumberCountry ## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. +Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. ## SYNTAX ``` PS C:\> Get-CsOnlineTelephoneNumberCountry [] ``` -## DESCRIPTION +## DESCRIPTION Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineTelephoneNumberCountry ``` @@ -60,10 +61,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) -[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) -[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) -[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) -[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberOrder.md similarity index 83% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberOrder.md index 5725171ad6..b11dbfd998 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberOrder.md @@ -1,19 +1,20 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: Get-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumberOrder --- # Get-CsOnlineTelephoneNumberOrder ## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number order. +Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number order. ## SYNTAX @@ -24,7 +25,7 @@ Get-CsOnlineTelephoneNumberOrder -OrderId [-OrderType ] ## DESCRIPTION -This `Get-CsOnlineTelephoneNumberOrder` cmdlet can be used to get the status of specific telephone number orders. Currently supported orders for retrievals are: Search [New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder), Direct Routing Number Upload [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder), and Direct Routing Number Release [New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder). When the OrderType is not indicated, the cmdlet will default to a Search order. +This `Get-CsOnlineTelephoneNumberOrder` cmdlet can be used to get the status of specific telephone number orders. Currently supported orders for retrievals are: Search [New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder), Direct Routing Number Upload [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedirectroutingtelephonenumberuploadorder), and Direct Routing Number Release [New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/microsoftteams/New-csonlinetelephonenumberreleaseorder). When the OrderType is not indicated, the cmdlet will default to a Search order. ## EXAMPLES @@ -52,9 +53,9 @@ ErrorCode NoError InventoryType Subscriber SendToServiceDesk False CountryCode CA - + PS C:\> $order.TelephoneNumbers - + Key Value --- ----- Location Vancouver @@ -78,17 +79,17 @@ CreatedBy ContosoAdmin Description Prefix Search Test NumberType UserSubscriber SearchType Prefix -AreaCode -PostalOrZipCode +AreaCode +PostalOrZipCode Quantity 1 Status Error IsManual False TelephoneNumbers {} -ReservationExpiryDate +ReservationExpiryDate ErrorCode OutOfStock InventoryType Subscriber SendToServiceDesk False -CountryCode +CountryCode ``` This example returns a failed telephone number search and the `ErrorCode` is showing that telephone numbers with `NumberPrefix: 1425` is `OutOfStock`. @@ -199,17 +200,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ## NOTES -Updates in Teams PowerShell Module version 6.7.1 and later: +Updates in Teams PowerShell Module version 6.7.1 and later: - A new optional parameter `OrderType` is introduced. If no OrderType is provided, it will default to a Search order. - [BREAKING CHANGE] When a Search order is queried, the property name `TelephoneNumber` in the output will be changed to `TelephoneNumbers`. The structure of the `TelephoneNumbers` output will remain unchanged. - Impact: Scripts and processes that reference the `TelephoneNumber` property will need to be updated to use `TelephoneNumbers`. ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) -[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) -[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) -[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) -[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) -[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder) -[New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder) +[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedirectroutingtelephonenumberuploadorder) +[New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/microsoftteams/New-csonlinetelephonenumberreleaseorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberType.md similarity index 82% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberType.md index 47c397e14b..91dec5ee4a 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberType.md @@ -1,19 +1,20 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype -Module Name: MicrosoftTeams -title: Get-CsOnlineTelephoneNumberType -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumberType --- # Get-CsOnlineTelephoneNumberType ## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. The telephone numbers can then be used to set up calling features for users and services in your organization. +Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. ## SYNTAX @@ -27,7 +28,7 @@ Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported te ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineTelephoneNumberType -Country US ``` @@ -54,7 +55,7 @@ RequiresCivicAddress : True This example returns the list of supported number offerings in United States. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineTelephoneNumberType -Country CA | ft NumberType ``` @@ -101,10 +102,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype) -[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) -[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) -[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) -[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineUser.md similarity index 96% rename from teams/teams-ps/teams/Get-CsOnlineUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineUser.md index 73ccb9f1c7..16d470b47f 100644 --- a/teams/teams-ps/teams/Get-CsOnlineUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineuser applicable: Microsoft Teams -title: Get-CsOnlineUser -schema: 2.0.0 -manager: sshastri author: praspatil +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sshastri +Module Name: MicrosoftTeams ms.author: praspatil -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineuser +schema: 2.0.0 +title: Get-CsOnlineUser --- # Get-CsOnlineUser @@ -57,21 +58,21 @@ Users homed on Skype for Business Online will a TenantId that is equal to some v ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineUser ``` The command shown in Example 1 returns information for all the users configured as online users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineUser -Identity "sip:kenmyer@litwareinc.com" ``` In Example 2 information is returned for a single online user: the user with the SIP address "sip:kenmyer@litwareinc.com". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOnlineUser -Filter "ArchivingPolicy -eq 'RedmondArchiving'" ``` @@ -80,7 +81,7 @@ Example 3 uses the Filter parameter to limit the returned data to online users w To do this, the filter value {ArchivingPolicy -eq "RedmondArchiving"} is employed; that syntax limits returned data to users where the ArchivingPolicy property is equal to (-eq) "RedmondArchiving". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsOnlineUser -Filter {HideFromAddressLists -eq $True} ``` @@ -89,7 +90,7 @@ Example 4 returns information only for user accounts that have been configured s (That is, the Active Directory attribute msExchHideFromAddressLists is True.) To carry out this task, the Filter parameter is included along with the filter value {HideFromAddressLists -eq $True}. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234"} Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234,ext:"} @@ -98,14 +99,14 @@ Get-CsOnlineUser -Filter {LineURI -eq "1234"} Example 5 returns information for user accounts that have been assigned a designated phone number. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsOnlineUser -AccountType ResourceAccount ``` Example 6 returns information for user accounts that are categorized as resource accounts. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsOnlineUser -Filter "FeatureTypes -Contains 'PhoneSystem'" ``` @@ -115,6 +116,9 @@ Example 7 returns information for user's assigned plans. ## PARAMETERS ### -AccountType + +> Applicable: Microsoft Teams + This parameter is added to Get-CsOnlineUser starting from TPM 4.5.1 to indicate the user type. The possible values for the AccountType parameter are: - `User` - to query for user accounts. @@ -127,7 +131,6 @@ This parameter is added to Get-CsOnlineUser starting from TPM 4.5.1 to indicate Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -136,7 +139,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Filter + +> Applicable: Microsoft Teams + +Enables you to limit the returned data by filtering on specific attributes. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. + +The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. + +Examples: +- Get-CsOnlineUser -Filter {AssignedPlan -like "*MCO*"} +- Get-CsOnlineUser -Filter {UserPrincipalName -like "test*" -and (AssignedPlans -eq "MCOEV" -or AssignedPlans -like "MCOPSTN*")} +- Get-CsOnlineUser -Filter {OnPremHostingProvider -ne $null} +- Get-CsOnlineUser -Filter {WhenChanged -gt "1/25/2022 11:59:59 PM"} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Microsoft Teams + Indicates the Identity of the user account to be retrieved. For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account: @@ -158,7 +190,6 @@ Using the Teams PowerShell Module version 2.6 or earlier only, you can use the f Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -167,43 +198,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to limit the returned data by filtering on specific attributes. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. - -The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. - -Examples: -- Get-CsOnlineUser -Filter {AssignedPlan -like "*MCO*"} -- Get-CsOnlineUser -Filter {UserPrincipalName -like "test*" -and (AssignedPlans -eq "MCOEV" -or AssignedPlans -like "MCOPSTN*")} -- Get-CsOnlineUser -Filter {OnPremHostingProvider -ne $null} -- Get-CsOnlineUser -Filter {WhenChanged -gt "1/25/2022 11:59:59 PM"} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Properties -Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Identity, UserPrincipalName, Alias, AccountEnabled and DisplayName attributes will always be present in the output. Please note that only attributes available in the output of the Get-CsOnlineUser cmdlet can be selected. For a complete list of available attributes, refer to the response of the Get-CsOnlineUser cmdlet. +> Applicable: Microsoft Teams + +Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Identity, UserPrincipalName, Alias, AccountEnabled and DisplayName attributes will always be present in the output. Please note that only attributes available in the output of the Get-CsOnlineUser cmdlet can be selected. For a complete list of available attributes, refer to the response of the Get-CsOnlineUser cmdlet. Examples: -- Get-CsOnlineUser -Properties DisplayName, UserPrincipalName, FeatureTypes +- Get-CsOnlineUser -Properties DisplayName, UserPrincipalName, FeatureTypes - Get-CsOnlineUser -Properties DisplayName, Alias, LineURI ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -214,6 +222,8 @@ Accept wildcard characters: False ### -ResultSize +> Applicable: Microsoft Teams + **Note**: Starting with Teams PowerShell Modules version 4.0 and later, "-ResultSize" type has been changed to uint32. Enables you to limit the number of records returned by the cmdlet. For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven users will be returned. @@ -224,7 +234,6 @@ The result size can be set to any whole number between 0 and 2147483647, inclusi Type: Unlimited Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -234,13 +243,15 @@ Accept wildcard characters: False ``` ### -SkipUserPolicies + +> Applicable: Microsoft Teams + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -251,13 +262,14 @@ Accept wildcard characters: False ### -SoftDeletedUser +> Applicable: Microsoft Teams + This parameter enables you to return a collection of all the users who are deleted and can be restored within 30 days from their deletion time ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -268,6 +280,8 @@ Accept wildcard characters: False ### -Sort +> Applicable: Microsoft Teams + Sorting is now enabled in Teams PowerShell Module by using the "-Sort" or "-OrderBy" parameters. For example: - Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" @@ -279,7 +293,6 @@ Sorting is now enabled in Teams PowerShell Module by using the "-Sort" or "-Orde Type: String Parameter Sets: (All) Aliases: OrderBy -Applicable: Microsoft Teams Required: False Position: Named @@ -326,11 +339,11 @@ A recent fix has addressed an issue where some Guest users were being omitted fr - PolicyType - which specifies the type of policy assigned (for example, TeamsMeetingPolicy, TeamsCallingPolicy, and so on.) - PolicyAssignment - which includes the display name of the assigned policy (displayName), the assignment type (assignmentType) indicating whether it is direct or group-based, the unique identifier of the policy (policyId), and the group identifier (groupId) if applicable. **Note**: The policyId property isn't currently supported. - + **Updates in Teams PowerShell Module**: - DialPlan: DialPlan attribute will be deprecated and no longer populated in the output of Get-CsOnlineUser in all clouds. - + **Updates in Teams PowerShell Module version 7.0.0 and later**: - OptionFlags: OptionFlags attribute will no longer be populated with value in the output of Get-CsOnlineUser in all clouds. It's important to note that other details besides EnterpriseVoiceEnabled, previously found in OptionFlags, are no longer relevant for Teams. Administrators can still utilize the EnterpriseVoiceEnabled attribute in the output of the Get-CsOnlineUser cmdlet to get this information. This change will be rolled out to all Teams Powershell Module versions. @@ -588,4 +601,4 @@ In Teams PowerShell Modules 3.0.0 and above OnPremLineURI will only refer to the ## RELATED LINKS -[Set-CsUser](https://learn.microsoft.com/powershell/module/teams/set-csuser) +[Set-CsUser](https://learn.microsoft.com/powershell/module/microsoftteams/set-csuser) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoute.md similarity index 83% rename from teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoute.md index 530da92267..cc4fd60396 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoute.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute applicable: Microsoft Teams -title: Get-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroute +schema: 2.0.0 +title: Get-CsOnlineVoiceRoute --- # Get-CsOnlineVoiceRoute ## SYNOPSIS -Returns information about the online voice routes configured for use in your tenant. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). +Returns information about the online voice routes configured for use in your tenant. ## SYNTAX @@ -36,28 +37,28 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineVoiceRoute ``` Retrieves the properties for all voice routes defined within the tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineVoiceRoute -Identity Route1 ``` Retrieves the properties for the Route1 voice route. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsOnlineVoiceRoute -Filter *test* ``` This command displays voice route settings where the Identity contains the string "test" anywhere within the value. To find the string test only at the end of the Identity, use the value \*test. Similarly, to find the string test only if it occurs at the beginning of the Identity, specify the value test\*. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> Get-CsOnlineVoiceRoute | Where-Object {$_.OnlinePstnGatewayList.Count -eq 0} ``` @@ -110,8 +111,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy.md similarity index 85% rename from teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy.md index 1aec9c2d0a..21d5485fe6 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Get-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Get-CsOnlineVoiceRoutingPolicy --- # Get-CsOnlineVoiceRoutingPolicy ## SYNOPSIS -Returns information about the online voice routing policies configured for use in your tenant. Online voice routing policies manage online PSTN usages for users of Phone System. +Returns information about the online voice routing policies configured for use in your tenant. ## SYNTAX @@ -34,35 +35,35 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy ``` The command shown in Example 1 returns information for all the online voice routing policies configured for use in the tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" ``` In Example 2, information is returned for a single online voice routing policy: the policy with the Identity RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy -Filter "tag:*" ``` The command shown in Example 3 returns information about all the online voice routing policies configured at the per-user scope. To do this, the command uses the Filter parameter and the filter value "tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Long Distance"} ``` In Example 4, information is returned only for those online voice routing policies that include the PSTN usage "Long Distance". To carry out this task, the command first calls `Get-CsVoiceRoutingPolicy` without any parameters; that returns a collection of all the voice routing policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those policies where the OnlinePstnUsages property includes (-contains) the usage "Long Distance". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -notcontains "Long Distance"} ``` @@ -127,10 +128,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceUser.md similarity index 94% rename from teams/teams-ps/teams/Get-CsOnlineVoiceUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceUser.md index 71f7ff2efb..0355ab3e34 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceuser applicable: Microsoft Teams -title: Get-CsOnlineVoiceUser -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceuser +schema: 2.0.0 +title: Get-CsOnlineVoiceUser --- # Get-CsOnlineVoiceUser @@ -81,7 +82,7 @@ In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Team ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineVoiceUser -Identity Ken.Myer@contoso.com ``` @@ -91,13 +92,15 @@ This example uses the User Principal Name (UPN) to retrieve the location and pho ## PARAMETERS ### -CivicAddressId + +> Applicable: Microsoft Teams + Specifies the identity of the civic address that is assigned to the target users. ```yaml Type: XdsCivicAddressId Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -EnterpriseVoiceStatus + +> Applicable: Microsoft Teams + Possible values are: * All * Enabled @@ -132,7 +140,6 @@ Possible values are: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -142,13 +149,15 @@ Accept wildcard characters: False ``` ### -ExpandLocation + +> Applicable: Microsoft Teams + Displays the location parameter with its value. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -First + +> Applicable: Microsoft Teams + Specifies the number of users to return. The default is 100. @@ -165,7 +177,6 @@ The default is 100. Type: Unlimited Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. The Force switch specifies whether to suppress warning and confirmation messages. @@ -185,7 +199,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -195,6 +208,9 @@ Accept wildcard characters: False ``` ### -GetFromAAD + +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. Use this switch to get the users from Microsoft Entra ID. @@ -203,7 +219,6 @@ Use this switch to get the users from Microsoft Entra ID. Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -213,6 +228,9 @@ Accept wildcard characters: False ``` ### -GetPendingUsers + +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. Use this switch to get only the users in pending state. @@ -221,7 +239,6 @@ Use this switch to get only the users in pending state. Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -231,6 +248,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + Specifies the identity of the target user. Acceptable values include: @@ -244,7 +264,6 @@ Example: 98403f08-577c-46dd-851a-f0460a13b03d Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -254,6 +273,9 @@ Accept wildcard characters: False ``` ### -LocationId + +> Applicable: Microsoft Teams + Specifies the location identity of the location whose users will be returned. You can find location identifiers by using the `Get-CsOnlineLisLocation` cmdlet. @@ -261,7 +283,6 @@ You can find location identifiers by using the `Get-CsOnlineLisLocation` cmdlet. Type: LocationID Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -271,13 +292,15 @@ Accept wildcard characters: False ``` ### -NumberAssigned + +> Applicable: Microsoft Teams + If specified, the query will return users who have a phone number assigned. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -287,13 +310,15 @@ Accept wildcard characters: False ``` ### -NumberNotAssigned + +> Applicable: Microsoft Teams + If specified, the query will return users who do not have a phone number assigned. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -304,6 +329,8 @@ Accept wildcard characters: False ### -PSTNConnectivity +> Applicable: Microsoft Teams + Possible values are: * All * Online @@ -313,7 +340,6 @@ Possible values are: Type: MultiValuedProperty Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -323,6 +349,9 @@ Accept wildcard characters: False ``` ### -SearchQuery + +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). For more details about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603). @@ -333,7 +362,6 @@ If this parameter is empty, all users are returned. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -343,6 +371,9 @@ Accept wildcard characters: False ``` ### -Skip + +> Applicable: Microsoft Teams + Specifies the number of users to skip. If you used the First parameter to return the first 50 users and wanted to get another 50, you could use -Skip 50 to avoid returning the first 50 you've already reviewed. The default is 0. @@ -351,7 +382,6 @@ The default is 0. Type: Unlimited Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -361,6 +391,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. This parameter is reserved for internal Microsoft use. @@ -369,7 +402,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -393,4 +425,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlineVoiceUser](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceuser) +[Set-CsOnlineVoiceUser](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceuser) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailPolicy.md similarity index 85% rename from teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailPolicy.md index 844b74b828..d99a41c570 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy applicable: Microsoft Teams -title: Get-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailpolicy +schema: 2.0.0 +title: Get-CsOnlineVoicemailPolicy --- # Get-CsOnlineVoicemailPolicy @@ -32,21 +33,21 @@ This cmdlet retrieves information about one or more voicemail policies that have ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineVoicemailPolicy ``` In Example 1, the Get-CsOnlineVoicemailPolicy cmdlet is called without any additional parameters; this returns a collection of all the voicemail policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineVoicemailPolicy -Identity TranscriptionDisabled ``` In Example 2, the Get-CsOnlineVoicemailPolicy cmdlet is used to return the per-user voicemail policy that has an Identity TranscriptionDisabled. Because identities are unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOnlineVoicemailPolicy -Filter "tag:*" ``` @@ -55,37 +56,41 @@ Example 3 uses the Filter parameter to return all the voicemail policies that ha ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. If this parameter is omitted, all voicemail policies available for use are returned. +### -Filter + +> Applicable: Microsoft Teams + +This parameter accepts a wildcard string and returns all voicemail policies with identities matching that string. For example, a Filter value of Tag:* will return all preconfigured voicemail policy instances (excluding forest default "Global") available to use by the tenant admins. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter accepts a wildcard string and returns all voicemail policies with identities matching that string. For example, a Filter value of Tag:* will return all preconfigured voicemail policy instances (excluding forest default "Global") available to use by the tenant admins. + +### -Identity + +> Applicable: Microsoft Teams + +A unique identifier specifying the scope, and in some cases the name, of the policy. If this parameter is omitted, all voicemail policies available for use are returned. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -100,10 +105,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings.md similarity index 88% rename from teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings.md index b4437f7b08..9018403c51 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailusersettings applicable: Microsoft Teams -title: Get-CsOnlineVoicemailUserSettings -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailusersettings +schema: 2.0.0 +title: Get-CsOnlineVoicemailUserSettings --- # Get-CsOnlineVoicemailUserSettings @@ -26,7 +27,7 @@ The Get-CsOnlineVoicemailUserSettings cmdlet returns information about online vo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineVoicemailUserSettings -Identity sip:user@contoso.com ``` @@ -35,33 +36,35 @@ This example gets the online voicemail user settings of user with SIP URI sip:us ## PARAMETERS -### -Identity -The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -81,4 +84,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) +[Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailusersettings) diff --git a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberAssignment.md similarity index 83% rename from teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberAssignment.md index 710ee1f968..12b29693df 100644 --- a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberAssignment.md @@ -1,638 +1,777 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment -applicable: Microsoft Teams -title: Get-CsPhoneNumberAssignment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Get-CsPhoneNumberAssignment - -## SYNOPSIS -This cmdlet displays information about one or more phone numbers. - -## SYNTAX - -### Assignment (Default) -```powershell -Get-CsPhoneNumberAssignment [-ActivationState ] [-AssignedPstnTargetId ] [-AssignmentCategory ] - [-CapabilitiesContain ] [-CivicAddressId ] [-Filter ] [-IsoCountryCode ] - [-LocationId ] [-NetworkSiteId ] [-NumberType ] [-PstnAssignmentStatus ] [-Skip ] [-TelephoneNumber ] - [-TelephoneNumberContain ] [-TelephoneNumberGreaterThan ] [-TelephoneNumberLessThan ] - [-TelephoneNumberStartsWith ] [-Top ] [] -``` - -## DESCRIPTION -This cmdlet displays information about one or more phone numbers. You can filter the phone numbers to return by using different parameters. Returned results are sorted by TelephoneNumber in ascending order. Supported list of attributes for Filter are: -- TelephoneNumber -- OperatorId -- PstnAssignmentStatus (also supported AssignmentStatus) -- ActivationState -- IsoCountryCode -- Capability (also supported AcquiredCapabilities) -- IsOperatorConnect -- PstnPartnerName (also supported PartnerName) -- LocationId -- CivicAddressId -- NetworkSiteId -- NumberType -- AssignedPstnTargetId (also supported TargetId) -- TargetType -- AssignmentCategory -- ResourceAccountSharedCallingPolicySupported -- SupportedCustomerActions -- ReverseNumberLookup -- RoutingOptions -- SmsActivationState -- Tags - -If you are using both -Skip X and -Top Y for filtering, the returned results will first be skipped by X, and then the top Y results will be returned. - -By default, this cmdlet returns a maximum of 500 results. A maximum of 1000 results can be returned using -Top filter. If you need to get more than 1000 results, a combination of -Skip and -Top filtering can be used to list incremental returns of 1000 numbers. If a full list of telephone numbers acquired by the tenant is required, you can use [Export-CsAcquiredPhoneNumber](./export-csacquiredphonenumber.md) cmdlet to download a list of all acquired telephone numbers. - - -## EXAMPLES - -### Example 1 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumber +14025551234 -``` -```output -TelephoneNumber : +14025551234 -OperatorId : 2b24d246-a9ee-428b-96bc-fb9d9a053c8d -NumberType : CallingPlan -ActivationState : Activated -AssignedPstnTargetId : dc13d97b-7897-494e-bc28-6b469bf7a70e -AssignmentCategory : Primary -Capability : {UserAssignment} -City : Omaha -CivicAddressId : 703b30e5-dbdd-4132-9809-4c6160a6acc7 -IsoCountryCode : US -IsoSubdivision : Nebraska -LocationId : 407c17ae-8c41-431e-894a-38787c682f68 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : 7fc2f2eb-89aa-41d7-93de-73d015d22ff0 -PstnPartnerName : Microsoft -NumberSource : Online -ReverseNumberLookup : {} -Tag : {} -``` -This example displays information about the Microsoft Calling Plan subscriber phone number +1 (402) 555-1234. You can see that it is assigned to a user. - -### Example 2 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" -``` -```output -TelephoneNumber : +12065551000;ext=524 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -Tag : {} -``` -This example displays information about the Direct Routing phone number +1 (206) 555-1000;ext=524. You can see that it is assigned to a user. - -### Example 3 -```powershell -Get-CsPhoneNumberAssignment -CapabilitiesContain "VoiceApplicationAssignment,ConferenceAssignment" -``` -This example returns all phone numbers that have both the capability VoiceApplicationAssignment and the capability ConferenceAssignment assigned, but phone numbers that have only one of these capabilities assigned won't be returned. - -### Example 4 -```powershell -Get-CsPhoneNumberAssignment -AssignedPstnTargetId user1@contoso.com -``` -This example returns information about the phone number assigned to user1@contoso.com. - -### Example 5 -```powershell -Get-CsPhoneNumberAssignment -AssignedPstnTargetId aa1@contoso.com -``` -This example returns information about the phone number assigned to resource account aa1@contoso.com. - -### Example 6 -```powershell -Get-CsPhoneNumberAssignment -ActivationState Activated -CapabilitiesContain VoiceApplicationAssignment -PstnAssignmentStatus Unassigned -``` -This example returns information about all activated phone numbers with the capability VoiceApplicationAssignment that are not assigned. - -### Example 7 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumberContain "524" -``` -This example returns information about all phone numbers that contain the digits 524, including the phone number with extension 524 used in example 2. - -### Example 8 -```powershell -Get-CsPhoneNumberAssignment -Skip 1000 -Top 1000 -``` -This example returns all phone numbers sequenced between 1001 to 2000 in the record of phone numbers. - - -### Example 9 -```powershell -Get-CsPhoneNumberAssignment -AssignedPstnTargetId 'TeamsSharedCallingRoutingPolicy|Tag:SC1' -``` -This example returns all phone numbers assigned as emergency numbers in the Teams shared calling routing policy instance SC1. - -### Example 10 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" -``` -```output -TelephoneNumber : +12065551000;ext=524 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a6f091 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {SkipInternalVoip} -Tag : {} -``` -This example displays when SkipInternalVoip option is turned on for a number. - -### Example 11 -```powershell -Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -eq '+12065551000'" -``` -```output -TelephoneNumber : +12065551000 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -Tag : {} -``` -This example shows a way to use -Filter parameter to display information of a specific number. - -### Example 12 -```powershell -Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -like '+12065551000' -and NumberType -eq 'DirectRouting'" -``` -```output -TelephoneNumber : +12065551000 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f591 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -Tag : {} -``` -This example shows a way to get filtered results using multiple Filter parameters. - -### Example 13 -```powershell -Get-CsPhoneNumberAssignment -Filter "Tags -contains ['Engineering']" -``` -```output -TelephoneNumber : +12065551102 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f071 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -Tag : {Engineering} -``` -This example shows a way to get filtered results using tags. Tags are not case sensitive. - - -## PARAMETERS - -### -ActivationState -Filters the returned results based on the number type. Supported values are Activated, AssignmentPending, AssignmentFailed, UpdatePending, and UpdateFailed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignedPstnTargetId -Filters the returned results based on the user or resource account ID the phone number is assigned to. Supported values are UserPrincipalName, SIP address, ObjectId, and the Teams shared calling routing policy instance name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCategory -This parameter is used to differentiate between Primary and Private line assignment for a user. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapabilitiesContain -Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and TeamsPhoneMobile. - -If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like -ConferenceAssignment, VoiceApplicationAssignment you will get all phone numbers that have both capabilities assigned, but you won't get phone numbers that have only -VoiceApplicationAssignment or ConferenceAssignment assigned as capability. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CivicAddressId -Filters the returned results based on the CivicAddressId assigned to the phone number. You can get the CivicAddressId by using [Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -This can be used to filter on one or more parameters within the search results. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsoCountryCode -Filters the returned results based on the ISO 3166-1 Alpha-2 country code assigned to the phone number. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationId -Filters the returned results based on the LocationId assigned to the phone number. You can get the LocationId by using [Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSiteId -ID of a network site. A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberType -Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PstnAssignmentStatus -Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, ThirdPartyAppAssigned, and PolicyAssigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -Skips the first X returned results and the default value is 0. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumber -Filters the returned results to a specific phone number. It is optional to specify a prefixed "+". The phone number can't have "tel:" prefixed. -We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberContain - -Filters the returned results based on substring match for the specified string on TelephoneNumber. To search for a number with an extension, you need to specify -the digits of the extension. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberGreaterThan -Filters the returned results based on greater than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberLessThan to specify a -range of phone numbers to return results for. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberLessThan -Filters the returned results based on less than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberGreaterThan to specify a -range of phone numbers to return results for. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberStartsWith -Filters the returned results based on starts with string match for the specified string on TelephoneNumber. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Returns the first X returned results and the default value is 500. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### ActivationState -The activation state of the telephone number. - -### AssignedPstnTargetId -The ID of the object the phone number is assigned to, either the ObjectId of a user or resource account or the policy instance ID of a Teams shared calling routing policy instance. - -### AssignmentCategory -Contains the assignment category such as Primary or Private. - -### Capability -The list of capabilities assigned to the phone number. - -### City -The city where the phone number is located. - -### CivicAddressId -The ID of the CivicAddress assigned to the phone number. - -### IsoCountryCode -The ISO country code assigned to the phone number. - -### IsoSubDivision -The subdivision within the country/region assigned to the phone number, for example, the state for US phone numbers. - -### LocationId -The ID of the Location assigned to the phone number. - -### LocationUpdateSupported -Boolean stating if updating of the location assigned to the phone number is allowed. - -### NetworkSiteId -This parameter is reserved for internal Microsoft use. - -### NumberSource -The source of the phone number. Online for phone numbers assigned in Microsoft 365 and OnPremises for phone numbers assigned in AD on-premises and synchronized into Microsoft 365. - -### NumberType -The type of the phone number. - -### OperatorId -The ID of the operator. - -### PortInOrderStatus -The status of any port in order covering the phone number. - -### PstnAssignmentStatus -The assignment status of the phone number. - -### PstnPartnerId -The ID of the PSTN partner providing the phone number. - -### PstnPartnerName -The name of the PSTN partner. - -### TelephoneNumber -The phone number. The number is always displayed with prefixed "+", even if it was not assigned using prefixed "+". - -The object returned is of type SkypeTelephoneNumberMgmtCmdletAcquiredTelephoneNumber. - -### ReverseNumberLookup -Status of Reverse Number Lookup (RNL). When it is set to SkipInternalVoip, the calls are handled through external PSTN connection instead of internal VoIP lookup. - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. The parameter AssignmentCategory was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The output parameter NumberSource was introduced in Teams PowerShell module 5.7.0. - -The cmdlet is only available in commercial and GCC cloud instances. - -## RELATED LINKS -[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) - -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumberassignment +schema: 2.0.0 +title: Get-CsPhoneNumberAssignment +--- + +# Get-CsPhoneNumberAssignment + +## SYNOPSIS +This cmdlet displays information about one or more phone numbers. + +## SYNTAX + +``` +Get-CsPhoneNumberAssignment [-ActivationState ] [-AssignedPstnTargetId ] + [-AssignmentCategory ] [-CapabilitiesContain ] [-CivicAddressId ] [-Filter ] + [-IsoCountryCode ] [-LocationId ] [-NetworkSiteId ] [-NumberType ] + [-PstnAssignmentStatus ] [-Skip ] [-TelephoneNumber ] + [-TelephoneNumberContain ] [-TelephoneNumberGreaterThan ] [-TelephoneNumberLessThan ] + [-TelephoneNumberStartsWith ] [-Top ] [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION +This cmdlet displays information about one or more phone numbers. You can filter the phone numbers to return by using different parameters. Returned results are sorted by TelephoneNumber in ascending order. Supported list of attributes for Filter are: +- TelephoneNumber +- OperatorId +- PstnAssignmentStatus (also supported AssignmentStatus) +- ActivationState +- IsoCountryCode +- Capability (also supported AcquiredCapabilities) +- IsOperatorConnect +- PstnPartnerName (also supported PartnerName) +- LocationId +- CivicAddressId +- NetworkSiteId +- NumberType +- AssignedPstnTargetId (also supported TargetId) +- TargetType +- AssignmentCategory +- ResourceAccountSharedCallingPolicySupported +- SupportedCustomerActions +- ReverseNumberLookup +- RoutingOptions +- SmsActivationState +- Tags + +If you are using both -Skip X and -Top Y for filtering, the returned results will first be skipped by X, and then the top Y results will be returned. + +By default, this cmdlet returns a maximum of 500 results. A maximum of 1000 results can be returned using -Top filter. If you need to get more than 1000 results, a combination of -Skip and -Top filtering can be used to list incremental returns of 1000 numbers. If a full list of telephone numbers acquired by the tenant is required, you can use [Export-CsAcquiredPhoneNumber](./export-csacquiredphonenumber.md) cmdlet to download a list of all acquired telephone numbers. + + +## EXAMPLES + +### Example 1 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber +14025551234 +``` +```output +TelephoneNumber : +14025551234 +OperatorId : 2b24d246-a9ee-428b-96bc-fb9d9a053c8d +NumberType : CallingPlan +ActivationState : Activated +AssignedPstnTargetId : dc13d97b-7897-494e-bc28-6b469bf7a70e +AssignmentCategory : Primary +Capability : {UserAssignment} +City : Omaha +CivicAddressId : 703b30e5-dbdd-4132-9809-4c6160a6acc7 +IsoCountryCode : US +IsoSubdivision : Nebraska +LocationId : 407c17ae-8c41-431e-894a-38787c682f68 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : 7fc2f2eb-89aa-41d7-93de-73d015d22ff0 +PstnPartnerName : Microsoft +NumberSource : Online +ReverseNumberLookup : {} +Tag : {} +``` +This example displays information about the Microsoft Calling Plan subscriber phone number +1 (402) 555-1234. You can see that it is assigned to a user. + +### Example 2 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" +``` +```output +TelephoneNumber : +12065551000;ext=524 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +Tag : {} +``` +This example displays information about the Direct Routing phone number +1 (206) 555-1000;ext=524. You can see that it is assigned to a user. + +### Example 3 +```powershell +Get-CsPhoneNumberAssignment -CapabilitiesContain "VoiceApplicationAssignment,ConferenceAssignment" +``` +This example returns all phone numbers that have both the capability VoiceApplicationAssignment and the capability ConferenceAssignment assigned, but phone numbers that have only one of these capabilities assigned won't be returned. + +### Example 4 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId user1@contoso.com +``` +This example returns information about the phone number assigned to user1@contoso.com. + +### Example 5 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId aa1@contoso.com +``` +This example returns information about the phone number assigned to resource account aa1@contoso.com. + +### Example 6 +```powershell +Get-CsPhoneNumberAssignment -ActivationState Activated -CapabilitiesContain VoiceApplicationAssignment -PstnAssignmentStatus Unassigned +``` +This example returns information about all activated phone numbers with the capability VoiceApplicationAssignment that are not assigned. + +### Example 7 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumberContain "524" +``` +This example returns information about all phone numbers that contain the digits 524, including the phone number with extension 524 used in example 2. + +### Example 8 +```powershell +Get-CsPhoneNumberAssignment -Skip 1000 -Top 1000 +``` +This example returns all phone numbers sequenced between 1001 to 2000 in the record of phone numbers. + + +### Example 9 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId 'TeamsSharedCallingRoutingPolicy|Tag:SC1' +``` +This example returns all phone numbers assigned as emergency numbers in the Teams shared calling routing policy instance SC1. + +### Example 10 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" +``` +```output +TelephoneNumber : +12065551000;ext=524 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a6f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {SkipInternalVoip} +Tag : {} +``` +This example displays when SkipInternalVoip option is turned on for a number. + +### Example 11 +```powershell +Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -eq '+12065551000'" +``` +```output +TelephoneNumber : +12065551000 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +Tag : {} +``` +This example shows a way to use -Filter parameter to display information of a specific number. + +### Example 12 +```powershell +Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -like '+12065551000' -and NumberType -eq 'DirectRouting'" +``` +```output +TelephoneNumber : +12065551000 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f591 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +Tag : {} +``` +This example shows a way to get filtered results using multiple Filter parameters. + +### Example 13 +```powershell +Get-CsPhoneNumberAssignment -Filter "Tags -contains ['Engineering']" +``` +```output +TelephoneNumber : +12065551102 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f071 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +Tag : {Engineering} +``` +This example shows a way to get filtered results using tags. Tags are not case sensitive. + + +## PARAMETERS + +### -ActivationState + +> Applicable: Microsoft Teams + +Filters the returned results based on the number type. Supported values are Activated, AssignmentPending, AssignmentFailed, UpdatePending, and UpdateFailed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignedPstnTargetId + +> Applicable: Microsoft Teams + +Filters the returned results based on the user or resource account ID the phone number is assigned to. Supported values are UserPrincipalName, SIP address, ObjectId, and the Teams shared calling routing policy instance name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignmentCategory + +> Applicable: Microsoft Teams + +This parameter is used to differentiate between Primary and Private line assignment for a user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapabilitiesContain + +> Applicable: Microsoft Teams + +Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and TeamsPhoneMobile. + +If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like +ConferenceAssignment, VoiceApplicationAssignment you will get all phone numbers that have both capabilities assigned, but you won't get phone numbers that have only +VoiceApplicationAssignment or ConferenceAssignment assigned as capability. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CivicAddressId + +> Applicable: Microsoft Teams + +Filters the returned results based on the CivicAddressId assigned to the phone number. You can get the CivicAddressId by using [Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliscivicaddress). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +This can be used to filter on one or more parameters within the search results. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsoCountryCode + +> Applicable: Microsoft Teams + +Filters the returned results based on the ISO 3166-1 Alpha-2 country code assigned to the phone number. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationId + +> Applicable: Microsoft Teams + +Filters the returned results based on the LocationId assigned to the phone number. You can get the LocationId by using [Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelislocation). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteId + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberType + +> Applicable: Microsoft Teams + +Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PstnAssignmentStatus + +> Applicable: Microsoft Teams + +Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, ThirdPartyAppAssigned, and PolicyAssigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skips the first X returned results and the default value is 0. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +Filters the returned results to a specific phone number. It is optional to specify a prefixed "+". The phone number can't have "tel:" prefixed. +We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberContain + +> Applicable: Microsoft Teams + +Filters the returned results based on substring match for the specified string on TelephoneNumber. To search for a number with an extension, you need to specify +the digits of the extension. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberGreaterThan + +> Applicable: Microsoft Teams + +Filters the returned results based on greater than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberLessThan to specify a +range of phone numbers to return results for. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberLessThan + +> Applicable: Microsoft Teams + +Filters the returned results based on less than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberGreaterThan to specify a +range of phone numbers to return results for. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberStartsWith + +> Applicable: Microsoft Teams + +Filters the returned results based on starts with string match for the specified string on TelephoneNumber. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top + +> Applicable: Microsoft Teams + +Returns the first X returned results and the default value is 500. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### ActivationState +The activation state of the telephone number. + +### AssignedPstnTargetId +The ID of the object the phone number is assigned to, either the ObjectId of a user or resource account or the policy instance ID of a Teams shared calling routing policy instance. + +### AssignmentCategory +Contains the assignment category such as Primary or Private. + +### Capability +The list of capabilities assigned to the phone number. + +### City +The city where the phone number is located. + +### CivicAddressId +The ID of the CivicAddress assigned to the phone number. + +### IsoCountryCode +The ISO country code assigned to the phone number. + +### IsoSubDivision +The subdivision within the country/region assigned to the phone number, for example, the state for US phone numbers. + +### LocationId +The ID of the Location assigned to the phone number. + +### LocationUpdateSupported +Boolean stating if updating of the location assigned to the phone number is allowed. + +### NetworkSiteId +This parameter is reserved for internal Microsoft use. + +### NumberSource +The source of the phone number. Online for phone numbers assigned in Microsoft 365 and OnPremises for phone numbers assigned in AD on-premises and synchronized into Microsoft 365. + +### NumberType +The type of the phone number. + +### OperatorId +The ID of the operator. + +### PortInOrderStatus +The status of any port in order covering the phone number. + +### PstnAssignmentStatus +The assignment status of the phone number. + +### PstnPartnerId +The ID of the PSTN partner providing the phone number. + +### PstnPartnerName +The name of the PSTN partner. + +### TelephoneNumber +The phone number. The number is always displayed with prefixed "+", even if it was not assigned using prefixed "+". + +The object returned is of type SkypeTelephoneNumberMgmtCmdletAcquiredTelephoneNumber. + +### ReverseNumberLookup +Status of Reverse Number Lookup (RNL). When it is set to SkipInternalVoip, the calls are handled through external PSTN connection instead of internal VoIP lookup. + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. The parameter AssignmentCategory was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The output parameter NumberSource was introduced in Teams PowerShell module 5.7.0. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) + +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Get-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberTag.md similarity index 87% rename from teams/teams-ps/teams/Get-CsPhoneNumberTag.md rename to teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberTag.md index beba5186cd..f5c25ae137 100644 --- a/teams/teams-ps/teams/Get-CsPhoneNumberTag.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberTag.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag applicable: Microsoft Teams -title: Get-CsPhoneNumberTag author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumbertag schema: 2.0.0 +title: Get-CsPhoneNumberTag --- # Get-CsPhoneNumberTag @@ -23,7 +24,7 @@ Get-CsPhoneNumberTag [] ``` ## DESCRIPTION -This cmdlet will get a list of all existing tags that are assigned to phone numbers in the tenant. +This cmdlet will get a list of all existing tags that are assigned to phone numbers in the tenant. ## EXAMPLES diff --git a/teams/teams-ps/teams/Get-CsPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Get-CsPolicyPackage.md similarity index 91% rename from teams/teams-ps/teams/Get-CsPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsPolicyPackage.md index 0e3330e1af..5cc5357210 100644 --- a/teams/teams-ps/teams/Get-CsPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Get-CsPolicyPackage -author: serdarsoysal ms.author: serdars -manager: amitar -online version: https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage schema: 2.0.0 +title: Get-CsPolicyPackage --- # Get-CsPolicyPackage @@ -66,13 +67,14 @@ Returns the set of policies in the Education_PrimaryStudent policy package. ### -Identity +> Applicable: Microsoft Teams + The name of a specific policy package. All possible policy package names can be found by running Get-CsPolicyPackage. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 0 Default value: None @@ -107,8 +109,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation) -[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackage) -[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csuserpolicypackage) diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestStatus.md similarity index 99% rename from teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestStatus.md index 7152c35e07..9ed49ecffe 100644 --- a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestStatus.md @@ -1,10 +1,10 @@ --- +applicable: Microsoft Teams external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -online version: -title: Get-CsSdgBulkSignInRequestStatus schema: 2.0.0 +title: Get-CsSdgBulkSignInRequestStatus --- # Get-CsSdgBulkSignInRequestStatus diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestsSummary.md similarity index 98% rename from teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md rename to teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestsSummary.md index b1f9e93472..8f1d328eaa 100644 --- a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestsSummary.md @@ -1,10 +1,10 @@ --- +applicable: Microsoft Teams external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -online version: -title: Get-CsSdgBulkSignInRequestsSummary schema: 2.0.0 +title: Get-CsSdgBulkSignInRequestsSummary --- # Get-CsSdgBulkSignInRequestsSummary diff --git a/teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/Get-CsSharedCallQueueHistoryTemplate.md similarity index 85% rename from teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md rename to teams/teams-ps/MicrosoftTeams/Get-CsSharedCallQueueHistoryTemplate.md index eed80beb3f..58f403ef60 100644 --- a/teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsSharedCallQueueHistoryTemplate.md @@ -1,39 +1,43 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsSharedCallQueueHistoryTemplate applicable: Microsoft Teams -title: Get-CsSharedCallQueueHistoryTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: Get-CsSharedCallQueueHistoryTemplate --- # Get-CsSharedCallQueueHistoryTemplate +## SYNOPSIS +Use the Get-CsSharedCallQueueHistory cmdlet to list the Shared Call Queue History templates. + ## SYNTAX -```powershell +``` Get-CsSharedCallQueueHistoryTemplate -Id [] ``` ## DESCRIPTION -Use the Get-CsSharedCallQueueHistory cmdlet to list the Shared Call Queue History templates +Use the Get-CsSharedCallQueueHistory cmdlet to list the Shared Call Queue History templates. > [!CAUTION] > This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsSharedCallQueueHistoryTemplate -Id 3a4b3d9b-91d8-4fbf-bcff-6907f325842c ``` This example retrieves the Shared Call Queue History Template with the Id `3a4b3d9b-91d8-4fbf-bcff-6907f325842c` -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsSharedCallQueueHistoryTemplate ``` @@ -43,13 +47,15 @@ This example retrieves all the Shared Call Queue History Templates ## PARAMETERS ### -Id + +> Applicable: Microsoft Teams + The Id of the shared call queue history template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: false Position: Named @@ -86,6 +92,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsCallQueue](./Set-CsCallQueue.md) [Remove-CsCallQueue](./Remove-CsCallQueue.md) - - - diff --git a/teams/teams-ps/teams/Get-CsTeamTemplate.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplate.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplate.md index de8f75a2f2..81dc98c798 100644 --- a/teams/teams-ps/teams/Get-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplate.md @@ -1,244 +1,244 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate -title: Get-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: farahf -schema: 2.0.0 ---- - -# Get-CsTeamTemplate - -## SYNOPSIS - -This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. - -NOTE: The returned template definition is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. - -## SYNTAX - -### Get (Default) - -```powershell -Get-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] -``` - -### GetViaIdentity - -```powershell -Get-CsTeamTemplate -InputObject [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] -``` - -## DESCRIPTION - -This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Get-CsTeamTemplate -OdataId $_.OdataId} -``` - -Within the universe of templates the admin's tenant has access to, returns a template definition object (displayed as a JSON by default) for every custom and every Microsoft en-US template which names include 'test'. - -### EXAMPLE 2 - -```powershell -PS C:\> Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/cefcf333-91a9-43d0-919f-bbca5b7d2b24/Tenant/en-US' > 'config.json' -``` - -Saves the template with specified template ID as a JSON file. - -## PARAMETERS - -### -OdataId - -A composite URI of a template. - -```yaml -Type: String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - - `[Bssid ]`: - - `[ChassisId ]`: - - `[CivicAddressId ]`: Civic address id. - - `[Country ]`: - - `[GroupId ]`: The ID of a group whose policy assignments will be returned. - - `[Id ]`: - - `[Identity ]`: - - `[Locale ]`: - - `[LocationId ]`: Location id. - - `[OdataId ]`: A composite URI of a template. - - `[OperationId ]`: The ID of a batch policy assignment operation. - - `[OrderId ]`: - - `[PackageName ]`: The name of a specific policy package - - `[PolicyType ]`: The policy type for which group policy assignments will be returned. - - `[Port ]`: - - `[PortInOrderId ]`: - - `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. - - `[SubnetId ]`: - - `[TenantId ]`: - - `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -## RELATED LINKS - -[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) - -[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) - -[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) - -[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) - -[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: farahf +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplate +schema: 2.0.0 +title: Get-CsTeamTemplate +--- + +# Get-CsTeamTemplate + +## SYNOPSIS + +This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + +## SYNTAX + +### Get (Default) + +```powershell +Get-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity + +```powershell +Get-CsTeamTemplate -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION + +This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + +NOTE: The returned template definition is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Get-CsTeamTemplate -OdataId $_.OdataId} +``` + +Within the universe of templates the admin's tenant has access to, returns a template definition object (displayed as a JSON by default) for every custom and every Microsoft en-US template which names include 'test'. + +### EXAMPLE 2 + +```powershell +PS C:\> Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/cefcf333-91a9-43d0-919f-bbca5b7d2b24/Tenant/en-US' > 'config.json' +``` + +Saves the template with specified template ID as a JSON file. + +## PARAMETERS + +### -Break + +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend + +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend + +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OdataId + +A composite URI of a template. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy + +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential + +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials + +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT \: Identity Parameter + - `[Bssid ]`: + - `[ChassisId ]`: + - `[CivicAddressId ]`: Civic address id. + - `[Country ]`: + - `[GroupId ]`: The ID of a group whose policy assignments will be returned. + - `[Id ]`: + - `[Identity ]`: + - `[Locale ]`: + - `[LocationId ]`: Location id. + - `[OdataId ]`: A composite URI of a template. + - `[OperationId ]`: The ID of a batch policy assignment operation. + - `[OrderId ]`: + - `[PackageName ]`: The name of a specific policy package + - `[PolicyType ]`: The policy type for which group policy assignments will be returned. + - `[Port ]`: + - `[PortInOrderId ]`: + - `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. + - `[SubnetId ]`: + - `[TenantId ]`: + - `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +## RELATED LINKS + +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) + +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplate) + +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamtemplate) + +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamtemplate) + +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Get-CsTeamTemplateList.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplateList.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTeamTemplateList.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplateList.md index c9928c4038..b88b964510 100644 --- a/teams/teams-ps/teams/Get-CsTeamTemplateList.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplateList.md @@ -1,147 +1,146 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist -title: Get-CsTeamTemplateList -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: farahf -schema: 2.0.0 ---- - -# Get-CsTeamTemplateList - -## SYNOPSIS - -This cmdlet supports retrieving information of all team templates available to your tenant, including both first party Microsoft team templates as well as custom templates. The templates information retrieved includes OData Id, template name, short description, count of channels and count of applications. -Note: All custom templates will be retrieved, regardless of the locale specification. If you have hidden templates in the admin center, you will still be able to see the hidden templates here. - -## SYNTAX - -### Get (Default) - -```powershell -Get-CsTeamTemplateList [[-PublicTemplateLocale] ] [] -``` - -### GetViaIdentity - -```powershell -Get-CsTeamTemplateList -InputObject [] -``` - -## DESCRIPTION - -Get a list of available team templates - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> Get-CsTeamTemplateList -``` - -Returns all en-US templates within the universe of templates the admin's tenant has access to. - -Note: All 1P Microsoft templates will always be returned in the specified locale. If the locale is not specified, en-US will be used. - -### EXAMPLE 2 - -```powershell -PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3 -``` - -Returns all en-US templates that have 3 channels within the universe of templates the admin's tenant has access to. - -## PARAMETERS - -### -PublicTemplateLocale - -The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US. - -```yaml -Type: String -Parameter Sets: Get -Aliases: - -Required: False -Position: 1 -Default value: 'en-US' -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateSummary - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties.\ -For information on hash tables, run Get-Help about_Hash_Tables.\ -\ -INPUTOBJECT \: Identity Parameter\ -\[Bssid \\]:\ -\[ChassisId \\]:\ -\[CivicAddressId \\]: Civic address id.\ -\[Country \\]:\ -\[GroupId \\]: The ID of a group whose policy assignments will be returned.\ -\[Id \\]:\ -\[Identity \\]:\ -\[Locale \\]: The language and country code of templates localization.\ -\[LocationId \\]: Location id.\ -\[OdataId \\]: A composite URI of a template.\ -\[OperationId \\]: The ID of a batch policy assignment operation.\ -\[OrderId \\]:\ -\[PackageName \\]: The name of a specific policy package\ -\[PolicyType \\]: The policy type for which group policy assignments will be returned.\ -\[Port \\]:\ -\[PortInOrderId \\]:\ -\[SubnetId \\]:\ -\[TenantId \\]:\ -\[UserId \\]: UserId.\ -Supports Guid.\ -Eventually UPN and SIP. - -## RELATED LINKS - -[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) - -[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) - -[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) - -[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) - -[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: farahf +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist +schema: 2.0.0 +title: Get-CsTeamTemplateList +--- + +# Get-CsTeamTemplateList + +## SYNOPSIS +Get a list of available team templates + +## SYNTAX + +### Get (Default) + +```powershell +Get-CsTeamTemplateList [[-PublicTemplateLocale] ] [] +``` + +### GetViaIdentity + +```powershell +Get-CsTeamTemplateList -InputObject [] +``` + +## DESCRIPTION + +This cmdlet supports retrieving information of all team templates available to your tenant, including both first party Microsoft team templates as well as custom templates. The templates information retrieved includes OData Id, template name, short description, count of channels and count of applications. +Note: All custom templates will be retrieved, regardless of the locale specification. If you have hidden templates in the admin center, you will still be able to see the hidden templates here. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> Get-CsTeamTemplateList +``` + +Returns all en-US templates within the universe of templates the admin's tenant has access to. + +Note: All 1P Microsoft templates will always be returned in the specified locale. If the locale is not specified, en-US will be used. + +### EXAMPLE 2 + +```powershell +PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3 +``` + +Returns all en-US templates that have 3 channels within the universe of templates the admin's tenant has access to. + +## PARAMETERS + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PublicTemplateLocale + +The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: False +Position: 1 +Default value: 'en-US' +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateSummary + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties.\ +For information on hash tables, run Get-Help about_Hash_Tables.\ +\ +INPUTOBJECT \: Identity Parameter\ +\[Bssid \\]:\ +\[ChassisId \\]:\ +\[CivicAddressId \\]: Civic address id.\ +\[Country \\]:\ +\[GroupId \\]: The ID of a group whose policy assignments will be returned.\ +\[Id \\]:\ +\[Identity \\]:\ +\[Locale \\]: The language and country code of templates localization.\ +\[LocationId \\]: Location id.\ +\[OdataId \\]: A composite URI of a template.\ +\[OperationId \\]: The ID of a batch policy assignment operation.\ +\[OrderId \\]:\ +\[PackageName \\]: The name of a specific policy package\ +\[PolicyType \\]: The policy type for which group policy assignments will be returned.\ +\[Port \\]:\ +\[PortInOrderId \\]:\ +\[SubnetId \\]:\ +\[TenantId \\]:\ +\[UserId \\]: UserId.\ +Supports Guid.\ +Eventually UPN and SIP. + +## RELATED LINKS + +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) + +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplate) + +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamtemplate) + +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamtemplate) + +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAIPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAIPolicy.md index 77a631f12f..e5d09c0aa8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Get-CsTeamsAIPolicy -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsAIPolicy -schema: 2.0.0 author: Andy447 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: andywang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsAIPolicy +schema: 2.0.0 +title: Get-CsTeamsAIPolicy --- # Get-CsTeamsAIPolicy @@ -38,31 +39,31 @@ Retrieves Teams AI policies and shows "EnrollFace", "EnrollVoice" and "SpeakerAt ## PARAMETERS -### -Identity -Identity of the Teams AI policy. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. -To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". +### -Identity +Identity of the Teams AI policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -80,10 +81,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaipolicy) -[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaipolicy) -[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAcsFederationConfiguration.md similarity index 85% rename from teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAcsFederationConfiguration.md index 6ba81b228a..445bcb18cb 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAcsFederationConfiguration.md @@ -1,22 +1,23 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsAcsFederationConfiguration -author: tomkau ms.author: tomkau -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsacsfederationconfiguration schema: 2.0.0 +title: Get-CsTeamsAcsFederationConfiguration --- # Get-CsTeamsAcsFederationConfiguration ## SYNOPSIS -This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. For more information, refer to [Azure Communication Services and Teams Interoperability](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). +This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. ## SYNTAX -```powershell +``` Get-CsTeamsAcsFederationConfiguration [-Identity ] [-Filter ] @@ -31,7 +32,7 @@ This cmdlet is used retrieve the Teams and ACS federation configuration for a Te You must be a Teams service admin or a Teams communication admin for your organization to run the cmdlet. -## Examples +## EXAMPLES ### Example 1 ```powershell @@ -102,10 +103,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) +[Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy.md similarity index 81% rename from teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy.md index cc36983ff2..61dd52de46 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy.md @@ -1,23 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsapppermissionpolicy applicable: Microsoft Teams -title: Get-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: mhayrapetyan +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsapppermissionpolicy +schema: 2.0.0 +title: Get-CsTeamsAppPermissionPolicy --- # Get-CsTeamsAppPermissionPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. - -As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . - -**This is only applicable for tenants who have not been migrated to ACM or UAM.** +As an admin, you can use app permission policies to allow or block apps for your users. ## SYNTAX @@ -33,10 +31,13 @@ Get-CsTeamsAppPermissionPolicy [-Tenant ] [-Filter ] [-Loca ``` ## DESCRIPTION + **NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppSetupPolicy.md similarity index 81% rename from teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppSetupPolicy.md index 47de4b4b99..16f6536082 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppSetupPolicy.md @@ -1,24 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsappsetuppolicy applicable: Microsoft Teams -title: Get-CsTeamsAppSetupPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsappsetuppolicy +schema: 2.0.0 +title: Get-CsTeamsAppSetupPolicy --- # Get-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy.md index 77cad0be0c..4c8c578e75 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy -title: Get-CsTeamsAudioConferencingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy schema: 2.0.0 +title: Get-CsTeamsAudioConferencingPolicy --- # Get-CsTeamsAudioConferencingPolicy @@ -103,8 +104,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy) -[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallHoldPolicy.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallHoldPolicy.md index 479035c0ea..04e7b9d2f6 100644 --- a/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy applicable: Microsoft Teams -title: Get-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallholdpolicy +schema: 2.0.0 +title: Get-CsTeamsCallHoldPolicy --- # Get-CsTeamsCallHoldPolicy @@ -118,10 +119,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy) -[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallholdpolicy) -[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallholdpolicy) -[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallholdpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallParkPolicy.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallParkPolicy.md index e9b195959d..54137a272e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallParkPolicy.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallparkpolicy applicable: Microsoft Teams -title: Get-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallparkpolicy +schema: 2.0.0 +title: Get-CsTeamsCallParkPolicy --- # Get-CsTeamsCallParkPolicy ## SYNOPSIS - -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. - -NOTE: the call park feature is currently only available in the desktop and web clients. Call Park functionality is currently completely disabled in mobile clients. +The Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. ## SYNTAX @@ -34,6 +33,8 @@ Get-CsTeamsCallParkPolicy [-Tenant ] [-Filter ] [-LocalStor ## DESCRIPTION The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different phone. The Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. +NOTE: the call park feature is currently only available in the desktop and web clients. Call Park functionality is currently completely disabled in mobile clients. + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallingPolicy.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallingPolicy.md index 44a936109d..a1863d8ee0 100644 --- a/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy applicable: Microsoft Teams -title: Get-CsTeamsCallingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallingpolicy +schema: 2.0.0 +title: Get-CsTeamsCallingPolicy --- # Get-CsTeamsCallingPolicy @@ -53,8 +53,9 @@ Retrieves the calling policies with Identity starting with Sales. ## PARAMETERS -### -Identity -Specify the TeamsCallingPolicy that you would like to retrieve. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". ```yaml Type: String @@ -62,15 +63,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. -To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". +### -Identity +Specify the TeamsCallingPolicy that you would like to retrieve. ```yaml Type: String @@ -78,7 +78,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -99,10 +99,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallingpolicy) -[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallingpolicy) -[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallingpolicy) -[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsChannelsPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsChannelsPolicy.md index 444867452e..767b0b4d93 100644 --- a/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsChannelsPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy applicable: Microsoft Teams -title: Get-CsTeamsChannelsPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamschannelspolicy +schema: 2.0.0 +title: Get-CsTeamsChannelsPolicy --- # Get-CsTeamsChannelsPolicy @@ -42,35 +44,35 @@ Retrieves all policies related to Teams & Channels that are available in your or ## PARAMETERS -### -Identity -Specify the unique name of a policy you would like to retrieve. Use one of the following values: - -- `Global` -- The name of a custom policy you've created. If the value contains spaces, enclose the value in quotation marks ("). Note that the Identity value shows as `Tag:`, but the `` value also works. -- `Default`: This is a template that's used to populate the default property values when you create a new policy or to reset the property values in the global policy in case you delete it. Note that the Identity value shows as `Tag:Default`, but the `Default` value also works. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return a collection of all the per-user policies, use this syntax: -Filter "tag:". ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: String +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return a collection of all the per-user policies, use this syntax: -Filter "tag:". +### -Identity +Specify the unique name of a policy you would like to retrieve. Use one of the following values: + +- `Global` +- The name of a custom policy you've created. If the value contains spaces, enclose the value in quotation marks ("). Note that the Identity value shows as `Tag:`, but the `` value also works. +- `Default`: This is a template that's used to populate the default property values when you create a new policy or to reset the property values in the global policy in case you delete it. Note that the Identity value shows as `Tag:Default`, but the `Default` value also works. ```yaml -Type: String -Parameter Sets: Filter +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsClientConfiguration.md similarity index 82% rename from teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsClientConfiguration.md index 8ade0c1ba8..69bb11b7c7 100644 --- a/teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsClientConfiguration.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsclientconfiguration applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Get-CsTeamsClientConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsclientconfiguration +schema: 2.0.0 +title: Get-CsTeamsClientConfiguration --- # Get-CsTeamsClientConfiguration ## SYNOPSIS -The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and how Surface Hub devices can interact with Skype for Business meetings. This cmdlet allows IT admins to retrieve the effective configuration for their organization. +This cmdlet allows IT admins to retrieve the effective configuration for their organization. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication.md index a480bcadfc..eddedafe26 100644 --- a/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication.md @@ -1,20 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication applicable: Microsoft Teams -title: Get-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication +schema: 2.0.0 +title: Get-CsTeamsComplianceRecordingApplication --- # Get-CsTeamsComplianceRecordingApplication ## SYNOPSIS Returns information about the application instances of policy-based recording applications that have been configured for administering automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. ## SYNTAX @@ -32,6 +32,7 @@ Get-CsTeamsComplianceRecordingApplication [-Tenant ] [-Filter Applicable: Microsoft Teams + Policy instance name (optional). ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -72,8 +75,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy.md similarity index 71% rename from teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy.md index 9a3a36317e..244c82580e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseducationassignmentsapppolicy applicable: Microsoft Teams -title: Get-CsTeamsEducationAssignmentsAppPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamseducationassignmentsapppolicy +schema: 2.0.0 +title: Get-CsTeamsEducationAssignmentsAppPolicy --- # Get-CsTeamsEducationAssignmentsAppPolicy ## SYNOPSIS - -This policy is controlled by Global and Teams Service Administrators, and is used to turn on/off certain features only related to the Assignments Service, which runs for tenants with EDU licenses. This cmdlet allows you to retrieve the current values of your Education Assignments App Policy. At this time, you can only modify your global policy - this policy type does not support user-level custom policies. +This cmdlet allows you to retrieve the current values of your Education Assignments App Policy. ## SYNTAX @@ -32,7 +32,10 @@ Get-CsTeamsEducationAssignmentsAppPolicy [-Tenant ] [-Filter ] [] ``` ### Filter -```powershell + +``` Get-CsTeamsEducationConfiguration [-Filter ] [] ``` @@ -32,7 +35,7 @@ This cmdlet is used to retrieve the organization-wide education configuration fo You must be a Teams Service Administrator for your organization to run the cmdlet. -## Examples +## EXAMPLES ### Example 1 ```powershell @@ -91,4 +94,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration) +[Set-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamseducationconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy.md index 82cff25140..165b263df3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Get-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Get-CsTeamsEmergencyCallRoutingPolicy --- # Get-CsTeamsEmergencyCallRoutingPolicy @@ -55,31 +57,31 @@ Retrieves all emergency call routing policies with identity starting with Test. ## PARAMETERS -### -Identity -Specify the policy that you would like to retrieve. +### -Filter + Enables you to use wildcard characters when indicating the policy (or policies) to be returned. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter - Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +### -Identity +Specify the policy that you would like to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -98,10 +100,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy) -[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy.md similarity index 87% rename from teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy.md index 2bae2ad08c..49eb1d04c8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Get-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy schema: 2.0.0 +title: Get-CsTeamsEmergencyCallingPolicy --- # Get-CsTeamsEmergencyCallingPolicy @@ -72,31 +74,31 @@ This example displays extended notifications set on emergency calling policy wit ## PARAMETERS -### -Identity -Specify the policy that you would like to retrieve. +### -Filter +The Filter parameter allows you to limit the number of results based on filters on Identity you specify. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to limit the number of results based on filters on Identity you specify. +### -Identity +Specify the policy that you would like to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -117,10 +119,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy) -[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy) -[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEnhancedEncryptionPolicy.md similarity index 86% rename from teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEnhancedEncryptionPolicy.md index d1c2fd903d..9f15733ba9 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEnhancedEncryptionPolicy.md @@ -1,111 +1,112 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy -title: Get-CsTeamsEnhancedEncryptionPolicy -author: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Get-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Returns information about the teams enhanced encryption policies configured for use in your organization. -## SYNTAX - -``` -Get-CsTeamsEnhancedEncryptionPolicy [-LocalStore] [[-Identity] ] [-Filter ] - [] -``` - -## DESCRIPTION -Returns information about the Teams enhanced encryption policies configured for use in your organization. -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -``` - -The command shown in Example 1 returns information for all the teams enhanced encryption policies configured for use in the tenant. - -### EXAMPLE 2 -```PowerShell -PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerEnhancedEncryptionPolicy' -``` - -In Example 2, information is returned for a single teams enhanced encryption policy: the policy with the Identity ContosoPartnerEnhancedEncryptionPolicy. - -## PARAMETERS - -### -LocalStore -Internal Microsoft use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed policies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Get-CsTeamsEnhancedEncryptionPolicy +--- + +# Get-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Returns information about the teams enhanced encryption policies configured for use in your organization. +## SYNTAX + +``` +Get-CsTeamsEnhancedEncryptionPolicy [-LocalStore] [[-Identity] ] [-Filter ] + [] +``` + +## DESCRIPTION +Returns information about the Teams enhanced encryption policies configured for use in your organization. +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> Get-CsTeamsEnhancedEncryptionPolicy +``` + +The command shown in Example 1 returns information for all the teams enhanced encryption policies configured for use in the tenant. + +### EXAMPLE 2 +```PowerShell +PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerEnhancedEncryptionPolicy' +``` + +In Example 2, information is returned for a single teams enhanced encryption policy: the policy with the Identity ContosoPartnerEnhancedEncryptionPolicy. + +## PARAMETERS + +### -Filter +If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed policies. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Internal Microsoft use only. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEventsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEventsPolicy.md index db497af1ae..e0fa56fe4e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEventsPolicy.md @@ -1,90 +1,91 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseventspolicy -title: Get-CsTeamsEventsPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsEventsPolicy - -## SYNOPSIS -Returns information about the Teams Events policy. Note that this policy is currently still in preview. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsEventsPolicy [[-Identity] ] [] -``` - -### Filter -``` -Get-CsTeamsEventsPolicy [-Filter ] [] -``` - -## DESCRIPTION -Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsEventsPolicy -``` - -Returns information for all Teams Events policies available for use in the tenant. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsEventsPolicy -Identity Global -``` - -Returns information for Teams Events policy with identity "Global". - -## PARAMETERS - -### -Filter -Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams Events policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamseventspolicy +schema: 2.0.0 +title: Get-CsTeamsEventsPolicy +--- + +# Get-CsTeamsEventsPolicy + +## SYNOPSIS +Returns information about the Teams Events policy. Note that this policy is currently still in preview. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsEventsPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsEventsPolicy [-Filter ] [] +``` + +## DESCRIPTION +Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsEventsPolicy +``` + +Returns information for all Teams Events policies available for use in the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsEventsPolicy -Identity Global +``` + +Returns information for Teams Events policy with identity "Global". + +## PARAMETERS + +### -Filter +Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsExternalAccessConfiguration.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsExternalAccessConfiguration.md index ca976fe3ca..d29bdca8ee 100644 --- a/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsExternalAccessConfiguration.md @@ -1,15 +1,16 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsexternalaccessconfiguration -title: Get-CsTeamsExternalAccessConfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsexternalaccessconfiguration schema: 2.0.0 +title: Get-CsTeamsExternalAccessConfiguration --- # Get-CsTeamsExternalAccessConfiguration ## SYNOPSIS -The TeamsExternalAccessConfiguration contains all configurations that can be used to enhance the security of the entire organization, such as managing blocked users. This cmdlet returns the current settings of your organization. +This cmdlet returns the current settings of your organization. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFeedbackPolicy.md similarity index 92% rename from teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsFeedbackPolicy.md index 5000645a03..92b57b2818 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFeedbackPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Get-CsTeamsFeedbackPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfeedbackpolicy +schema: 2.0.0 +title: Get-CsTeamsFeedbackPolicy --- # Get-CsTeamsFeedbackPolicy @@ -42,31 +43,31 @@ In this example, we retrieve all the existing Teams feedback policies in the org ## PARAMETERS -### -Identity -The unique identifier of the policy. +### -Filter +Internal Microsoft use ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Internal Microsoft use +### -Identity +The unique identifier of the policy. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFilesPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsFilesPolicy.md index 0340a280a1..e87e325295 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFilesPolicy.md @@ -1,15 +1,16 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy -title: Get-CsTeamsFilesPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfilespolicy schema: 2.0.0 +title: Get-CsTeamsFilesPolicy --- # Get-CsTeamsFilesPolicy ## SYNOPSIS -Use the \`Get-CsTeamsFilesPolicy\` cmdlet to get a list of all pre-configured policy instances related to teams files. +Get a list of all pre-configured policy instances related to teams files. ## SYNTAX @@ -54,33 +55,33 @@ The filter value "tag:*" tells the Get-CsTeamsFilesPolicy cmdlet to return only ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. -If this parameter is omitted, all teams files policies available for use are returned. +### -Filter +This parameter accepts a wildcard string and returns all teams files policies with identities matching that string. +For example, a Filter value of Tag:* will return all preconfigured teams files policy instances (excluding forest default "Global") available to use by the tenant admins. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter accepts a wildcard string and returns all teams files policies with identities matching that string. -For example, a Filter value of Tag:* will return all preconfigured teams files policy instances (excluding forest default "Global") available to use by the tenant admins. +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. +If this parameter is omitted, all teams files policies available for use are returned. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -101,10 +102,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md index 274a3a8171..14a32c67ce 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration -title: Get-CsTeamsFirstPartyMeetingTemplateConfiguration -schema: 2.0.0 -author: boboPD ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration +schema: 2.0.0 +title: Get-CsTeamsFirstPartyMeetingTemplateConfiguration --- # Get-CsTeamsFirstPartyMeetingTemplateConfiguration @@ -55,6 +56,8 @@ Fetches all the first-party templates on the tenant. ### -Identity +> Applicable: Microsoft Teams + This parameter can be used to fetch a specific instance of the configuration. Note: This configuration is read only and will only have the Global instance. @@ -63,7 +66,6 @@ Note: This configuration is read only and will only have the Global instance. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -81,4 +83,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplateconfiguration) +[Get-CsTeamsMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplateconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration.md index c14d3fbeec..d20d862687 100644 --- a/teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration.md @@ -1,13 +1,13 @@ --- +author: tomkau external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestcallingconfiguration +Locale: en-US +manager: bulenteg Module Name: MicrosoftTeams -title: Get-CsTeamsGuestCallingConfiguration -schema: 2.0.0 -author: tomkau ms.author: tomkau -manager: bulenteg -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsguestcallingconfiguration +schema: 2.0.0 +title: Get-CsTeamsGuestCallingConfiguration --- # Get-CsTeamsGuestCallingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration.md index fb9aee778f..3555fb9882 100644 --- a/teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestmeetingconfiguration applicable: Microsoft Teams -title: Get-CsTeamsGuestMeetingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsguestmeetingconfiguration +schema: 2.0.0 +title: Get-CsTeamsGuestMeetingConfiguration --- # Get-CsTeamsGuestMeetingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration.md index c5dbf828bd..4202b878fb 100644 --- a/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestmessagingconfiguration applicable: Microsoft Teams -title: Get-CsTeamsGuestMessagingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsguestmessagingconfiguration +schema: 2.0.0 +title: Get-CsTeamsGuestMessagingConfiguration --- # Get-CsTeamsGuestMessagingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsIPPhonePolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsIPPhonePolicy.md index 4df635ab40..753f46a1ae 100644 --- a/teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsipphonepolicy applicable: Microsoft Teams -title: Get-CsTeamsIPPhonePolicy author: tonywoodruff +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsipphonepolicy schema: 2.0.0 +title: Get-CsTeamsIPPhonePolicy --- # Get-CsTeamsIPPhonePolicy @@ -48,31 +49,31 @@ Retrieves the IP Phone Policy with name "CommonAreaPhone". ## PARAMETERS -### -Identity -Specify the unique name of the TeamsIPPhonePolicy that you would like to retrieve. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". +### -Identity +Specify the unique name of the TeamsIPPhonePolicy that you would like to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaConnectivityPolicy.md similarity index 84% rename from teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaConnectivityPolicy.md index 8c4debe867..52ceb4a618 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Get-CsTeamsMediaConnectivityPolicy -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMediaConnectivityPolicy -schema: 2.0.0 author: lirunping-MSFT +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: runli +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +title: Get-CsTeamsMediaConnectivityPolicy --- # Get-CsTeamsMediaConnectivityPolicy @@ -91,10 +92,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy) -[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy) -[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy) -[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaLoggingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaLoggingPolicy.md index 85ecd6cb9c..9de6e861c2 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaLoggingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy applicable: Microsoft Teams -title: Get-CsTeamsMediaLoggingPolicy author: LeoKuhorev -ms.author: leokukharau +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US manager: shalages +Module Name: MicrosoftTeams +ms.author: leokukharau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmedialoggingpolicy schema: 2.0.0 +title: Get-CsTeamsMediaLoggingPolicy --- # Get-CsTeamsMediaLoggingPolicy @@ -58,42 +59,44 @@ Return Teams Media Logging policy that is set for the entire tenant. ## PARAMETERS -### -Identity +### -Filter -Unique identifier assigned to the Teams Media Logging policy. Note that Teams Media Logging policy has only one instance that has Identity "Enabled". +> Applicable: Microsoft Teams -Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. +Enables using wildcards when specifying the policy (or policies) to be retrieved. +Note that you cannot use both the Filter and the Identity parameters in the same command. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: -applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables using wildcards when specifying the policy (or policies) to be retrieved. -Note that you cannot use both the Filter and the Identity parameters in the same command. +### -Identity + +> Applicable: Microsoft Teams + +Unique identifier assigned to the Teams Media Logging policy. Note that Teams Media Logging policy has only one instance that has Identity "Enabled". + +Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -108,4 +111,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy) +[Grant-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmedialoggingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy.md similarity index 86% rename from teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy.md index d7a61ce63f..af50137246 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Get-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # Get-CsTeamsMeetingBrandingPolicy @@ -93,12 +93,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration.md similarity index 84% rename from teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration.md index 973021d356..18e25f56c3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbroadcastconfiguration applicable: Microsoft Teams -title: Get-CsTeamsMeetingBroadcastConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbroadcastconfiguration +schema: 2.0.0 +title: Get-CsTeamsMeetingBroadcastConfiguration --- # Get-CsTeamsMeetingBroadcastConfiguration ## SYNOPSIS -Get-CsTeamsMeetingBroadcastConfiguration \[\[-Identity\] \\] \[-Tenant \\] \[-ExposeSDNConfigurationJsonBlob \\] \[-LocalStore\] \[\\] - -Get-CsTeamsMeetingBroadcastConfiguration \[-Tenant \\] \[-ExposeSDNConfigurationJsonBlob \\] \[-Filter \\] \[-LocalStore\] \[\\] +Gets Tenant level configuration for broadcast events in Teams. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy.md index 0b2ca7c3cd..c3d06519ad 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbroadcastpolicy applicable: Microsoft Teams -title: Get-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Get-CsTeamsMeetingBroadcastPolicy --- # Get-CsTeamsMeetingBroadcastPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingConfiguration.md similarity index 93% rename from teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingConfiguration.md index 3cd9448904..a317e68552 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingconfiguration applicable: Microsoft Teams -title: Get-CsTeamsMeetingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingconfiguration +schema: 2.0.0 +title: Get-CsTeamsMeetingConfiguration --- # Get-CsTeamsMeetingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingPolicy.md similarity index 92% rename from teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingPolicy.md index 3679deb1f5..a8de0bd11c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy applicable: Microsoft Teams -title: Get-CsTeamsMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingpolicy +schema: 2.0.0 +title: Get-CsTeamsMeetingPolicy --- # Get-CsTeamsMeetingPolicy @@ -36,14 +38,14 @@ The Get-CsTeamsMeetingPolicy cmdlet enables you to return information about all ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsTeamsMeetingPolicy ``` In Example 1, Get-CsTeamsMeetingPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsTeamsMeetingPolicy -Identity SalesPolicy ``` @@ -51,7 +53,7 @@ Get-CsTeamsMeetingPolicy -Identity SalesPolicy In Example 2, Get-CsTeamsMeetingPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell Get-CsTeamsMeetingPolicy | Where-Object {$_.AllowMeetNow -eq $True} ``` @@ -60,7 +62,7 @@ The preceding command returns a collection of all the meeting policies where the To do this, Get-CsTeamsMeetingPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the AllowMeetNow property is equal to True. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell Get-CsTeamsMeetingPolicy -Identity Global | fl NewMeetingRecordingExpirationDays ``` diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplateConfiguration.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplateConfiguration.md index f5121f5202..40422e491b 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsMeetingTemplateConfiguration -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplateConfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsMeetingTemplateConfiguration schema: 2.0.0 +title: Get-CsTeamsMeetingTemplateConfiguration --- # Get-CsTeamsMeetingTemplateConfiguration @@ -53,6 +54,8 @@ Fetches all the custom templates on the tenant. ### -Identity +> Applicable: Microsoft Teams + This parameter can be used to fetch a specific instance of the configuration. Note: This configuration is read only and will only have the Global instance. @@ -61,7 +64,6 @@ Note: This configuration is read only and will only have the Global instance. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -79,4 +81,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsfirstpartymeetingtemplateconfiguration) +[Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfirstpartymeetingtemplateconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 86% rename from teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplatePermissionPolicy.md index 22af122659..3a877a3be8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplatePermissionPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Get-CsTeamsMeetingTemplatePermissionPolicy --- # Get-CsTeamsMeetingTemplatePermissionPolicy @@ -82,36 +83,38 @@ Note: _The "Tag:" prefix can be ignored when specifying the identity._ ## PARAMETERS -### -Identity +### -Filter -This parameter can be used to fetch a specific instance of the policy. +> Applicable: Microsoft Teams + +This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None Accept pipeline input: False -Accept wildcard characters: False +Accept wildcard characters: True ``` -### -Filter +### -Identity -This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. +> Applicable: Microsoft Teams + +This parameter can be used to fetch a specific instance of the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None Accept pipeline input: False -Accept wildcard characters: True +Accept wildcard characters: False ``` ### CommonParameters @@ -124,10 +127,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingConfiguration.md similarity index 90% rename from teams/teams-ps/teams/get-csteamsmessagingconfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingConfiguration.md index fc5ad06309..7a197af8c4 100644 --- a/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingConfiguration.md @@ -1,93 +1,94 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMessagingConfiguration -title: Get-CsTeamsMessagingConfiguration -schema: 2.0.0 ---- - -# Get-CsTeamsMessagingConfiguration - -## SYNOPSIS - -TeamsMessagingConfiguration determines the messaging settings for users. This cmdlet returns your organization's current settings. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsMessagingConfiguration [[-Identity] ] [] -``` - -### Filter - -```powershell -Get-CsTeamsMessagingConfiguration [-Filter ] [] -``` - -## DESCRIPTION - -TeamsMessagingConfiguration determines the messaging settings for users. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsTeamsMessagingConfiguration -``` - -The command shown in Example 1 returns teams messaging configuration information for the current tenant. - -## PARAMETERS - -### -Filter - -Enables you to use wildcard characters in order to return a collection of tenant messaging configuration settings. Because each tenant is limited to a single, global collection of the messaging configuration settings there is no need to use the Filter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingconfiguration) +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsMessagingConfiguration +schema: 2.0.0 +title: Get-CsTeamsMessagingConfiguration +--- + +# Get-CsTeamsMessagingConfiguration + +## SYNOPSIS + +TeamsMessagingConfiguration determines the messaging settings for users. This cmdlet returns your organization's current settings. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsMessagingConfiguration [[-Identity] ] [] +``` + +### Filter + +```powershell +Get-CsTeamsMessagingConfiguration [-Filter ] [] +``` + +## DESCRIPTION + +TeamsMessagingConfiguration determines the messaging settings for users. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsMessagingConfiguration +``` + +The command shown in Example 1 returns teams messaging configuration information for the current tenant. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters in order to return a collection of tenant messaging configuration settings. Because each tenant is limited to a single, global collection of the messaging configuration settings there is no need to use the Filter parameter. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingPolicy.md index 8f998b1d2f..055fdc8614 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy applicable: Microsoft Teams -title: Get-CsTeamsMessagingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmessagingpolicy +schema: 2.0.0 +title: Get-CsTeamsMessagingPolicy --- # Get-CsTeamsMessagingPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMobilityPolicy.md similarity index 93% rename from teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMobilityPolicy.md index 3a147f9743..d6e704548c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmobilitypolicy applicable: Microsoft Teams -title: Get-CsTeamsMobilityPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmobilitypolicy +schema: 2.0.0 +title: Get-CsTeamsMobilityPolicy --- # Get-CsTeamsMobilityPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMultiTenantOrganizationConfiguration.md similarity index 85% rename from teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMultiTenantOrganizationConfiguration.md index 73ca7780ac..d4c7f80275 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMultiTenantOrganizationConfiguration.md @@ -1,15 +1,16 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Get-CsTeamsMultiTenantOrganizationConfiguration -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmultitenantorganizationconfiguration -schema: 2.0.0 author: samlyu +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: samlyu +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmultitenantorganizationconfiguration +schema: 2.0.0 +title: Get-CsTeamsMultiTenantOrganizationConfiguration --- -# Get-CsTeamsMultiTenantOrganizationConfiguration +# Get-CsTeamsMultiTenantOrganizationConfiguration ## SYNOPSIS diff --git a/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy.md index f098d86971..5fe67a86d5 100644 --- a/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnetworkroamingpolicy applicable: Microsoft Teams -title: Get-CsTeamsNetworkRoamingPolicy author: TristanChen-msft -ms.author: jiaych -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsnetworkroamingpolicy schema: 2.0.0 +title: Get-CsTeamsNetworkRoamingPolicy --- # Get-CsTeamsNetworkRoamingPolicy @@ -44,14 +44,14 @@ To enable the network roaming policy for users who are not Enterprise Voice enab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsTeamsNetworkRoamingPolicy ``` In Example 1, Get-CsTeamsNetworkRoamingPolicy is called without any additional parameters; this returns a collection of all the teams network roaming policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsTeamsNetworkRoamingPolicy -Identity OfficePolicy ``` @@ -61,13 +61,12 @@ Because identities are unique, this command will never return more than one item ## PARAMETERS -### -Identity -Unique identifier of the policy to be returned. -If this parameter is omitted, then all the Teams Network Roaming Policies configured for use in your organization will be returned. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False @@ -77,12 +76,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +### -Identity +Unique identifier of the policy to be returned. +If this parameter is omitted, then all the Teams Network Roaming Policies configured for use in your organization will be returned. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False diff --git a/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNotificationAndFeedsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsNotificationAndFeedsPolicy.md index 95ac82e696..b0b1eb93f8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNotificationAndFeedsPolicy.md @@ -1,100 +1,101 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnotificationandfeedspolicy -title: Get-CsTeamsNotificationAndFeedsPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsNotificationAndFeedsPolicy - -## SYNOPSIS -Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. - -## SYNTAX - -### Identity (Default) -```powershell -Get-CsTeamsNotificationAndFeedsPolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter -```powershell -Get-CsTeamsNotificationAndFeedsPolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## DESCRIPTION -The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsNotificationAndFeedsPolicy -``` - -The command shown above returns information of all Teams NotificationAndFeedsPolicy that have been configured for use in the tenant. - -## PARAMETERS - -### -Filter -A filter that is not expressed in the standard wildcard language. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the policy when it was created. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsnotificationandfeedspolicy +schema: 2.0.0 +title: Get-CsTeamsNotificationAndFeedsPolicy +--- + +# Get-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS +Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsNotificationAndFeedsPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter +```powershell +Get-CsTeamsNotificationAndFeedsPolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsNotificationAndFeedsPolicy +``` + +The command shown above returns information of all Teams NotificationAndFeedsPolicy that have been configured for use in the tenant. + +## PARAMETERS + +### -Filter +A filter that is not expressed in the standard wildcard language. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRecordingRollOutPolicy.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsRecordingRollOutPolicy.md index f4c168932c..493ee2f5a3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsrecordingrolloutpolicy -schema: 2.0.0 applicable: Microsoft Teams -title: Get-CsTeamsRecordingRollOutPolicy -manager: yujin1 author: ronwa +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams ms.author: ronwa +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsrecordingrolloutpolicy +schema: 2.0.0 +title: Get-CsTeamsRecordingRollOutPolicy --- # Get-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md index d0da8be66e..5231769195 100644 --- a/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,99 +1,102 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsroomvideoteleconferencingpolicy -title: Get-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsTeamsRoomVideoTeleConferencingPolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -Filter - -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The name the tenant admin gave to the Policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Get-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Get-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsRoomVideoTeleConferencingPolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## EXAMPLES + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The name the tenant admin gave to the Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSettingsCustomApp.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSettingsCustomApp.md index 74dc4c20ca..a170e558de 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSettingsCustomApp.md @@ -1,83 +1,84 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp -title: Get-CsTeamsSettingsCustomApp -schema: 2.0.0 ---- - -# Get-CsTeamsSettingsCustomApp - -## SYNOPSIS -Get the Custom Apps Setting's value of Teams Admin Center. - -## SYNTAX - -``` -Get-CsTeamsSettingsCustomApp [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -There is a switch for managing Custom Apps in the Org-wide app settings page of Teams Admin Center. The command can get the current value of this switch. If the switch is enabled, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsSettingsCustomApp - -IsSideloadedAppsInteractionEnabled ----------------------------------- - False -``` - -Get the value of Custom Apps Setting. The value in the example is False, so custom apps are unavailable in the organization's app store. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[Set-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssettingscustomapp +schema: 2.0.0 +title: Get-CsTeamsSettingsCustomApp +--- + +# Get-CsTeamsSettingsCustomApp + +## SYNOPSIS +Get the Custom Apps Setting's value of Teams Admin Center. + +## SYNTAX + +``` +Get-CsTeamsSettingsCustomApp [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +There is a switch for managing Custom Apps in the Org-wide app settings page of Teams Admin Center. The command can get the current value of this switch. If the switch is enabled, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsSettingsCustomApp + +IsSideloadedAppsInteractionEnabled +---------------------------------- + False +``` + +Get the value of Custom Apps Setting. The value in the example is False, so custom apps are unavailable in the organization's app store. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSharedCallingRoutingPolicy.md similarity index 87% rename from teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSharedCallingRoutingPolicy.md index 817189ce6e..2f2ee7b031 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -title: Get-CsTeamsSharedCallingRoutingPolicy -schema: 2.0.0 author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy +schema: 2.0.0 +title: Get-CsTeamsSharedCallingRoutingPolicy --- # Get-CsTeamsSharedCallingRoutingPolicy @@ -61,35 +60,35 @@ The command shown in Example 4 returns information about the Global policy insta ## PARAMETERS -### -Identity -Unique identifier of the Teams shared calling routing policy to be retrieved. - -You cannot use wildcard characters when specifying the Identity. If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsSharedCallingRoutingPolicy -returns all the Teams shared calling routing policies configured for use in the organization. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. -To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". +### -Identity +Unique identifier of the Teams shared calling routing policy to be retrieved. + +You cannot use wildcard characters when specifying the Identity. If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsSharedCallingRoutingPolicy +returns all the Teams shared calling routing policies configured for use in the organization. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -105,10 +104,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy) -[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsAppPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsAppPolicy.md index e669a7e816..371677e591 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsAppPolicy.md @@ -1,107 +1,108 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsapppolicy -title: Get-CsTeamsShiftsAppPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsShiftsAppPolicy - -## SYNOPSIS - -Returns information about the Teams Shifts App policies that have been configured for use in your organization. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsShiftsAppPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] -``` - -### Filter - -```powershell -Get-CsTeamsShiftsAppPolicy [-MsftInternalProcessingMode ] [-Filter ] [] -``` - -## DESCRIPTION - -The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsTeamsShiftsAppPolicy -``` - -Lists any available Teams Shifts Apps Policies. - -## PARAMETERS - -### -Filter - -This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique Identity assigned to the policy when it was created. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -{{ Fill MsftInternalProcessingMode Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsapppolicy +schema: 2.0.0 +title: Get-CsTeamsShiftsAppPolicy +--- + +# Get-CsTeamsShiftsAppPolicy + +## SYNOPSIS + +Returns information about the Teams Shifts App policies that have been configured for use in your organization. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsShiftsAppPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsTeamsShiftsAppPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsShiftsAppPolicy +``` + +Lists any available Teams Shifts Apps Policies. + +## PARAMETERS + +### -Filter + +This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique Identity assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnection.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnection.md index 5bfed6ecbd..8f0e90f914 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection schema: 2.0.0 +title: Get-CsTeamsShiftsConnection --- # Get-CsTeamsShiftsConnection @@ -109,6 +110,21 @@ Returns the connection with the specified -ConnectionId. ## PARAMETERS +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Break Wait for .NET debugger to attach. @@ -229,21 +245,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -261,8 +262,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnection) -[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnection) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionConnector.md similarity index 85% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionConnector.md index b236e9c29c..974ae50be3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionConnector.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionConnector -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionconnector schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionConnector --- # Get-CsTeamsShiftsConnectionConnector @@ -60,10 +61,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection) -[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionErrorReport.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionErrorReport.md index adf41720e0..0df570692a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionErrorReport.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionErrorReport -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionerrorreport schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionErrorReport --- # Get-CsTeamsShiftsConnectionErrorReport @@ -141,24 +142,10 @@ Returns the error report created after `2022-12-12T19:11:39.073Z`. ## PARAMETERS -### -ErrorReportId - -The ID of the error report. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Activeness +> Applicable: Microsoft Teams + The flag indicating results should have which activeness. Set this to `ActiveOnly` to get Error reports that are not resolved. Set this to `InactiveOnly` to get Error reports that are resolved. @@ -168,7 +155,6 @@ Set this to `Both` to get both active and inactive Error reports. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -176,15 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId +### -After -The UUID of a WFM connection. +> Applicable: Microsoft Teams + +The timestamp indicating results should be after which date and time. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -192,15 +179,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorInstanceId - -The UUID of a connector instance. +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Get Aliases: -Applicable: Microsoft Teams + Required: False Position: Named Default value: None @@ -208,15 +194,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamId +### -Before -The UUID of a team in Graph. +> Applicable: Microsoft Teams + +The timestamp indicating results should be before which date and time. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -224,15 +211,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Operation - -The name of the action of the controller or the name of the command. +### -Break +Wait for the .NET debugger to attach. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + Required: False Position: Named Default value: None @@ -240,15 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Procedure +### -Code -The name of the executing function or procedure. +> Applicable: Microsoft Teams + +The enum value of error code, human readable string defined in codebase. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -256,15 +243,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Code +### -ConnectionId -The enum value of error code, human readable string defined in codebase. +> Applicable: Microsoft Teams + +The UUID of a WFM connection. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -272,15 +260,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Before +### -ConnectorInstanceId -The timestamp indicating results should be before which date and time. +> Applicable: Microsoft Teams + +The UUID of a connector instance. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -288,15 +277,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -After +### -ErrorReportId -The timestamp indicating results should be after which date and time. +> Applicable: Microsoft Teams + +The ID of the error report. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -304,12 +294,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: Get +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: Required: False @@ -319,11 +309,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for the .NET debugger to attach. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: SwitchParameter +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -334,29 +324,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -InputObject +Identity Parameter ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -Operation + +> Applicable: Microsoft Teams + +The name of the action of the controller or the name of the command. ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -364,18 +356,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter +### -Procedure + +> Applicable: Microsoft Teams + +The name of the executing function or procedure. ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity +Type: String +Parameter Sets: (All) Aliases: - -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -423,6 +417,23 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamId + +> Applicable: Microsoft Teams + +The UUID of a team in Graph. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -434,4 +445,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Disable-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport) +[Disable-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/microsoftteams/disable-csteamsshiftsconnectionerrorreport) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionInstance.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionInstance.md index 9cae80f516..470a011735 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: leonardospina external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionInstance -author: leonardospina ms.author: lespina -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionInstance --- # Get-CsTeamsShiftsConnectionInstance @@ -272,8 +273,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionOperation.md similarity index 84% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionOperation.md index e1910f5da5..d837395e0a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionOperation.md @@ -1,31 +1,32 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionOperation -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionoperation schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionOperation --- # Get-CsTeamsShiftsConnectionOperation ## SYNOPSIS -This cmdlet gets the requested batch mapping operation. The batch mapping operation can be submitted by running [New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap). +This cmdlet gets the requested batch mapping operation. ## SYNTAX ### Get (Default) -```powershell +``` Get-CsTeamsShiftsConnectionOperation -OperationId [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` ### GetViaIdentity -```powershell +``` Get-CsTeamsShiftsConnectionOperation -InputObject [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] @@ -33,7 +34,7 @@ Get-CsTeamsShiftsConnectionOperation -InputObject Get-CsTeamsShiftsConnectionOperation -OperationId c79131b7-9ecb-484b-a8df-2959c7c1e5f2 ``` + ```output CreatedDateTime LastActionDateTime Id Status TenantId Type WfmConnectorInstanceId ---------------- ------------------ ----------- ------ -------- ---- ---------------------- -12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2959c7c1e5f2 NotStarted dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a TeamsMappingOperation WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a113e01 +--------------- ------------------ ----------- ------ -------- ---- ---------------------- +12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2959c7c1e5f2 NotStarted dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a TeamsMappingOperation WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a113e01 ``` Returns the details of batch mapping operation with ID `c79131b7-9ecb-484b-a8df-2959c7c1e5f2`. @@ -182,4 +184,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap) +[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectionbatchteammap) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionSyncResult.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionSyncResult.md index d893f5cf7e..5f5946b32f 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionSyncResult.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionSyncResult -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionsyncresult +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionsyncresult schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionSyncResult --- # Get-CsTeamsShiftsConnectionSyncResult @@ -46,13 +47,14 @@ Returns the successful and failed users in the team mapping of Teams `12345d29-7 ### -ConnectorInstanceId -The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). +> Applicable: Microsoft Teams + +The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -60,35 +62,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamId +### -InputObject -The Teams team ID. It can be retrieved by visiting [AzureAAD](https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). +The Identity parameter. ```yaml -Type: String -Parameter Sets: (All) +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -InputObject +### -TeamId -The Identity parameter. +> Applicable: Microsoft Teams + +The Teams team ID. It can be retrieved by visiting [AzureAAD](https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity +Type: String +Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -103,4 +106,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionTeamMap.md similarity index 87% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionTeamMap.md index 7bdc708135..a83288964a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionTeamMap.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionTeamMap -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionteammap schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionTeamMap --- # Get-CsTeamsShiftsConnectionTeamMap @@ -23,7 +24,7 @@ Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId -InputObject Applicable: Microsoft Teams + The ID of the connection instance. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -90,6 +92,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Remove-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectionteammap) +[Remove-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectionteammap) -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmTeam.md similarity index 92% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmTeam.md index f65e7c3eed..cd1c59aeee 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmTeam.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionWfmTeam -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmteam schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionWfmTeam --- # Get-CsTeamsShiftsConnectionWfmTeam @@ -107,62 +108,64 @@ Returns the WFM teams for the WFM connection with ID `a2d1b091-5140-4dd2-987a-98 ## PARAMETERS -### -ConnectorInstanceId - -The ID of the connection instance. You can retrieve it by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Get1, GetViaIdentity1 Aliases: -Applicable: Microsoft Teams -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId - -The ID of the connection. You can retrieve it by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -Break +Wait for the .NET debugger to attach. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. +### -ConnectionId + +> Applicable: Microsoft Teams + +The ID of the connection. You can retrieve it by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). ```yaml Type: String -Parameter Sets: Get1, GetViaIdentity1 +Parameter Sets: (All) Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for the .NET debugger to attach. +### -ConnectorInstanceId + +> Applicable: Microsoft Teams + +The ID of the connection instance. You can retrieve it by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -270,8 +273,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection) -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[Get-CsTeamsShiftsConnectionWfmUser](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser) +[Get-CsTeamsShiftsConnectionWfmUser](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmuser) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmUser.md similarity index 84% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmUser.md index f32eda9d1a..6b24542c66 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmUser.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionWfmUser -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmuser schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionWfmUser --- # Get-CsTeamsShiftsConnectionWfmUser @@ -49,13 +50,14 @@ Returns the users in the WFM team with ID `1000107` in the connection instances ### -ConnectorInstanceId -The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). +> Applicable: Microsoft Teams + +The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -63,35 +65,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WfmTeamId +### -InputObject -The Teams team ID. It can be retrieved by running [Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam). +The identity parameter. ```yaml -Type: String -Parameter Sets: (All) +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -InputObject +### -WfmTeamId -The identity parameter. +> Applicable: Microsoft Teams + +The Teams team ID. It can be retrieved by running [Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmteam). ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity +Type: String +Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -106,6 +109,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam) +[Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmteam) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsPolicy.md similarity index 86% rename from teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsPolicy.md index 05e0a5d12c..9e7914d861 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsPolicy.md @@ -1,99 +1,102 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamsshiftspolicy -title: Get-CsTeamsShiftsPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. - -## SYNTAX - -### Identity (Default) -```powershell -Get-CsTeamsShiftsPolicy [[-Identity] ] [] -``` - -### Filter -```powershell -Get-CsTeamsShiftsPolicy [-Filter ] [] -``` - -## DESCRIPTION -This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsShiftsPolicy -``` - -Gets the properties of all instances of the TeamsShiftPolicy. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -``` - -Gets the properties of the OffShiftAccessMessage1Always instance of the TeamsShiftPolicy. - -## PARAMETERS - -### -Identity -Policy instance name. Optional. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamsshiftspolicy +schema: 2.0.0 +title: Get-CsTeamsShiftsPolicy +--- + +# Get-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsShiftsPolicy [[-Identity] ] [] +``` + +### Filter +```powershell +Get-CsTeamsShiftsPolicy [-Filter ] [] +``` + +## DESCRIPTION +This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsPolicy +``` + +Gets the properties of all instances of the TeamsShiftPolicy. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always +``` + +Gets the properties of the OffShiftAccessMessage1Always instance of the TeamsShiftPolicy. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Microsoft Teams + +Policy instance name. Optional. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSipDevicesConfiguration.md similarity index 72% rename from teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSipDevicesConfiguration.md index bae35132f4..c1782ecd64 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSipDevicesConfiguration.md @@ -1,11 +1,12 @@ --- +author: anmandav external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsSipDevicesConfiguration -author: anmandav ms.author: anmandav -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssipdevicesconfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssipdevicesconfiguration schema: 2.0.0 +title: Get-CsTeamsSipDevicesConfiguration --- # Get-CsTeamsSipDevicesConfiguration @@ -16,7 +17,7 @@ This cmdlet is used to retrieve the organization-wide Teams SIP devices configur ## SYNTAX -```powershell +``` Get-CsTeamsSipDevicesConfiguration [] ``` @@ -26,7 +27,12 @@ This cmdlet is used to retrieve the organization-wide Teams SIP devices configur To execute the cmdlet, you need to hold a role within your organization such as Global Reader, Teams Administrator, or Teams Communication Administrator. -## Examples +## EXAMPLES + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ### Example 1 @@ -50,4 +56,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamssipdevicesconfiguration) +[Set-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssipdevicesconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliance.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliance.md index e62879f6a5..9c1be693cd 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliance.md @@ -1,95 +1,100 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliance -title: Get-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# Get-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsSurvivableBranchAppliance [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsTeamsSurvivableBranchAppliance [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## PARAMETERS - -### -Filter - -This parameter can be used to fetch instances based on partial matches on the Identity field. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the SBA. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssurvivablebranchappliance +schema: 2.0.0 +title: Get-CsTeamsSurvivableBranchAppliance +--- + +# Get-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Gets the Survivable Branch Appliance (SBA) configured in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsSurvivableBranchAppliance [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsSurvivableBranchAppliance [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Filter + +This parameter can be used to fetch instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the SBA. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliancePolicy.md index c978c4c0a6..dd1dfa3bb9 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,95 +1,100 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliancepolicy -title: Get-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Get-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsTeamsSurvivableBranchAppliancePolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## PARAMETERS - -### -Filter - -This parameter can be used to fetch policy instances based on partial matches on the Identity field. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -This parameter can be used to fetch a specific instance of the policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Get-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Get-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Get the Survivable Branch Appliance (SBA) Policy defined in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsSurvivableBranchAppliancePolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Filter + +This parameter can be used to fetch policy instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTargetingPolicy.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsTargetingPolicy.md index 8b48de854b..434b596532 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTargetingPolicy.md @@ -1,111 +1,109 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy -title: Get-CsTeamsTargetingPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsTargetingPolicy - -## SYNOPSIS - -The Teams Targeting Policy cmdlets enable administrators to control the type of Tenant tag setting that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsTargetingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] -``` - -### Filter - -```powershell -Get-CsTeamsTargetingPolicy [-MsftInternalProcessingMode ] [-Filter ] [] -``` - -## DESCRIPTION - -The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. - -The Get-CsTeamsTargetingPolicy cmdlet enables you to return information about all the Tenant tag setting policies that have been configured for use in your organization. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsTeamsTargetingPolicy -Identity SalesPolicy -``` - -In this example Get-CsTeamsTargetingPolicy is used to return the per-tenant tag policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. - -## PARAMETERS - -### -Filter - -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-tenant policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the tenant tag setting policies configured for use in your organization will be returned. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) -[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstargetingpolicy +schema: 2.0.0 +title: Get-CsTeamsTargetingPolicy +--- + +# Get-CsTeamsTargetingPolicy + +## SYNOPSIS +The Get-CsTeamsTargetingPolicy cmdlet enables you to return information about all the Tenant tag setting policies that have been configured for use in your organization. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsTargetingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsTeamsTargetingPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsTargetingPolicy -Identity SalesPolicy +``` + +In this example Get-CsTeamsTargetingPolicy is used to return the per-tenant tag policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-tenant policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the tenant tag setting policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTemplatePermissionPolicy.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsTemplatePermissionPolicy.md index 783c5f16c2..d3f2915002 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTemplatePermissionPolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy -title: Get-CsTeamsTemplatePermissionPolicy author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy schema: 2.0.0 +title: Get-CsTeamsTemplatePermissionPolicy --- # Get-CsTeamsTemplatePermissionPolicy @@ -119,8 +119,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy) -[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy) -[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTranslationRule.md similarity index 68% rename from teams/teams-ps/teams/Get-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsTranslationRule.md index 402b525db2..d1f7344b2c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule applicable: Microsoft Teams -title: Get-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstranslationrule +schema: 2.0.0 +title: Get-CsTeamsTranslationRule --- # Get-CsTeamsTranslationRule @@ -19,12 +20,12 @@ Cmdlet to get an existing number manipulation rule (or list of rules). ### Identity (Default) ``` -Get-CsTeamsTranslationRule [[-Identity] ] [] +Get-CsTeamsTranslationRule [[-Identity] ] [-MsftInternalProcessingMode ] [] ``` ### Filter ``` -Get-CsTeamsTranslationRule [-Filter ] [] +Get-CsTeamsTranslationRule [-MsftInternalProcessingMode ] [-Filter ] [] ``` ## DESCRIPTION @@ -55,14 +56,34 @@ This command will show Identity, Name, Description, Pattern, and Translation par ## PARAMETERS +### -Filter + +> Applicable: Microsoft Teams + +The filter to use against the Identity of translation rules. + +```yaml +Type: System.String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Microsoft Teams + Identifier of the specific translation rule to display. ```yaml -Type: String -Parameter Sets: (Identity) +Type: System.String +Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -71,23 +92,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The filter to use against the Identity of translation rules. +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} ```yaml -Type: String -Parameter Sets: (Filter) +Type: System.String +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -96,10 +117,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) -[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstranslationrule) + +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamstranslationrule) -[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstranslationrule) -[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUnassignedNumberTreatment.md similarity index 66% rename from teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUnassignedNumberTreatment.md index cd8a81e96e..ca4f840bf8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUnassignedNumberTreatment.md @@ -1,105 +1,125 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment -applicable: Microsoft Teams -title: Get-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Get-CsTeamsUnassignedNumberTreatment - -## SYNOPSIS -Displays a specific or all treatments for how calls to an unassigned number range should be routed. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsUnassignedNumberTreatment [[-Identity] ] [] -``` - -### Filter -``` -Get-CsTeamsUnassignedNumberTreatment [-Filter ] [] -``` - -## DESCRIPTION -This cmdlet displays a specific or all treatments for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsTeamsUnassignedNumberTreatment -Identity MainAA -``` -This example displays the treatment MainAA. - -### Example 2 -```powershell -Get-CsTeamsUnassignedNumberTreatment -``` -This example displays all configured treatments. - -### Example 3 -```powershell -Get-CsTeamsUnassignedNumberTreatment -Filter Ann* -``` -This example displays all configured treatments with an Identity starting with Ann. - -## PARAMETERS - -### -Filter -Enables you to limit the returned data by filtering on the Identity attribute. - -```yaml -Type: String -Parameter Sets: (Filter) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Id of the specific treatment to show. - -```yaml -Type: System.String -Parameter Sets: (Identity) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.5.1 or later. - -## RELATED LINKS -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) - -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) - -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment +schema: 2.0.0 +title: Get-CsTeamsUnassignedNumberTreatment +--- + +# Get-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +Displays a specific or all treatments for how calls to an unassigned number range should be routed. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsUnassignedNumberTreatment [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter +``` +Get-CsTeamsUnassignedNumberTreatment [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +This cmdlet displays a specific or all treatments for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsTeamsUnassignedNumberTreatment -Identity MainAA +``` +This example displays the treatment MainAA. + +### Example 2 +```powershell +Get-CsTeamsUnassignedNumberTreatment +``` +This example displays all configured treatments. + +### Example 3 +```powershell +Get-CsTeamsUnassignedNumberTreatment -Filter Ann* +``` +This example displays all configured treatments with an Identity starting with Ann. + +## PARAMETERS + +### -Filter + +> Applicable: Microsoft Teams + +Enables you to limit the returned data by filtering on the Identity attribute. + +```yaml +Type: System.String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the specific treatment to show. + +```yaml +Type: System.String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +## RELATED LINKS + +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment) + +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpdateManagementPolicy.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpdateManagementPolicy.md index 3bcd814b61..5f10990f13 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsupdatemanagementpolicy applicable: Microsoft Teams -title: Get-CsTeamsUpdateManagementPolicy -schema: 2.0.0 author: vargasj-ms -ms.author: vargasj +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: gnamun +Module Name: MicrosoftTeams +ms.author: vargasj +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupdatemanagementpolicy +schema: 2.0.0 +title: Get-CsTeamsUpdateManagementPolicy --- # Get-CsTeamsUpdateManagementPolicy @@ -42,32 +43,32 @@ In this example, we retrieve all the existing Teams Update Management policies i ## PARAMETERS -### -Identity -The unique identifier of the policy. +### -Filter + +This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter - -This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. +### -Identity +The unique identifier of the policy. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradeConfiguration.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradeConfiguration.md index 7443bce227..7024501240 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradeConfiguration.md @@ -1,19 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration applicable: Microsoft Teams -title: Get-CsTeamsUpgradeConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration +schema: 2.0.0 +title: Get-CsTeamsUpgradeConfiguration --- # Get-CsTeamsUpgradeConfiguration ## SYNOPSIS -Returns information related to managing the upgrade to Teams from Skype for Business. TeamsUpgradeConfiguration should be used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. For Office 365 users, it allows administrators to determine which application end users should use to join Skype for Business meetings. +Returns information related to managing the upgrade to Teams from Skype for Business. ## SYNTAX @@ -114,10 +116,10 @@ These settings are only honored by newer versions of Skype for Business clients. ## RELATED LINKS -[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsupgradeconfiguration) -[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradepolicy) -[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsupgradepolicy) [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradePolicy.md similarity index 84% rename from teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradePolicy.md index 1da715da85..6b0387f238 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradePolicy.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy applicable: Microsoft Teams -title: Get-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy +schema: 2.0.0 +title: Get-CsTeamsUpgradePolicy --- # Get-CsTeamsUpgradePolicy ## SYNOPSIS -TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. - -> [!IMPORTANT] -> It can take up to 24 hours for a change to TeamsUpgradePolicy to take effect. Before then, user presence status may not be correct (may show as **Unknown**). +This cmdlet returns the set of instances of this policy. ## SYNTAX @@ -31,7 +30,11 @@ Get-CsTeamsUpgradePolicy [-Tenant ] [-Filter ] [-LocalStore] [ [!IMPORTANT] +> It can take up to 24 hours for a change to TeamsUpgradePolicy to take effect. Before then, user presence status may not be correct (may show as **Unknown**). + NOTES: - Except for on-premise versions of Skype for Business Server, all relevant instances of TeamsUpgradePolicy are built into the system, so there is no corresponding New cmdlet. @@ -127,45 +130,51 @@ List all on-premises instances (if any) of TeamsUpgradePolicy. ## PARAMETERS -### -Identity -If identity parameter is passed, this will return a specific instance. If no identity parameter is specified, the cmdlet returns all instances. +### -Filter + +> Applicable: Microsoft Teams + +{{Fill Filter Description}} ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -{{Fill Filter Description}} + +### -Identity + +> Applicable: Microsoft Teams + +If identity parameter is passed, this will return a specific instance. If no identity parameter is specified, the cmdlet returns all instances. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### -Tenant + +> Applicable: Microsoft Teams + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -189,10 +198,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradeconfiguration) +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradeconfiguration) -[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsupgradeconfiguration) -[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsupgradepolicy) [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVdiPolicy.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVdiPolicy.md index 41be427ab3..aadd7a94a4 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVdiPolicy.md @@ -1,99 +1,100 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvdipolicy -title: Get-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsVdiPolicy - -## SYNOPSIS -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -### Identity (Default) -```powershell -Get-CsTeamsVdiPolicy [[-Identity] ] [] -``` - -### Filter -```powershell -Get-CsTeamsVdiPolicy [-Filter ] [] -``` - -## DESCRIPTION -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -Teams Vdi policies can be configured at the global and per-user scopes. The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsVdiPolicy -``` - -In Example 1, Get-CsTeamsVdiPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsVdiPolicy -Identity SalesPolicy -``` - -In Example 2, Get-CsTeamsVdiPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identites are unique, this command will never return more than one item. - -### Example 3 -```powershell -PS C:\> Get-CsTeamsVdiPolicy | where-Object {$_.VDI2Optimization -eq "Enabled"} -``` - -The preceding command returns a collection of all the meeting policies where the VDI2Optimization property is Enabled. To do this, Get-CsTeamsVdiPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the VDI2Optimization property is equal to Enabled. - -## PARAMETERS - -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvdipolicy +schema: 2.0.0 +title: Get-CsTeamsVdiPolicy +--- + +# Get-CsTeamsVdiPolicy + +## SYNOPSIS +The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsVdiPolicy [[-Identity] ] [] +``` + +### Filter +```powershell +Get-CsTeamsVdiPolicy [-Filter ] [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +Teams Vdi policies can be configured at the global and per-user scopes. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsVdiPolicy +``` + +In Example 1, Get-CsTeamsVdiPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsVdiPolicy -Identity SalesPolicy +``` + +In Example 2, Get-CsTeamsVdiPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identites are unique, this command will never return more than one item. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsVdiPolicy | where-Object {$_.VDI2Optimization -eq "Enabled"} +``` + +The preceding command returns a collection of all the meeting policies where the VDI2Optimization property is Enabled. To do this, Get-CsTeamsVdiPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the VDI2Optimization property is equal to Enabled. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy.md similarity index 76% rename from teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy.md index be0b2b593d..3a47b7b839 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvideointeropservicepolicy applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Get-CsTeamsVideoInteropServicePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvideointeropservicepolicy +schema: 2.0.0 +title: Get-CsTeamsVideoInteropServicePolicy --- # Get-CsTeamsVideoInteropServicePolicy ## SYNOPSIS - -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. +The Get-CsTeamsVideoInteropServicePolicy cmdlet allows you to identify the pre-constructed policies that you can use in your organization. ## SYNTAX @@ -32,9 +32,12 @@ Get-CsTeamsVideoInteropServicePolicy [-Tenant ] [-Filter ] ``` ## DESCRIPTION -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. Microsoft provides pre-constructed policies for each of our supported partners that allow you to designate which partner(s) to use for cloud video interop. - -The Get-CsTeamsVideoInteropServicePolicy cmdlet allows you to identify the pre-constructed policies that you can use in your organization. You can assign this policy to one or more of your users leveraging the Grant-CsTeamsVideoInteropServicePolicy cmdlet. +Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You +can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular +users or for your entire organization. Microsoft provides pre-constructed policies for each of our +supported partners that allow you to designate which partner(s) to use for cloud video interop. You +can assign this policy to one or more of your users leveraging the +Grant-CsTeamsVideoInteropServicePolicy cmdlet. ## EXAMPLES diff --git a/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVirtualAppointmentsPolicy.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVirtualAppointmentsPolicy.md index 5d698766b8..c26c238fb2 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy -title: Get-CsTeamsVirtualAppointmentsPolicy -schema: 2.0.0 ms.author: erocha -manager: sonaggarwal -author: emmanuelrocha001 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy +schema: 2.0.0 +title: Get-CsTeamsVirtualAppointmentsPolicy --- # Get-CsTeamsVirtualAppointmentsPolicy @@ -115,10 +116,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVoiceApplicationsPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVoiceApplicationsPolicy.md index 0a73f7a287..1e9c968987 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy -title: Get-CsTeamsVoiceApplicationsPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy schema: 2.0.0 +title: Get-CsTeamsVoiceApplicationsPolicy --- # Get-CsTeamsVoiceApplicationsPolicy @@ -51,6 +52,23 @@ The command shown in Example 3 returns information about all the Teams voice app ## PARAMETERS +### -Filter +Enables you to use wildcards when retrieving one or more Teams voice applications policies. For example, to return all the policies configured at the per-user scope, use this syntax: + +-Filter "tag:*" + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier of the Teams voice applications policy to be retrieved. To return the global policy, use this syntax: @@ -76,23 +94,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when retrieving one or more Teams voice applications policies. For example, to return all the policies configured at the per-user scope, use this syntax: - --Filter "tag:*" - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -106,10 +107,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy) -[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy) -[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLoadPolicy.md similarity index 85% rename from teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLoadPolicy.md index 894f122d6b..f227b55115 100644 --- a/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLoadPolicy.md @@ -1,115 +1,116 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy -title: Get-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsWorkLoadPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] -``` - -### Filter - -```powershell -Get-CsTeamsWorkLoadPolicy [-MsftInternalProcessingMode ] [-Filter ] [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsTeamsWorkLoadPolicy -``` - -Retrieves the Teams Workload Policy instances and shows assigned values. - -## PARAMETERS - -### -Filter - -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Identity of the Teams Workload Policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Microsoft internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworkloadpolicy +schema: 2.0.0 +title: Get-CsTeamsWorkLoadPolicy +--- + +# Get-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsWorkLoadPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsTeamsWorkLoadPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsWorkLoadPolicy +``` + +Retrieves the Teams Workload Policy instances and shows assigned values. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLocationDetectionPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLocationDetectionPolicy.md index 2dd5152b3d..a0d5a1ee49 100644 --- a/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy -title: Get-CsTeamsWorkLocationDetectionPolicy -schema: 2.0.0 ms.author: arkozlov -manager: prashibadkur -author: artemiykozlov +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy +schema: 2.0.0 +title: Get-CsTeamsWorkLocationDetectionPolicy --- # Get-CsTeamsWorkLocationDetectionPolicy @@ -116,10 +117,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy) -[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy) -[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy) -[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Get-CsTenant.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenant.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTenant.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenant.md index 2558268bcf..e014208800 100644 --- a/teams/teams-ps/teams/Get-CsTenant.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenant applicable: Microsoft Teams -title: Get-CsTenant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenant +schema: 2.0.0 +title: Get-CsTenant --- # Get-CsTenant @@ -93,7 +95,7 @@ In the Teams PowerShell Module version 3.0.0 or later, the following attributes ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenant ``` @@ -104,13 +106,15 @@ Organizations will have only one tenant. ## PARAMETERS ### -DomainController + +> Applicable: Microsoft Teams + This parameter is not used with Skype for Business Online and will be deprecated in the near future. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -121,6 +125,8 @@ Accept wildcard characters: False ### -Filter +> Applicable: Microsoft Teams + **Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. Enables you to return data by using Active Directory attributes and without having to specify the full Active Directory distinguished name. @@ -140,7 +146,6 @@ You cannot use both the Identity parameter and the Filter parameter in the same Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -151,6 +156,8 @@ Accept wildcard characters: False ### -Identity +> Applicable: Microsoft Teams + **Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. Unique identifier for the tenant. @@ -164,7 +171,6 @@ If you do not include either the Identity or the Filter parameter then the `Get- Type: OUIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -175,6 +181,8 @@ Accept wildcard characters: False ### -ResultSize +> Applicable: Microsoft Teams + **Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. Enables you to limit the number of records returned by the cmdlet. @@ -189,7 +197,6 @@ If you set the tenants to 7 but you have only three contacts in your forest, the Type: Int32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers.md index 8f125d7c02..dbe7682f5c 100644 --- a/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers -title: Get-CsTenantBlockedCallingNumbers applicable: Microsoft Teams -schema: 2.0.0 author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers +schema: 2.0.0 +title: Get-CsTenantBlockedCallingNumbers --- # Get-CsTenantBlockedCallingNumbers @@ -43,7 +45,7 @@ The scope of tenant blocked calling numbers is global across the given tenant. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantBlockedCallingNumbers ``` @@ -52,31 +54,31 @@ This example returns the tenant global settings for blocked calling numbers. It ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the scope, and for per-user scope a name, which identifies the TenantBlockedCallingNumbers to retrieve. +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to limit the number of results based on filters you specify. +### -Identity +The Identity parameter is a unique identifier that designates the scope, and for per-user scope a name, which identifies the TenantBlockedCallingNumbers to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -111,6 +113,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/set-cstenantblockedcallingnumbers) +[Set-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantblockedcallingnumbers) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Get-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantDialPlan.md similarity index 87% rename from teams/teams-ps/teams/Get-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantDialPlan.md index 6981f68fc3..1d92d218a5 100644 --- a/teams/teams-ps/teams/Get-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan applicable: Microsoft Teams -title: Get-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan +schema: 2.0.0 +title: Get-CsTenantDialPlan --- # Get-CsTenantDialPlan @@ -37,14 +38,14 @@ You can use the Get-CsTenantDialPlan cmdlet to retrieve specific information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantDialPlan ``` This example retrieves all existing tenant dial plans. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTenantDialPlan -Identity Vt1TenantDialPlan2 ``` @@ -54,13 +55,15 @@ This example retrieves the tenant dial plan that has an identity of Vt1TenantDia ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml Type: String Parameter Sets: (Filter) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter is a unique identifier that designates the name of the tenant dial plan to retrieve. ```yaml Type: String Parameter Sets: (Identity) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -98,10 +103,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cstenantdialplan) -[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan) -[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) -[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantdialplan) diff --git a/teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantFederationConfiguration.md similarity index 93% rename from teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantFederationConfiguration.md index 8a7b9f790c..339936d807 100644 --- a/teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantFederationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantfederationconfiguration applicable: Microsoft Teams -title: Get-CsTenantFederationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantfederationconfiguration +schema: 2.0.0 +title: Get-CsTenantFederationConfiguration --- # Get-CsTenantFederationConfiguration @@ -44,14 +46,14 @@ However, administrators must use the Get-CsTenantPublicProvider cmdlet in order ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantFederationConfiguration ``` The command shown in Exercise 1 returns federation configuration information for the current tenant: -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTenantFederationConfiguration | Select-Object -ExpandProperty AllowedDomains ``` @@ -61,6 +63,9 @@ In Example 2, information is returned for all the allowed domains found on the f ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + Enables you to use wildcard characters in order to return a collection of tenant federation configuration settings. Because each tenant is limited to a single, global collection of federation configuration settings there is no need to use the Filter parameter. However, this is valid syntax for the Get-CsTenantFederationConfiguration cmdlet: @@ -71,7 +76,6 @@ However, this is valid syntax for the Get-CsTenantFederationConfiguration cmdlet Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + Specifies the collection of tenant federation configuration settings to be returned. Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the Get-CsTenantFederationConfiguration cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. @@ -92,7 +99,6 @@ For example: Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -102,13 +108,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Microsoft Teams + This parameter is not used with Skype for Business Online. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -118,6 +126,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + Globally unique identifier (GUID) of the tenant account whose federation settings are being returned. For example: @@ -135,7 +146,6 @@ The Tenant parameter is primarily for use in a hybrid deployment. Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -159,4 +169,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantLicensingConfiguration.md similarity index 90% rename from teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantLicensingConfiguration.md index 5eab013035..59e90133a0 100644 --- a/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantLicensingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantlicensingconfiguration applicable: Microsoft Teams -title: Get-CsTenantLicensingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantlicensingconfiguration +schema: 2.0.0 +title: Get-CsTenantLicensingConfiguration --- # Get-CsTenantLicensingConfiguration @@ -40,7 +42,7 @@ If not, then licensing information is not available in the admin center. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantLicensingConfiguration ``` @@ -50,6 +52,9 @@ The command shown in Example 1 returns licensing configuration information for t ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + Enables you to use wildcard characters in order to return a collection of tenant licensing configuration settings. Because each tenant is limited to a single, global collection of licensing configuration settings there is no need to use the Filter parameter. @@ -57,7 +62,6 @@ Because each tenant is limited to a single, global collection of licensing confi Type: String Parameter Sets: Filter Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -67,6 +71,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + Specifies the collection of tenant licensing configuration settings to be returned. Because each tenant is limited to a single, global collection of licensing settings there is no need include this parameter when calling the Get-CsTenantLicensingConfiguration cmdlet. @@ -74,7 +81,6 @@ Because each tenant is limited to a single, global collection of licensing setti Type: XdsIdentity Parameter Sets: Identity Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -113,4 +119,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTenant](https://learn.microsoft.com/powershell/module/teams/get-cstenant) +[Get-CsTenant](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenant) diff --git a/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantMigrationConfiguration.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantMigrationConfiguration.md index 23ce62dd9e..00d6e5e756 100644 --- a/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantMigrationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration applicable: Microsoft Teams -title: Get-CsTenantMigrationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantmigrationconfiguration +schema: 2.0.0 +title: Get-CsTenantMigrationConfiguration --- # Get-CsTenantMigrationConfiguration @@ -29,7 +31,7 @@ The Get-CsTenantMigrationConfiguration cmdlet retrieves the Meeting Migration Se ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsTenantMigrationConfiguration ``` @@ -39,13 +41,15 @@ This example shows the MMS configuration in your organization. ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -55,13 +59,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -71,13 +77,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -87,13 +95,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -112,4 +122,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration) +[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantmigrationconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkConfiguration.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkConfiguration.md index 110a8e54cc..6c4f63315f 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkConfiguration.md @@ -1,10 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkconfiguration applicable: Microsoft Teams -title: Get-CsTenantNetworkConfiguration +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworkconfiguration schema: 2.0.0 -ms.reviewer: +title: Get-CsTenantNetworkConfiguration --- # Get-CsTenantNetworkConfiguration @@ -121,7 +122,7 @@ This parameter is reserved for internal Microsoft use. ## NOTES ## RELATED LINKS -[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) -[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) -[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkRegion.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkRegion.md index 4e5bac9aa2..103827da09 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion applicable: Microsoft Teams -title: Get-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworkregion +schema: 2.0.0 +title: Get-CsTenantNetworkRegion --- # Get-CsTenantNetworkRegion @@ -98,8 +99,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworkregion) -[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworkregion) -[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSite.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSite.md index 140fb2c326..9b5bba3ee3 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite applicable: Microsoft Teams -title: Get-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite +schema: 2.0.0 +title: Get-CsTenantNetworkSite --- # Get-CsTenantNetworkSite @@ -165,8 +166,8 @@ This parameter is reserved for internal Microsoft use. The parameter IncludePhoneNumbers was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS -[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksite) -[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksite) -[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSubnet.md similarity index 92% rename from teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSubnet.md index 451655976b..ef886c2a52 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet applicable: Microsoft Teams -title: Get-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksubnet +schema: 2.0.0 +title: Get-CsTenantNetworkSubnet --- # Get-CsTenantNetworkSubnet @@ -54,31 +55,31 @@ The command shown in Example 2 returns the IPv6 format network subnet within the ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network subnets to be returned. +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to limit the number of results based on filters you specify. +### -Identity +The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network subnets to be returned. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -97,8 +98,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksubnet) -[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksubnet) -[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet) +[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksubnet) diff --git a/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantTrustedIPAddress.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantTrustedIPAddress.md index 178e4bd1fa..bec063bfec 100644 --- a/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantTrustedIPAddress.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenanttrustedipaddress applicable: Microsoft Teams -title: Get-CsTenantTrustedIPAddress -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenanttrustedipaddress +schema: 2.0.0 +title: Get-CsTenantTrustedIPAddress --- # Get-CsTenantTrustedIPAddress diff --git a/teams/teams-ps/teams/Get-CsUserCallingSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserCallingSettings.md similarity index 73% rename from teams/teams-ps/teams/Get-CsUserCallingSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserCallingSettings.md index 43b422011c..4ba4c9a51b 100644 --- a/teams/teams-ps/teams/Get-CsUserCallingSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserCallingSettings.md @@ -1,249 +1,363 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings -applicable: Microsoft Teams -title: Get-CsUserCallingSettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Get-CsUserCallingSettings - -## SYNOPSIS -This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. - -## SYNTAX - -```powershell -Get-CsUserCallingSettings -Identity [] - -``` - -## DESCRIPTION -This cmdlet shows the call forwarding, simultaneous ringing, call group and delegation settings for a user. It will also show any call groups the user is a member of and -if someone else has added the user as a delegate. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsUserCallingSettings -Identity user1@contoso.com -``` -```output -SipUri : sip:user1@contoso.com -IsForwardingEnabled : True -ForwardingType : Immediate -ForwardingTarget : -ForwardingTargetType : Voicemail -IsUnansweredEnabled : False -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : -``` - -This example shows that user1@contoso.com has immediate call forwarding set (IsForwardingEnabled and ForwardingType) to route all incoming calls to voicemail (ForwardingTargetType). - -### Example 2 -```powershell -Get-CsUserCallingSettings -Identity user2@contoso.com -``` -```output -SipUri : sip:user2@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : sip:user3@contoso.com -ForwardingTargetType : SingleTarget -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : -``` - -This example shows that user2@contoso.com has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to user3@contoso.com -(ForwardingTarget and ForwardingTargetType) and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed -to voicemail (UnansweredTargetType). - -### Example 3 -```powershell -Get-CsUserCallingSettings -Identity user4@contoso.com -``` -```output -SipUri : sip:user4@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : -ForwardingTargetType : Group -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {sip:user5@contoso.com} -GroupMembershipDetails : CallGroupOwnerId:sip:user6@contoso.com -GroupNotificationOverride : Mute -``` -```powershell -(Get-CsUserCallingSettings -Identity user4@contoso.com).GroupMembershipDetails -``` -```output -CallGroupOwnerId NotificationSetting ----------------- ------------------- -sip:user6@contoso.com Ring -``` - -This example shows that user4@contoso.com has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains user5@contoso.com -(CallGroupTargets). The call group is defined to ring members in the order listed in the call group (CallGroupOrder). - -You can also see that user4@contoso.com is a member of user6@contoso.com's call group (GroupMembershipDetails), that user6@contoso.com defined the call group with Ring -notification for user4@contoso.com (NotificationSetting) and that user4@contoso.com has decided to turn off call notification for call group calls (GroupNotificationOverride). - -### Example 4 -```powershell -Get-CsUserCallingSettings -Identity user7@contoso.com -``` -```output -SipUri : sip:opr7@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : -ForwardingTargetType : MyDelegates -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : Id:sip:user8@contoso.com -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : Ring -``` -```powershell -(Get-CsUserCallingSettings -Identity user7@contoso.com).Delegates -``` -```output -Id : sip:user8@contoso.com -MakeCalls : True -ManageSettings : True -ReceiveCalls : True -``` - -This example shows that user7@contoso.com has simultaneous ringing set to his/her delegates (ForwardingTargetType). User8@contoso.com is the only delegate -(Delegates) and that user has all the permissions you can have as a delegate (Delegates). - -### Example 5 -```powershell -Get-CsUserCallingSettings -Identity user9@contoso.com -``` -```output -SipUri : sip:user9@contoso.com -IsForwardingEnabled : False -ForwardingType : Immediate -ForwardingTarget : -ForwardingTargetType : Voicemail -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : Id:sip:user10@contoso.com -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : Ring -``` -```powershell -(Get-CsUserCallingSettings -Identity user9@contoso.com).Delegators -``` -```output -Id : sip:user10@contoso.com -MakeCalls : True -ManageSettings : True -ReceiveCalls : True -``` - -This example shows that user9@contoso.com is a delegate of user10@contoso.com (Delegators) and that user10@contoso.com has given user9@contoso.com all the -permissions you can have as a delegate (Delegators). - -### Example 6 -```powershell -Get-CsUserCallingSettings -Identity user11@contoso.com -``` -```output -SipUri : sip:user11@contoso.com -IsForwardingEnabled : -ForwardingType : -ForwardingTarget : -ForwardingTargetType : -IsUnansweredEnabled : -UnansweredTarget : -UnansweredTargetType : -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : Simultaneous -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : -``` - -This example shows the default settings for a user that has never changed the call forward settings via Microsoft Teams. Note that for users with settings as shown here, -unanswered calls will by default be forwarded to voicemail after 30 seconds. - -## PARAMETERS - -### -Identity -The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -## RELATED LINKS - -[Set-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csusercallingsettings +schema: 2.0.0 +title: Get-CsUserCallingSettings +--- + +# Get-CsUserCallingSettings + +## SYNOPSIS +This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. + +## SYNTAX + +### Get (Default) +``` +Get-CsUserCallingSettings -Identity [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity +``` +Get-CsUserCallingSettings -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION +This cmdlet shows the call forwarding, simultaneous ringing, call group and delegation settings for a user. It will also show any call groups the user is a member of and +if someone else has added the user as a delegate. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsUserCallingSettings -Identity user1@contoso.com +``` +```output +SipUri : sip:user1@contoso.com +IsForwardingEnabled : True +ForwardingType : Immediate +ForwardingTarget : +ForwardingTargetType : Voicemail +IsUnansweredEnabled : False +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : +``` + +This example shows that user1@contoso.com has immediate call forwarding set (IsForwardingEnabled and ForwardingType) to route all incoming calls to voicemail (ForwardingTargetType). + +### Example 2 +```powershell +Get-CsUserCallingSettings -Identity user2@contoso.com +``` +```output +SipUri : sip:user2@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : sip:user3@contoso.com +ForwardingTargetType : SingleTarget +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : +``` + +This example shows that user2@contoso.com has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to user3@contoso.com +(ForwardingTarget and ForwardingTargetType) and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed +to voicemail (UnansweredTargetType). + +### Example 3 +```powershell +Get-CsUserCallingSettings -Identity user4@contoso.com +``` +```output +SipUri : sip:user4@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : +ForwardingTargetType : Group +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {sip:user5@contoso.com} +GroupMembershipDetails : CallGroupOwnerId:sip:user6@contoso.com +GroupNotificationOverride : Mute +``` +```powershell +(Get-CsUserCallingSettings -Identity user4@contoso.com).GroupMembershipDetails +``` +```output +CallGroupOwnerId NotificationSetting +---------------- ------------------- +sip:user6@contoso.com Ring +``` + +This example shows that user4@contoso.com has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains user5@contoso.com +(CallGroupTargets). The call group is defined to ring members in the order listed in the call group (CallGroupOrder). + +You can also see that user4@contoso.com is a member of user6@contoso.com's call group (GroupMembershipDetails), that user6@contoso.com defined the call group with Ring +notification for user4@contoso.com (NotificationSetting) and that user4@contoso.com has decided to turn off call notification for call group calls (GroupNotificationOverride). + +### Example 4 +```powershell +Get-CsUserCallingSettings -Identity user7@contoso.com +``` +```output +SipUri : sip:opr7@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : +ForwardingTargetType : MyDelegates +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : Id:sip:user8@contoso.com +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : Ring +``` +```powershell +(Get-CsUserCallingSettings -Identity user7@contoso.com).Delegates +``` +```output +Id : sip:user8@contoso.com +MakeCalls : True +ManageSettings : True +ReceiveCalls : True +``` + +This example shows that user7@contoso.com has simultaneous ringing set to his/her delegates (ForwardingTargetType). User8@contoso.com is the only delegate +(Delegates) and that user has all the permissions you can have as a delegate (Delegates). + +### Example 5 +```powershell +Get-CsUserCallingSettings -Identity user9@contoso.com +``` +```output +SipUri : sip:user9@contoso.com +IsForwardingEnabled : False +ForwardingType : Immediate +ForwardingTarget : +ForwardingTargetType : Voicemail +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : Id:sip:user10@contoso.com +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : Ring +``` +```powershell +(Get-CsUserCallingSettings -Identity user9@contoso.com).Delegators +``` +```output +Id : sip:user10@contoso.com +MakeCalls : True +ManageSettings : True +ReceiveCalls : True +``` + +This example shows that user9@contoso.com is a delegate of user10@contoso.com (Delegators) and that user10@contoso.com has given user9@contoso.com all the +permissions you can have as a delegate (Delegators). + +### Example 6 +```powershell +Get-CsUserCallingSettings -Identity user11@contoso.com +``` +```output +SipUri : sip:user11@contoso.com +IsForwardingEnabled : +ForwardingType : +ForwardingTarget : +ForwardingTargetType : +IsUnansweredEnabled : +UnansweredTarget : +UnansweredTargetType : +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : Simultaneous +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : +``` + +This example shows the default settings for a user that has never changed the call forward settings via Microsoft Teams. Note that for users with settings as shown here, +unanswered calls will by default be forwarded to voicemail after 30 seconds. + +## PARAMETERS + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +{{ Fill InputObject Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +## RELATED LINKS + +[Set-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csusercallingdelegate) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyAssignment.md similarity index 96% rename from teams/teams-ps/teams/Get-CsUserPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyAssignment.md index 692be05e33..6075516892 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyAssignment.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment -title: Get-CsUserPolicyAssignment -schema: 2.0.0 -author: tomkau ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicyassignment +schema: 2.0.0 +title: Get-CsUserPolicyAssignment --- # Get-CsUserPolicyAssignment @@ -88,44 +89,41 @@ d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/20 ## PARAMETERS -### -Identity -The identify of the user whose policy assignments will be returned. - -The -Identity parameter can be in the form of the users ObjectID (taken from Microsoft Entra ID) or in the form of the UPN (a.smith@example.com) +### -Break +Wait for .NET debugger to attach ```yaml -Type: String -Parameter Sets: Get +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline ```yaml -Type: IIc3AdminConfigRpPolicyIdentity -Parameter Sets: GetViaIdentity +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -Use to filter to a specific policy type. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline ```yaml -Type: String +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -136,41 +134,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach +### -Identity +The identify of the user whose policy assignments will be returned. + +The -Identity parameter can be in the form of the users ObjectID (taken from Microsoft Entra ID) or in the form of the UPN (a.smith@example.com) ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: Get Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: IIc3AdminConfigRpPolicyIdentity +Parameter Sets: GetViaIdentity Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -PolicyType +Use to filter to a specific policy type. ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: @@ -249,8 +250,8 @@ INPUTOBJECT \: Identity Parameter ## RELATED LINKS -[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment) -[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csgrouppolicyassignment) -[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackage.md similarity index 84% rename from teams/teams-ps/teams/Get-CsUserPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackage.md index c0edaf3689..0f254b84b7 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Get-CsUserPolicyPackage -author: serdarsoysal ms.author: serdars -manager: amitar -online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackage schema: 2.0.0 +title: Get-CsUserPolicyPackage --- # Get-CsUserPolicyPackage @@ -39,13 +40,14 @@ Returns the policy package that's assigned to johndoe@example.com. ### -Identity +> Applicable: Microsoft Teams + The user that will get their assigned policy package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -64,8 +66,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation) -[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csuserpolicypackage) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackageRecommendation.md similarity index 87% rename from teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackageRecommendation.md index ca19b2c0d9..88286a45c7 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackageRecommendation.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Get-CsUserPolicyPackageRecommendation -author: serdarsoysal ms.author: serdars -manager: amitar -online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation schema: 2.0.0 +title: Get-CsUserPolicyPackageRecommendation --- # Get-CsUserPolicyPackageRecommendation @@ -39,13 +40,14 @@ Returns recommendations for which policy packages are best suited for johndoe@ex ### -Identity +> Applicable: Microsoft Teams + The user that will receive policy package recommendations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -64,8 +66,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackage) -[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csuserpolicypackage) diff --git a/teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/Get-CsVideoInteropServiceProvider.md similarity index 88% rename from teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/Get-CsVideoInteropServiceProvider.md index 2210e9d40f..71d30859f2 100644 --- a/teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsVideoInteropServiceProvider.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csvideointeropserviceprovider applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Get-CsVideoInteropServiceProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csvideointeropserviceprovider +schema: 2.0.0 +title: Get-CsVideoInteropServiceProvider --- # Get-CsVideoInteropServiceProvider ## SYNOPSIS -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. +Get information about the Cloud Video Interop for Teams. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-M365TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Get-M365TeamsApp.md similarity index 94% rename from teams/teams-ps/teams/Get-M365TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Get-M365TeamsApp.md index 2d665c2c79..467ef10577 100644 --- a/teams/teams-ps/teams/Get-M365TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Get-M365TeamsApp.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Get-M365TeamsApp applicable: Microsoft Teams -title: Get-M365TeamsApp author: lkueter -ms.author: sribagchi +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Get-M365TeamsApp schema: 2.0.0 +title: Get-M365TeamsApp --- # Get-M365TeamsApp @@ -124,5 +125,5 @@ Properties: ## RELATED LINKS -[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) -[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) +[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/microsoftteams/get-allm365teamsapps) +[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/microsoftteams/get-allm365teamsapps) diff --git a/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedCustomPendingApps.md similarity index 56% rename from teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md rename to teams/teams-ps/MicrosoftTeams/Get-M365UnifiedCustomPendingApps.md index 0e4deaa2f7..6c3a05f368 100644 --- a/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md +++ b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedCustomPendingApps.md @@ -1,17 +1,18 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Get-M365UnifiedCustomPendingApps applicable: Microsoft Teams -title: Get-M365UnifiedCustomPendingApps author: michelle-paradis -ms.author: mparadis +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: swmerchant +Module Name: MicrosoftTeams +ms.author: mparadis ms.date: 01/14/2025 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Get-M365UnifiedCustomPendingApps schema: 2.0.0 +title: Get-M365UnifiedCustomPendingApps --- -# Get-M365UnifiedCustomPendingApps +# Get-M365UnifiedCustomPendingApps ## SYNOPSIS @@ -19,7 +20,7 @@ This cmdlet returns all custom Microsoft Teams apps that are pending review from ## SYNTAX -```powershell +``` Get-M365UnifiedCustomPendingApps [] ``` @@ -29,7 +30,7 @@ Get-M365UnifiedCustomPendingApps retrieves a complete list of all custom Microso ## EXAMPLES -### Example +### Example 1 ```powershell PS C:\> Get-M365UnifiedCustomPendingApps @@ -51,27 +52,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object -**Id**: -Application ID of the Teams app. - -**ExternalId**: -External ID of the Teams app. - -**Iteration**: -The Staged App Definition Etag of the app. This is a unique tag created everytime the staged app is updated, to help track changes. - -**CreatedBy**: -The User ID of the user that created the app. - -**LastUpdateDateTime**: -The date and time the app was last updated. - -**ReviewStatus**: -The review status of the app. -Values: +- **Id**: Application ID of the Teams app. +- **ExternalId**: External ID of the Teams app. +- **Iteration**: The Staged App Definition Etag of the app. This is a unique tag created every time + the staged app is updated, to help track changes. +- **CreatedBy**: The User ID of the user that created the app. +- **LastUpdateDateTime**: The date and time the app was last updated. +- **ReviewStatus**: The review status of the app. Values: + - PendingPublishing: A new custom app was requested that hasn't been published before. + - PendingUpdate: An existing custom app that was previously published and now has an update. +- **Metadata**: The metadata of the app. -- PendingPublishing: A new custom app was requested that hasn't been published before. -- PendingUpdate: An existing custom app that was previously published and now has an update. +## NOTES -**Metadata**: -The metadata of the app. +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedTenantSettings.md similarity index 94% rename from teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-M365UnifiedTenantSettings.md index c67594e6ff..642654e597 100644 --- a/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedTenantSettings.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Get-M365UnifiedTenantSettings applicable: Microsoft Teams -title: Get-M365UnifiedTenantSettings author: lkueter -ms.author: sribagchi +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 10/22/2024 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Get-M365UnifiedTenantSettings schema: 2.0.0 +title: Get-M365UnifiedTenantSettings --- # Get-M365UnifiedTenantSettings diff --git a/teams/teams-ps/teams/Get-SharedWithTeam.md b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeam.md similarity index 89% rename from teams/teams-ps/teams/Get-SharedWithTeam.md rename to teams/teams-ps/MicrosoftTeams/Get-SharedWithTeam.md index 4728ffa1b4..b7ba2002f4 100644 --- a/teams/teams-ps/teams/Get-SharedWithTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeam.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteam -title: Get-SharedWithTeam -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-sharedwithteam +schema: 2.0.0 +title: Get-SharedWithTeam --- # Get-SharedWithTeam @@ -41,8 +42,8 @@ Returns detail of a team with which a specified channel is shared. ## PARAMETERS -### -HostTeamId -Team ID of the host team (Group ID). +### -ChannelId +Thread ID of the shared channel. ```yaml Type: String @@ -56,8 +57,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ChannelId -Thread ID of the shared channel. +### -HostTeamId +Team ID of the host team (Group ID). ```yaml Type: String @@ -91,7 +92,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### HostTeamId, ChannelId, SharedWithTeamId +### HostTeamId + +### ChannelId + +### SharedWithTeamId ## OUTPUTS @@ -100,5 +105,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) -[Get-AssociatedTeam](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-Team](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) +[Get-AssociatedTeam](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) diff --git a/teams/teams-ps/teams/Get-SharedWithTeamUser.md b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeamUser.md similarity index 90% rename from teams/teams-ps/teams/Get-SharedWithTeamUser.md rename to teams/teams-ps/MicrosoftTeams/Get-SharedWithTeamUser.md index 4a3f016867..28b2d8a72b 100644 --- a/teams/teams-ps/teams/Get-SharedWithTeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeamUser.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteamuser -title: Get-SharedWithTeamUser -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-sharedwithteamuser +schema: 2.0.0 +title: Get-SharedWithTeamUser --- # Get-SharedWithTeamUser @@ -42,8 +43,8 @@ Returns owners of a team with which a specified channel is shared. ## PARAMETERS -### -HostTeamId -Team ID of the host team (Group ID). +### -ChannelId +Thread ID of the shared channel. ```yaml Type: String @@ -57,8 +58,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ChannelId -Thread ID of the shared channel. +### -HostTeamId +Team ID of the host team (Group ID). ```yaml Type: String @@ -72,33 +73,33 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -SharedWithTeamId -Team ID of the shared with team. +### -Role +Filters the results to only users with the given role of "Owner" or "Member". ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True Accept wildcard characters: False ``` -### -Role -Filters the results to only users with the given role of "Owner" or "Member". +### -SharedWithTeamId +Team ID of the shared with team. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -107,7 +108,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### HostTeamId, ChannelId, SharedWithTeamId +### HostTeamId + +### ChannelId + +### SharedWithTeamId ## OUTPUTS @@ -116,4 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-TeamUser](https://learn.microsoft.com/powershell/module/teams/get-teamuser) +[Get-TeamUser](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamuser) diff --git a/teams/teams-ps/teams/Get-Team.md b/teams/teams-ps/MicrosoftTeams/Get-Team.md similarity index 76% rename from teams/teams-ps/teams/Get-Team.md rename to teams/teams-ps/MicrosoftTeams/Get-Team.md index b2edb13e51..758df29b8a 100644 --- a/teams/teams-ps/teams/Get-Team.md +++ b/teams/teams-ps/MicrosoftTeams/Get-Team.md @@ -1,19 +1,18 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-team -title: Get-Team -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-team +schema: 2.0.0 +title: Get-Team --- # Get-Team ## SYNOPSIS - -This cmdlet supports retrieving teams with particular properties/information, including all teams that a specific user belongs to, all teams that have been archived, all teams with a specific display name, or all teams in the organization. +Get Team information based on particular properties. ## SYNTAX @@ -71,52 +70,12 @@ Returns the team that includes the specified escaped representation of its Displ ## PARAMETERS -### -User -User's UPN (user principal name - e.g. -johndoe@example.com) - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Filters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Archived If $true, filters to return teams that have been archived. If $false, filters to return teams that have not been archived. Do not specify any value to return teams that match filter regardless of archived state. This is a filter rather than an exact match. ```yaml Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Boolean -Parameter Sets: Filters +Parameter Sets: Identity, Filters Aliases: Required: False @@ -131,19 +90,7 @@ Specify this parameter to return teams with the provided display name as a filte ```yaml Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Filters +Parameter Sets: Identity, Filters Aliases: Required: False @@ -173,7 +120,7 @@ Specify the mailnickname of the team that is being returned. This acts as a filt ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Identity, Filters Aliases: Required: False @@ -183,24 +130,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NumberOfThreads +Specifies the number of threads to use. If you have sufficient network bandwidth and want to decrease the time required to retrieve the list of teams, use the -NumberOfThreads parameter, which supports a value from 1 through 20. + ```yaml -Type: String -Parameter Sets: Filters +Type: Int32 +Parameter Sets: All Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: False +Default value: 20 +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Visibility -Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. +### -User +User's UPN (user principal name - e.g. +johndoe@example.com) ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Identity, Filters Aliases: Required: False @@ -210,9 +161,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Visibility +Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. + ```yaml Type: String -Parameter Sets: Filters +Parameter Sets: Identity, Filters Aliases: Required: False @@ -222,27 +176,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberOfThreads -Specifies the number of threads to use. If you have sufficient network bandwidth and want to decrease the time required to retrieve the list of teams, use the -NumberOfThreads parameter, which supports a value from 1 through 20. - -```yaml -Type: Int32 -Parameter Sets: All -Aliases: - -Required: False -Position: Named -Default value: 20 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### UPN, UserID +### UPN + +### UserID ## OUTPUTS @@ -252,6 +193,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) +[New-Team](https://learn.microsoft.com/powershell/module/microsoftteams/new-team) -[Set-Team](https://learn.microsoft.com/powershell/module/teams/set-team) +[Set-Team](https://learn.microsoft.com/powershell/module/microsoftteams/set-team) diff --git a/teams/teams-ps/teams/Get-TeamAllChannel.md b/teams/teams-ps/MicrosoftTeams/Get-TeamAllChannel.md similarity index 90% rename from teams/teams-ps/teams/Get-TeamAllChannel.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamAllChannel.md index eae8aeb08e..3eaea1638c 100644 --- a/teams/teams-ps/teams/Get-TeamAllChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamAllChannel.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamallchannel -title: Get-TeamAllChannel -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamallchannel +schema: 2.0.0 +title: Get-TeamAllChannel --- # Get-TeamAllChannel @@ -75,7 +76,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, MembershipType +### GroupId + +### MembershipType ## OUTPUTS @@ -84,5 +87,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-TeamChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) -[Get-TeamIncomingChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) +[Get-TeamChannel](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchannel) +[Get-TeamIncomingChannel](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchannel) diff --git a/teams/teams-ps/teams/Get-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/Get-TeamChannel.md similarity index 93% rename from teams/teams-ps/teams/Get-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamChannel.md index 9eae890d9e..3003a7fb20 100644 --- a/teams/teams-ps/teams/Get-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamChannel.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamchannel -title: Get-TeamChannel +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchannel schema: 2.0.0 +title: Get-TeamChannel --- # Get-TeamChannel diff --git a/teams/teams-ps/teams/Get-TeamChannelUser.md b/teams/teams-ps/MicrosoftTeams/Get-TeamChannelUser.md similarity index 94% rename from teams/teams-ps/teams/Get-TeamChannelUser.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamChannelUser.md index a245c41c40..5c989c4f7d 100644 --- a/teams/teams-ps/teams/Get-TeamChannelUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamChannelUser.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamchanneluser -title: Get-TeamChannelUser +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchanneluser schema: 2.0.0 +title: Get-TeamChannelUser --- # Get-TeamChannelUser @@ -32,8 +33,8 @@ Get owners of channel with display name as "Engineering" ## PARAMETERS -### -GroupId -GroupId of the team +### -DisplayName +Display name of the channel ```yaml Type: String @@ -47,8 +48,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Display name of the channel +### -GroupId +GroupId of the team ```yaml Type: String diff --git a/teams/teams-ps/teams/Get-TeamIncomingChannel.md b/teams/teams-ps/MicrosoftTeams/Get-TeamIncomingChannel.md similarity index 88% rename from teams/teams-ps/teams/Get-TeamIncomingChannel.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamIncomingChannel.md index b1ad0429ef..964e62dc30 100644 --- a/teams/teams-ps/teams/Get-TeamIncomingChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamIncomingChannel.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamincomingchannel -title: Get-TeamIncomingChannel -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamincomingchannel +schema: 2.0.0 +title: Get-TeamIncomingChannel --- # Get-TeamIncomingChannel @@ -62,5 +63,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-TeamChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) -[Get-TeamAllChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) +[Get-TeamChannel](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchannel) +[Get-TeamAllChannel](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamchannel) diff --git a/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md b/teams/teams-ps/MicrosoftTeams/Get-TeamTargetingHierarchyStatus.md similarity index 88% rename from teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamTargetingHierarchyStatus.md index 2480953c1b..92f62d0cf8 100644 --- a/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamTargetingHierarchyStatus.md @@ -1,18 +1,18 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus -title: Get-TeamTargetingHierarchyStatus -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamtargetinghierarchystatus +schema: 2.0.0 +title: Get-TeamTargetingHierarchyStatus --- # Get-TeamTargetingHierarchyStatus ## SYNOPSIS -Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy)) +Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/microsoftteams/set-teamtargetinghierarchy)) ## SYNTAX @@ -20,6 +20,8 @@ Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://l ``` Get-TeamTargetingHierarchyStatus [-RequestId ] [-ApiVersion ] [] ``` +## DESCRIPTION +The `Get-TeamTargetingHierarchyStatus` cmdlet retrieves the status of a hierarchy upload initiated by the `Set-TeamTargetingHierarchy` cmdlet. It provides information about the success or failure of the upload, including any errors encountered during the process. ## EXAMPLES @@ -67,35 +69,35 @@ Prompts for user credentials to connect and manage a Microsoft Teams environment ## PARAMETERS -### -RequestId -Specifies the ID returned by the Set-TeamTargetingHierarchy cmdlet. This parameter is optional and the status of the most recent upload will be retrieved. +### -ApiVersion +The version of the Hierarchy APIs to use. Valid values are: 1 or 2. + +Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None -Accept pipeline input: False +Default value: 1 +Accept pipeline input: false Accept wildcard characters: False ``` -### -ApiVersion -The version of the Hierarchy APIs to use. Valid values are: 1 or 2. - -Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. +### -RequestId +Specifies the ID returned by the Set-TeamTargetingHierarchy cmdlet. This parameter is optional and the status of the most recent upload will be retrieved. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 1 -Accept pipeline input: false +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` @@ -110,4 +112,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy) +[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/microsoftteams/set-teamtargetinghierarchy) diff --git a/teams/teams-ps/teams/Get-TeamUser.md b/teams/teams-ps/MicrosoftTeams/Get-TeamUser.md similarity index 93% rename from teams/teams-ps/teams/Get-TeamUser.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamUser.md index a7b4fd3d69..2f305472f3 100644 --- a/teams/teams-ps/teams/Get-TeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamUser.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamuser -title: Get-TeamUser -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamuser +schema: 2.0.0 +title: Get-TeamUser --- # Get-TeamUser diff --git a/teams/teams-ps/teams/Get-TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Get-TeamsApp.md similarity index 95% rename from teams/teams-ps/teams/Get-TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamsApp.md index e393faf0f5..d53c6a6ca1 100644 --- a/teams/teams-ps/teams/Get-TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamsApp.md @@ -1,13 +1,14 @@ --- +author: joeyglocke external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: islubin Module Name: MicrosoftTeams -title: Get-TeamsApp -author: joeyglocke ms.author: joglocke ms.reviewer: ken.withee -manager: islubin -online version: https://learn.microsoft.com/powershell/module/teams/get-teamsapp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-teamsapp schema: 2.0.0 +title: Get-TeamsApp --- # Get-TeamsApp diff --git a/teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsApplicationAccessPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsApplicationAccessPolicy.md index b321e2118c..cc4a149a58 100644 --- a/teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy applicable: Microsoft Teams -title: Grant-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni author: frankpeng7 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy +schema: 2.0.0 +title: Grant-CsApplicationAccessPolicy --- # Grant-CsApplicationAccessPolicy @@ -76,30 +77,13 @@ The command shown above assigns the per-user application access policy "ASimpleP ## PARAMETERS -### -Identity - -Indicates the user (object) ID of the user account to be assigned the per-user application access policy. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:ASimplePolicy has a PolicyName equal to ASimplePolicy. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -139,12 +123,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Identity + +Indicates the user (object) ID of the user account to be assigned the per-user application access policy. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) Aliases: Required: False @@ -154,13 +155,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -PassThru + +Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. Be aware that this parameter is tied to the cmdlet itself instead of to a property of the input object. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -169,12 +171,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsftInternalProcessingMode +### -PolicyName -For internal use only. +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:ASimplePolicy has a PolicyName equal to ASimplePolicy. ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -185,13 +187,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru - -Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. Be aware that this parameter is tied to the cmdlet itself instead of to a property of the input object. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -228,7 +229,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) -[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) -[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) -[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Grant-CsCallingLineIdentity.md similarity index 89% rename from teams/teams-ps/teams/Grant-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsCallingLineIdentity.md index bac8b79e4c..4bb23ba840 100644 --- a/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity applicable: Microsoft Teams -title: Grant-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-cscallinglineidentity +schema: 2.0.0 +title: Grant-CsCallingLineIdentity --- # Grant-CsCallingLineIdentity @@ -60,14 +61,16 @@ This example assigns the Caller ID policy with the Identity CallerIDSeattle to t ## PARAMETERS -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter -Parameter Sets: (GrantToTenant) -Aliases: -applicable: Microsoft Teams +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -76,14 +79,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsCallingLineIdentity cmdlet does not pass objects through the pipeline. +### -Global + +> Applicable: Microsoft Teams + +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: (GrantToTenant) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -92,46 +97,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name (Identity) of the Caller ID policy to be assigned. To remove an existing user level policy assignment, specify PolicyName as $null. +### -Group + +> Applicable: Microsoft Teams + +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: -applicable: Microsoft Teams -Required: False -Position: 1 +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -Identity + +> Applicable: Microsoft Teams + +The Identity of the user to whom the policy is being assigned. User Identities can be specified using the user's SIP address, the user's user principal name (UPN), or +the user's ObjectId/Identity. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (Identity) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PassThru + +> Applicable: Microsoft Teams + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsCallingLineIdentity cmdlet does not pass objects through the pipeline. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -139,31 +151,35 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity of the user to whom the policy is being assigned. User Identities can be specified using the user's SIP address, the user's user principal name (UPN), or -the user's ObjectId/Identity. + +### -PolicyName + +> Applicable: Microsoft Teams + +The name (Identity) of the Caller ID policy to be assigned. To remove an existing user level policy assignment, specify PolicyName as $null. ```yaml Type: String -Parameter Sets: (Identity) +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 0 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +### -Rank + +> Applicable: Microsoft Teams + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: Required: False Position: Named @@ -171,15 +187,16 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -WhatIf -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +> Applicable: Microsoft Teams + +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -200,10 +217,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. ## RELATED LINKS -[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallinglineidentity) -[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallinglineidentity) -[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallinglineidentity) -[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Grant-CsDialoutPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsDialoutPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsDialoutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsDialoutPolicy.md index 73c1d5c787..7beb049a2e 100644 --- a/teams/teams-ps/teams/Grant-CsDialoutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsDialoutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csdialoutpolicy applicable: Microsoft Teams -title: Grant-CsDialoutPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csdialoutpolicy +schema: 2.0.0 +title: Grant-CsDialoutPolicy --- # Grant-CsDialoutPolicy @@ -76,14 +77,34 @@ This example assigns the policy instance "DialoutCPCandPSTNInternational" to the ## PARAMETERS +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global + +> Applicable: Microsoft Teams + This parameter sets the tenant global policy instance. This is the policy that all users in the tenant will get unless they have a specific policy instance assigned. ```yaml Type: SwitchParameter Parameter Sets: GrantToTenant Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -93,13 +114,15 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: Microsoft Teams + Specifies the group used for the group policy assignment. ```yaml Type: String Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams Required: True Position: 0 @@ -109,13 +132,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of three formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's ObjectId/Identity. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 0 @@ -125,13 +150,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams + Returns the results of the command. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -141,6 +168,9 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Microsoft Teams + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DialoutCPCZoneAPSTNDomestic has a PolicyName equal to DialoutCPCZoneAPSTNDomestic. To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). @@ -149,7 +179,6 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -159,13 +188,15 @@ Accept wildcard characters: False ``` ### -Rank + +> Applicable: Microsoft Teams + The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml Type: Int32 Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -175,6 +206,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -182,23 +216,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -223,4 +240,4 @@ The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or The cmdlet is not supported for Teams resource accounts. ## RELATED LINKS -[Get-CsOnlineDialOutPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialoutpolicy) +[Get-CsOnlineDialOutPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialoutpolicy) diff --git a/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsExternalAccessPolicy.md similarity index 86% rename from teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsExternalAccessPolicy.md index ffce2c43e2..6456e03865 100644 --- a/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsExternalAccessPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy applicable: Microsoft Teams -title: Grant-CsExternalAccessPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy +schema: 2.0.0 +title: Grant-CsExternalAccessPolicy --- # Grant-CsExternalAccessPolicy @@ -15,9 +17,6 @@ ms.reviewer: rogupta ## SYNOPSIS Enables you to assign an external access policy to a user or a group of users. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. - -This cmdlet was introduced in Lync Server 2010. ## SYNTAX @@ -42,6 +41,7 @@ Grant-CsExternalAccessPolicy [[-PolicyName] ] [-Global] [-Force] [ Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified, then the Grant-CsExternalAccessPolicy cmdlet will contact the first available domain controller. ```yaml -Type: UserIdParameter -Parameter Sets: GrantToUser +Type: Fqdn +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondAccessPolicy has a PolicyName equal to RedmondAccessPolicy. +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". -To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 2 +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. -If this parameter is not specified, then the Grant-CsExternalAccessPolicy cmdlet will contact the first available domain controller. +### -Identity + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Identity of the user account the policy should be assigned to. +User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. + +In addition, you can use the asterisk (*) wildcard character when specifying the user Identity. +For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith." ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: UserIdParameter +Parameter Sets: GrantToUser Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsExternalAccessPolicy cmdlet does not pass objects through the pipeline. @@ -196,7 +213,6 @@ By default, the Grant-CsExternalAccessPolicy cmdlet does not pass objects throug Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -205,17 +221,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -PolicyName + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondAccessPolicy has a PolicyName equal to RedmondAccessPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -236,31 +258,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +### -Tenant -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: Guid +Parameter Sets: (All) Aliases: -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -288,10 +298,10 @@ However, if you include the PassThru parameter, the cmdlet will return instances ## RELATED LINKS -[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexternalaccesspolicy) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md b/teams/teams-ps/MicrosoftTeams/Grant-CsGroupPolicyPackageAssignment.md similarity index 92% rename from teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsGroupPolicyPackageAssignment.md index a3f18f52c8..9d1e3f71f5 100644 --- a/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsGroupPolicyPackageAssignment.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: Grant-CsGroupPolicyPackageAssignment -author: serdarsoysal ms.author: serdars -manager: dasosby -online version: https://learn.microsoft.com/powershell/module/teams/grant-csgrouppolicypackageassignment +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csgrouppolicypackageassignment schema: 2.0.0 +title: Grant-CsGroupPolicyPackageAssignment --- # Grant-CsGroupPolicyPackageAssignment @@ -30,7 +31,7 @@ Policy rankings can be optionally specified for each policy type in the package - If the policy type was previously assigned to the group, the ranking for the policy type will not change. - If the policy type was not previously assigned to the group, the ranking for the policy type will be ranked last. -Finally, if a user was directly assigned a package, direct assignment takes precedence over group assignment. For more information on policy rankings and group policy assignments, please review [the description section under New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment#description). +Finally, if a user was directly assigned a package, direct assignment takes precedence over group assignment. For more information on policy rankings and group policy assignments, please review [the description section under New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment#description). ## EXAMPLES @@ -50,15 +51,31 @@ Assigns the Education_Teacher policy package to the group. The group will receiv ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GroupId +> Applicable: Microsoft Teams + A group id in the tenant. It can either be a group's object id or a group's email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -68,13 +85,14 @@ Accept wildcard characters: False ### -PackageName +> Applicable: Microsoft Teams + The name of a policy package. All policy package names can be found by running Get-CsPolicyPackage. To reset the currently assigned package value for the group, use $null or an empty string "". This will not remove any existing policy assignments to the group. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -84,13 +102,14 @@ Accept wildcard characters: False ### -PolicyRankings +> Applicable: Microsoft Teams + The policy rankings for each of the policy types in the package. To specify the policy rankings, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). Policy rank must be a number greater than or equal to 1. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 2 Default value: None @@ -114,21 +133,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -140,6 +144,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineAudioConferencingRoutingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsOnlineAudioConferencingRoutingPolicy.md index d9f1d28be6..7bd387bd41 100644 --- a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,247 +1,248 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy -title: Grant-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# Grant-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. - -To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." - -The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. - -Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com -``` - -Applies the policy "test" to the user "". - -### Example 2 - -```powershell -PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity Global -``` - -Applies the policy "test" to the entire tenant. - -### Example 3 - -```powershell -PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test -``` - -Applies the policy "test" to the specified group. - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -This can be used to apply the policy to the entire tenant. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group - -This is the identifier of the group that the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the identity of the target user. - -Example: - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -Use the "Global" Identity if you wish to set the policy for the entire tenant. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank - -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) -[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) -[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) -[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Grant-CsOnlineAudioConferencingRoutingPolicy +--- + +# Grant-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Applies the policy "test" to the user "". + +### Example 2 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity Global +``` + +Applies the policy "test" to the entire tenant. + +### Example 3 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Applies the policy "test" to the specified group. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +This can be used to apply the policy to the entire tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the target user. + +Example: + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy.md index 4f5598bbb8..00ffcbc34c 100644 --- a/teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Grant-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Grant-CsOnlineVoiceRoutingPolicy --- # Grant-CsOnlineVoiceRoutingPolicy @@ -76,59 +77,57 @@ Example 5 assigns the online voice routing policy RedmondOnlineVoiceRoutingPolic ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user online voice routing policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. ```yaml -Type: String -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the online voice routing policy. By default, the `Grant-CsOnlineVoiceRoutingPolicy` cmdlet does not pass objects through the pipeline. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: GrantToGroup Aliases: -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondOnlineVoiceRoutingPolicy has a PolicyName equal to RedmondOnlineVoiceRoutingPolicy. - -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +### -Identity +Indicates the Identity of the user account to be assigned the per-user online voice routing policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity Aliases: -Required: True -Position: 1 +Required: False +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the online voice routing policy. By default, the `Grant-CsOnlineVoiceRoutingPolicy` cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant +Parameter Sets: (All) Aliases: Required: False @@ -138,16 +137,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondOnlineVoiceRoutingPolicy has a PolicyName equal to RedmondOnlineVoiceRoutingPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: Required: True -Position: 0 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -182,10 +183,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy) -[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy.md similarity index 88% rename from teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy.md index fada417049..b19c9fe7ea 100644 --- a/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy applicable: Microsoft Teams -title: Grant-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy +schema: 2.0.0 +title: Grant-CsOnlineVoicemailPolicy --- # Grant-CsOnlineVoicemailPolicy @@ -52,30 +53,16 @@ The command shown in Example 2 assigns the online voicemail policy Transcription ## PARAMETERS -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsOnlineVoicemailPolicy cmdlet does not pass objects through the pipeline. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -84,30 +71,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -A unique identifier(name) of the policy. +### -Global + +> Applicable: Microsoft Teams + +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Group + +> Applicable: Microsoft Teams + Specifies the group used for the group policy assignment. ```yaml Type: String Parameter Sets: GrantToGroup Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -116,14 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP address or an Object ID. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: System.String +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -132,14 +125,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP address or an Object ID. +### -PassThru + +> Applicable: Microsoft Teams + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsOnlineVoicemailPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -148,14 +143,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PolicyName + +> Applicable: Microsoft Teams + +A unique identifier(name) of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +> Applicable: Microsoft Teams + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: Required: False Position: Named @@ -164,14 +179,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -192,10 +209,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAIPolicy.md similarity index 95% rename from teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAIPolicy.md index 4b3575f42c..b1d3b5cd1d 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Grant-CsTeamsAIPolicy -online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsAIPolicy -schema: 2.0.0 author: Andy447 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: andywang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Grant-CsTeamsAIPolicy +schema: 2.0.0 +title: Grant-CsTeamsAIPolicy --- # Grant-CsTeamsAIPolicy @@ -184,10 +185,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaipolicy) -[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaipolicy) -[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaipolicy) -[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) \ No newline at end of file +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppPermissionPolicy.md similarity index 84% rename from teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppPermissionPolicy.md index 76d9afbba6..c51279d971 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppPermissionPolicy.md @@ -1,23 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsapppermissionpolicy applicable: Microsoft Teams -title: Grant-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: mhayrapetyan +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsapppermissionpolicy +schema: 2.0.0 +title: Grant-CsTeamsAppPermissionPolicy --- # Grant-CsTeamsAppPermissionPolicy ## SYNOPSIS -**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. - -As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . - -This is only applicable for tenants who have not been migrated to ACM or UAM. +As an admin, you can use app permission policies to allow or block apps for your users. ## SYNTAX @@ -47,6 +45,8 @@ Grant-CsTeamsAppPermissionPolicy [[-PolicyName] ] [-Global] [-Force] [. +This is only applicable for tenants who have not been migrated to ACM or UAM. + ## EXAMPLES ### Example 1 @@ -102,6 +102,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The user to whom the policy should be assigned. @@ -146,6 +161,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named + +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant Do not use. @@ -177,37 +208,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named - -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy.md similarity index 83% rename from teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy.md index 3568887beb..c6a457f961 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy.md @@ -1,24 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsappsetuppolicy applicable: Microsoft Teams -title: Grant-CsTeamsAppSetupPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsappsetuppolicy +schema: 2.0.0 +title: Grant-CsTeamsAppSetupPolicy --- # Grant-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. ## SYNTAX @@ -105,6 +102,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The user to whom the policy should be assigned. @@ -149,6 +161,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant Do not use. @@ -180,36 +207,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy.md index 10b0d7085d..809765f7b5 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy -title: Grant-CsTeamsAudioConferencingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy schema: 2.0.0 +title: Grant-CsTeamsAudioConferencingPolicy --- # Grant-CsTeamsAudioConferencingPolicy @@ -47,6 +48,21 @@ In this example, a user with identity "Ken Myer" is being assigned the "Emea Use ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. @@ -62,6 +78,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the Identity of the user account to be assigned the per-user online voice routing policy. User Identities can be specified using one of the following formats: 1) the user's SIP address; 2) the user's user principal name (UPN); or, 3) the user's Active Directory display name (for example, Ken Myer). @@ -123,36 +154,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -184,8 +185,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy) -[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy) -[Remove-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy) +[Remove-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy.md index 6d1b8028b7..2504b577f7 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy applicable: Microsoft Teams -title: Grant-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallholdpolicy +schema: 2.0.0 +title: Grant-CsTeamsCallHoldPolicy --- # Grant-CsTeamsCallHoldPolicy @@ -79,6 +80,51 @@ The command shown in Example 5 sets the Teams call hold policy, ContosoPartnerTe ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the Identity of the user account to be assigned the per-user Teams call hold policy. User Identities can be specified using one of the following formats: @@ -135,36 +181,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Rank The rank of the policy assignment, relative to other group policy assignments for the same policy type. @@ -196,21 +212,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -226,10 +227,10 @@ The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or ## RELATED LINKS -[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy) -[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallholdpolicy) -[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallholdpolicy) -[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallholdpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallParkPolicy.md similarity index 78% rename from teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallParkPolicy.md index 65c8d7ab00..16a23ff60b 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallParkPolicy.md @@ -1,22 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallparkpolicy applicable: Microsoft Teams -title: Grant-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallparkpolicy +schema: 2.0.0 +title: Grant-CsTeamsCallParkPolicy --- # Grant-CsTeamsCallParkPolicy ## SYNOPSIS - -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. - -NOTE: the call park feature currently only available in desktop, web clients and mobile clients. Call Park functionality is currently on the roadmap for Teams IP Phones. Supported with TeamsOnly mode for users with the Phone System license +The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. ## SYNTAX @@ -36,7 +34,14 @@ Grant-CsTeamsCallParkPolicy [-Group] [[-PolicyName] ] [-PassThr ``` ## DESCRIPTION -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different phone. The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. +The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in +Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then +perform a number of actions on that call: transfer to another department, retrieve via the same +phone, or retrieve via a different phone. + +NOTE: the call park feature currently only available in desktop, web clients and mobile clients. +Call Park functionality is currently on the roadmap for Teams IP Phones. Supported with TeamsOnly +mode for users with the Phone System license ## EXAMPLES @@ -56,27 +61,27 @@ Assigns a custom policy "Sales Policy" to the members of the group sales@contoso ## PARAMETERS -### -Identity -The User ID of the user to whom the policy is being assigned. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. By default, the cmdlet does not pass objects through the pipeline. +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: Required: False @@ -86,29 +91,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope ("tag:"). For example, a policy that has the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. - -If you set PolicyName to a null value, the command will unassign any per-user policy assigned to the user. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. +### -Identity +The User ID of the user to whom the policy is being assigned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. By default, the cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant +Parameter Sets: (All) Aliases: Required: False @@ -118,16 +136,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope ("tag:"). For example, a policy that has the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. + +If you set PolicyName to a null value, the command will unassign any per-user policy assigned to the user. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: Required: True -Position: 0 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -164,21 +184,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -193,10 +198,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. ## RELATED LINKS -[Set-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallparkpolicy) +[Set-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallparkpolicy) -[Get-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallparkpolicy) +[Get-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallparkpolicy) -[New-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallparkpolicy) +[New-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallparkpolicy) -[Remove-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallparkpolicy) +[Remove-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallparkpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallingPolicy.md index c843a89e58..b44a0ab4c6 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsCallingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallingpolicy +schema: 2.0.0 +title: Grant-CsTeamsCallingPolicy --- # Grant-CsTeamsCallingPolicy @@ -63,57 +63,57 @@ Assigns the TeamsCallingPolicy called "SalesCallingPolicy" to the members of the ## PARAMETERS -### -Identity -The user object to whom the policy is being assigned. +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml -Type: String -Parameter Sets: (Identity) +Type: SwitchParameter +Parameter Sets: (GrantToTenant) Aliases: Required: False -Position: 0 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsCallingPolicy cmdlet does not pass objects through the pipeline. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: (GrantToGroup) Aliases: -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the policy being assigned. To remove an existing user level policy assignment, specify PolicyName as $null. +### -Identity +The user object to whom the policy is being assigned. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (Identity) Aliases: Required: False -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsCallingPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter -Parameter Sets: (GrantToTenant) +Parameter Sets: (All) Aliases: Required: False @@ -123,16 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +The name of the policy being assigned. To remove an existing user level policy assignment, specify PolicyName as $null. ```yaml Type: String -Parameter Sets: (GrantToGroup) +Parameter Sets: (All) Aliases: -Required: True -Position: 0 +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -168,10 +168,10 @@ The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or ## RELATED LINKS -[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallingpolicy) -[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallingpolicy) -[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallingpolicy) -[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsChannelsPolicy.md similarity index 92% rename from teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsChannelsPolicy.md index abfbdfe908..208f05b30b 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsChannelsPolicy.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy applicable: Microsoft Teams -title: Grant-CsTeamsChannelsPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamschannelspolicy +schema: 2.0.0 +title: Grant-CsTeamsChannelsPolicy --- # Grant-CsTeamsChannelsPolicy ## SYNOPSIS - -The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. +The Grant-CsTeamsChannelsPolicy allows you to assign specific policies to users that have been created in your tenant. ## SYNTAX @@ -37,7 +38,7 @@ Grant-CsTeamsChannelsPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalP ``` ## DESCRIPTION -The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. The Grant-CsTeamsChannelsPolicy allows you to assign specific policies to users that have been created in your tenant. +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. ## EXAMPLES @@ -95,6 +96,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Specify the user to whom the policy is being assigned. @@ -139,12 +155,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -154,28 +170,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Tenant +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup Aliases: Required: False @@ -185,15 +185,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy.md index caa013a167..bb1b8e110d 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: Grant-CsTeamsComplianceRecordingPolicy --- # Grant-CsTeamsComplianceRecordingPolicy @@ -73,23 +74,33 @@ As a result, the user will be managed by the global Teams recording policy. ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user Teams recording policy. -User Identities can be specified using one of the following formats: +### -Confirm +Prompts you for confirmation before running the cmdlet. -- The user's SIP address; -- The user's user principal name (UPN); -- The user's Active Directory display name (for example, Ken Myer). +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. ```yaml -Type: UserIdParameter -Parameter Sets: Identity +Type: Fqdn +Parameter Sets: (All) Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -109,57 +120,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -Name of the policy to be assigned. -The PolicyName is simply the policy Identity without the policy scope i.e. the "Tag:" prefix. -For example, a policy with the Identity Tag:ContosoPartnerComplianceRecordingPolicy has a PolicyName equal to ContosoPartnerComplianceRecordingPolicy. - -To revoke a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams recording policy. +User Identities can be specified using one of the following formats: -If you are using a remote session of Windows PowerShell and are connected only to Microsoft Teams or Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. +- The user's SIP address; +- The user's user principal name (UPN); +- The user's Active Directory display name (for example, Ken Myer). ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams recording policy. +By default, the Grant-CsTeamsComplianceRecordingPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: Required: False @@ -169,27 +171,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +Name of the policy to be assigned. +The PolicyName is simply the policy Identity without the policy scope i.e. the "Tag:" prefix. +For example, a policy with the Identity Tag:ContosoPartnerComplianceRecordingPolicy has a PolicyName equal to ContosoPartnerComplianceRecordingPolicy. + +To revoke a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -This parameter is reserved for internal Microsoft use. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -199,29 +205,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams recording policy. -By default, the Grant-CsTeamsComplianceRecordingPolicy cmdlet does not pass objects through the pipeline. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +You can return your tenant ID by running this command: -### -Confirm -Prompts you for confirmation before running the cmdlet. +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Microsoft Teams or Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -261,20 +262,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCortanaPolicy.md similarity index 97% rename from teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCortanaPolicy.md index ef2205b07d..c963022870 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy applicable: Microsoft Teams -title: Grant-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscortanapolicy +schema: 2.0.0 +title: Grant-CsTeamsCortanaPolicy --- # Grant-CsTeamsCortanaPolicy @@ -98,6 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the identity of the user account the policy should be assigned to. User identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -157,21 +173,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Tenant Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" diff --git a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy.md index c86a84aa89..35ba890327 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Grant-CsTeamsEmergencyCallRoutingPolicy --- # Grant-CsTeamsEmergencyCallRoutingPolicy @@ -56,6 +58,21 @@ This example assigns the Teams Emergency Call Routing policy (Test) to the membe ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global Sets the parameters of the Global policy instance to the values in the specified policy instance. @@ -162,21 +179,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -190,10 +192,10 @@ The GrantToGroup syntax is supported in Teams PowerShell Module version 4.5.1-pr ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy) -[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy) -[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy.md index 6a5ce3b2a9..a16a1909e7 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc, pthota +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy schema: 2.0.0 +title: Grant-CsTeamsEmergencyCallingPolicy --- # Grant-CsTeamsEmergencyCallingPolicy @@ -53,6 +55,21 @@ Assigns the Teams Emergency Calling policy called "SalesTECP" to the Global poli ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global Sets the parameters of the Global policy instance to the values in the specified policy instance. @@ -159,21 +176,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -189,10 +191,10 @@ The GrantToGroup syntax is supported in Teams PowerShell Module version 4.5.1-pr ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy) -[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy) -[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy) -[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEnhancedEncryptionPolicy.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEnhancedEncryptionPolicy.md index 58b0be1886..106ee672a2 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEnhancedEncryptionPolicy.md @@ -1,201 +1,202 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy -title: Grant-CsTeamsEnhancedEncryptionPolicy -author: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Grant-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Cmdlet to assign a specific Teams enhanced encryption Policy to a user. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ][-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup -``` -Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] -Group [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Cmdlet to assign a specific Teams enhanced encryption Policy to a user. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsEnhancedEncryptionPolicy' -``` - -The command shown in Example 1 assigns the per-user Teams enhanced encryption policy, ContosoPartnerTeamsEnhancedEncryptionPolicy, to the user with the user principal name (UPN) "KenMyer@contoso.com". - -### EXAMPLE 2 -```PowerShell -PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'Ken Myer' -PolicyName $null -``` - -In Example 2, any per-user Teams enhanced encryption policy previously assigned to the user "Ken Myer" is revoked. - -As a result, the user will be managed by the global Teams enhanced encryption policy. - -## PARAMETERS - -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Global -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Grant-CsTeamsEnhancedEncryptionPolicy +--- + +# Grant-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ][-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] -Group [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsEnhancedEncryptionPolicy' +``` + +The command shown in Example 1 assigns the per-user Teams enhanced encryption policy, ContosoPartnerTeamsEnhancedEncryptionPolicy, to the user with the user principal name (UPN) "KenMyer@contoso.com". + +### EXAMPLE 2 +```PowerShell +PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'Ken Myer' -PolicyName $null +``` + +In Example 2, any per-user Teams enhanced encryption policy previously assigned to the user "Ken Myer" is revoked. + +As a result, the user will be managed by the global Teams enhanced encryption policy. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy) + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEventsPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEventsPolicy.md index ad83d722d4..04eb03be0c 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEventsPolicy.md @@ -1,207 +1,208 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamseventspolicy -title: Grant-CsTeamsEventsPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsEventsPolicy - -## SYNOPSIS -Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsEventsPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup -``` -Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] - [-Group] [-Rank ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Assigns Teams Events policy to a user, group of users, or the entire tenant. - -TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy DisablePublicWebinars -``` - -The command shown in Example 1 assigns the per-user Teams Events policy, DisablePublicWebinars, to the user with the user principal name (UPN) "user1@contoso.com". - -### Example 2 -```powershell -PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy $null -``` - -The command shown in Example 2 revokes the per-user Teams Events policy for the user with the user principal name (UPN) "user1@contoso.com". As a result, the user will be managed by the global Teams Events policy. - -### Example 3 -```powershell -PS C:\> Grant-CsTeamsEventsPolicy -Group "sales@contoso.com" -Rank 10 -Policy DisablePublicWebinars -``` - -The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "sales@contoso.com". - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the identity of the target user. Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -Use the "Global" Identity if you wish to set the policy for the entire tenant. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. - -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamseventspolicy +schema: 2.0.0 +title: Grant-CsTeamsEventsPolicy +--- + +# Grant-CsTeamsEventsPolicy + +## SYNOPSIS +Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsEventsPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] + [-Group] [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Assigns Teams Events policy to a user, group of users, or the entire tenant. + +TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy DisablePublicWebinars +``` + +The command shown in Example 1 assigns the per-user Teams Events policy, DisablePublicWebinars, to the user with the user principal name (UPN) "user1@contoso.com". + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy $null +``` + +The command shown in Example 2 revokes the per-user Teams Events policy for the user with the user principal name (UPN) "user1@contoso.com". As a result, the user will be managed by the global Teams Events policy. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Group "sales@contoso.com" -Rank 10 -Policy DisablePublicWebinars +``` + +The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "sales@contoso.com". + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy.md index cacbfb5a0b..539ec21dc4 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Grant-CsTeamsFeedbackPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfeedbackpolicy +schema: 2.0.0 +title: Grant-CsTeamsFeedbackPolicy --- # Grant-CsTeamsFeedbackPolicy @@ -95,6 +96,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the identity of the user account the policy should be assigned to. @@ -140,12 +156,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: Object -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -155,28 +171,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Tenant +Internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup Aliases: Required: False @@ -186,15 +186,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFilesPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFilesPolicy.md index 3f44d72269..3f9f63aba5 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFilesPolicy.md @@ -1,207 +1,208 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy -title: Grant-CsTeamsFilesPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsFilesPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsFilesPolicy [] -``` - -### GrantToUser - -```powershell -Grant-CsTeamsFilesPolicy -Identity [[-PolicyName] ] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Group] -Rank [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Global] [-Force] [] -``` - -## DESCRIPTION - -The Teams Files Policy is used to modify files related settings in Microsoft teams. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com -``` - -Assigns a given policy to a user. - -### Example 2 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test -``` - -Assigns a given policy to a group. - -### Example 3 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test -``` - -Assigns a given policy to the tenant. - -### Example 4 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test -``` - -Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ - -## PARAMETERS - -### -Force - -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -This is the equivalent to `-Identity Global`. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group - -This is the identifier of the group that the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the identity of the target user. - -Example: - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -Use the "Global" Identity if you wish to set the policy for the entire tenant. - -```yaml -Type: String -Parameter Sets: GrantToUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PolicyName - -Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - -```yaml -Type: String -Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank - -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) - -[Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) - -[Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) - -[Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) - -[New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfilespolicy +schema: 2.0.0 +title: Grant-CsTeamsFilesPolicy +--- + +# Grant-CsTeamsFilesPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsFilesPolicy [] +``` + +### GrantToUser + +```powershell +Grant-CsTeamsFilesPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Group] -Rank [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION + +The Teams Files Policy is used to modify files related settings in Microsoft teams. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the target user. + +Example: + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) + +[Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) + +[Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) + +[Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) + +[New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) diff --git a/teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy.md similarity index 97% rename from teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy.md index 4e0833c5a5..8875198248 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsipphonepolicy applicable: Microsoft Teams -title: Grant-CsTeamsIPPhonePolicy author: tonywoodruff +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsipphonepolicy schema: 2.0.0 +title: Grant-CsTeamsIPPhonePolicy --- # Grant-CsTeamsIPPhonePolicy @@ -98,6 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the identity of the user account the policy should be assigned to. @@ -143,21 +159,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Rank The rank of the policy assignment, relative to other group policy assignments for the same policy type. diff --git a/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaConnectivityPolicy.md similarity index 91% rename from teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaConnectivityPolicy.md index 126e7adfd2..260dd07111 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Grant-CsTeamsMediaConnectivityPolicy -online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMediaConnectivityPolicy -schema: 2.0.0 author: lirunping-MSFT +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: runli +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Grant-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +title: Grant-CsTeamsMediaConnectivityPolicy --- # Grant-CsTeamsMediaConnectivityPolicy @@ -182,10 +183,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy) -[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy) -[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy) -[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaLoggingPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaLoggingPolicy.md index 960fd62910..d4131e4307 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaLoggingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsMediaLoggingPolicy author: LeoKuhorev -ms.author: leokukharau +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US manager: shalages +Module Name: MicrosoftTeams +ms.author: leokukharau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmedialoggingpolicy schema: 2.0.0 +title: Grant-CsTeamsMediaLoggingPolicy --- # Grant-CsTeamsMediaLoggingPolicy @@ -77,41 +78,34 @@ Unassign Teams Media Logging policy from the entire tenant. ## PARAMETERS -### -Identity - -Specifies the identity of the target user. -Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com +### -Confirm -Example: 98403f08-577c-46dd-851a-f0460a13b03d +> Applicable: Microsoft Teams -Use the "Global" Identity if you wish to set the policy for the entire tenant. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: -applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Global -Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. +> Applicable: Microsoft Teams + +When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -120,72 +114,83 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName - -Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - -Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". - -If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: -applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global +### -Identity -When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". +> Applicable: Microsoft Teams + +Specifies the identity of the target user. +Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: String +Parameter Sets: Identity Aliases: -applicable: Microsoft Teams Required: False -Position: Named -Default value: False -Accept pipeline input: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf +### -PassThru -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +> Applicable: Microsoft Teams + +Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName + +> Applicable: Microsoft Teams + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". + +If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: -Required: True -Position: Named +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -206,15 +211,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -WhatIf -Prompts you for confirmation before running the cmdlet. +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -239,4 +246,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy) +[Get-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmedialoggingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy.md index cd29d655c1..7ce6703dd6 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Grant-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # Grant-CsTeamsMeetingBrandingPolicy @@ -54,6 +54,21 @@ In this example, the command will assign TeamsMeetingBrandingPolicy with the nam ## PARAMETERS +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. @@ -129,21 +144,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -157,12 +157,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy.md similarity index 87% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy.md index 1fac390b29..67c6f3e20c 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbroadcastpolicy applicable: Microsoft Teams -title: Grant-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Grant-CsTeamsMeetingBroadcastPolicy --- # Grant-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS -Grant-CsTeamsMeetingBroadcastPolicy \[\[-Identity\] \\] \[-PolicyName\] \ \[-Tenant \\] \[-DomainController \\] \[-PassThru\] \[-WhatIf\] \[-Confirm\] \[\\] - -Grant-CsTeamsMeetingBroadcastPolicy \[-PolicyName\] \ \[-Tenant \\] \[-DomainController \\] \[-PassThru\] \[-Global\] \[-WhatIf\] \[-Confirm\] \[\\] +Use this cmdlet to assign a policy to a user. ## SYNTAX @@ -38,7 +38,7 @@ Grant-CsTeamsMeetingBroadcastPolicy [-PassThru] [[-PolicyName] ] ``` ## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to assign a policy to a user. +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## EXAMPLES @@ -88,6 +88,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -147,21 +162,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Tenant ```yaml diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingPolicy.md index 555e7a9518..9928aaa8ff 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingpolicy +schema: 2.0.0 +title: Grant-CsTeamsMeetingPolicy --- # Grant-CsTeamsMeetingPolicy @@ -50,11 +52,12 @@ In this example, a user with identity "Ken Myer" is being assigned the StudentMe ### -DomainController +> Applicable: Microsoft Teams + ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -63,59 +66,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". ```yaml -Type: UserIdParameter -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: -applicable: Microsoft Teams Required: False -Position: 0 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: GrantToGroup Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. +### -Identity + +> Applicable: Microsoft Teams + +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. ```yaml -Type: String +Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". +### -PassThru + +> Applicable: Microsoft Teams ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant +Parameter Sets: (All) Aliases: Required: False @@ -125,16 +130,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName + +> Applicable: Microsoft Teams + +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: -Required: True -Position: Named +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -157,11 +165,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 85% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md index 591125a048..e6e183462b 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Grant-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Grant-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Grant-CsTeamsMeetingTemplatePermissionPolicy --- # Grant-CsTeamsMeetingTemplatePermissionPolicy @@ -54,15 +55,16 @@ Assigns a given policy to a user. ## PARAMETERS -### -PolicyName +### -Force -Specifies the Identity of the policy to assign to the user or group. +> Applicable: Microsoft Teams + +Forces the policy assignment. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -70,16 +72,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity +### -Global -This is the identifier of the user that the policy should be assigned to. +> Applicable: Microsoft Teams + +This is the equivalent to `-Identity Global`. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -88,13 +91,14 @@ Accept wildcard characters: False ### -Group +> Applicable: Microsoft Teams + This is the identifier of the group that the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -102,31 +106,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Global +### -Identity -This is the equivalent to `-Identity Global`. +> Applicable: Microsoft Teams + +This is the identifier of the user that the policy should be assigned to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -PolicyName -Forces the policy assignment. +> Applicable: Microsoft Teams + +Specifies the Identity of the policy to assign to the user or group. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -159,10 +165,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy) -[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMessagingPolicy.md similarity index 97% rename from teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMessagingPolicy.md index cbe96c09cb..152270a356 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMessagingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmessagingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsMessagingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmessagingpolicy +schema: 2.0.0 +title: Grant-CsTeamsMessagingPolicy --- # Grant-CsTeamsMessagingPolicy @@ -85,21 +87,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Global When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". @@ -130,16 +117,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Identity +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -174,6 +161,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant ```yaml diff --git a/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMobilityPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMobilityPolicy.md index 9ca488f23b..c79c90d5f9 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmobilitypolicy applicable: Microsoft Teams -title: Grant-CsTeamsMobilityPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmobilitypolicy +schema: 2.0.0 +title: Grant-CsTeamsMobilityPolicy --- # Grant-CsTeamsMobilityPolicy @@ -63,89 +65,89 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The User Id of the user to whom the policy is being assigned. +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". ```yaml -Type: UserIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the Global policy, you can assign $Null. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". +### -Identity +The User Id of the user to whom the policy is being assigned. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the cmdlet does not pass objects through the pipeline. ```yaml -Type: String -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the Global policy, you can assign $Null. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: String +Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. - -By default, the cmdlet does not pass objects through the pipeline. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRecordingRollOutPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRecordingRollOutPolicy.md index de38261c46..7dd7636329 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsrecordingrolloutpolicy -schema: 2.0.0 applicable: Microsoft Teams -title: Grant-CsTeamsRecordingRollOutPolicy -manager: yujin1 author: ronwa +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams ms.author: ronwa +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsrecordingrolloutpolicy +schema: 2.0.0 +title: Grant-CsTeamsRecordingRollOutPolicy --- # Grant-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md index e9460ea3d0..f3bb5bc3cc 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,204 +1,207 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsroomvideoteleconferencingpolicy -title: Grant-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -When you use this cmdlet without specifying a identity, the policy applies to all rooms in your tenant, except any that have an explicit policy assignment. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group - -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The alias of the Teams room that the IT admin is granting this PolicyName to. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Corresponds to the name of the policy under -Identity from the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank - -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Grant-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Grant-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. + +## SYNTAX + +### Identity (Default) + +``` +Grant-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +``` +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +``` +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +When you use this cmdlet without specifying a identity, the policy applies to all rooms in your tenant, except any that have an explicit policy assignment. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The alias of the Teams room that the IT admin is granting this PolicyName to. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Corresponds to the name of the policy under -Identity from the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSharedCallingRoutingPolicy.md similarity index 84% rename from teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSharedCallingRoutingPolicy.md index 4eb7f30ac5..fffe5cff12 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsSharedCallingRoutingPolicy -schema: 2.0.0 author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy +schema: 2.0.0 +title: Grant-CsTeamsSharedCallingRoutingPolicy --- # Grant-CsTeamsSharedCallingRoutingPolicy @@ -39,6 +38,9 @@ Grant-CsTeamsSharedCallingRoutingPolicy -Global [[-PolicyName] ] [-Force Grant-CsTeamsSharedCallingRoutingPolicy [-Group] [[-PolicyName] ] -Rank [] ``` +## DESCRIPTION +The `Grant-CsTeamsSharedCallingRoutingPolicy` cmdlet assigns a Teams shared calling routing policy to a user, a group of users, or sets the Global policy instance. This cmdlet is used to manage how calls are routed in Microsoft Teams, allowing administrators to control call handling and routing behavior for users within their organization. + ## EXAMPLES ### EXAMPLE 1 @@ -55,34 +57,20 @@ Example 2 assigns the per-user Teams shared calling routing policy instance Seat ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user Teams shared calling routing policy. User identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's ObjectId or Identity. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +### -Force -### -PolicyName -Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Seattle has a PolicyName equal to Seattle. +> Applicable: Microsoft Teams -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -117,12 +105,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams shared calling routing policy. User identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's ObjectId or Identity. ```yaml -Type: Int32 -Parameter Sets: (GrantToGroup) +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Seattle has a PolicyName equal to Seattle. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + +```yaml +Type: String +Parameter Sets: (All) Aliases: Required: False @@ -132,18 +137,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Type: Int32 +Parameter Sets: (GrantToGroup) +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -159,10 +163,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable This cmdlet was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS -[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy) -[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy) -[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsShiftsPolicy.md similarity index 88% rename from teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsShiftsPolicy.md index 43875faa32..2be5e973bb 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsShiftsPolicy.md @@ -1,162 +1,167 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-teamsshiftspolicy -title: Grant-CsTeamsShiftsPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet supports applying the TeamsShiftsPolicy to users in a tenant. - -## SYNTAX - -### Identity (Default) -```powershell -Grant-CsTeamsShiftsPolicy [] -``` - -### GrantToUser -```powershell -Grant-CsTeamsShiftsPolicy [-Identity] [[-PolicyName] ] [] -``` - -### GrantToGroup -```powershell -Grant-CsTeamsShiftsPolicy [[-PolicyName] ] [-Group] [-Rank] [] -``` - -### GrantToTenant -```powershell -Grant-CsTeamsShiftsPolicy [[-PolicyName] ] [-Global] [-Force] [] -``` - -## DESCRIPTION -This cmdlet enables admins to grant Shifts specific policy settings to users in their tenant. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsShiftsPolicy -Identity IsaiahL@mwtdemo.onmicrosoft.com -PolicyName OffShiftAccessMessage1Always -``` -Applies the OffShiftAccessMessage1Always instance of TeamsShiftsPolicy to one user in the tenant. - -## PARAMETERS - -### -Identity -UserId to whom the policy is granted. Email id is acceptable. - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PolicyName -The name of the TeamsShiftsPolicy instance that is being applied to the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named - -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-teamsshiftspolicy +schema: 2.0.0 +title: Grant-CsTeamsShiftsPolicy +--- + +# Grant-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet supports applying the TeamsShiftsPolicy to users in a tenant. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsShiftsPolicy [] +``` + +### GrantToUser +```powershell +Grant-CsTeamsShiftsPolicy [-Identity] [[-PolicyName] ] [] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsShiftsPolicy [[-PolicyName] ] [-Group] [-Rank] [] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsShiftsPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION +This cmdlet enables admins to grant Shifts specific policy settings to users in their tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsShiftsPolicy -Identity IsaiahL@mwtdemo.onmicrosoft.com -PolicyName OffShiftAccessMessage1Always +``` +Applies the OffShiftAccessMessage1Always instance of TeamsShiftsPolicy to one user in the tenant. + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Microsoft Teams + +UserId to whom the policy is granted. Email id is acceptable. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName + +> Applicable: Microsoft Teams + +The name of the TeamsShiftsPolicy instance that is being applied to the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named + +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftspolicy) + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 92% rename from teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md index bbe885264d..57349e431d 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,199 +1,204 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssurvivablebranchappliancepolicy -title: Grant-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group - -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the user. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank - -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Grant-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Grant-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Grants a Survivable Branch Appliance (SBA) Policy to users in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +Grant-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +``` +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +``` +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the user. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpdateManagementPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpdateManagementPolicy.md index d17f961f44..e67586f45c 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsupdatemanagementpolicy applicable: Microsoft Teams -title: Grant-CsTeamsUpdateManagementPolicy -schema: 2.0.0 author: vargasj-ms -ms.author: vargasj +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: gnamun +Module Name: MicrosoftTeams +ms.author: vargasj +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsupdatemanagementpolicy +schema: 2.0.0 +title: Grant-CsTeamsUpdateManagementPolicy --- # Grant-CsTeamsUpdateManagementPolicy diff --git a/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpgradePolicy.md similarity index 98% rename from teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpgradePolicy.md index 54251476e5..b59e391ee5 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpgradePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy applicable: Microsoft Teams -title: Grant-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy +schema: 2.0.0 +title: Grant-CsTeamsUpgradePolicy --- # Grant-CsTeamsUpgradePolicy @@ -154,28 +156,29 @@ After running these lines will create an HTML file on the Desktop of the curre ## PARAMETERS -### -Identity - -The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: UserIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName +### -Global -The name of the policy instance. +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -186,46 +189,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Global - -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: GrantToGroup Aliases: -Required: False -Position: 1 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Identity -Do not use. +The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. ```yaml -Type: Object -Parameter Sets: (All) +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -MigrateMeetingsToTeams +Not supported anymore, see the Description section. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: Boolean +Parameter Sets: (All) Aliases: Required: False @@ -235,44 +235,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the cmdlet does not pass objects through the pipeline. ```yaml -Type: String -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateMeetingsToTeams -Not supported anymore, see the Description section. +### -PolicyName + +The name of the policy instance. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. - -By default, the cmdlet does not pass objects through the pipeline. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -282,12 +283,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Tenant + +Do not use. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: Object +Parameter Sets: (All) Aliases: Required: False @@ -318,8 +320,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Coexistence with Skype for Business](https://learn.microsoft.com/microsoftteams/coexistence-chat-calls-presence) -[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradeconfiguration) +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradeconfiguration) -[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsupgradeconfiguration) -[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradepolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVdiPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVdiPolicy.md index 6d3a365fa0..0e775357fe 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVdiPolicy.md @@ -1,153 +1,154 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvdipolicy -title: Grant-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsVdiPolicy - -## SYNOPSIS -Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -### Identity (Default) -```powershell -Grant-CsTeamsVdiPolicy [] -``` - -### GrantToUser -```powershell -Grant-CsTeamsVdiPolicy -Identity [[-PolicyName] ] [] -``` - -### GrantToGroup -```powershell -Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Group] -Rank [] -``` - -### GrantToTenant -```powershell -Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Global] [-Force] [] -``` - -## DESCRIPTION -Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsVdiPolicy -identity "Ken Myer" -PolicyName RestrictedUserPolicy -``` - -In this example, a user with identity "Ken Myer" is being assigned the RestrictedUserPolicy - -## PARAMETERS - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. - -```yaml -Type: String -Parameter Sets: GrantToUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. - -```yaml -Type: String -Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvdipolicy +schema: 2.0.0 +title: Grant-CsTeamsVdiPolicy +--- + +# Grant-CsTeamsVdiPolicy + +## SYNOPSIS +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsVdiPolicy [] +``` + +### GrantToUser +```powershell +Grant-CsTeamsVdiPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Group] -Rank [] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsVdiPolicy -identity "Ken Myer" -PolicyName RestrictedUserPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the RestrictedUserPolicy + +## PARAMETERS + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy.md similarity index 95% rename from teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy.md index a6a5f02703..532b2e864a 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvideointeropservicepolicy applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Grant-CsTeamsVideoInteropServicePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvideointeropservicepolicy +schema: 2.0.0 +title: Grant-CsTeamsVideoInteropServicePolicy --- # Grant-CsTeamsVideoInteropServicePolicy ## SYNOPSIS - -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. +The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. ## SYNTAX @@ -41,8 +41,6 @@ Grant-CsTeamsVideoInteropServicePolicy [-PassThru] [[-PolicyName] ] ## DESCRIPTION Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. Microsoft provides pre-constructed policies for each of our supported partners that allow you to designate which of the partners to use for cloud video interop. -The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. - User needs to be assigned one policy from admin to create a CVI meeting. There could be multiple provides in a tenant, but user can only be assigned only one policy(provide). **FAQ**: @@ -144,6 +142,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity {{Fill Identity Description}} @@ -189,12 +202,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -204,44 +217,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Tenant +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVirtualAppointmentsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVirtualAppointmentsPolicy.md index 1203279e74..aab8aec8e6 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy -title: Grant-CsTeamsVirtualAppointmentsPolicy -schema: 2.0.0 ms.author: erocha -manager: sonaggarwal -author: emmanuelrocha001 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy +schema: 2.0.0 +title: Grant-CsTeamsVirtualAppointmentsPolicy --- # Grant-CsTeamsVirtualAppointmentsPolicy @@ -185,11 +186,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy) -[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVoiceApplicationsPolicy.md similarity index 92% rename from teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVoiceApplicationsPolicy.md index e97f8b3ab1..5f994f136f 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy -title: Grant-CsTeamsVoiceApplicationsPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy schema: 2.0.0 +title: Grant-CsTeamsVoiceApplicationsPolicy --- # Grant-CsTeamsVoiceApplicationsPolicy @@ -51,27 +52,27 @@ Example 2 assigns the per-user online voice routing policy "SDA-Allow-All to all ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user Teams voice applications policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: Required: False @@ -80,64 +81,63 @@ Default value: False Accept pipeline input: False Accept wildcard characters: False ``` - -### -PolicyName -"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. - -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: -Required: False -Position: 2 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams voice applications policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named -Default value: False -Accept pipeline input: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -PolicyName +"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -158,15 +158,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -187,10 +188,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy) -[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy) -[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLoadPolicy.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLoadPolicy.md index b6dcf697af..39a805833f 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLoadPolicy.md @@ -1,253 +1,254 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy -title: Grant-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsWorkLoadPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] - [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] - [-Group] [-Rank ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com -``` - -Assigns a given policy to a user. - -### Example 2 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test -``` - -Assigns a given policy to a group. - -### Example 3 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test -``` - -Assigns a given policy to the tenant. - -### Example 4 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test -``` - -> [!NOTE] -> _Using `$null` in place of a policy name can be used to unassigned a policy instance._ - - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -This is the equivalent to `-Identity Global`. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group - -This is the identifier of the group that the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the identity of the target user. - -Example: - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -Use the "Global" Identity if you wish to set the policy for the entire tenant. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Microsoft internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank - -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworkloadpolicy +schema: 2.0.0 +title: Grant-CsTeamsWorkLoadPolicy +--- + +# Grant-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsWorkLoadPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] + [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] + [-Group] [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test +``` + +> [!NOTE] +> _Using `$null` in place of a policy name can be used to unassigned a policy instance._ + + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the target user. + +Example: + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLocationDetectionPolicy.md similarity index 91% rename from teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLocationDetectionPolicy.md index 35c5297361..67a1e95478 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy -title: Grant-CsTeamsWorkLocationDetectionPolicy -schema: 2.0.0 ms.author: arkozlov -manager: prashibadkur -author: artemiykozlov +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy +schema: 2.0.0 +title: Grant-CsTeamsWorkLocationDetectionPolicy --- # Grant-CsTeamsWorkLocationDetectionPolicy @@ -185,10 +186,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy) -[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy) -[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy) -[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTenantDialPlan.md similarity index 90% rename from teams/teams-ps/teams/Grant-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTenantDialPlan.md index 9f4245e9a8..f6398048e4 100644 --- a/teams/teams-ps/teams/Grant-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan applicable: Microsoft Teams -title: Grant-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-cstenantdialplan +schema: 2.0.0 +title: Grant-CsTenantDialPlan --- # Grant-CsTenantDialPlan @@ -69,13 +70,15 @@ This example grants the Vt1tenantDialPlan9 dial plan to members of the group sal ## PARAMETERS ### -Global + +> Applicable: Microsoft Teams + Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: SwitchParameter Parameter Sets: (GrantToTenant) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -84,82 +87,91 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Group + +> Applicable: Microsoft Teams + +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: (GrantToGroup) Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The PolicyName parameter is the name of the tenant dial plan to be assigned. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter identifies the user to whom the policy should be assigned. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (Identity) Aliases: -Applicable: Microsoft Teams Required: False -Position: 1 +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PassThru + +> Applicable: Microsoft Teams ```yaml -Type: String -Parameter Sets: (GrantToGroup) +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PolicyName + +> Applicable: Microsoft Teams + +The PolicyName parameter is the name of the tenant dial plan to be assigned. ```yaml -Type: Int32 -Parameter Sets: (GrantToGroup) +Type: String +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter identifies the user to whom the policy should be assigned. +### -Rank + +> Applicable: Microsoft Teams + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: String -Parameter Sets: (Identity) +Type: Int32 +Parameter Sets: (GrantToGroup) Aliases: -Applicable: Microsoft Teams Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -176,10 +188,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) -[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan) -[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantdialplan) -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Grant-CsUserPolicyPackage.md similarity index 88% rename from teams/teams-ps/teams/Grant-CsUserPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsUserPolicyPackage.md index 6d4fc120b3..0dcab00759 100644 --- a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsUserPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Grant-CsUserPolicyPackage -author: serdarsoysal ms.author: serdars -manager: amitar -online version: https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csuserpolicypackage schema: 2.0.0 +title: Grant-CsUserPolicyPackage --- # Grant-CsUserPolicyPackage @@ -37,15 +38,31 @@ Applies the Education_PrimaryStudent policy package to two users in the tenant. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Microsoft Teams + A list of one or more users in the tenant. Note that there is a limit of 20 users you can apply the package to at a time. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -55,13 +72,14 @@ Accept wildcard characters: False ### -PackageName +> Applicable: Microsoft Teams + The name of a specific policy package to apply. All possible policy package names can be found by running Get-CsPolicyPackage. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -85,21 +103,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -111,10 +114,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation) -[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackage) -[New-CsBatchPolicyPackageAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation) +[New-CsBatchPolicyPackageAssignmentOperation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchpolicypackageassignmentoperation) diff --git a/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md b/teams/teams-ps/MicrosoftTeams/Import-CsAutoAttendantHolidays.md similarity index 92% rename from teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md rename to teams/teams-ps/MicrosoftTeams/Import-CsAutoAttendantHolidays.md index aee3150e6e..4dbfb416bf 100644 --- a/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/MicrosoftTeams/Import-CsAutoAttendantHolidays.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays applicable: Microsoft Teams -title: Import-CsAutoAttendantHolidays -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/import-csautoattendantholidays +schema: 2.0.0 +title: Import-CsAutoAttendantHolidays --- # Import-CsAutoAttendantHolidays @@ -44,7 +46,7 @@ where ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv") Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -Input $bytes @@ -52,7 +54,7 @@ Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -I In this example, the Import-CsAutoAttendantHolidays cmdlet is used to import holiday schedule information from a file at path "C:\Imports\Holidays.csv" to an auto attendant with Identity of 6abea1cd-904b-520b-be96-1092cc096432. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv") Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -Input $bytes | Format-Table -Wrap -AutoSize @@ -63,13 +65,15 @@ In this example, the Import-CsAutoAttendantHolidays cmdlet is used to import hol ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the AA whose holiday schedules are to be imported. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -79,13 +83,15 @@ Accept wildcard characters: False ``` ### -Input + +> Applicable: Microsoft Teams + The Input parameter specifies the holiday schedule information that is to be imported. ```yaml Type: System.Byte[] Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -96,11 +102,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -125,6 +132,6 @@ The Import-CsAutoAttendantHolidays cmdlet accepts a string as the Identity param ## RELATED LINKS -[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays) +[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/export-csautoattendantholidays) -[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays) +[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantholidays) diff --git a/teams/teams-ps/teams/Import-CsOnlineAudioFile.md b/teams/teams-ps/MicrosoftTeams/Import-CsOnlineAudioFile.md similarity index 89% rename from teams/teams-ps/teams/Import-CsOnlineAudioFile.md rename to teams/teams-ps/MicrosoftTeams/Import-CsOnlineAudioFile.md index 08de362834..8b4932a602 100644 --- a/teams/teams-ps/teams/Import-CsOnlineAudioFile.md +++ b/teams/teams-ps/MicrosoftTeams/Import-CsOnlineAudioFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile applicable: Microsoft Teams -title: Import-CsOnlineAudioFile -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile +schema: 2.0.0 +title: Import-CsOnlineAudioFile --- # Import-CsOnlineAudioFile @@ -32,7 +33,7 @@ $content = [System.IO.File]::ReadAllBytes('C:\Media\Hello.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "Hello.wav" -Content $content ``` -This example creates a new audio file using the WAV content that has a filename of Hello.wav to be used with organizational auto attendants. The stored variable, $audioFile, will be used when running other cmdlets to update the audio file for Auto Attendant, for example [New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt). +This example creates a new audio file using the WAV content that has a filename of Hello.wav to be used with organizational auto attendants. The stored variable, $audioFile, will be used when running other cmdlets to update the audio file for Auto Attendant, for example [New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantprompt). ### Example 2 ```powershell @@ -40,7 +41,7 @@ $content = [System.IO.File]::ReadAllBytes('C:\Media\MOH.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "HuntGroup" -FileName "MOH.wav" -Content $content ``` -This example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as a Music On Hold file with a Call Queue. The stored variable, $audioFile, will be used with [Set-CsCallQueue](https://learn.microsoft.com/powershell/module/teams/set-cscallqueue) to provide the audio file id. +This example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as a Music On Hold file with a Call Queue. The stored variable, $audioFile, will be used with [Set-CsCallQueue](https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallqueue) to provide the audio file id. ### Example 3 ```powershell @@ -48,11 +49,14 @@ $content = [System.IO.File]::ReadAllBytes('C:\Media\MOH.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId TenantGlobal -FileName "MOH.wav" -Content $content ``` -This example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as Music On Hold for Microsoft Teams. The stored variable, $audioFile, will be used with [New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) to provide the audio file id. +This example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as Music On Hold for Microsoft Teams. The stored variable, $audioFile, will be used with [New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy) to provide the audio file id. ## PARAMETERS ### -ApplicationId + +> Applicable: Microsoft Teams + The ApplicationId parameter is the identifier for the application which will use this audio file. For example, if the audio file will be used with an Auto Attendant, then it needs to be set to "OrgAutoAttendant". If the audio file will be used with a Call Queue, then it needs to be set to "HuntGroup". If the audio file will be used with Microsoft Teams, then it needs to be set to "TenantGlobal". Supported values: @@ -65,7 +69,6 @@ Supported values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -74,14 +77,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileName -The FileName parameter is the name of the audio file. For example, the file name for the file C:\Media\Welcome.wav is Welcome.wav. +### -Content + +> Applicable: Microsoft Teams + +The Content parameter represents the content of the audio file. Supported formats are WAV (uncompressed, linear PCM with 8/16/32-bit depth in mono or stereo), WMA (mono only), and MP3. The audio file content cannot be more 5MB. ```yaml -Type: String +Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -90,14 +95,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Content -The Content parameter represents the content of the audio file. Supported formats are WAV (uncompressed, linear PCM with 8/16/32-bit depth in mono or stereo), WMA (mono only), and MP3. The audio file content cannot be more 5MB. +### -FileName + +> Applicable: Microsoft Teams + +The FileName parameter is the name of the audio file. For example, the file name for the file C:\Media\Welcome.wav is Welcome.wav. ```yaml -Type: Byte[] +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -126,8 +133,8 @@ Auto Attendant and Call Queue before 48 hours after it was imported. You are responsible for independently clearing and securing all necessary rights and permissions to use any music or audio file with your Microsoft Teams service, which may include intellectual property and other rights in any music, sound effects, audio, brands, names, and other content in the audio file from all relevant rights holders, which may include artists, actors, performers, musicians, songwriters, composers, record labels, music publishers, unions, guilds, rights societies, collective management organizations and any other parties who own, control or license the music copyrights, sound effects, audio and other intellectual property rights. ## RELATED LINKS -[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile) +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/export-csonlineaudiofile) -[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineaudiofile) -[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineaudiofile) diff --git a/teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md b/teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md new file mode 100644 index 0000000000..5906e52c75 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md @@ -0,0 +1,1716 @@ +--- +Locale: en-US +Module Guid: d910df43-3ca6-4c9c-a2e3-e9f45a8e2ad9 +Module Name: MicrosoftTeams +title: MicrosoftTeams PowerShell module +Download Help Link: +Help Version: +--- + +# MicrosoftTeams PowerShell module + +## Description +The following cmdlet references are for Microsoft Teams. + +## MicrosoftTeams Cmdlets + +### [Add-TeamChannelUser](Add-TeamChannelUser.md) +Adds an owner or member to the private channel. + +### [Add-TeamsAppInstallation](Add-TeamsAppInstallation.md) +Add a Teams App to Microsoft Teams. + +### [Add-TeamUser](Add-TeamUser.md) +The `Add-TeamUser` adds an owner or member to the team, and to the unified group which backs the team. + +### [Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) +Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telephone number search order and release the telephone numbers. The telephone numbers can then be available for search and acquire. + +### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md) +Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. + +### [Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) +Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. + +### [Connect-MicrosoftTeams](Connect-MicrosoftTeams.md) +The Connect-MicrosoftTeams cmdlet connects an authenticated account for use with cmdlets from the MicrosoftTeams module. + +### [Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) +This cmdlet prevents provisioning of users in Skype for Business Online for the specified domain. + +### [Disconnect-MicrosoftTeams](Disconnect-MicrosoftTeams.md) +{{Placeholder}} + +### [Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) +This cmdlet enables provisioning of users in Skype for Business Online for the specified domain. + +### [Export-CsAcquiredPhoneNumber](Export-CsAcquiredPhoneNumber.md) +This cmdlet exports the list of phone numbers acquired by Teams Phone tenant. + +### [Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) +Use Export-CsAutoAttendantHolidays cmdlet to export holiday schedules of an existing Auto Attendant (AA). + +### [Export-CsOnlineAudioFile](Export-CsOnlineAudioFile.md) +Use the Export-CsOnlineAudioFile cmdlet to download an existing audio file. + +### [Find-CsGroup](Find-CsGroup.md) +Use the Find-CsGroup cmdlet to search groups. + +### [Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria. + +### [Get-AllM365TeamsApps](Get-AllM365TeamsApps.md) +This cmdlet returns all Microsoft Teams apps in the app catalog, including Microsoft, custom, and non-Microsoft apps. + +### [Get-AssociatedTeam](Get-AssociatedTeam.md) +This cmdlet supports retrieving all teams associated with a user, including teams which host shared channels. + +### [Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) +Retrieves information about the application access policy configured for use in the tenant. + +### [Get-CsApplicationMeetingConfiguration](Get-CsApplicationMeetingConfiguration.md) +Retrieves information about the application meeting configuration settings configured for the tenant. + +### [Get-CsAutoAttendant](Get-CsAutoAttendant.md) +Use the Get-CsAutoAttendant cmdlet to get information about your Auto Attendants (AA). + +### [Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) +Use Get-CsAutoAttendantHolidays cmdlet to get the holiday information for an existing Auto Attendant (AA). + +### [Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) +Use Get-CsAutoAttendantStatus cmdlet to get the status of an Auto Attendant (AA) provisioning. + +### [Get-CsAutoAttendantSupportedLanguage](Get-CsAutoAttendantSupportedLanguage.md) +The Get-CsAutoAttendantSupportedLanguage cmdlet gets languages that are supported by the Auto Attendant (AA) service. + +### [Get-CsAutoAttendantSupportedTimeZone](Get-CsAutoAttendantSupportedTimeZone.md) +The Get-CsAutoAttendantSupportedTimeZone cmdlet gets supported time zones for the Auto Attendant (AA) service. + +### [Get-CsAutoAttendantTenantInformation](Get-CsAutoAttendantTenantInformation.md) +Gets the default tenant information for Auto Attendant (AA) feature. + +### [Get-CsBatchPolicyAssignmentOperation](Get-CsBatchPolicyAssignmentOperation.md) +This cmdlet is used to retrieve the status of batch policy assignment operations. + +### [Get-CsBatchTeamsDeploymentStatus](Get-CsBatchTeamsDeploymentStatus.md) +This cmdlet is used to get the status of the batch deployment orchestration. + +### [Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) +Use the `Get-CsCallingLineIdentity` cmdlet to display the Caller ID policies for your organization. + +### [Get-CsCallQueue](Get-CsCallQueue.md) +The Get-CsCallQueue cmdlet returns the identified Call Queues. + +### [Get-CsCloudCallDataConnection](Get-CsCloudCallDataConnection.md) +This cmdlet retrieves an already existing online call data connection. + +### [Get-CsComplianceRecordingForCallQueueTemplate](Get-CsComplianceRecordingForCallQueueTemplate.md) +```powershell Get-CsComplianceRecordingForCallQueueTemplate [-Id ] [] ``` + +### [Get-CsEffectiveTenantDialPlan](Get-CsEffectiveTenantDialPlan.md) +Use the Get-CsEffectiveTenantDialPlan cmdlet to retrieve an effective tenant dial plan. + +### [Get-CsExportAcquiredPhoneNumberStatus](Get-CsExportAcquiredPhoneNumberStatus.md) +This cmdlet shows the status of the [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/export-csacquiredphonenumber) cmdlet. + +### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) +Returns information about the external access policies that have been configured for use in your organization. + +### [Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) +This cmdlet is used to return group policy assignments. + +### [Get-CsHybridTelephoneNumber](Get-CsHybridTelephoneNumber.md) +This cmdlet displays information about one or more hybrid telephone numbers. + +### [Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) +Returns a list of all blocked number patterns added to the tenant list. + +### [Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) +Returns a specific or the full list of all number patterns exempt from call blocking. + +### [Get-CsMeetingMigrationStatus](Get-CsMeetingMigrationStatus.md) +You use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of meeting migrations. + +### [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) +Get application instance for the tenant from Microsoft Entra ID. + +### [Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) +Use the Get-CsOnlineApplicationInstanceAssociation cmdlet to get information about the associations setup in your organization. + +### [Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) +Use the Get-CsOnlineApplicationInstanceAssociationStatus cmdlet to get the provisioning status for the associations you have setup in your organization. + +### [Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet retrieves all online audio conferencing routing policies for the tenant. + +### [Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) +Returns information about a specific or all uploaded audio files of a given application type. + +### [Get-CsOnlineDialInConferencingBridge](Get-CsOnlineDialInConferencingBridge.md) +Use the Get-CsOnlineDialInConferencingBridge cmdlet to view the settings on an audio conferencing bridge that is used when Microsoft is the audio conferencing provider. + +### [Get-CsOnlineDialInConferencingLanguagesSupported](Get-CsOnlineDialInConferencingLanguagesSupported.md) +Use the Get-CsOnlineDialInConferencingLanguagesSupported cmdlet to view the list of languages that are supported when an organization uses Microsoft as the dial-in audio conferencing provider. + +### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) +Retrieves the available Dial-in Conferencing policies in the tenant. + +### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) +Use the Get-CsOnlineDialInConferencingServiceNumber cmdlet to return all of the default dial-in service numbers that are assigned to an Office 365 audio conferencing bridge. + +### [Get-CsOnlineDialinConferencingTenantConfiguration](Get-CsOnlineDialinConferencingTenantConfiguration.md) +Use the Get-CsOnlineDialinConferencingTenantConfiguration cmdlet to retrieve the tenant level configuration for dial-in conferencing. + +### [Get-CsOnlineDialInConferencingTenantSettings](Get-CsOnlineDialInConferencingTenantSettings.md) +Use the Get-CsOnlineDialInConferencingTenantSettings cmdlet to retrieve tenant level settings for dial-in conferencing. + +### [Get-CsOnlineDialInConferencingUser](Get-CsOnlineDialInConferencingUser.md) +Use the `Get-CsOnlineDialInConferencingUser` cmdlet to view the properties and settings of users that are enabled for dial-in conferencing and are using Microsoft as their PSTN conferencing provider. + +### [Get-CsOnlineDialOutPolicy](Get-CsOnlineDialOutPolicy.md) +Use the `Get-CsOnlineDialOutPolicy` cmdlet to get all the available outbound calling restriction policies in your organization. + +### [Get-CsOnlineDirectoryTenant](Get-CsOnlineDirectoryTenant.md) +Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve a tenant and associated parameters from the Business Voice Directory. + +### [Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +Use the Get-CsOnlineEnhancedEmergencyServiceDisclaimer cmdlet to determine whether your organization has accepted the terms and conditions of enhanced emergency service. + +### [Get-CsOnlineLisCivicAddress](Get-CsOnlineLisCivicAddress.md) +Use the Get-CsOnlineLisCivicAddress cmdlet to retrieve information about existing emergency civic addresses defined in the Location Information Service (LIS). + +### [Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) +Use the Get-CsOnlineLisLocation cmdlet to retrieve information on previously defined locations in the Location Information Service (LIS.) + +### [Get-CsOnlineLisPort](Get-CsOnlineLisPort.md) +Retrieves one or more ports from the location configuration database. + +### [Get-CsOnlineLisSubnet](Get-CsOnlineLisSubnet.md) +Retrieves one or more subnets from the location configuration database. + +### [Get-CsOnlineLisSwitch](Get-CsOnlineLisSwitch.md) +Retrieves one or more network switches from the location configuration database. + +### [Get-CsOnlineLisWirelessAccessPoint](Get-CsOnlineLisWirelessAccessPoint.md) +Retrieves one or more wireless access points (WAPs) from the location configuration database. + +### [Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) +Shows the configuration of the previously defined Session Border Controller(s) (SBC(s)) that describes the settings for the peer entity. This cmdlet was introduced with Microsoft Phone System Direct Routing. + +### [Get-CsOnlinePstnUsage](Get-CsOnlinePstnUsage.md) +Returns information about online public switched telephone network (PSTN) usage records used in your tenant. + +### [Get-CsOnlineSchedule](Get-CsOnlineSchedule.md) +Use the Get-CsOnlineSchedule cmdlet to get information about schedules that belong to your organization. + +### [Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) +This cmdlet lists online sip domains and their enabled/disabled status. In a disabled domain, provisioning of users is blocked. Once a domain is re-enabled, provisioning of users in that domain will happen. + +### [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) +Use the `Get-CsOnlineTelephoneNumber` to retrieve telephone numbers from the Business Voice Directory. + +### [Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) +Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. + +### [Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) +Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number order. + +### [Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) +Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. + +### [Get-CsOnlineUser](Get-CsOnlineUser.md) +Returns information about users who have accounts homed on Microsoft Teams or Skype for Business Online. + +### [Get-CsOnlineVoicemailPolicy](Get-CsOnlineVoicemailPolicy.md) +Use the `Get-CsOnlineVoicemailPolicy` cmdlet to get a list of all pre-configured policy instances related to Cloud Voicemail service. + +### [Get-CsOnlineVoicemailUserSettings](Get-CsOnlineVoicemailUserSettings.md) +Use the Get-CsOnlineVoicemailUserSettings cmdlet to get information about online voicemail user settings of a specific user. + +### [Get-CsOnlineVoiceRoute](Get-CsOnlineVoiceRoute.md) +Returns information about the online voice routes configured for use in your tenant. + +### [Get-CsOnlineVoiceRoutingPolicy](Get-CsOnlineVoiceRoutingPolicy.md) +Returns information about the online voice routing policies configured for use in your tenant. + +### [Get-CsOnlineVoiceUser](Get-CsOnlineVoiceUser.md) +Use the `Get-CsOnlineVoiceUser` cmdlet to retrieve a voice user's telephone number and location. + +### [Get-CsPhoneNumberAssignment](Get-CsPhoneNumberAssignment.md) +This cmdlet displays information about one or more phone numbers. + +### [Get-CsPhoneNumberTag](Get-CsPhoneNumberTag.md) +This cmdlet allows the admin to get a list of existing tags for telephone numbers. + +### [Get-CsPolicyPackage](Get-CsPolicyPackage.md) +This cmdlet supports retrieving all the policy packages available on a tenant. + +### [Get-CsSdgBulkSignInRequestsSummary](Get-CsSdgBulkSignInRequestsSummary.md) +Get the tenant level summary of all bulk sign in requests executed in the past 30 days. + +### [Get-CsSdgBulkSignInRequestStatus](Get-CsSdgBulkSignInRequestStatus.md) +Get the status of an active bulk sign in request. + +### [Get-CsSharedCallQueueHistoryTemplate](Get-CsSharedCallQueueHistoryTemplate.md) +```powershell Get-CsSharedCallQueueHistoryTemplate -Id [] ``` + +### [Get-CsTeamsAcsFederationConfiguration](Get-CsTeamsAcsFederationConfiguration.md) +This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. + +### [Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md) +This cmdlet retrieves all Teams AI policies for the tenant. + +### [Get-CsTeamsAppPermissionPolicy](Get-CsTeamsAppPermissionPolicy.md) +As an admin, you can use app permission policies to allow or block apps for your users. + +### [Get-CsTeamsAppSetupPolicy](Get-CsTeamsAppSetupPolicy.md) +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. + +### [Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) +Audio conferencing policies can be used to manage audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. + +### [Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) +Returns information about the policies configured to customize the call hold experience for Teams clients. + +### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) +Returns information about the teams calling policies configured for use in your organization. Teams calling policies help determine which users are able to use calling functionality within Microsoft Teams. + +### [Get-CsTeamsCallParkPolicy](Get-CsTeamsCallParkPolicy.md) +The Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. + +### [Get-CsTeamsChannelsPolicy](Get-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [Get-CsTeamsClientConfiguration](Get-CsTeamsClientConfiguration.md) +This cmdlet allows IT admins to retrieve the effective configuration for their organization. + +### [Get-CsTeamsComplianceRecordingApplication](Get-CsTeamsComplianceRecordingApplication.md) +Returns information about the application instances of policy-based recording applications that have been configured for administering automatic policy-based recording in your tenant. + +### [Get-CsTeamsComplianceRecordingPolicy](Get-CsTeamsComplianceRecordingPolicy.md) +Returns information about the policies configured for governing automatic policy-based recording in your tenant. Automatic policy-based recording is only applicable to Microsoft Teams users. + +### [Get-CsTeamsCortanaPolicy](Get-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +### [Get-CsTeamsEducationAssignmentsAppPolicy](Get-CsTeamsEducationAssignmentsAppPolicy.md) +This cmdlet allows you to retrieve the current values of your Education Assignments App Policy. + +### [Get-CsTeamsEducationConfiguration](Get-CsTeamsEducationConfiguration.md) +This cmdlet is used to retrieve the organization-wide education configuration for Teams. + +### [Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet returns one or more Emergency Call Routing policies. + +### [Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) +Returns information about the teams enhanced encryption policies configured for use in your organization. + +### [Get-CsTeamsEventsPolicy](Get-CsTeamsEventsPolicy.md) +Returns information about the Teams Events policy. Note that this policy is currently still in preview. + +### [Get-CsTeamsExternalAccessConfiguration](Get-CsTeamsExternalAccessConfiguration.md) +This cmdlet returns the current settings of your organization. + +### [Get-CsTeamsFeedbackPolicy](Get-CsTeamsFeedbackPolicy.md) +Use this cmdlet to retrieve the current Teams Feedback policies (the ability to send feedback about Teams to Microsoft and whether they receive the survey) in the organization. + +### [Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) +Get a list of all pre-configured policy instances related to teams files. + +### [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) +This cmdlet fetches the first-party meeting templates stored on the tenant. + +### [Get-CsTeamsGuestCallingConfiguration](Get-CsTeamsGuestCallingConfiguration.md) +Returns information about the GuestCallingConfiguration, which specifies what options guest users have for calling within Teams. + +### [Get-CsTeamsGuestMeetingConfiguration](Get-CsTeamsGuestMeetingConfiguration.md) +Designates what meeting features guests using Microsoft Teams will have available. + +### [Get-CsTeamsGuestMessagingConfiguration](Get-CsTeamsGuestMessagingConfiguration.md) +TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. This cmdlet returns your organization's current settings. + +### [Get-CsTeamsIPPhonePolicy](Get-CsTeamsIPPhonePolicy.md) +Get-CsTeamsIPPhonePolicy allows IT Admins to view policies for IP Phone experiences in Microsoft Teams. + +### [Get-CsTeamsMediaConnectivityPolicy](Get-CsTeamsMediaConnectivityPolicy.md) +This cmdlet retrieves all Teams media connectivity policies for the current tenant. + +### [Get-CsTeamsMediaLoggingPolicy](Get-CsTeamsMediaLoggingPolicy.md) +Returns information about the Teams Media Logging policy. + +### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [Get-CsTeamsMeetingBroadcastConfiguration](Get-CsTeamsMeetingBroadcastConfiguration.md) +Gets Tenant level configuration for broadcast events in Teams. + +### [Get-CsTeamsMeetingBroadcastPolicy](Get-CsTeamsMeetingBroadcastPolicy.md) +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. + +### [Get-CsTeamsMeetingConfiguration](Get-CsTeamsMeetingConfiguration.md) +The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants. + +### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) +The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +### [Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) +This cmdlet fetches the custom meeting templates stored on the tenant. + +### [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) +Fetches the TeamsMeetingTemplatePermissionPolicy. This policy can be used to hide meeting templates from users and groups. + +### [Get-CsTeamsMessagingConfiguration](Get-CsTeamsMessagingConfiguration.md) +TeamsMessagingConfiguration determines the messaging settings for users. This cmdlet returns your organization's current settings. + +### [Get-CsTeamsMessagingPolicy](Get-CsTeamsMessagingPolicy.md) +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. + +### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Get-CsTeamsMultiTenantOrganizationConfiguration](Get-CsTeamsMultiTenantOrganizationConfiguration.md) +This cmdlet retrieves all tenant settings for Multi-tenant Organizations + +### [Get-CsTeamsNetworkRoamingPolicy](Get-CsTeamsNetworkRoamingPolicy.md) +Get-CsTeamsNetworkRoamingPolicy allows IT Admins to view policies for the Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [Get-CsTeamsNotificationAndFeedsPolicy](Get-CsTeamsNotificationAndFeedsPolicy.md) +Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. + +### [Get-CsTeamsRecordingRollOutPolicy](Get-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Get-CsTeamsRoomVideoTeleConferencingPolicy](Get-CsTeamsRoomVideoTeleConferencingPolicy.md) +Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. + +### [Get-CsTeamsSettingsCustomApp](Get-CsTeamsSettingsCustomApp.md) +Get the Custom Apps Setting's value of Teams Admin Center. + +### [Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) +Use the Get-CsTeamsSharedCallingRoutingPolicy cmdlet to get Teams shared calling routing policy information. Teams shared calling routing policy is used to configure shared calling. + +### [Get-CsTeamsShiftsAppPolicy](Get-CsTeamsShiftsAppPolicy.md) +Returns information about the Teams Shifts App policies that have been configured for use in your organization. + +### [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) +This cmdlet returns the list of existing workforce management (WFM) connections. It can also return the configuration details for a given WFM connection. + +### [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) +This cmdlet supports retrieving the available Shifts Connectors. + +### [Get-CsTeamsShiftsConnectionErrorReport](Get-CsTeamsShiftsConnectionErrorReport.md) +This cmdlet returns the list of all the team mapping error reports. It can also return the configuration details of one mapping error report with its ID provided or other filter parameters. + +### [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +This cmdlet returns the list of existing connection instances. It can also return the configuration details for a given connection instance. + +### [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md) +This cmdlet gets the requested batch mapping operation. + +### [Get-CsTeamsShiftsConnectionSyncResult](Get-CsTeamsShiftsConnectionSyncResult.md) +This cmdlet supports retrieving the list of user details in the mapped teams of last sync. + +### [Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) +This cmdlet supports retrieving the list of team mappings. + +### [Get-CsTeamsShiftsConnectionWfmTeam](Get-CsTeamsShiftsConnectionWfmTeam.md) +This cmdlet supports retrieving the list of available Workforce management (WFM) teams in the connection instance. + +### [Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) +This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. + +### [Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) +This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. + +### [Get-CsTeamsSipDevicesConfiguration](Get-CsTeamsSipDevicesConfiguration.md) +This cmdlet is used to retrieve the organization-wide Teams SIP devices configuration. + +### [Get-CsTeamsSurvivableBranchAppliance](Get-CsTeamsSurvivableBranchAppliance.md) +Gets the Survivable Branch Appliance (SBA) configured in the tenant. + +### [Get-CsTeamsSurvivableBranchAppliancePolicy](Get-CsTeamsSurvivableBranchAppliancePolicy.md) +Get the Survivable Branch Appliance (SBA) Policy defined in the tenant. + +### [Get-CsTeamsTargetingPolicy](Get-CsTeamsTargetingPolicy.md) +The Get-CsTeamsTargetingPolicy cmdlet enables you to return information about all the Tenant tag setting policies that have been configured for use in your organization. + +### [Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) +Fetches the TeamsTemplatePermissionPolicy. This policy can be used to hide Teams templates from users and groups. + +### [Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) +Cmdlet to get an existing number manipulation rule (or list of rules). + +### [Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) +Displays a specific or all treatments for how calls to an unassigned number range should be routed. + +### [Get-CsTeamsUpdateManagementPolicy](Get-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to retrieve the current Teams Update Management policies in the organization. + +### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) +Returns information related to managing the upgrade to Teams from Skype for Business. + +### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) +This cmdlet returns the set of instances of this policy. + +### [Get-CsTeamsVdiPolicy](Get-CsTeamsVdiPolicy.md) +The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. + +### [Get-CsTeamsVideoInteropServicePolicy](Get-CsTeamsVideoInteropServicePolicy.md) +The Get-CsTeamsVideoInteropServicePolicy cmdlet allows you to identify the pre-constructed policies that you can use in your organization. + +### [Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to fetch policy instances of TeamsVirtualAppointmentsPolicy. + +### [Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) +Use the Get-CsTeamsVoiceApplicationsPolicy cmdlet to get Teams voice applications policy information. + +### [Get-CsTeamsWorkLoadPolicy](Get-CsTeamsWorkLoadPolicy.md) +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +### [Get-CsTeamsWorkLocationDetectionPolicy](Get-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to fetch policy instances of TeamsWorkLocationDetectionPolicy. + +### [Get-CsTeamTemplate](Get-CsTeamTemplate.md) +This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + +### [Get-CsTeamTemplateList](Get-CsTeamTemplateList.md) +Get a list of available team templates + +### [Get-CsTenant](Get-CsTenant.md) +Returns information about the Microsoft Teams or Skype for Business Online tenants that have been configured for use in your organization. + +### [Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) +Use the Get-CsTenantBlockedCallingNumbers cmdlet to retrieve tenant blocked calling numbers setting. + +### [Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) +Use the Get-CsTenantDialPlan cmdlet to retrieve a tenant dial plan. + +### [Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) +Returns information about the federation configuration settings for your Skype for Business Online tenants. + +### [Get-CsTenantLicensingConfiguration](Get-CsTenantLicensingConfiguration.md) +Indicates whether licensing information for the specified tenant is available in the Teams admin center. + +### [Get-CsTenantMigrationConfiguration](Get-CsTenantMigrationConfiguration.md) +Use the Get-CsTenantMigrationConfiguration cmdlet to check if Meeting Migration Service (MMS) is enabled in your organization. + +### [Get-CsTenantNetworkConfiguration](Get-CsTenantNetworkConfiguration.md) +Returns information about the network regions, sites and subnets in the tenant network configuration. + +### [Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) +Returns information about the network region setting in the tenant. + +### [Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) +Returns information about the network site setting in the tenant. + +### [Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) +Returns information about the network subnet setting in the tenant. + +### [Get-CsTenantTrustedIPAddress](Get-CsTenantTrustedIPAddress.md) +Returns information about the external trusted IPs in the tenant. + +### [Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) +This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. + +### [Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md) +This cmdlet is used to return the policy assignments for a user, both directly assigned and inherited from a group. + +### [Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) +This cmdlet supports retrieving the policy package that's assigned to a user. + +### [Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) +This cmdlet supports retrieving recommendations for which policy packages are best suited for a given user. + +### [Get-CsVideoInteropServiceProvider](Get-CsVideoInteropServiceProvider.md) +Get information about the Cloud Video Interop for Teams. + +### [Get-M365TeamsApp](Get-M365TeamsApp.md) +This cmdlet returns app availability and state for the Microsoft Teams app. + +### [Get-M365UnifiedCustomPendingApps](Get-M365UnifiedCustomPendingApps.md) +This cmdlet returns all custom Microsoft Teams apps that are pending review from an IT Admin. + +### [Get-M365UnifiedTenantSettings](Get-M365UnifiedTenantSettings.md) +This cmdlet returns the current tenant settings for a particular tenant + +### [Get-SharedWithTeam](Get-SharedWithTeam.md) +This cmdlet supports retrieving teams with which a specified channel is shared. + +### [Get-SharedWithTeamUser](Get-SharedWithTeamUser.md) +This cmdlet supports retrieving users of a shared with team. + +### [Get-Team](Get-Team.md) +Get Team information based on particular properties. + +### [Get-TeamAllChannel](Get-TeamAllChannel.md) +This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. + +### [Get-TeamChannel](Get-TeamChannel.md) +This cmdlet supports retrieving channels hosted by a team. + +### [Get-TeamChannelUser](Get-TeamChannelUser.md) +Returns users of a channel. + +### [Get-TeamIncomingChannel](Get-TeamIncomingChannel.md) +This cmdlet supports retrieving incoming channels of a team. + +### [Get-TeamsApp](Get-TeamsApp.md) +Returns app information from the Teams tenant app store. + +### [Get-TeamTargetingHierarchyStatus](Get-TeamTargetingHierarchyStatus.md) +Get the status of a hierarchy upload. + +### [Get-TeamUser](Get-TeamUser.md) +Returns users of a team. + +### [Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) +Assigns a per-user application access policy to one or more users. + +### [Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) +Use the `Grant-CsCallingLineIdentity` cmdlet to apply a Caller ID policy to a user account, to a group of users, or to set the tenant Global instance. + +### [Grant-CsDialoutPolicy](Grant-CsDialoutPolicy.md) +Use the `Grant-CsDialoutPolicy` cmdlet to assign the tenant global, a group of users, or a per-user outbound calling restriction policy to one or more users. + +### [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) +Enables you to assign an external access policy to a user or a group of users. + +### [Grant-CsGroupPolicyPackageAssignment](Grant-CsGroupPolicyPackageAssignment.md) +This cmdlet assigns a policy package to a group in a tenant. + +### [Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant. + +### [Grant-CsOnlineVoicemailPolicy](Grant-CsOnlineVoicemailPolicy.md) +Assigns an online voicemail policy to a user account, to a group of users, or set the tenant Global instance. Online voicemail policies manage usages for Voicemail service. + +### [Grant-CsOnlineVoiceRoutingPolicy](Grant-CsOnlineVoiceRoutingPolicy.md) +Assigns a per-user online voice routing policy to one user, a group of users, or sets the Global policy instance. Online voice routing policies manage online PSTN usages for Phone System users. + +### [Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md) +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +### [Grant-CsTeamsAppPermissionPolicy](Grant-CsTeamsAppPermissionPolicy.md) +As an admin, you can use app permission policies to allow or block apps for your users. + +### [Grant-CsTeamsAppSetupPolicy](Grant-CsTeamsAppSetupPolicy.md) +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. + +### [Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) +Assigns a Teams audio-conferencing policy at the per-user scope. + +### [Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) +Assigns a per-user Teams call hold policy to one or more users. + +### [Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) +Assigns a specific Teams Calling Policy to a user, a group of users, or sets the Global policy instance. + +### [Grant-CsTeamsCallParkPolicy](Grant-CsTeamsCallParkPolicy.md) +The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. + +### [Grant-CsTeamsChannelsPolicy](Grant-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [Grant-CsTeamsComplianceRecordingPolicy](Grant-CsTeamsComplianceRecordingPolicy.md) +The Grant-CsTeamsChannelsPolicy allows you to assign specific policies to users that have been created in your tenant. + +### [Grant-CsTeamsCortanaPolicy](Grant-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) +This cmdlet assigns a Teams Emergency Calling policy. + +### [Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet assigns a Teams Emergency Call Routing policy. + +### [Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) +Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + +### [Grant-CsTeamsEventsPolicy](Grant-CsTeamsEventsPolicy.md) +Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. + +### [Grant-CsTeamsFeedbackPolicy](Grant-CsTeamsFeedbackPolicy.md) +Use this cmdlet to grant a specific Teams Feedback policy to a user (the ability to send feedback about Teams to Microsoft and whether they receive the survey). + +### [Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +### [Grant-CsTeamsIPPhonePolicy](Grant-CsTeamsIPPhonePolicy.md) +Use the Grant-CsTeamsIPPhonePolicy cmdlet to assign a set of Teams phone policies to a user account or group of user accounts. + +### [Grant-CsTeamsMediaConnectivityPolicy](Grant-CsTeamsMediaConnectivityPolicy.md) +This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant. + +### [Grant-CsTeamsMediaLoggingPolicy](Grant-CsTeamsMediaLoggingPolicy.md) +Assigns Teams Media Logging policy to a user or entire tenant. + +### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +Assigns a teams meeting branding policy at the per-user scope. + +### [Grant-CsTeamsMeetingBroadcastPolicy](Grant-CsTeamsMeetingBroadcastPolicy.md) +Use this cmdlet to assign a policy to a user. + +### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) +Assigns a teams meeting policy at the per-user scope. + +### [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) +This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to users or groups in a tenant. + +### [Grant-CsTeamsMessagingPolicy](Grant-CsTeamsMessagingPolicy.md) +Assigns a teams messaging policy at the per-user scope. Teams messaging policies determine the features and capabilities that can be used in messaging within the teams client. + +### [Grant-CsTeamsMobilityPolicy](Grant-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Grant-CsTeamsRecordingRollOutPolicy](Grant-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Grant-CsTeamsRoomVideoTeleConferencingPolicy](Grant-CsTeamsRoomVideoTeleConferencingPolicy.md) +Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. + +### [Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) +Assigns a specific Teams shared calling routing policy to a user, a group of users, or sets the Global policy instance. + +### [Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) +This cmdlet supports applying the TeamsShiftsPolicy to users in a tenant. + +### [Grant-CsTeamsSurvivableBranchAppliancePolicy](Grant-CsTeamsSurvivableBranchAppliancePolicy.md) +Grants a Survivable Branch Appliance (SBA) Policy to users in the tenant. + +### [Grant-CsTeamsUpdateManagementPolicy](Grant-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to grant a specific Teams Update Management policy to a user. + +### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. + +### [Grant-CsTeamsVdiPolicy](Grant-CsTeamsVdiPolicy.md) +Assigns a teams Vdi policy at the per-user scope. + +### [Grant-CsTeamsVideoInteropServicePolicy](Grant-CsTeamsVideoInteropServicePolicy.md) +The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. + +### [Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet applies an instance of the TeamsVirtualAppointmentsPolicy to users or groups in a tenant. + +### [Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) +Assigns a per-user Teams voice applications policy to one or more users. + +### [Grant-CsTeamsWorkLoadPolicy](Grant-CsTeamsWorkLoadPolicy.md) +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +### [Grant-CsTeamsWorkLocationDetectionPolicy](Grant-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant. + +### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) +Use the Grant-CsTenantDialPlan cmdlet to assign an existing tenant dial plan to a user, to a group of users, or to set the Global policy instance. + +### [Grant-CsUserPolicyPackage](Grant-CsUserPolicyPackage.md) +This cmdlet supports applying a policy package to users in a tenant. + +### [Import-CsAutoAttendantHolidays](Import-CsAutoAttendantHolidays.md) +Use Import-CsAutoAttendantHolidays cmdlet to import holiday schedules of an existing Auto Attendant (AA). + +### [Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) +Use the Import-CsOnlineAudioFile cmdlet to upload a new audio file. + +### [New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) +Creates a new application access policy. Application access policy contains a list of application (client) IDs. + +### [New-CsAutoAttendant](New-CsAutoAttendant.md) +Use the New-CsAutoAttendant cmdlet to create a new Auto Attendant (AA). + +### [New-CsAutoAttendantCallableEntity](New-CsAutoAttendantCallableEntity.md) +The New-CsAutoAttendantCallableEntity cmdlet lets you create a callable entity. + +### [New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) +Use the New-CsAutoAttendantCallFlow cmdlet to create a new call flow. + +### [New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md) +Use the `New-CsAutoAttendantCallHandlingAssociation` cmdlet to create a new call handling association. + +### [New-CsAutoAttendantDialScope](New-CsAutoAttendantDialScope.md) +Use New-CsAutoAttendantDialScope cmdlet to create dial-scopes for use with Auto Attendant (AA) service. + +### [New-CsAutoAttendantMenu](New-CsAutoAttendantMenu.md) +The New-CsAutoAttendantMenu cmdlet creates a new menu. + +### [New-CsAutoAttendantMenuOption](New-CsAutoAttendantMenuOption.md) +Use the New-CsAutoAttendantMenuOption cmdlet to create a new menu option. + +### [New-CsAutoAttendantPrompt](New-CsAutoAttendantPrompt.md) +Use the New-CsAutoAttendantPrompt cmdlet to create a new prompt. + +### [New-CsBatchPolicyAssignmentOperation](New-CsBatchPolicyAssignmentOperation.md) +This cmdlet is used to assign or unassign a policy to a batch of users. + +### [New-CsBatchPolicyPackageAssignmentOperation](New-CsBatchPolicyPackageAssignmentOperation.md) +This cmdlet submits an operation that applies a policy package to a batch of users in a tenant. + +### [New-CsBatchTeamsDeployment](New-CsBatchTeamsDeployment.md) +This cmdlet is used to run a batch deployment orchestration. + +### [New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) +Use the New-CsCallingLineIdentity cmdlet to create a new Caller ID policy for your organization. + +### [New-CsCallQueue](New-CsCallQueue.md) +Creates new Call Queue in your Skype for Business Online organization. + +### [New-CsCloudCallDataConnection](New-CsCloudCallDataConnection.md) +This cmdlet creates an online call data connection. + +### [New-CsComplianceRecordingForCallQueueTemplate](New-CsComplianceRecordingForCallQueueTemplate.md) +Use the New-CsComplianceRecordingForCallQueueTemplate cmdlet to create a Compliance Recording for Call Queues template. + +### [New-CsCustomPolicyPackage](New-CsCustomPolicyPackage.md) +This cmdlet creates a custom policy package. + +### [New-CsEdgeAllowAllKnownDomains](New-CsEdgeAllowAllKnownDomains.md) +Enables Skype for Business Online federation with all domains except for those domains included on the blocked domains list. + +### [New-CsEdgeAllowList](New-CsEdgeAllowList.md) +Enables administrators to specify the domains that their users will be allowed to communicate with. + +### [New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) +Used to specify a domain that will be added or removed from the set of domains enabled for federation or the set of domains disabled for federation. + +### [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) +Enables you to create a new external access policy. + +### [New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md) +This cmdlet is used to assign a policy to a security group or distribution list. + +### [New-CsHybridTelephoneNumber](New-CsHybridTelephoneNumber.md) +This cmdlet adds a hybrid telephone number to the tenant. + +### [New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) +Adds a blocked number pattern to the tenant list. + +### [New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) +This cmdlet lets you configure a new number pattern that is exempt from tenant call blocking. + +### [New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) +Creates an application instance in Microsoft Entra ID. + +### [New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) +Use the New-CsOnlineApplicationInstanceAssociation cmdlet to associate either a single or multiple application instances with an application configuration, like auto attendant or call queue. + +### [New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet creates a Online Audio Conferencing Routing Policy. + +### [New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) +Use the New-CsOnlineDateTimeRange cmdlet to create a new date-time range. + +### [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md) +This cmdlet creates a request to upload Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. + +### [New-CsOnlineLisCivicAddress](New-CsOnlineLisCivicAddress.md) +Use the New-CsOnlineLisCivicAddress cmdlet to create a civic address in the Location Information Service (LIS). + +### [New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) +Use the New-CsOnlineLisLocation cmdlet to create a new emergency dispatch location within an existing civic address. + +### [New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) +Creates a new Session Border Controller (SBC) Configuration that describes the settings for the peer entity. + +### [New-CsOnlineSchedule](New-CsOnlineSchedule.md) +Use the New-CsOnlineSchedule cmdlet to create a new schedule. + +### [New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) +Use the `New-CsOnlineTelephoneNumberOrder` cmdlet to create a telephone number search order. + +### [New-CsOnlineTelephoneNumberReleaseOrder](New-CsOnlineTelephoneNumberReleaseOrder.md) +This cmdlet creates a request to release telephone numbers from Microsoft Teams telephone number management inventory. + +### [New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) +The New-CsOnlineTimeRange cmdlet creates a new time range. + +### [New-CsOnlineVoicemailPolicy](New-CsOnlineVoicemailPolicy.md) +Creates a new Online Voicemail policy. + +### [New-CsOnlineVoiceRoute](New-CsOnlineVoiceRoute.md) +Creates a new online voice route. + +### [New-CsOnlineVoiceRoutingPolicy](New-CsOnlineVoiceRoutingPolicy.md) +Creates a new online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. + +### [New-CsSdgBulkSignInRequest](New-CsSdgBulkSignInRequest.md) +Use the New-CsSdgBulkSignInRequest cmdlet to sign in a batch of up to 100 devices. + +### [New-CsSharedCallQueueHistoryTemplate](New-CsSharedCallQueueHistoryTemplate.md) +Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue History template. + +### [New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md) +This cmdlet creates a Teams AI policy. + +### [New-CsTeamsAppPermissionPolicy](New-CsTeamsAppPermissionPolicy.md) +As an admin, you can use app permission policies to allow or block apps for your users. + +### [New-CsTeamsAppSetupPolicy](New-CsTeamsAppSetupPolicy.md) +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. + +### [New-CsTeamsAudioConferencingPolicy](New-CsTeamsAudioConferencingPolicy.md) +{{Placeholder}} + +### [New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) +Creates a new Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +### [New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) +Use this cmdlet to create a new instance of a Teams Calling Policy. + +### [New-CsTeamsCallParkPolicy](New-CsTeamsCallParkPolicy.md) +The New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. + +### [New-CsTeamsChannelsPolicy](New-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [New-CsTeamsComplianceRecordingApplication](New-CsTeamsComplianceRecordingApplication.md) +Creates a new association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. + +### [New-CsTeamsComplianceRecordingPairedApplication](New-CsTeamsComplianceRecordingPairedApplication.md) +Creates a new association between multiple application instances of policy-based recording applications to achieve application resiliency in automatic policy-based recording scenarios. + +### [New-CsTeamsComplianceRecordingPolicy](New-CsTeamsComplianceRecordingPolicy.md) +Creates a new Teams recording policy for governing automatic policy-based recording in your tenant. + +### [New-CsTeamsCortanaPolicy](New-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +### [New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) +{{Placeholder}} + +### [New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet creates a new Teams Emergency Call Routing policy with one or more emergency number. + +### [New-CsTeamsEmergencyNumber](New-CsTeamsEmergencyNumber.md) +{{Placeholder}} + +### [New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) +Use this cmdlet to create a new Teams enhanced encryption policy. + +### [New-CsTeamsEventsPolicy](New-CsTeamsEventsPolicy.md) +This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. + +### [New-CsTeamsFeedbackPolicy](New-CsTeamsFeedbackPolicy.md) +Use this cmdlet to control whether users in your organization can send feedback about Teams to Microsoft through Give feedback and whether they receive the survey. + +### [New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) +Creates a new teams files policy. + +### [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md) +This cmdlet is used to create a `HiddenMeetingTemplate` object. + +### [New-CsTeamsHiddenTemplate](New-CsTeamsHiddenTemplate.md) +This cmdlet is used to create a `HiddenTemplate` object. + +### [New-CsTeamsIPPhonePolicy](New-CsTeamsIPPhonePolicy.md) +New-CsTeamsIPPhonePolicy allows you to create a policy to manage features related to Teams phone experiences. + +### [New-CsTeamsMediaConnectivityPolicy](New-CsTeamsMediaConnectivityPolicy.md) +This cmdlet creates a Teams media connectivity policy. + +### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [New-CsTeamsMeetingBroadcastPolicy](New-CsTeamsMeetingBroadcastPolicy.md) +Use this cmdlet to create a new policy. + +### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) +The New-CsTeamsMeetingPolicy cmdlet allows administrators to define new meeting policies that can be assigned to particular users to control Teams features related to meetings. + +### [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) +Creates a new instance of the TeamsMeetingTemplatePermissionPolicy. + +### [New-CsTeamsMessagingPolicy](New-CsTeamsMessagingPolicy.md) +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. + +### [New-CsTeamsMobilityPolicy](New-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [New-CsTeamsNetworkRoamingPolicy](New-CsTeamsNetworkRoamingPolicy.md) +New-CsTeamsNetworkRoamingPolicy allows IT Admins to create policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [New-CsTeamsRecordingRollOutPolicy](New-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [New-CsTeamsRoomVideoTeleConferencingPolicy](New-CsTeamsRoomVideoTeleConferencingPolicy.md) +Creates a new TeamsRoomVideoTeleConferencingPolicy. + +### [New-CsTeamsSharedCallingRoutingPolicy](New-CsTeamsSharedCallingRoutingPolicy.md) +Use the New-CsTeamsSharedCallingRoutingPolicy cmdlet to configure a shared calling routing policy. + +### [New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) +This cmdlet creates a new workforce management (WFM) connection. + +### [New-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.md) +This cmdlet submits an operation connecting multiple Microsoft Teams teams and Workforce management (WFM) teams. + +### [New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) +This cmdlet creates a Shifts connection instance. + +### [New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) +This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. + +### [New-CsTeamsSurvivableBranchAppliance](New-CsTeamsSurvivableBranchAppliance.md) +Creates a new Survivable Branch Appliance (SBA) object in the tenant. + +### [New-CsTeamsSurvivableBranchAppliancePolicy](New-CsTeamsSurvivableBranchAppliancePolicy.md) +Creates a new Survivable Branch Appliance (SBA) policy object in the tenant. + +### [New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) +Creates a new instance of the TeamsTemplatePermissionPolicy. + +### [New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) +Cmdlet to create a new telephone number manipulation rule. + +### [New-CsTeamsUnassignedNumberTreatment](New-CsTeamsUnassignedNumberTreatment.md) +Creates a new treatment for how calls to an unassigned number range should be routed. + +### [New-CsTeamsUpdateManagementPolicy](New-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to create Teams Update Management policy. + +### [New-CsTeamsVdiPolicy](New-CsTeamsVdiPolicy.md) +The New-CsTeamsVdiPolicy cmdlet allows administrators to define new Vdi policies that can be assigned to particular users to control Teams features related to meetings on a VDI environment. + +### [New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to create a new instance of the TeamsVirtualAppointmentsPolicy. + +### [New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) +Creates a new Teams voice applications policy. + +### [New-CsTeamsWorkLoadPolicy](New-CsTeamsWorkLoadPolicy.md) +This cmdlet creates a Teams Workload Policy instance for the tenant. + +### [New-CsTeamsWorkLocationDetectionPolicy](New-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to create a new instance of the TeamsWorkLocationDetectionPolicy. + +### [New-CsTeamTemplate](New-CsTeamTemplate.md) +This cmdlet lets you provision a new team template for use in Microsoft Teams. + +### [New-CsTenantDialPlan](New-CsTenantDialPlan.md) +Use the `New-CsTenantDialPlan` cmdlet to create a new tenant dial plan. + +### [New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) +Creates a new network region. + +### [New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) +Creates a new network site. + +### [New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) +Creates a new network subnet. + +### [New-CsTenantTrustedIPAddress](New-CsTenantTrustedIPAddress.md) +Creates a new IP address. + +### [New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) +This cmdlet will add a new delegate for calling in Microsoft Teams. + +### [New-CsVideoInteropServiceProvider](New-CsVideoInteropServiceProvider.md) +Use the New-CsVideoInteropServiceProvider to specify information about a supported CVI partner your organization would like to use. + +### [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) +Creates a new voice normalization rule. + +### [New-Team](New-Team.md) +This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. + +### [New-TeamChannel](New-TeamChannel.md) +Add a new channel to a team. + +### [New-TeamsApp](New-TeamsApp.md) +Creates a new app in the Teams tenant app store. + +### [Register-CsOnlineDialInConferencingServiceNumber](Register-CsOnlineDialInConferencingServiceNumber.md) +The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. + +### [Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) +Deletes an existing application access policy. + +### [Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) +Use the Remove-CsAutoAttendant cmdlet to delete an Auto Attendant (AA). + +### [Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) +Use the `Remove-CsCallingLineIdentity` cmdlet to remove a Caller ID policy from your organization. + +### [Remove-CsCallQueue](Remove-CsCallQueue.md) +The Remove-CsCallQueue cmdlet deletes an existing Call Queue. + +### [Remove-CsComplianceRecordingForCallQueueTemplate](Remove-CsComplianceRecordingForCallQueueTemplate.md) +Use the Remove-CsComplianceRecordingForCallQueueTemplate cmdlet to delete a Compliance Recording for Call Queues template. + +### [Remove-CsCustomPolicyPackage](Remove-CsCustomPolicyPackage.md) +This cmdlet deletes a custom policy package. + +### [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) +Enables you to remove an existing external access policy. + +### [Remove-CsGroupPolicyAssignment](Remove-CsGroupPolicyAssignment.md) +This cmdlet is used to remove a group policy assignment. + +### [Remove-CsHybridTelephoneNumber](Remove-CsHybridTelephoneNumber.md) +This cmdlet removes a hybrid telephone number. + +### [Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) +Removes a blocked number pattern from the tenant list. + +### [Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) +Removes a number pattern exempt from call blocking. + +### [Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) +Use the Remove-CsOnlineApplicationInstanceAssociation cmdlet to remove the association between an application instance and the associated application configuration. + +### [Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet deletes an instance of the Online Audio Conferencing Routing Policy. + +### [Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) +Marks an audio file of application type TenantGlobal for deletion and later removal (within 24 hours). + +### [Remove-CsOnlineDialInConferencingTenantSettings](Remove-CsOnlineDialInConferencingTenantSettings.md) +Use the `Remove-CsOnlineDialInConferencingTenantSettings` cmdlet to revert the tenant level dial-in conferencing settings to their original defaults. + +### [Remove-CsOnlineLisCivicAddress](Remove-CsOnlineLisCivicAddress.md) +Use the Remove-CsOnlineLisCivicAddress cmdlet to delete an existing civic address from the Location Information Server (LIS). + +### [Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) +Use the Remove-CsOnlineLisLocation cmdlet to remove an existing emergency location from the Location Information Service (LIS). + +### [Remove-CsOnlineLisPort](Remove-CsOnlineLisPort.md) +Removes an association between a Location port and a location. This association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + +### [Remove-CsOnlineLisSubnet](Remove-CsOnlineLisSubnet.md) +Removes a Location Information Server (LIS) subnet. + +### [Remove-CsOnlineLisSwitch](Remove-CsOnlineLisSwitch.md) +Removes a Location Information Server (LIS) network switch. + +### [Remove-CsOnlineLisWirelessAccessPoint](Remove-CsOnlineLisWirelessAccessPoint.md) +Removes a Location Information Server (LIS) wireless access point (WAP). + +### [Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) +Removes the configuration of the previously defined Session Border Controller(s) (SBC(s)) that describes the settings for the peer entity. + +### [Remove-CsOnlineSchedule](Remove-CsOnlineSchedule.md) +Use the Remove-CsOnlineSchedule cmdlet to remove a schedule. + +### [Remove-CsOnlineTelephoneNumber](Remove-CsOnlineTelephoneNumber.md) +Use the `Remove-CsOnlineTelephoneNumber` cmdlet to remove one or more unassigned telephone numbers from your tenant. + +### [Remove-CsOnlineVoicemailPolicy](Remove-CsOnlineVoicemailPolicy.md) +Deletes an existing Online Voicemail policy or resets the Global policy instance to the default values. + +### [Remove-CsOnlineVoiceRoute](Remove-CsOnlineVoiceRoute.md) +Removes an online voice route. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). + +### [Remove-CsOnlineVoiceRoutingPolicy](Remove-CsOnlineVoiceRoutingPolicy.md) +Deletes an existing online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. + +### [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) +This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). + +### [Remove-CsPhoneNumberTag](Remove-CsPhoneNumberTag.md) +This cmdlet allows admin to remove a tag from phone number. + +### [Remove-CsSharedCallQueueHistoryTemplate](Remove-CsSharedCallQueueHistoryTemplate.md) +```powershell Remove-CsSharedCallQueueHistoryTemplate -Id [] ``` + +### [Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md) +This cmdlet deletes a Teams AI policy. + +### [Remove-CsTeamsAppPermissionPolicy](Remove-CsTeamsAppPermissionPolicy.md) +This cmdlet allows you to remove app permission policies that have been created within your organization. + +### [Remove-CsTeamsAppSetupPolicy](Remove-CsTeamsAppSetupPolicy.md) +You can use this cmdlet to remove custom app setup policies. + +### [Remove-CsTeamsAudioConferencingPolicy](Remove-CsTeamsAudioConferencingPolicy.md) +Deletes a custom Teams audio conferencing policy. Audio conferencing policies are used to manage audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. + +### [Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) +Deletes an existing Teams call hold policy in your tenant. + +### [Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) +{{Placeholder}} + +### [Remove-CsTeamsCallParkPolicy](Remove-CsTeamsCallParkPolicy.md) +The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. + +### [Remove-CsTeamsChannelsPolicy](Remove-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [Remove-CsTeamsComplianceRecordingApplication](Remove-CsTeamsComplianceRecordingApplication.md) +Deletes an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. + +### [Remove-CsTeamsComplianceRecordingPolicy](Remove-CsTeamsComplianceRecordingPolicy.md) +Deletes an existing Teams recording policy that is used to govern automatic policy-based recording in your tenant. Automatic policy-based recording is only applicable to Microsoft Teams users. + +### [Remove-CsTeamsCortanaPolicy](Remove-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) +Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call. + +### [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet removes an existing Teams Emergency Call Routing policy instance. + +### [Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) +Use this cmdlet to remove an existing Teams enhanced encryption policy. + +### [Remove-CsTeamsEventsPolicy](Remove-CsTeamsEventsPolicy.md) +The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. + +### [Remove-CsTeamsFeedbackPolicy](Remove-CsTeamsFeedbackPolicy.md) +Use this cmdlet to remove a Teams Feedback policy from the Tenant. + +### [Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) +Deletes an existing teams files policy or resets the Global policy instance to the default values. + +### [Remove-CsTeamsIPPhonePolicy](Remove-CsTeamsIPPhonePolicy.md) +Use the Remove-CsTeamsIPPhonePolicy cmdlet to remove a custom policy that's been created for controlling Teams phone experiences. + +### [Remove-CsTeamsMediaConnectivityPolicy](Remove-CsTeamsMediaConnectivityPolicy.md) +This cmdlet deletes a Teams media connectivity policy. + +### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [Remove-CsTeamsMeetingBroadcastPolicy](Remove-CsTeamsMeetingBroadcastPolicy.md) +Deletes an existing Teams meeting broadcast policy in your tenant. + +### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) +The `CsTeamsMeetingPolicy` cmdlets removes a previously created TeamsMeetingPolicy. + +### [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) +Deletes an instance of TeamsMeetingTemplatePermissionPolicy. + +### [Remove-CsTeamsMessagingPolicy](Remove-CsTeamsMessagingPolicy.md) +Deletes a custom messaging policy. + +### [Remove-CsTeamsMobilityPolicy](Remove-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Remove-CsTeamsNetworkRoamingPolicy](Remove-CsTeamsNetworkRoamingPolicy.md) +Remove-CsTeamsNetworkRoamingPolicy allows IT Admins to delete policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [Remove-CsTeamsNotificationAndFeedsPolicy](Remove-CsTeamsNotificationAndFeedsPolicy.md) +Deletes an existing Teams Notification and Feeds Policy + +### [Remove-CsTeamsRecordingRollOutPolicy](Remove-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Remove-CsTeamsRoomVideoTeleConferencingPolicy](Remove-CsTeamsRoomVideoTeleConferencingPolicy.md) +Deletes an existing TeamsRoomVideoTeleConferencingPolicy. + +### [Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) +Deletes an existing Teams shared calling routing policy instance. + +### [Remove-CsTeamsShiftsConnection](Remove-CsTeamsShiftsConnection.md) +This cmdlet deletes a Shifts connection. + +### [Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) +This cmdlet deletes a Shifts connection instance. + +### [Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) +This cmdlet removes the mapping between the Microsoft Teams team and workforce management (WFM) team. + +### [Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) +The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. + +### [Remove-CsTeamsShiftsScheduleRecord](Remove-CsTeamsShiftsScheduleRecord.md) +This cmdlet enqueues the clear schedule message. + +### [Remove-CsTeamsSurvivableBranchAppliance](Remove-CsTeamsSurvivableBranchAppliance.md) +Removes a Survivable Branch Appliance (SBA) from the tenant. + +### [Remove-CsTeamsSurvivableBranchAppliancePolicy](Remove-CsTeamsSurvivableBranchAppliancePolicy.md) +Removes a Survivable Branch Appliance (SBA) policy from the tenant. + +### [Remove-CsTeamsTargetingPolicy](Remove-CsTeamsTargetingPolicy.md) +The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. + +### [Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) +Deletes an instance of TeamsTemplatePermissionPolicy. + +### [Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) +Cmdlet to remove an existing number manipulation rule (or list of rules). + +### [Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) +Removes a treatment for how calls to an unassigned number range should be routed. + +### [Remove-CsTeamsUpdateManagementPolicy](Remove-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to remove a Teams Update Management policy from the tenant. + +### [Remove-CsTeamsVdiPolicy](Remove-CsTeamsVdiPolicy.md) +This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. + +### [Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to delete an instance of TeamsVirtualAppointmentsPolicy. + +### [Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) +Deletes an existing Teams voice applications policy. + +### [Remove-CsTeamsWorkLoadPolicy](Remove-CsTeamsWorkLoadPolicy.md) +This cmdlet deletes a Teams Workload Policy instance. + +### [Remove-CsTeamsWorkLocationDetectionPolicy](Remove-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to delete an instance of TeamsWorkLocationDetectionPolicy. + +### [Remove-CsTeamTemplate](Remove-CsTeamTemplate.md) +This cmdlet deletes a specified Team Template from Microsoft Teams. + +### [Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) +Use the `Remove-CsTenantDialPlan` cmdlet to remove a tenant dial plan. + +### [Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) +Use the `Remove-CsTenantNetworkRegion` cmdlet to remove a tenant network region. + +### [Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) +Use the `Remove-CsTenantNetworkSite` cmdlet to remove a tenant network site. + +### [Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) +Use the `Remove-CsTenantNetworkSubnet` cmdlet to remove a tenant network subnet. + +### [Remove-CsTenantTrustedIPAddress](Remove-CsTenantTrustedIPAddress.md) +Use the `Remove-CsTenantTrustedIPAddress` cmdlet to remove a tenant trusted IP address. + +### [Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) +This cmdlet will remove a delegate for calling in Microsoft Teams. + +### [Remove-CsUserLicenseGracePeriod](Remove-CsUserLicenseGracePeriod.md) +The `CsUserLicenseGracePeriod` cmdlet expedites the delicensing operation for the assigned plan(s) of a user or resource account. + +### [Remove-CsVideoInteropServiceProvider](Remove-CsVideoInteropServiceProvider.md) +Use the Remove-CsVideoInteropServiceProvider to remove all provider information about a provider that your organization no longer uses. + +### [Remove-SharedWithTeam](Remove-SharedWithTeam.md) +This cmdlet supports unsharing a channel with a team. + +### [Remove-Team](Remove-Team.md) +This cmdlet deletes a specified Team from Microsoft Teams. NOTE: The associated Office 365 Unified Group will also be removed. + +### [Remove-TeamChannel](Remove-TeamChannel.md) +Delete a Teams channel. + +### [Remove-TeamChannelUser](Remove-TeamChannelUser.md) +Removes a user from a channel in Microsoft Teams. + +### [Remove-TeamsApp](Remove-TeamsApp.md) +Removes an app in the Teams tenant app store. + +### [Remove-TeamTargetingHierarchy](Remove-TeamTargetingHierarchy.md) +Removes the tenant's hierarchy. + +### [Remove-TeamUser](Remove-TeamUser.md) +Remove an owner or member from a team, and from the unified group which backs the team. + +### [Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) +Modifies an existing application access policy. + +### [Set-CsApplicationMeetingConfiguration](Set-CsApplicationMeetingConfiguration.md) +Modifies an existing application meeting configuration for the tenant. + +### [Set-CsAutoAttendant](Set-CsAutoAttendant.md) +Use the Set-CsAutoAttendant cmdlet to modify the properties of an existing Auto Attendant (AA). + +### [Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) +Use the `Set-CsCallingLineIdentity` cmdlet to modify a Caller ID policy in your organization. + +### [Set-CsCallQueue](Set-CsCallQueue.md) +Updates a Call Queue in your Skype for Business Online or Teams organization. + +### [Set-CsComplianceRecordingForCallQueueTemplate](Set-CsComplianceRecordingForCallQueueTemplate.md) +```powershell Set-CsComplianceRecordingForCallQueueTemplate -Instance [] ``` + +### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) +Enables you to modify the properties of an existing external access policy. + +### [Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) +Modifies one or more parameters of a blocked number pattern in the tenant list. + +### [Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) +Modifies one or more parameters of an exempt number pattern in the tenant list. + +### [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) +Updates an application instance in Microsoft Entra ID. + +### [Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. + +### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) +Use the `Set-CsOnlineDialInConferencingBridge` cmdlet to modify the settings of a Microsoft audio conferencing bridge. + +### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) +Use the `Set-CsOnlineDialInConferencingServiceNumber` cmdlet to modify the properties of a dial-in or audio conferencing service number that is used by callers when they dial in to a meeting. + +### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md) +Use the `Set-CsOnlineDialInConferencingTenantSettings` to modify the tenant level settings of dial-in conferencing. + +### [Set-CsOnlineDialInConferencingUser](Set-CsOnlineDialInConferencingUser.md) +Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of a user that has been enabled for Microsoft's audio conferencing service. + +### [Set-CsOnlineEnhancedEmergencyServiceDisclaimer](Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +You can use Get-CsOnlineEnhancedEmergencyServiceDisclaimer to see the status of the emergency service disclaimer. + +### [Set-CsOnlineLisCivicAddress](Set-CsOnlineLisCivicAddress.md) +Use the cmdlet to modify an existing civic address which has not been validated. + +### [Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) +Use the cmdlet to modify an existing emergency dispatch location. + +### [Set-CsOnlineLisPort](Set-CsOnlineLisPort.md) +Creates a Location Information Server (LIS) port, creates an association between a port and a location, or modifies an existing port and its associated location. + +### [Set-CsOnlineLisSubnet](Set-CsOnlineLisSubnet.md) +Creates a Location Information Server (LIS) subnet, creates an association between a subnet and a location, or modifies an existing subnet and its associated location. + +### [Set-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) +Creates a Location Information Server (LIS) switch, creates an association between a switch and a location, or modifies an existing switch and its associated location. + +### [Set-CsOnlineLisWirelessAccessPoint](Set-CsOnlineLisWirelessAccessPoint.md) +Creates a Location Information Server (LIS) wireless access point (WAP), creates an association between a WAP and a location, or modifies an existing WAP and its associated location. + +### [Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) +Modifies the previously defined Session Border Controller (SBC) Configuration that describes the settings for the peer entity. + +### [Set-CsOnlinePstnUsage](Set-CsOnlinePstnUsage.md) +Modifies a set of strings that identify the allowed online public switched telephone network (PSTN) usages. + +### [Set-CsOnlineSchedule](Set-CsOnlineSchedule.md) +Use the Set-CsOnlineSchedule cmdlet to update a schedule. + +### [Set-CsOnlineVoiceApplicationInstance](Set-CsOnlineVoiceApplicationInstance.md) +The cmdlet modifies an application instance in Microsoft Entra ID. + +### [Set-CsOnlineVoicemailPolicy](Set-CsOnlineVoicemailPolicy.md) +Modifies an existing Online Voicemail policy. + +### [Set-CsOnlineVoicemailUserSettings](Set-CsOnlineVoicemailUserSettings.md) +Use the Set-CsOnlineVoicemailUserSettings cmdlet to modify the online voicemail user settings of a specific user. + +### [Set-CsOnlineVoiceRoute](Set-CsOnlineVoiceRoute.md) +Modifies an online voice route. + +### [Set-CsOnlineVoiceRoutingPolicy](Set-CsOnlineVoiceRoutingPolicy.md) +Modifies an existing online voice routing policy. + +### [Set-CsOnlineVoiceUser](Set-CsOnlineVoiceUser.md) +Use the `Set-CsOnlineVoiceUser` cmdlet to set the PSTN specific parameters (like telephone numbers and emergency response locations.) + +### [Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) +This cmdlet will assign a phone number to a user or a resource account (online application instance). + +### [Set-CsPhoneNumberTag](Set-CsPhoneNumberTag.md) +This cmdlet allows the admin to create and assign a tag to a phone number. + +### [Set-CsSharedCallQueueHistoryTemplate](Set-CsSharedCallQueueHistoryTemplate.md) +```powershell Set-CsSharedCallQueueHistoryTemplate -Instance [] ``` + +### [Set-CsTeamsAcsFederationConfiguration](Set-CsTeamsAcsFederationConfiguration.md) +This cmdlet is used to manage the federation configuration between Teams and Azure Communication Services. + +### [Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md) +This cmdlet sets Teams AI policy value for users in the tenant. + +### [Set-CsTeamsAppPermissionPolicy](Set-CsTeamsAppPermissionPolicy.md) +Cmdlet to set the app permission policy for Teams. + +### [Set-CsTeamsAppSetupPolicy](Set-CsTeamsAppSetupPolicy.md) +Cmdlet to set the app setup policy for Teams. + +### [Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) +Audio conferencing policies can be used to manage audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. + +### [Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) +Modifies an existing Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) +Use this cmdlet to update values in existing Teams Calling Policies. + +### [Set-CsTeamsCallParkPolicy](Set-CsTeamsCallParkPolicy.md) +The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. + +### [Set-CsTeamsChannelsPolicy](Set-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams and Channels experience within the Teams application. + +### [Set-CsTeamsClientConfiguration](Set-CsTeamsClientConfiguration.md) +Changes the Teams client configuration settings for the specified tenant. + +### [Set-CsTeamsComplianceRecordingApplication](Set-CsTeamsComplianceRecordingApplication.md) +Modifies an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. + +### [Set-CsTeamsComplianceRecordingPolicy](Set-CsTeamsComplianceRecordingPolicy.md) +Modifies an existing Teams recording policy for governing automatic policy-based recording in your tenant. + +### [Set-CsTeamsCortanaPolicy](Set-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +Enables administrators to update a configured custom text on the banner displayed when compliance recording bots start recording the call. + +### [Set-CsTeamsEducationAssignmentsAppPolicy](Set-CsTeamsEducationAssignmentsAppPolicy.md) +This policy is controlled by Global and Teams Service Administrators, and is used to turn on/off certain features only related to the Assignments Service, which runs for tenants with EDU licenses. + +### [Set-CsTeamsEducationConfiguration](Set-CsTeamsEducationConfiguration.md) +This cmdlet is used to manage the organization-wide education configuration for Teams. + +### [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet modifies an existing Teams Emergency Call Routing Policy. + +### [Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +Use this cmdlet to update values in existing Teams enhanced encryption policy. + +### [Set-CsTeamsEventsPolicy](Set-CsTeamsEventsPolicy.md) +This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. + +### [Set-CsTeamsExternalAccessConfiguration](Set-CsTeamsExternalAccessConfiguration.md) +{{Placeholder}} + +### [Set-CsTeamsFeedbackPolicy](Set-CsTeamsFeedbackPolicy.md) +Use this cmdlet to modify a Teams feedback policy (the ability to send feedback about Teams to Microsoft and whether they receive the survey). + +### [Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) +Creates a new teams files policy. + +### [Set-CsTeamsGuestCallingConfiguration](Set-CsTeamsGuestCallingConfiguration.md) +Allows admins to set values in the GuestCallingConfiguration, which specifies what options guest users have for calling within Teams. + +### [Set-CsTeamsGuestMeetingConfiguration](Set-CsTeamsGuestMeetingConfiguration.md) +Designates what meeting features guests using Microsoft Teams will have available. Use this cmdlet to set the configuration. + +### [Set-CsTeamsGuestMessagingConfiguration](Set-CsTeamsGuestMessagingConfiguration.md) +TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. + +### [Set-CsTeamsIPPhonePolicy](Set-CsTeamsIPPhonePolicy.md) +Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing Teams phone policy settings. + +### [Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.md) +This cmdlet Set Teams media connectivity policy value for current tenant. + +### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [Set-CsTeamsMeetingBroadcastConfiguration](Set-CsTeamsMeetingBroadcastConfiguration.md) +Changes the Teams meeting broadcast configuration settings for the specified tenant. + +### [Set-CsTeamsMeetingBroadcastPolicy](Set-CsTeamsMeetingBroadcastPolicy.md) +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. + +### [Set-CsTeamsMeetingConfiguration](Set-CsTeamsMeetingConfiguration.md) +The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants. + +### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) +The `CsTeamsMeetingPolicy` cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +### [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) +This cmdlet updates an existing TeamsMeetingTemplatePermissionPolicy. + +### [Set-CsTeamsMessagingConfiguration](Set-CsTeamsMessagingConfiguration.md) +The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. + +### [Set-CsTeamsMessagingPolicy](Set-CsTeamsMessagingPolicy.md) +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. + +### [Set-CsTeamsMobilityPolicy](Set-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Set-CsTeamsMultiTenantOrganizationConfiguration](Set-CsTeamsMultiTenantOrganizationConfiguration.md) +This cmdlet configures the Multi-tenant Organization settings for the tenant. + +### [Set-CsTeamsNetworkRoamingPolicy](Set-CsTeamsNetworkRoamingPolicy.md) +Set-CsTeamsNetworkRoamingPolicy allows IT Admins to create or update policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [Set-CsTeamsNotificationAndFeedsPolicy](Set-CsTeamsNotificationAndFeedsPolicy.md) +Modifies an existing Teams Notifications and Feeds Policy + +### [Set-CsTeamsRecordingRollOutPolicy](Set-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Set-CsTeamsRoomVideoTeleConferencingPolicy](Set-CsTeamsRoomVideoTeleConferencingPolicy.md) +Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. + +### [Set-CsTeamsSettingsCustomApp](Set-CsTeamsSettingsCustomApp.md) +Set the Custom Apps Setting's value of Teams Admin Center. + +### [Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) +Use the Set-CsTeamsSharedCallingRoutingPolicy cmdlet to change a shared calling routing policy instance. + +### [Set-CsTeamsShiftsAppPolicy](Set-CsTeamsShiftsAppPolicy.md) +Allows you to set or update properties of a Teams Shifts App Policy instance. + +### [Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) +This cmdlet sets an existing workforce management (WFM) connection. + +### [Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) +This cmdlet updates a Shifts connection instance. + +### [Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. + +### [Set-CsTeamsSipDevicesConfiguration](Set-CsTeamsSipDevicesConfiguration.md) +This cmdlet is used to manage the organization-wide Teams SIP devices configuration. + +### [Set-CsTeamsSurvivableBranchAppliance](Set-CsTeamsSurvivableBranchAppliance.md) +Changes the Survivable Branch Appliance (SBA) configuration settings for the specified tenant. + +### [Set-CsTeamsSurvivableBranchAppliancePolicy](Set-CsTeamsSurvivableBranchAppliancePolicy.md) +Changes the Survivable Branch Appliance (SBA) Policy configuration settings for the specified tenant. + +### [Set-CsTeamsTargetingPolicy](Set-CsTeamsTargetingPolicy.md) +The Set-CsTeamsTargetingPolicy cmdlet allows administrators to update existing Tenant tag settings that can be assigned to particular teams to control Team features related to tags. + +### [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) +This cmdlet updates an existing TeamsTemplatePermissionPolicy. + +### [Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) +Cmdlet to modify an existing normalization rule. + +### [Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) +Changes a treatment for how calls to an unassigned number range should be routed. + +### [Set-CsTeamsUpdateManagementPolicy](Set-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to modify a Teams Update Management policy. + +### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) +Manage certain aspects of client behavior for users being upgraded from Skype for Business to Teams. + +### [Set-CsTeamsVdiPolicy](Set-CsTeamsVdiPolicy.md) +The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. + +### [Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to update an instance of TeamsVirtualAppointmentsPolicy. + +### [Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) +Modifies an existing Teams voice applications policy. + +### [Set-CsTeamsWorkLoadPolicy](Set-CsTeamsWorkLoadPolicy.md) +This cmdlet sets the Teams Workload Policy value for current tenant. + +### [Set-CsTeamsWorkLocationDetectionPolicy](Set-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to update an instance of TeamsWorkLocationDetectionPolicy. + +### [Set-CsTenantBlockedCallingNumbers](Set-CsTenantBlockedCallingNumbers.md) +Use the Set-CsTenantBlockedCallingNumbers cmdlet to set tenant blocked calling numbers setting. + +### [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) +Use the `Set-CsTenantDialPlan` cmdlet to modify an existing tenant dial plan. + +### [Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) +Manages federation configuration settings for your Skype for Business Online tenants. + +### [Set-CsTenantMigrationConfiguration](Set-CsTenantMigrationConfiguration.md) +Used to enable or disable Meeting Migration Service (MMS). + +### [Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) +Changes the definintion of network regions. + +### [Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) +Changes the definition of network sites. + +### [Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) +Changes the definition of network subnets. + +### [Set-CsTenantTrustedIPAddress](Set-CsTenantTrustedIPAddress.md) +Changes the definition of network IP addresses. + +### [Set-CsUser](Set-CsUser.md) +Modifies Skype for Business properties for an existing user account. + +### [Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) +This cmdlet will change permissions for a delegate for calling in Microsoft Teams. + +### [Set-CsUserCallingSettings](Set-CsUserCallingSettings.md) +This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. + +### [Set-CsVideoInteropServiceProvider](Set-CsVideoInteropServiceProvider.md) +Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. + +### [Set-Team](Set-Team.md) +This cmdlet allows you to update properties of a team, including its displayname, description, and team-specific settings. + +### [Set-TeamArchivedState](Set-TeamArchivedState.md) +This cmdlet is used to freeze all of the team activity, but Teams Administrators and team owners will still be able to add or remove members and update roles. + +### [Set-TeamChannel](Set-TeamChannel.md) +Update Team channels settings. + +### [Set-TeamPicture](Set-TeamPicture.md) +Update the team picture. + +### [Set-TeamsApp](Set-TeamsApp.md) +Updates an app in the Teams tenant app store. + +### [Set-TeamsEnvironmentConfig](Set-TeamsEnvironmentConfig.md) +Sets environment-specific configurations on the local machine and is used to connect to the right environment when running Connect-MicrosoftTeams. + +### [Set-TeamTargetingHierarchy](Set-TeamTargetingHierarchy.md) +Upload a hierarchy to the tenant. + +### [Start-CsExMeetingMigration](Start-CsExMeetingMigration.md) +This cmdlet manually trigger a meeting migration request for the specified user. + +### [Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) +Sync the application instance from Microsoft Entra ID into Agent Provisioning Service. + +### [Test-CsEffectiveTenantDialPlan](Test-CsEffectiveTenantDialPlan.md) +Use the Test-CsEffectiveTenantDialPlan cmdlet to test a tenant dial plan. + +### [Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) +This cmdlet tests the given number against the created (by using New-CsInboundBlockedNumberPattern cmdlet) blocked numbers pattern. + +### [Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) +This cmdlet validates workforce management (WFM) connection settings. + +### [Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) +This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. + +### [Test-CsTeamsUnassignedNumberTreatment](Test-CsTeamsUnassignedNumberTreatment.md) +This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. + +### [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) +Tests a telephone number against a voice normalization rule and returns the number after the normalization rule has been applied. + +### [Unregister-CsOnlineDialInConferencingServiceNumber](Unregister-CsOnlineDialInConferencingServiceNumber.md) +Unassigns the previously assigned service number as default Conference Bridge number. + +### [Update-CsAutoAttendant](Update-CsAutoAttendant.md) +Use Update-CsAutoAttendant cmdlet to force an update of resources associated with an Auto Attendant (AA) provisioning. + +### [Update-CsCustomPolicyPackage](Update-CsCustomPolicyPackage.md) +**Note:** This cmdlet is currently in private preview. This cmdlet updates a custom policy package. + +### [Update-CsPhoneNumberTag](Update-CsPhoneNumberTag.md) +This cmdlet allows admin to update existing telephone number tags. + +### [Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) +This cmdlet updates an existing workforce management (WFM) connection. + +### [Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) +This cmdlet updates Shifts connection instance fields. + +### [Update-CsTeamTemplate](Update-CsTeamTemplate.md) +This cmdlet submits an operation that updates a custom team template with new team template settings. + +### [Update-M365TeamsApp](Update-M365TeamsApp.md) +This cmdlet updates app state and app available values for the Microsoft Teams app. + +### [Update-M365UnifiedCustomPendingApp](Update-M365UnifiedCustomPendingApp.md) +This cmdlet updates the review status for a custom Microsoft Teams app that is pending review from an IT Admin. + +### [Update-M365UnifiedTenantSettings](Update-M365UnifiedTenantSettings.md) +This cmdlet updates tenant settings. diff --git a/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsApplicationAccessPolicy.md similarity index 88% rename from teams/teams-ps/teams/New-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsApplicationAccessPolicy.md index 1f6d71a39b..8b6afd06f5 100644 --- a/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy applicable: Microsoft Teams -title: New-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni author: frankpeng7 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy +schema: 2.0.0 +title: New-CsApplicationAccessPolicy --- # New-CsApplicationAccessPolicy @@ -48,28 +49,28 @@ The command shown above shows how to create a new policy with a list of (three) ## PARAMETERS -### -Identity +### -AppIds -Unique identifier assigned to the policy when it was created. +A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). ```yaml -Type: XdsIdentity +Type: PSListModifier Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AppIds +### -Description -A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). +Specifies the description of the policy. ```yaml -Type: PSListModifier +Type: String Parameter Sets: (All) Aliases: @@ -80,17 +81,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Specifies the description of the policy. +Unique identifier assigned to the policy when it was created. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -108,7 +109,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) -[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) -[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) -[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy) +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/New-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendant.md similarity index 91% rename from teams/teams-ps/teams/New-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendant.md index 394233ef02..c066cb1110 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendant applicable: Microsoft Teams -title: New-CsAutoAttendant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendant +schema: 2.0.0 +title: New-CsAutoAttendant --- # New-CsAutoAttendant @@ -47,7 +49,7 @@ You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly creat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity $operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User @@ -84,7 +86,7 @@ This example creates a new AA named _Main auto attendant_ that has the following - The time zone is set to UTC. - An inclusion scope is specified. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity $operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User @@ -128,7 +130,7 @@ This example creates a new AA named _Main auto attendant_ that has the following - The default language is en-US. - The time zone is set to UTC. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell # Create Christmas Schedule $dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" @@ -213,9 +215,9 @@ This example creates two new AAs named _Main auto attendant_ and _Customer Suppo We can see when we ran the Get-CsOnlineSchedule cmdlet at the end, to get the _Christmas Holiday_ schedule information, that the configuration IDs for the newly created AAs have been added to the `AssociatedConfigurationIds` properties of that schedule. This means any updates made to this schedule would reflect in both associated AAs. -Removing an association between an AA and a schedule is as simple as deleting the CallHandlingAssociation of that schedule in the AA you want to modify. Please refer to [Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) cmdlet documentation for examples on how to do that. +Removing an association between an AA and a schedule is as simple as deleting the CallHandlingAssociation of that schedule in the AA you want to modify. Please refer to [Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant) cmdlet documentation for examples on how to do that. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell $aaName = "Main Auto Attendant" $language = "en-US" @@ -268,32 +270,36 @@ This example creates a new AA named _Main auto attendant_ that has the following ## PARAMETERS -### -Name -The Name parameter is a friendly name that is assigned to the AA. +### -AuthorizedUsers + +> Applicable: Microsoft Teams + +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml -Type: System.String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LanguageId -The LanguageId parameter is the language that is used to read text-to-speech (TTS) prompts. +### -CallFlows + +> Applicable: Microsoft Teams + +The CallFlows parameter represents call flows, which are required if they are referenced in the CallHandlingAssociations parameter. -You can query the supported languages using the [`Get-CsAutoAttendantSupportedLanguage`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage) cmdlet. +You can create CallFlows by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) cmdlet. ```yaml -Type: System.String +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -302,16 +308,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeZoneId -The TimeZoneId parameter represents the AA time zone. All schedules are evaluated based on this time zone. +### -CallHandlingAssociations -You can query the supported timezones using the [`Get-CsAutoAttendantSupportedTimeZone`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone) cmdlet. +> Applicable: Microsoft Teams + +The CallHandlingAssociations parameter represents the call handling associations. +The AA service uses call handling associations to determine which call flow to execute when a specific schedule is in effect. + +You can create CallHandlingAssociations by using the `New-CsAutoAttendantCallHandlingAssociation` cmdlet. ```yaml -Type: System.String +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -321,15 +330,17 @@ Accept wildcard characters: False ``` ### -DefaultCallFlow + +> Applicable: Microsoft Teams + The DefaultCallFlow parameter is the flow to be executed when no other call flow is in effect (for example, during business hours). -You can create the DefaultCallFlow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. +You can create the DefaultCallFlow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) cmdlet. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -338,53 +349,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallFlows -The CallFlows parameter represents call flows, which are required if they are referenced in the CallHandlingAssociations parameter. +### -EnableMainlineAttendant -You can create CallFlows by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +The EnableMainlineAttendant parameter enables Mainline Attendant features for this Auto attendant. + +> [!NOTE] +> 1. The Auto attendant must have a Resource account assigned +> 1. `-LanguageId` options are limited when Mainline Attendant is enabled +> 1. `-VoiceId` choices are limited when Mainline Attendate is enabled +> 1. `-EnableVoiceResponse` will be enabled automatically ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CallHandlingAssociations -The CallHandlingAssociations parameter represents the call handling associations. -The AA service uses call handling associations to determine which call flow to execute when a specific schedule is in effect. +### -EnableVoiceResponse -You can create CallHandlingAssociations by using the `New-CsAutoAttendantCallHandlingAssociation` cmdlet. +> Applicable: Microsoft Teams + +The EnableVoiceResponse parameter indicates whether voice response for AA is enabled. ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Operator -The Operator parameter represents the SIP address or PSTN number of the operator. +### -ExclusionScope -You can create callable entities by using the `New-CsAutoAttendantCallableEntity` cmdlet. +> Applicable: Microsoft Teams + +Specifies the users to which call transfers are not allowed through directory lookup feature. +If not specified, no user in the organization is excluded from directory lookup. + +Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantdialscope) cmdlet. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -393,21 +416,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceId -The VoiceId parameter represents the voice that is used to read text-to-speech (TTS) prompts. +### -HideAuthorizedUsers -You can query the supported voices by using the `Get-CsAutoAttendantSupportedLanguage` cmdlet. You can determine the default voice for a language by issuing the following command: +> Applicable: Microsoft Teams -``` -$language = Get-CsAutoAttendantSupportedLanguage -Identity "en-US" -$defaultVoice = $language.Voices[0].Id -``` +_Saving an auto attendant configuration through Teams admin center will *remove* this setting._ + +The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml -Type: System.String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -416,14 +436,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVoiceResponse -The EnableVoiceResponse parameter indicates whether voice response for AA is enabled. +### -InclusionScope + +> Applicable: Microsoft Teams + +Specifies the users to which call transfers are allowed through directory lookup feature. +If not specified, all users in the organization can be reached through directory lookup. + +Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantdialscope) cmdlet. ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -432,62 +457,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMainlineAttendant -_Voice applications private preview customers only._ +### -LanguageId -_Saving an auto attendant configuration through Teams admin center will remove this setting._ +> Applicable: Microsoft Teams -The EnableMainlineAttendant parameter enables Mainline Attendant features for this Auto attendant. +The LanguageId parameter is the language that is used to read text-to-speech (TTS) prompts. -> [!NOTE] -> 1. The Auto attendant must have a Resource account assigned -> 1. `-LanguageId` options are limited when Mainline Attendant is enabled - see [put link here]() -> 1. `-VoiceId` choices are limited when Mainline Attendate is enabled - see [put link here]() -> 1. `-EnableVoiceResponse` will be enabled automatically +You can query the supported languages using the [`Get-CsAutoAttendantSupportedLanguage`](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage) cmdlet. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InclusionScope -Specifies the users to which call transfers are allowed through directory lookup feature. -If not specified, all users in the organization can be reached through directory lookup. +### -Name -Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. +> Applicable: Microsoft Teams + +The Name parameter is a friendly name that is assigned to the AA. ```yaml -Type: Object +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExclusionScope -Specifies the users to which call transfers are not allowed through directory lookup feature. -If not specified, no user in the organization is excluded from directory lookup. +### -Operator -Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. +> Applicable: Microsoft Teams + +The Operator parameter represents the SIP address or PSTN number of the operator. + +You can create callable entities by using the `New-CsAutoAttendantCallableEntity` cmdlet. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -496,14 +515,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthorizedUsers -This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +### -Tenant + +> Applicable: Microsoft Teams ```yaml -Type: List +Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -512,18 +531,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HideAuthorizedUsers -_Saving an auto attendant configuration through Teams admin center will *remove* this setting._ +### -TimeZoneId -The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +> Applicable: Microsoft Teams + +The TimeZoneId parameter represents the AA time zone. All schedules are evaluated based on this time zone. + +You can query the supported timezones using the [`Get-CsAutoAttendantSupportedTimeZone`](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone) cmdlet. ```yaml -Type: List +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -531,6 +552,9 @@ Accept wildcard characters: False ``` ### -UserNameExtension + +> Applicable: Microsoft Teams + _Saving an auto attendant configuration through Teams admin center will *remove* this setting._ The UserNameExtension parameter is a string that specifies how to extend usernames in dial search by appending additional information after the name. @@ -544,7 +568,6 @@ This parameter is used in dial search when multiple search results are found, as Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: false Position: Named Default value: None @@ -552,13 +575,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -VoiceId + +> Applicable: Microsoft Teams + +The VoiceId parameter represents the voice that is used to read text-to-speech (TTS) prompts. + +You can query the supported voices by using the `Get-CsAutoAttendantSupportedLanguage` cmdlet. ```yaml -Type: System.Guid +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -582,26 +610,26 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation) -[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant) -[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus) -[Get-CsAutoAttendantSupportedLanguage](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage) +[Get-CsAutoAttendantSupportedLanguage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage) -[Get-CsAutoAttendantSupportedTimeZone](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone) +[Get-CsAutoAttendantSupportedTimeZone](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone) -[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity) +[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallableentity) -[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) -[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation) +[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation) -[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) -[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant) -[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant) -[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/update-csautoattendant) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallFlow.md similarity index 89% rename from teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallFlow.md index f7dd275002..7e23f4fdaf 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallFlow.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow applicable: Microsoft Teams -title: New-CsAutoAttendantCallFlow -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow +schema: 2.0.0 +title: New-CsAutoAttendantCallFlow --- # New-CsAutoAttendantCallFlow @@ -15,11 +17,6 @@ ms.reviewer: williamlooney ## SYNOPSIS Use the New-CsAutoAttendantCallFlow cmdlet to create a new call flow. -> [!CAUTION] -> The following configuration parameters will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. -> -> - -RingResourceAccountDelegates - ## SYNTAX ```powershell @@ -29,9 +26,14 @@ New-CsAutoAttendantCallFlow -Name -Menu [-Greetings ] [- ## DESCRIPTION The New-CsAutoAttendantCallFlow cmdlet creates a new call flow for use with the Auto Attendant (AA) service. The AA service uses the call flow to handle inbound calls by playing a greeting (if present), and provide callers with actions through a menu. +> [!CAUTION] +> The following configuration parameters will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. +> +> - -RingResourceAccountDelegates + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -EnableDialByName @@ -40,7 +42,7 @@ $callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu This example creates a new call flow that renders the "Default Menu" menu. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts $menuPrompt -EnableDialByName @@ -52,34 +54,18 @@ This example creates a new call flow that plays a greeting before rendering the ## PARAMETERS -### -Name -The Name parameter represents a unique friendly name for the call flow. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -ForceListenMenuEnabled -### -Menu -The Menu parameter identifies the menu to render when the call flow is executed. +> Applicable: Microsoft Teams -You can create a new menu by using the [`New-CsAutoAttendantMenu`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu) cmdlet. +If specified, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection. ```yaml -Type: System.Object +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -87,9 +73,12 @@ Accept wildcard characters: False ``` ### -Greetings + +> Applicable: Microsoft Teams + If present, the prompts specified by the Greetings parameter (either TTS or Audio) are played before the call flow's menu is rendered. -You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) cmdlet. +You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantprompt) cmdlet. > [!NOTE] > If Mainline Attendant is enabled, only TTS prompts are supported. @@ -102,7 +91,6 @@ You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn. Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -111,32 +99,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Menu + +> Applicable: Microsoft Teams + +The Menu parameter identifies the menu to render when the call flow is executed. + +You can create a new menu by using the [`New-CsAutoAttendantMenu`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenu) cmdlet. ```yaml -Type: System.Guid +Type: System.Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ForceListenMenuEnabled +### -Name -If specified, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection. +> Applicable: Microsoft Teams + +The Name parameter represents a unique friendly name for the call flow. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -145,6 +139,8 @@ Accept wildcard characters: False ### -RingResourceAccountDelegates +> Applicable: Microsoft Teams + _Voice applications private preview customers only._ _Saving an auto attendant configuration through Teams admin center will remove this setting._ @@ -157,7 +153,6 @@ If there are no delegates assigned to the resource account the call is on then t Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -166,6 +161,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Tenant + +> Applicable: Microsoft Teams + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -182,6 +193,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsAutoAttendantMenu](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu) +[New-CsAutoAttendantMenu](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenu) -[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) +[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantprompt) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation.md similarity index 87% rename from teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation.md index 0dd8a74ae2..bfb23abb50 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation applicable: Microsoft Teams -title: New-CsAutoAttendantCallHandlingAssociation -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation +schema: 2.0.0 +title: New-CsAutoAttendantCallHandlingAssociation --- # New-CsAutoAttendantCallHandlingAssociation @@ -26,7 +28,7 @@ The `New-CsAutoAttendantCallHandlingAssociation` cmdlet creates a new call handl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $tr = New-CsOnlineTimeRange -Start 09:00 -End 17:00 $schedule = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr) -TuesdayHours @($tr) -WednesdayHours @($tr) -ThursdayHours @($tr) -FridayHours @($tr) -Complement @@ -46,7 +48,7 @@ This example creates the following: - a new after-hours call flow - a new after-hours call handling association -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $tr = New-CsOnlineTimeRange -Start 09:00 -End 17:00 $schedule = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr) -TuesdayHours @($tr) -WednesdayHours @($tr) -ThursdayHours @($tr) -FridayHours @($tr) -Complement @@ -66,7 +68,7 @@ This example creates the following: - a new after-hours call flow - a disabled after-hours call handling association -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" $schedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) @@ -90,15 +92,17 @@ This example creates the following: ## PARAMETERS ### -CallFlowId + +> Applicable: Microsoft Teams + The CallFlowId parameter represents the call flow to be associated with the schedule. -You can create a call flow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. +You can create a call flow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -107,35 +111,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScheduleId -The ScheduleId parameter represents the schedule to be associated with the call flow. +### -Disable + +> Applicable: Microsoft Teams -You can create a schedule by using the [New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) cmdlet. additionally, you can use [Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule) cmdlet to get the schedules configured for your organization. +The Disable parameter, if set, establishes that the call handling association is created as disabled. This parameter can only be used when the Type parameter is set to AfterHours. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -The Type parameter represents the type of the call handling association. Currently, only the following types are supported: +### -ScheduleId -- `AfterHours` -- `Holiday` +> Applicable: Microsoft Teams + +The ScheduleId parameter represents the schedule to be associated with the call flow. + +You can create a schedule by using the [New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) cmdlet. additionally, you can use [Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineschedule) cmdlet to get the schedules configured for your organization. ```yaml -Type: Object +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -144,14 +149,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Disable -The Disable parameter, if set, establishes that the call handling association is created as disabled. This parameter can only be used when the Type parameter is set to AfterHours. +### -Tenant + +> Applicable: Microsoft Teams + +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -160,24 +175,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +### -Type -You can return your tenant ID by running this command: +> Applicable: Microsoft Teams -Get-CsTenant | Select-Object DisplayName, TenantID +The Type parameter represents the type of the call handling association. Currently, only the following types are supported: -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. +- `AfterHours` +- `Holiday` ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -199,8 +211,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) -[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) -[Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule) +[Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineschedule) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallableEntity.md similarity index 93% rename from teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallableEntity.md index b496fcaaad..2a38fa9e72 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallableEntity.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity applicable: Microsoft Teams -title: New-CsAutoAttendantCallableEntity -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallableentity +schema: 2.0.0 +title: New-CsAutoAttendantCallableEntity --- # New-CsAutoAttendantCallableEntity @@ -74,57 +76,65 @@ This example gets an Office 365 group by name using Find-CsGroup cmdlet. Then th ## PARAMETERS -### -Identity -The Identity parameter represents the ID of the callable entity; this can be either a Object ID or a TEL URI. +### -CallPriority -- Only the Object IDs of users that have Enterprise Voice enabled are supported. -- Only PSTN numbers that are acquired and assigned through Skype for Business Online are supported. +> Applicable: Microsoft Teams + +_Saving an auto attendant configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +The Call Priority of the MenuOption, only applies when the `Type` is `ApplicationEndpoint` or `ConfigurationEndpoint`. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 + +1 = Very High +2 = High +3 = Normal / Default +4 = Low +5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: System.String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: 3 Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -The Type parameter represents the type of the callable entity, which can be any of the following: +### -EnableSharedVoicemailSystemPromptSuppression -- User -- ApplicationEndpoint (when transferring to a Resource Account) -- ConfigurationEndpoint (when transferring directly to a nested Auto Attendant or Call Queue) -- ExternalPstn -- SharedVoicemail +> Applicable: Microsoft Teams -> [!IMPORTANT] -> Nesting Auto attendants and Call queues via ***ConfigurationEndpoint*** isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. If you nest an Auto attendant or Call queue without a resource account, authorized users can't edit the auto attendant or call queue. +Suppresses the "Please leave a message after the tone" system prompt when transferring to shared voicemail. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -EnableTranscription + +> Applicable: Microsoft Teams + +Enables the email transcription of voicemail, this is only supported with shared voicemail callable entities. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -133,30 +143,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTranscription -Enables the email transcription of voicemail, this is only supported with shared voicemail callable entities. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter represents the ID of the callable entity; this can be either a Object ID or a TEL URI. + +- Only the Object IDs of users that have Enterprise Voice enabled are supported. +- Only PSTN numbers that are acquired and assigned through Skype for Business Online are supported. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSharedVoicemailSystemPromptSuppression -Suppresses the "Please leave a message after the tone" system prompt when transferring to shared voicemail. +### -Tenant + +> Applicable: Microsoft Teams ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -165,31 +180,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallPriority -_Saving an auto attendant configuration through Teams admin center will reset the priority to 3 - Normal / Default._ +### -Type -The Call Priority of the MenuOption, only applies when the `Type` is `ApplicationEndpoint` or `ConfigurationEndpoint`. +> Applicable: Microsoft Teams -PARAMVALUE: 1 | 2 | 3 | 4 | 5 +The Type parameter represents the type of the callable entity, which can be any of the following: -1 = Very High -2 = High -3 = Normal / Default -4 = Low -5 = Very Low +- User +- ApplicationEndpoint (when transferring to a Resource Account) +- ConfigurationEndpoint (when transferring directly to a nested Auto Attendant or Call Queue) +- ExternalPstn +- SharedVoicemail > [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +> Nesting Auto attendants and Call queues via ***ConfigurationEndpoint*** isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. If you nest an Auto attendant or Call queue without a resource account, authorized users can't edit the auto attendant or call queue. ```yaml -Type: Int16 +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -209,6 +222,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineuser) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantDialScope.md similarity index 87% rename from teams/teams-ps/teams/New-CsAutoAttendantDialScope.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantDialScope.md index acea07c42e..8c2faba8f3 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantDialScope.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope applicable: Microsoft Teams -title: New-CsAutoAttendantDialScope -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantdialscope +schema: 2.0.0 +title: New-CsAutoAttendantDialScope --- # New-CsAutoAttendantDialScope @@ -28,7 +30,7 @@ This cmdlet creates a new dial-scope to be used with Auto Attendant (AA) service ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $groupIds = @("00000000-0000-0000-0000-000000000000") $dialScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $groupIds @@ -36,7 +38,7 @@ $dialScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $groupIds In Example 1, the New-CsAutoAttendantDialScope cmdlet is used to create a dial-scope with a group whose id is 00000000-0000-0000-0000-000000000000. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $groupIds = Find-CsGroup -SearchQuery "Contoso Sales" | % { $_.Id } $dialScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $groupIds @@ -46,14 +48,18 @@ In Example 2, we use the Find-CsGroup cmdlet to find groups with name "Contoso S ## PARAMETERS -### -GroupScope -Indicates that a dial-scope based on groups (distribution lists, security groups) is to be created. +### -GroupIds + +> Applicable: Microsoft Teams + +Refers to the IDs of the groups that are to be included in the dial-scope. + +Group IDs can be obtained by using the Find-CsGroup cmdlet. ```yaml -Type: SwitchParameter +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -62,16 +68,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GroupIds -Refers to the IDs of the groups that are to be included in the dial-scope. +### -GroupScope -Group IDs can be obtained by using the Find-CsGroup cmdlet. +> Applicable: Microsoft Teams + +Indicates that a dial-scope based on groups (distribution lists, security groups) is to be created. ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -82,11 +88,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -110,4 +117,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Find-CsGroup](https://learn.microsoft.com/powershell/module/teams/find-csgroup) +[Find-CsGroup](https://learn.microsoft.com/powershell/module/microsoftteams/find-csgroup) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenu.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenu.md similarity index 88% rename from teams/teams-ps/teams/New-CsAutoAttendantMenu.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenu.md index b6012b8fc6..27ca0ad7c7 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantMenu.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenu.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu applicable: Microsoft Teams -title: New-CsAutoAttendantMenu -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenu +schema: 2.0.0 +title: New-CsAutoAttendantMenu --- # New-CsAutoAttendantMenu @@ -26,7 +28,7 @@ The New-CsAutoAttendantMenu cmdlet creates a new menu for the Auto Attendant (AA ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -EnableDialByName -DirectorySearchMethod ByExtension @@ -34,7 +36,7 @@ $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -En This example creates a new menu that allows the caller to reach a target by name, and also defines the Directory Search Method to Dial By Extension. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $menuOptionZero = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign. For operator, press zero." @@ -45,14 +47,22 @@ This example creates a new menu that allows the caller to reach a target by name ## PARAMETERS -### -Name -The Name parameter represents a friendly name for the menu. +### -DirectorySearchMethod + +> Applicable: Microsoft Teams + +The DirectorySearchMethod parameter lets you define the type of Directory Search Method for the Auto Attendant menu, for more information, see [Set up a Cloud auto attendant](https://learn.microsoft.com/MicrosoftTeams/create-a-phone-system-auto-attendant?WT.mc_id=TeamsAdminCenterCSH) + +Possible values are + +- None +- ByName +- ByExtension ```yaml -Type: System.String +Type: Microsoft.Rtc.Management.Hosted.OAA.Models.DirectorySearchMethod Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -61,16 +71,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MenuOptions -The MenuOptions parameter is a list of menu options for this menu. These menu options specify what action to take when the user sends a particular input. +### -EnableDialByName -You can create menu options by using the New-CsAutoAttendantMenuOption cmdlet. +> Applicable: Microsoft Teams + +The EnableDialByName parameter lets users do a directory search by recipient name and get transferred to the party. ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -79,19 +89,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Prompts -The Prompts parameter reflects the prompts to play when the menu is activated. +### -MenuOptions -You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) cmdlet. +> Applicable: Microsoft Teams -> [!NOTE] -> If Mainline Attendant is enabled, only TTS prompts are supported. +The MenuOptions parameter is a list of menu options for this menu. These menu options specify what action to take when the user sends a particular input. + +You can create menu options by using the New-CsAutoAttendantMenuOption cmdlet. ```yaml -Type: Object +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -100,38 +109,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDialByName -The EnableDialByName parameter lets users do a directory search by recipient name and get transferred to the party. +### -Name + +> Applicable: Microsoft Teams + +The Name parameter represents a friendly name for the menu. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DirectorySearchMethod -The DirectorySearchMethod parameter lets you define the type of Directory Search Method for the Auto Attendant menu, for more information, see [Set up a Cloud auto attendant](https://learn.microsoft.com/MicrosoftTeams/create-a-phone-system-auto-attendant?WT.mc_id=TeamsAdminCenterCSH) +### -Prompts -Possible values are +> Applicable: Microsoft Teams -- None -- ByName -- ByExtension +The Prompts parameter reflects the prompts to play when the menu is activated. + +You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantprompt) cmdlet. + +> [!NOTE] +> If Mainline Attendant is enabled, only TTS prompts are supported. ```yaml -Type: Microsoft.Rtc.Management.Hosted.OAA.Models.DirectorySearchMethod +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -140,11 +152,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -168,5 +181,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsAutoAttendantMenuOption](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption) -[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption) +[New-CsAutoAttendantMenuOption](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenuoption) +[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenuoption) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md similarity index 91% rename from teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md index 3f723b2ff8..aa95b63c10 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption applicable: Microsoft Teams -title: New-CsAutoAttendantMenuOption -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantmenuoption +schema: 2.0.0 +title: New-CsAutoAttendantMenuOption --- # New-CsAutoAttendantMenuOption @@ -33,14 +35,14 @@ The New-CsAutoAttendantMenuOption cmdlet creates a new menu option for the Auto ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $menuOption = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 ``` This example creates a menu option to call the operator when the 0 key is pressed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $troubleShootObjectId = (Get-CsOnlineUser troubleShoot@contoso.com).ObjectId $troubleShootEntity = New-CsAutoAttendantCallableEntity -Identity $troubleShootObjectId -Type ApplicationEndpoint @@ -49,7 +51,7 @@ $menuOption = New-CsAutoAttendantMenuOption -Action TransferCallToTarget -DtmfRe This example creates a menu option to transfer the call to an application endpoint when the caller speaks the word "Sales" or presses the 1 key. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $Prompt = New-CsAutoAttendantPrompt -ActiveType TextToSpeech -TextToSpeechPrompt "Our Office is open from Monday to Friday from 9 AM to 5 PM" $menuOption = New-CsAutoAttendantMenuOption -Action Announcement -DtmfResponse Tone2 -VoiceResponses "Hours" -Prompt $Prompt @@ -61,6 +63,9 @@ This example creates a menu option to play an announcement for the defined promp ### -Action + +> Applicable: Microsoft Teams + The Action parameter represents the action to be taken when the menu option is activated. The Action must be set to one of the following values: - Announcement - plays a defined prompt then returns to the menu @@ -72,7 +77,6 @@ The Action parameter represents the action to be taken when the menu option is a Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -81,37 +85,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DtmfResponse -The DtmfResponse parameter indicates the key on the telephone keypad to be pressed to activate the menu option. The DtmfResponse must be set to one of the following values: +### -CallTarget -- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. -- ToneStar - Corresponds to DTMF tone *. -- TonePound - Corresponds to DTMF tone #. -- Automatic - The action is executed without user response. +> Applicable: Microsoft Teams + +The CallTarget parameter represents the target for call transfer after the menu option is selected. + +CallTarget is required if the action of the menu option is TransferCallToTarget. + +Use the New-CsAutoAttendantCallableEntity cmdlet to create new callable entities. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceResponses -The VoiceResponses parameter represents the voice responses to select a menu option when Voice Responses are enabled for the auto attendant. +### -Description -Voice responses are currently limited to one voice response per menu option. +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +A description/set of keywords for the option. + +Used by Mainline Attendant only. + +Limit: 500 characters ```yaml -Type: System.Collections.Generic.List +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -120,62 +133,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallTarget -The CallTarget parameter represents the target for call transfer after the menu option is selected. +### -DtmfResponse -CallTarget is required if the action of the menu option is TransferCallToTarget. +> Applicable: Microsoft Teams -Use the New-CsAutoAttendantCallableEntity cmdlet to create new callable entities. +The DtmfResponse parameter indicates the key on the telephone keypad to be pressed to activate the menu option. The DtmfResponse must be set to one of the following values: + +- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. +- ToneStar - Corresponds to DTMF tone *. +- TonePound - Corresponds to DTMF tone #. +- Automatic - The action is executed without user response. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Prompt -The **Prompt** parameter reflects the prompts to play when the menu option is activated. +### -MainlineAttendantTarget -You can create new prompts by using the **New-CsAutoAttendantPrompt** cmdlet. +> Applicable: Microsoft Teams -This parameter is required if the **Action** is set to **Announcement**. +_Voice applications private preview customers only._ + +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +The Mainline Attendant call flow target identifier. ```yaml -Type: Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True if -Action = MainlineAttendantFlow Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -_Voice applications private preview customers only._ +### -Prompt -_Saving an auto attendant configuration through Teams admin center will remove this setting._ +> Applicable: Microsoft Teams -A description/set of keywords for the option. +The **Prompt** parameter reflects the prompts to play when the menu option is activated. -Used by Mainline Attendant only. +You can create new prompts by using the **New-CsAutoAttendantPrompt** cmdlet. -Limit: 500 characters +This parameter is required if the **Action** is set to **Announcement**. ```yaml -Type: System.String +Type: Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -184,33 +200,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MainlineAttendantTarget -_Voice applications private preview customers only._ - -_Saving an auto attendant configuration through Teams admin center will remove this setting._ +### -Tenant -The Mainline Attendant call flow target identifier. +> Applicable: Microsoft Teams ```yaml -Type: System.String +Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True if -Action = MainlineAttendantFlow +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -VoiceResponses + +> Applicable: Microsoft Teams + +The VoiceResponses parameter represents the voice responses to select a menu option when Voice Responses are enabled for the auto attendant. + +Voice responses are currently limited to one voice response per menu option. ```yaml -Type: System.Guid +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -234,4 +251,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity) +[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallableentity) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantPrompt.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantPrompt.md similarity index 90% rename from teams/teams-ps/teams/New-CsAutoAttendantPrompt.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantPrompt.md index 9a601bd5d8..2b528539cd 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantPrompt.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantPrompt.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt applicable: Microsoft Teams -title: New-CsAutoAttendantPrompt -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantprompt +schema: 2.0.0 +title: New-CsAutoAttendantPrompt --- # New-CsAutoAttendantPrompt @@ -37,14 +39,14 @@ The New-CsAutoAttendantPrompt cmdlet creates a new prompt for the Auto Attendant ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $ttsPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" ``` This example creates a new prompt that reads the supplied text. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content @@ -53,7 +55,7 @@ $audioFilePrompt = New-CsAutoAttendantPrompt -AudioFilePrompt $audioFile This example creates a new prompt that plays the selected audio file. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content @@ -65,6 +67,9 @@ This example creates a new prompt that has both audio file and text-to-speech da ## PARAMETERS ### -ActiveType + +> Applicable: Microsoft Teams + PARAMVALUE: None | TextToSpeech | AudioFile The ActiveType parameter identifies the active type (modality) of the AA prompt. It can be set to None (the prompt is disabled), TextToSpeech (text-to-speech is played when the prompt is rendered) or AudioFile (audio file data is played when the prompt is rendered). @@ -75,7 +80,6 @@ This is explicitly required if both Audio File and TTS prompts are specified. Ot Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -AudioFilePrompt + +> Applicable: Microsoft Teams + The AudioFilePrompt parameter represents the audio to play when the prompt is activated (rendered). This parameter is required when audio file prompts are being created. You can create audio files by using the `Import-CsOnlineAudioFile` cmdlet. @@ -93,7 +100,6 @@ This parameter is required when audio file prompts are being created. You can cr Type: Object Parameter Sets: AudioFile, Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -102,16 +108,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextToSpeechPrompt -The TextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt that is to be read when the prompt is activated. +### -Tenant -This parameter is required when text to speech prompts are being created. +> Applicable: Microsoft Teams ```yaml -Type: System.String -Parameter Sets: TextToSpeech, Dual +Type: System.Guid +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -120,13 +124,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -TextToSpeechPrompt + +> Applicable: Microsoft Teams + +The TextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt that is to be read when the prompt is activated. + +This parameter is required when text to speech prompts are being created. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: System.String +Parameter Sets: TextToSpeech, Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -150,4 +159,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyAssignmentOperation.md similarity index 97% rename from teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md rename to teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyAssignmentOperation.md index e710dfbc0a..fe8d43ed6f 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyAssignmentOperation.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation -title: New-CsBatchPolicyAssignmentOperation -schema: 2.0.0 -author: tomkau ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchpolicyassignmentoperation +schema: 2.0.0 +title: New-CsBatchPolicyAssignmentOperation --- # New-CsBatchPolicyAssignmentOperation @@ -73,56 +74,56 @@ In this example, the batch of users is obtained by connecting to Microsoft Entra ## PARAMETERS -### -Identity -An array of users, specified either using object IDs (guid) or SIP addresses. There is a maximum of 5,000 users per batch. +### -AdditionalParameters +. ```yaml -Type: String +Type: Hashtable Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". +### -Break +Wait for .NET debugger to attach ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -The type of the policy to be assigned to the users. For the list of current policy types accepted by this parameter, see the Description section at the beginning of this article. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline ```yaml -Type: String +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OperationName -An optional name for the batch assignment operation. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline ```yaml -Type: String +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -133,60 +134,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdditionalParameters -. +### -Identity +An array of users, specified either using object IDs (guid) or SIP addresses. There is a maximum of 5,000 users per batch. ```yaml -Type: Hashtable +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach +### -OperationName +An optional name for the batch assignment operation. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -PolicyName +The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -PolicyType +The type of the policy to be assigned to the users. For the list of current policy types accepted by this parameter, see the Description section at the beginning of this article. ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -252,4 +253,4 @@ The ID of the operation that can be used with the Get-CsBatchPolicyAssignmentOpe ## RELATED LINKS -[Get-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation) +[Get-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csbatchpolicyassignmentoperation) diff --git a/teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyPackageAssignmentOperation.md similarity index 88% rename from teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md rename to teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyPackageAssignmentOperation.md index 7ff16c4092..bfce7fc16a 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyPackageAssignmentOperation.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: New-CsBatchPolicyPackageAssignmentOperation -author: serdarsoysal ms.author: serdars -manager: amitar -online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchpolicypackageassignmentoperation schema: 2.0.0 +title: New-CsBatchPolicyPackageAssignmentOperation --- # New-CsBatchPolicyPackageAssignmentOperation @@ -37,13 +38,14 @@ Applies the Education_PrimaryStudent policy package to three users in the tenant ### -Identity +> Applicable: Microsoft Teams + A list of one or more users in the tenant. A user identity can either be a user's object id or email address. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -53,13 +55,14 @@ Accept wildcard characters: False ### -PackageName +> Applicable: Microsoft Teams + The name of a specific policy package to apply. All policy package names can be found by running Get-CsPolicyPackage. To remove the currently assigned package, use $null or an empty string "". This will not remove any policy assignments, just the package assigned value. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -78,8 +81,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation) -[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicypackage) diff --git a/teams/teams-ps/teams/New-CsBatchTeamsDeployment.md b/teams/teams-ps/MicrosoftTeams/New-CsBatchTeamsDeployment.md similarity index 93% rename from teams/teams-ps/teams/New-CsBatchTeamsDeployment.md rename to teams/teams-ps/MicrosoftTeams/New-CsBatchTeamsDeployment.md index 90392de568..da1be57b71 100644 --- a/teams/teams-ps/teams/New-CsBatchTeamsDeployment.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsBatchTeamsDeployment.md @@ -1,98 +1,99 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment -title: New-CsBatchTeamsDeployment -schema: 2.0.0 ---- - -# New-CsBatchTeamsDeployment - -## SYNOPSIS - -This cmdlet is used to run a batch deployment orchestration. - -## SYNTAX - -``` -New-CsBatchTeamsDeployment -TeamsFilePath -UsersFilePath - -UsersToNotify [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Deploying Teams at scale enables admins to deploy up to 500 teams and add 25 users per team using one Teams PowerShell command and two CSV files. This allows admins to meet your organization's scale needs and significantly reduce deployment time. Admins can also use this solution to add and remove members from existing teams at scale. You can use this cmdlet to: -- Create teams using pre-built templates or your own custom templates. -- Add users to teams as owners or members. -- Manage teams at scale by adding or removing users from existing teams. -- Stay notified through email, including completion, status, and errors (if any). You can choose to notify up to five people about the status of each batch of teams you deploy. Team owners and members are automatically notified when they're added to a team. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-CsBatchTeamsDeployment -TeamsFilePath "C:\dscale\Teams.csv" -UsersFilePath "C:\dscale\Users.csv" -UsersToNotify "adminteams@contoso.com,adelev@contoso.com" -``` -This command runs a batch deployment with the provided parameters in the CSV files and emails the status and errors (if any) to adminteams@contoso.com and adelev@contoso.com. - -## PARAMETERS - -### -TeamsFilePath -The path to the CSV file that defines the teams you're creating. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsersFilePath -The path to the CSV file that maps the users you're adding to each team. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsersToNotify -The email addresses of up to five recipients to notify about this deployment. The recipients will receive email notifications about deployment status. The email contains the orchestration ID for the batch you submitted and any errors that may have occurred. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### OrchestrationId -The ID of the operation that can be used with the Get-CsBatchTeamsDeploymentStatus cmdlet to get the status of the operation. - -## NOTES - -## RELATED LINKS - -[Get-CsBatchTeamsDeploymentStatus](https://learn.microsoft.com/powershell/module/teams/get-csbatchteamsdeploymentstatus) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csbatchteamsdeployment +schema: 2.0.0 +title: New-CsBatchTeamsDeployment +--- + +# New-CsBatchTeamsDeployment + +## SYNOPSIS + +This cmdlet is used to run a batch deployment orchestration. + +## SYNTAX + +``` +New-CsBatchTeamsDeployment -TeamsFilePath -UsersFilePath + -UsersToNotify [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deploying Teams at scale enables admins to deploy up to 500 teams and add 25 users per team using one Teams PowerShell command and two CSV files. This allows admins to meet your organization's scale needs and significantly reduce deployment time. Admins can also use this solution to add and remove members from existing teams at scale. You can use this cmdlet to: +- Create teams using pre-built templates or your own custom templates. +- Add users to teams as owners or members. +- Manage teams at scale by adding or removing users from existing teams. +- Stay notified through email, including completion, status, and errors (if any). You can choose to notify up to five people about the status of each batch of teams you deploy. Team owners and members are automatically notified when they're added to a team. + +## EXAMPLES + +### EXAMPLE 1 +``` +New-CsBatchTeamsDeployment -TeamsFilePath "C:\dscale\Teams.csv" -UsersFilePath "C:\dscale\Users.csv" -UsersToNotify "adminteams@contoso.com,adelev@contoso.com" +``` +This command runs a batch deployment with the provided parameters in the CSV files and emails the status and errors (if any) to adminteams@contoso.com and adelev@contoso.com. + +## PARAMETERS + +### -TeamsFilePath +The path to the CSV file that defines the teams you're creating. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersFilePath +The path to the CSV file that maps the users you're adding to each team. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersToNotify +The email addresses of up to five recipients to notify about this deployment. The recipients will receive email notifications about deployment status. The email contains the orchestration ID for the batch you submitted and any errors that may have occurred. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### OrchestrationId +The ID of the operation that can be used with the Get-CsBatchTeamsDeploymentStatus cmdlet to get the status of the operation. + +## NOTES + +## RELATED LINKS + +[Get-CsBatchTeamsDeploymentStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csbatchteamsdeploymentstatus) diff --git a/teams/teams-ps/teams/New-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/New-CsCallQueue.md similarity index 95% rename from teams/teams-ps/teams/New-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/New-CsCallQueue.md index d651361f1a..d5edf96b3a 100644 --- a/teams/teams-ps/teams/New-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCallQueue.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cscallqueue applicable: Microsoft Teams -title: New-CsCallQueue author: tomkau -ms.author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US manager: bulenteg -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallqueue schema: 2.0.0 +title: New-CsCallQueue --- # New-CsCallQueue @@ -78,30 +79,16 @@ This example creates a Call Queue for the organization named "Help Desk" with mu ## PARAMETERS -### -Name -The Name parameter specifies a unique name for the Call Queue. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -AgentAlertTime -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AgentAlertTime The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. The default value is 30 seconds. ```yaml Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -111,13 +98,15 @@ Accept wildcard characters: False ``` ### -AllowOptOut + +> Applicable: Microsoft Teams + The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -126,14 +115,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DistributionLists -The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. +### -AuthorizedUsers + +> Applicable: Microsoft Teams + +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -142,14 +133,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for Microsoft internal use only. +### -CallbackEmailNotificationTarget + +> Applicable: Microsoft Teams + +The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -158,14 +151,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDefaultMusicOnHold -The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. +### -CallbackOfferAudioFilePromptResourceId + +> Applicable: Microsoft Teams + +The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -174,14 +169,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeMusicAudioFileId -The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. +### -CallbackOfferTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -190,14 +187,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MusicOnHoldAudioFileId -The MusicOnHoldAudioFileId parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. +### -CallbackRequestDtmf + +The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: + +- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. +- ToneStar - Corresponds to DTMF tone *. +- TonePound - Corresponds to DTMF tone #. + +This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -206,32 +209,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowAction -The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. +### -CallToAgentRatioThresholdBeforeOfferingCallback -PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail +The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Minimum value of 1. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: Object +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: DisconnectWithBusy +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. +### -ChannelId + +> Applicable: Microsoft Teams + +Id of the channel to connect a call queue to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -240,26 +245,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -If the OverFlowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. +### -ChannelUserObjectId -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +> Applicable: Microsoft Teams -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team the channels belongs to. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -268,48 +263,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowThreshold -The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. +### -ComplianceRecordingForCallQueueTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. ```yaml -Type: Int16 +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: 50 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutAction -The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. +### -ConferenceMode -PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail +> Applicable: Microsoft Teams + +The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: + +- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. + +- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionTarget -The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. +### -CustomAudioFileAnnouncementForCR + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -318,26 +326,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ +### -CustomAudioFileAnnouncementForCRFailure -If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. +> Applicable: Microsoft Teams -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +_Voice applications private preview customers only._ -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -346,165 +348,160 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutThreshold -The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. -The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. +### -DistributionLists + +> Applicable: Microsoft Teams + +The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. ```yaml -Type: Int16 +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: 1200 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentApplyTo -The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. +### -EnableNoAgentSharedVoicemailSystemPromptSuppression -PARAMVALUE: AllCalls | NewCalls +> Applicable: Microsoft Teams + +The EnableNoAgentSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentAction -The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. +### -EnableNoAgentSharedVoicemailTranscription -PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail +> Applicable: Microsoft Teams + +The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentActionTarget -The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a GUID or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a Microsoft 365 Group ID. Otherwise, this field is optional. +### -EnableOverflowSharedVoicemailSystemPromptSuppression + +> Applicable: Microsoft Teams + +The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. +### -EnableOverflowSharedVoicemailTranscription -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +> Applicable: Microsoft Teams -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: Int16 +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -RoutingMethod -The RoutingMethod parameter defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If the routing method is set to RoundRobin, the agents will be called using the Round Robin strategy so that all agents share the call load equally. If the routing method is set to LongestIdle, the agents will be called based on their idle time, that is, the agent that has been idle for the longest period will be called. +### -EnableTimeoutSharedVoicemailSystemPromptSuppression -PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle +> Applicable: Microsoft Teams + +The EnableTimeoutSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Attendant +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PresenceBasedRouting -The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. +### -EnableTimeoutSharedVoicemailTranscription + +> Applicable: Microsoft Teams + +The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: True +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ConferenceMode -The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: +### -HideAuthorizedUsers -- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. +> Applicable: Microsoft Teams -- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml -Type: Boolean +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Users -The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). +### -IsCallbackEnabled + +The IsCallbackEnabled parameter is used to turn on/off callback. ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -514,6 +511,9 @@ Accept wildcard characters: False ``` ### -LanguageId + +> Applicable: Microsoft Teams + The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter if either OverflowAction or TimeoutAction is set to SharedVoicemail. You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. @@ -522,7 +522,6 @@ You can query the supported languages using the Get-CsAutoAttendantSupportedLang Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -532,13 +531,15 @@ Accept wildcard characters: False ``` ### -LineUri + +> Applicable: Microsoft Teams + This parameter is reserved for Microsoft internal use only. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -547,14 +548,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OboResourceAccountIds -The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. +### -MusicOnHoldAudioFileId + +> Applicable: Microsoft Teams + +The MusicOnHoldAudioFileId parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. ```yaml -Type: List +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -563,48 +566,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectTextToSpeechPrompt -The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. +### -Name + +> Applicable: Microsoft Teams + +The Name parameter specifies a unique name for the Call Queue. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectAudioFilePrompt -The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. +### -NoAgentAction + +> Applicable: Microsoft Teams + +The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. + +PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentActionCallPriority -The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -613,16 +634,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentActionTarget -The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. +> Applicable: Microsoft Teams + +The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a GUID or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a Microsoft 365 Group ID. Otherwise, this field is optional. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -631,30 +652,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppTextToSpeechPrompt -The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentApplyTo + +> Applicable: Microsoft Teams + +The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. + +PARAMVALUE: AllCalls | NewCalls ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppAudioFilePrompt -The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentDisconnectAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -663,14 +690,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberTextToSpeechPrompt -The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -NoAgentDisconnectTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -679,14 +708,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberAudioFilePrompt -The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -NoAgentRedirectPersonAudioFilePrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -695,16 +728,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailTextToSpeechPrompt +### -NoAgentRedirectPersonTextToSpeechPrompt + +> Applicable: Microsoft Teams + _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. +The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -713,16 +748,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentRedirectPhoneNumberAudioFilePrompt -The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. +> Applicable: Microsoft Teams + +The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -731,14 +766,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailTextToSpeechPrompt -The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. +### -NoAgentRedirectPhoneNumberTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -747,14 +784,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailAudioFilePrompt -The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. +### -NoAgentRedirectVoiceAppAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -763,46 +802,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailTranscription -The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -NoAgentRedirectVoiceAppTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailSystemPromptSuppression -The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -NoAgentRedirectVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectTextToSpeechPrompt -The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. +### -NoAgentRedirectVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -811,14 +860,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectAudioFilePrompt -The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. +### -NoAgentSharedVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -827,16 +878,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentSharedVoicemailTextToSpeechPrompt -The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. +> Applicable: Microsoft Teams + +The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -845,16 +896,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NumberOfCallsInQueueBeforeOfferingCallback -The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. +The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -863,14 +914,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppTextToSpeechPrompt -The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. +### -OboResourceAccountIds + +> Applicable: Microsoft Teams + +The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -879,14 +932,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppAudioFilePrompt -The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. +### -OverflowAction + +> Applicable: Microsoft Teams + +The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. + +PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail ```yaml -Type: Guid +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: DisconnectWithBusy +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowActionCallPriority + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the OverFlowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -895,14 +982,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberTextToSpeechPrompt -The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowActionTarget + +> Applicable: Microsoft Teams + +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -911,14 +1000,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberAudioFilePrompt -The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowDisconnectAudioFilePrompt + +> Applicable: Microsoft Teams + +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -927,16 +1018,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowDisconnectTextToSpeechPrompt -The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. +> Applicable: Microsoft Teams + +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -945,16 +1036,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailAudioFilePrompt +### -OverflowRedirectPersonAudioFilePrompt + +> Applicable: Microsoft Teams + _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -963,14 +1056,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailTextToSpeechPrompt -The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. +### -OverflowRedirectPersonTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -979,14 +1076,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailAudioFilePrompt -The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. +### -OverflowRedirectPhoneNumberAudioFilePrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -995,46 +1094,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailTranscription -The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. +### -OverflowRedirectPhoneNumberTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailSystemPromptSuppression -The EnableTimeoutSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -OverflowRedirectVoiceAppAudioFilePrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectTextToSpeechPrompt -The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. +### -OverflowRedirectVoiceAppTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1043,14 +1148,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectAudioFilePrompt -The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. +### -OverflowRedirectVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1059,16 +1168,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonTextToSpeechPrompt +### -OverflowRedirectVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1077,16 +1188,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowSharedVoicemailAudioFilePrompt -The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. +> Applicable: Microsoft Teams + +The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1095,14 +1206,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppTextToSpeechPrompt -The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. +### -OverflowSharedVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1111,64 +1224,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppAudioFilePrompt -The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. +### -OverflowThreshold + +> Applicable: Microsoft Teams + +The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: 50 Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberTextToSpeechPrompt -The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -PresenceBasedRouting + +> Applicable: Microsoft Teams + +The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberAudioFilePrompt -The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -RoutingMethod + +> Applicable: Microsoft Teams + +The RoutingMethod parameter defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If the routing method is set to RoundRobin, the agents will be called using the Round Robin strategy so that all agents share the call load equally. If the routing method is set to LongestIdle, the agents will be called based on their idle time, that is, the agent that has been idle for the longest period will be called. + +PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Attendant Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -ServiceLevelThresholdResponseTimeInSecond -The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. +The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. + +A value of `$null` indicates that a service level percentage will not be calculated for this call queue. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1177,16 +1298,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailAudioFilePrompt +### -SharedCallQueueHistoryTemplateId +_Voice applications private preview customers only._ + _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. +The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1195,14 +1317,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailTextToSpeechPrompt -The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. +### -ShiftsSchedulingGroupId + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Scheduling Group to connect a call queue to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1211,14 +1339,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailAudioFilePrompt -The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. +### -ShiftsTeamId + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Team containing the Scheduling Group to connect a call queue to. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1227,14 +1361,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailTranscription -The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -ShouldOverwriteCallableChannelProperty + +A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1243,30 +1377,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailSystemPromptSuppression -The EnableNoAgentSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -Tenant + +> Applicable: Microsoft Teams + +This parameter is reserved for Microsoft internal use only. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelId -Id of the channel to connect a call queue to. +### -TextAnnouncementForCR + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1275,14 +1417,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelUserObjectId -Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team the channels belongs to. +### -TextAnnouncementForCRFailure + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1291,38 +1439,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShiftsTeamId -_Voice applications private preview customers only._ +### -TimeoutAction -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -Id of the Team containing the Scheduling Group to connect a call queue to. +The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. + +PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -ShiftsSchedulingGroupId -_Voice applications private preview customers only._ +### -TimeoutActionCallPriority -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -Id of the Scheduling Group to connect a call queue to. +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1331,14 +1489,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthorizedUsers -This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +### -TimeoutActionTarget + +> Applicable: Microsoft Teams + +The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. ```yaml -Type: List +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1347,16 +1507,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HideAuthorizedUsers -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -TimeoutDisconnectAudioFilePrompt -This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +> Applicable: Microsoft Teams + +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. ```yaml -Type: List +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1365,8 +1525,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeTextToSpeechPrompt -This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. +### -TimeoutDisconnectTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. ```yaml Type: String @@ -1380,12 +1543,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsCallbackEnabled +### -TimeoutRedirectPersonAudioFilePrompt -The IsCallbackEnabled parameter is used to turn on/off callback. +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: @@ -1396,15 +1563,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackRequestDtmf +### -TimeoutRedirectPersonTextToSpeechPrompt -The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: +> Applicable: Microsoft Teams -- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. -- ToneStar - Corresponds to DTMF tone *. -- TonePound - Corresponds to DTMF tone #. +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. ```yaml Type: String @@ -1418,14 +1583,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WaitTimeBeforeOfferingCallbackInSecond +### -TimeoutRedirectPhoneNumberAudioFilePrompt -The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: @@ -1436,14 +1601,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberOfCallsInQueueBeforeOfferingCallback +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt -The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: @@ -1454,14 +1619,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallToAgentRatioThresholdBeforeOfferingCallback +### -TimeoutRedirectVoiceAppAudioFilePrompt -The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Minimum value of 1. Set to null ($null) to disable this condition. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: @@ -1472,15 +1637,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferAudioFilePromptResourceId +### -TimeoutRedirectVoiceAppTextToSpeechPrompt -The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. +> Applicable: Microsoft Teams + +The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1489,15 +1655,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferTextToSpeechPrompt +### -TimeoutRedirectVoicemailAudioFilePrompt -The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1506,15 +1675,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackEmailNotificationTarget +### -TimeoutRedirectVoicemailTextToSpeechPrompt -The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1523,14 +1695,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceLevelThresholdResponseTimeInSecond +### -TimeoutSharedVoicemailAudioFilePrompt -The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. +> Applicable: Microsoft Teams -A value of `$null` indicates that a service level percentage will not be calculated for this call queue. +The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: @@ -1541,15 +1713,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingForCallQueueTemplateId -_Voice applications private preview customers only._ +### -TimeoutSharedVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. +The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. ```yaml -Type: List +Type: String Parameter Sets: (All) Aliases: @@ -1560,38 +1731,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextAnnouncementForCR -_Voice applications private preview customers only._ +### -TimeoutThreshold -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. +The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. +The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: 1200 Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomAudioFileAnnouncementForCR -_Voice applications private preview customers only._ +### -UseDefaultMusicOnHold -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. +The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1600,18 +1768,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextAnnouncementForCRFailure -_Voice applications private preview customers only._ +### -Users -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. +The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1620,18 +1786,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomAudioFileAnnouncementForCRFailure -_Voice applications private preview customers only._ +### -WaitTimeBeforeOfferingCallbackInSecond -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. -The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1640,15 +1804,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharedCallQueueHistoryTemplateId -_Voice applications private preview customers only._ +### -WelcomeMusicAudioFileId -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. +The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: @@ -1659,18 +1822,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShouldOverwriteCallableChannelProperty - -A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. +### -WelcomeTextToSpeechPrompt +This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/New-CsCallingLineIdentity.md similarity index 91% rename from teams/teams-ps/teams/New-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/New-CsCallingLineIdentity.md index 93e83c74a1..902d493002 100644 --- a/teams/teams-ps/teams/New-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity applicable: Microsoft Teams -title: New-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallinglineidentity +schema: 2.0.0 +title: New-CsCallingLineIdentity --- # New-CsCallingLineIdentity @@ -63,23 +64,10 @@ This example creates a new Caller ID policy that allows Teams users to make anon ## PARAMETERS -### -Identity -The Identity parameter identifies the Caller ID policy. +### -BlockIncomingPstnCallerID -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockIncomingPstnCallerID The BlockIncomingPstnCallerID switch determines whether to block the incoming Caller ID. The default value is false. The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. If this is set to True and if this policy is assigned to a user, then Caller ID for incoming calls is suppressed/anonymous. @@ -88,7 +76,6 @@ The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN c Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -98,13 +85,15 @@ Accept wildcard characters: False ``` ### -CallingIDSubstitute + +> Applicable: Microsoft Teams + The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The default value is LineUri. Supported values are Anonymous, LineUri, and Resource. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -114,13 +103,33 @@ Accept wildcard characters: False ``` ### -CompanyName + +> Applicable: Microsoft Teams + This parameter sets the Calling party name (typically referred to as CNAM) on the outgoing PSTN call. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + The Description parameter briefly describes the Caller ID policy. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -EnableUserOverride + +> Applicable: Microsoft Teams + The EnableUserOverride parameter gives Microsoft Teams users the option under Settings and Calls to hide their phone number when making outgoing calls. The CallerID will be Anonymous. If CallingIDSubstitute is set to Anonymous, the EnableUserOverride parameter has no effect, and the caller ID is always set to Anonymous. @@ -156,7 +170,6 @@ EnableUserOverride has precedence over other settings in the policy unless subst Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -165,30 +178,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceAccount -This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter identifies the Caller ID policy. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +### -ResourceAccount + +> Applicable: Microsoft Teams + +This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -197,14 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -WhatIf + +> Applicable: Microsoft Teams + +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -228,10 +247,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallinglineidentity) -[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cscallinglineidentity) -[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallinglineidentity) -[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallinglineidentity) diff --git a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md b/teams/teams-ps/MicrosoftTeams/New-CsCloudCallDataConnection.md similarity index 90% rename from teams/teams-ps/teams/New-CsCloudCallDataConnection.md rename to teams/teams-ps/MicrosoftTeams/New-CsCloudCallDataConnection.md index 772f8f1d49..a78d31ab05 100644 --- a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCloudCallDataConnection.md @@ -1,15 +1,15 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: New-CsCloudCallDataConnection -online version: https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection -schema: 2.0.0 author: 2012ucp1544 +external help file: MicrosoftTeams-help.xml +Locale: en-US +manager: subadjat +Module Name: MicrosoftTeams ms.author: uditagrawal ms.reviewer: pbafna -manager: subadjat - +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cscloudcalldataconnection +schema: 2.0.0 +title: New-CsCloudCallDataConnection --- # New-CsCloudCallDataConnection @@ -59,4 +59,4 @@ The New-CsCloudCallDataConnection cmdlet is only supported in commercial environ ## RELATED LINKS [Configure Call Data Connector](https://learn.microsoft.com/skypeforbusiness/hybrid/configure-call-data-connector) -[Get-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection) +[Get-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-cscloudcalldataconnection) diff --git a/teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsComplianceRecordingForCallQueueTemplate.md similarity index 84% rename from teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsComplianceRecordingForCallQueueTemplate.md index f98067448d..2cc3f34801 100644 --- a/teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsComplianceRecordingForCallQueueTemplate.md @@ -1,21 +1,27 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/New-CsComplianceRecordingForCallQueueTemplate applicable: Microsoft Teams -title: New-CsComplianceRecordingForCallQueueTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: New-CsComplianceRecordingForCallQueueTemplate --- # New-CsComplianceRecordingForCallQueueTemplate +## SYNOPSIS +Use the New-CsComplianceRecordingForCallQueueTemplate cmdlet to create a Compliance Recording for Call Queues template. + ## SYNTAX -```powershell -New-CsComplianceRecordingForCallQueueTemplate -Name -Description -BotId [-RequiredDuringCall ] [-RequiredBeforeCall ] [-CurrentInvitationCount ] [-PairedApplication ] [] +``` +New-CsComplianceRecordingForCallQueueTemplate -Name -Description -BotId + [-RequiredDuringCall ] [-RequiredBeforeCall ] [-CurrentInvitationCount ] + [-PairedApplication ] [] ``` ## DESCRIPTION @@ -26,7 +32,7 @@ Use the New-CsComplianceRecordingForCallQueueTemplate cmdlet to create a Complia ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsComplianceRecordingForCallQueueTemplate -Name "Customer Service" -Description "Required before/during call" -BotId 14732826-8206-42e3-b51e-6693e2abb698 -RequiredDuringCall $true -RequiredBeforeCall $true ``` @@ -35,14 +41,16 @@ This example creates a new Compliance Recording for Call Queue template. ## PARAMETERS -### -Name -The name of the compliance recording for call queue template. +### -BotId + +> Applicable: Microsoft Teams + +The Id of the compliance recording for call queue bot to invite. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -51,14 +59,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConcurrentInvitationCount + +> Applicable: Microsoft Teams + +The number of concurrent invitations to send to the compliance recording for call queue bot. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description + +> Applicable: Microsoft Teams + A description for the compliance recording for call queues template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -67,14 +95,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BotId -The Id of the compliance recording for call queue bot to invite. +### -Name + +> Applicable: Microsoft Teams + +The name of the compliance recording for call queue template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -83,24 +113,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredDuringCall -Indicates if the compliance recording for call queues bot must remain part of the call. -*Strict recording* - if the bot leaves the call, the call will end. +### -PairedApplication + +> Applicable: Microsoft Teams + +The PairedApplication parameter specifies the paired application for the call queue. ```yaml -Type: System.Booleen +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -RequiredBeforeCall + +> Applicable: Microsoft Teams + Indicates if the compliance recording for call queues bot must be able to join the call. *Strict recording* - if the bot can't join the call, the call will end. @@ -108,7 +142,6 @@ Indicates if the compliance recording for call queues bot must be able to join t Type: System.Booleen Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -117,34 +150,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentInvitationCount -The number of concurrent invitations to send to the compliance recording for call queue bot. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -RequiredDuringCall -Required: False -Position: Named -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -PairedApplication -The PairedApplication parameter specifies the paired application for the call queue. +Indicates if the compliance recording for call queues bot must remain part of the call. +*Strict recording* - if the bot leaves the call, the call will end. ```yaml -Type: System.String +Type: System.Booleen Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -177,6 +197,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsCallQueue](./Set-CsCallQueue.md) [Remove-CsCallQueue](./Remove-CsCallQueue.md) - - - diff --git a/teams/teams-ps/teams/New-CsCustomPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/New-CsCustomPolicyPackage.md similarity index 86% rename from teams/teams-ps/teams/New-CsCustomPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/New-CsCustomPolicyPackage.md index bf6a5dfc6b..5510131935 100644 --- a/teams/teams-ps/teams/New-CsCustomPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCustomPolicyPackage.md @@ -1,20 +1,18 @@ --- +author: sunguchuan external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: New-CsCustomPolicyPackage -author: sunguchuan ms.author: gucsun -manager: dasosby -online version: https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cscustompolicypackage schema: 2.0.0 +title: New-CsCustomPolicyPackage --- # New-CsCustomPolicyPackage ## SYNOPSIS - -**Note:** This cmdlet is currently in private preview. - This cmdlet creates a custom policy package. ## SYNTAX @@ -27,6 +25,8 @@ New-CsCustomPolicyPackage -Identity -PolicyList [-Descriptio This cmdlet creates a custom policy package. It allows the admin to create their own policy packages for the tenant. For more information on policy packages and the policy types available, see [Managing policy packages in Teams](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages). +**Note:** This cmdlet is currently in private preview. + ## EXAMPLES ### Example 1 @@ -44,49 +44,52 @@ Creates a custom package named "MyPackage" with description "My package" and two ## PARAMETERS -### -Identity +### -Description -The name of the custom package. +> Applicable: Microsoft Teams + +The description of the custom package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True -Position: 0 +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyList +### -Identity -A list of one or more policies to be added in the package. To specify the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy). +> Applicable: Microsoft Teams + +The name of the custom package. ```yaml -Type: String[] +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -PolicyList -The description of the custom package. +> Applicable: Microsoft Teams + +A list of one or more policies to be added in the package. To specify the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmessagingpolicy). ```yaml -Type: String +Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -103,6 +106,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage) +[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/update-cscustompolicypackage) -[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage) +[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscustompolicypackage) diff --git a/teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains.md similarity index 94% rename from teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md rename to teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains.md index 2aef1fe8ea..b5735fb638 100644 --- a/teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csedgeallowallknowndomains applicable: Microsoft Teams -title: New-CsEdgeAllowAllKnownDomains -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csedgeallowallknowndomains +schema: 2.0.0 +title: New-CsEdgeAllowAllKnownDomains --- # New-CsEdgeAllowAllKnownDomains @@ -51,7 +53,7 @@ To configure federation with all known domains, use a set of commands similar to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsEdgeAllowAllKnownDomains @@ -82,4 +84,4 @@ The New-CsEdgeAllowAllKnownDomains cmdlet creates new instances of the Microsoft ## RELATED LINKS -[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/New-CsEdgeAllowList.md b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowList.md similarity index 93% rename from teams/teams-ps/teams/New-CsEdgeAllowList.md rename to teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowList.md index 051c806683..57549a497b 100644 --- a/teams/teams-ps/teams/New-CsEdgeAllowList.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowList.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csedgeallowlist applicable: Microsoft Teams -title: New-CsEdgeAllowList -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csedgeallowlist +schema: 2.0.0 +title: New-CsEdgeAllowList --- # New-CsEdgeAllowList ## SYNOPSIS Enables administrators to specify the domains that their users will be allowed to communicate with. -The `New-CsEdgeAllowList` cmdlet, which can be used only with Skype for Business Online, must be used in conjunction with the `New-CsEdgeDomainPattern` cmdlet and the `Set-CsTenantFederationConfiguration` cmdlet. ## SYNTAX @@ -23,6 +24,8 @@ New-CsEdgeAllowList [-AllowedDomain ] [] ``` ## DESCRIPTION +The `New-CsEdgeAllowList` cmdlet, which can be used only with Skype for Business Online, must be used in conjunction with the `New-CsEdgeDomainPattern` cmdlet and the `Set-CsTenantFederationConfiguration` cmdlet. + Federation is a service that enables users to exchange IM and presence information with users from other domains. With Skype for Business Online, administrators can use the federation configuration settings to govern: @@ -56,7 +59,7 @@ When this command finishes executing, users will only be allowed to communicate ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -72,7 +75,7 @@ After the domain object has been created, the `New-CsEdgeAllowList` cmdlet is us With the allowed domain list created, the final command in the example can then use the `Set-CsTenantFederationConfiguration` cmdlet to configure fabrikam.com as the only domain on the allowed domain list for the current tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = New-CsEdgeDomainPattern -Domain "contoso.com" @@ -87,7 +90,7 @@ Example 2 shows how you can add multiple domains to an allowed domains list. This is done by calling the `New-CsEdgeDomainPattern` cmdlet multiple times (one for each domain to be added to the list), and storing the resulting domain objects in separate variables. Each of those variables can then be added to the allow list created by the `New-CsEdgeAllowList` cmdlet simply by using the AllowedDomain parameter and separating the variables name by using commas. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $newAllowList = New-CsEdgeAllowList -AllowedDomain $Null @@ -101,6 +104,9 @@ The resulting object reference ($newAllowList) is then used in conjunction with ## PARAMETERS ### -AllowedDomain + +> Applicable: Microsoft Teams + Object reference to the new domain (or set of domains) to be added to the allowed domain list. Domain object references must be created by using the `New-CsEdgeDomainPattern` cmdlet. Multiple domain objects can be added by separating the object references using commas. @@ -112,7 +118,6 @@ For example: Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -139,6 +144,6 @@ The `New-CsEdgeAllowList` cmdlet creates new instances of the Microsoft.Rtc.Mana ## RELATED LINKS -[New-CsEdgeDomainPattern](https://learn.microsoft.com/powershell/module/teams/new-csedgedomainpattern) +[New-CsEdgeDomainPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csedgedomainpattern) -[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/New-CsEdgeDomainPattern.md b/teams/teams-ps/MicrosoftTeams/New-CsEdgeDomainPattern.md similarity index 93% rename from teams/teams-ps/teams/New-CsEdgeDomainPattern.md rename to teams/teams-ps/MicrosoftTeams/New-CsEdgeDomainPattern.md index 5bc669bc16..b4707cac30 100644 --- a/teams/teams-ps/teams/New-CsEdgeDomainPattern.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsEdgeDomainPattern.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csedgedomainpattern applicable: Microsoft Teams -title: New-CsEdgeDomainPattern -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csedgedomainpattern +schema: 2.0.0 +title: New-CsEdgeDomainPattern --- # New-CsEdgeDomainPattern ## SYNOPSIS Used to specify a domain that will be added or removed from the set of domains enabled for federation or the set of domains disabled for federation. -You must use the New-CsEdgeDomainPattern cmdlet when modifying the allowed or blocked domain lists. -String values (such as "fabrikam.com") cannot be directly passed to the cmdlets used to manage either of these lists. ## SYNTAX @@ -24,6 +24,9 @@ New-CsEdgeDomainPattern -Domain [] ``` ## DESCRIPTION +You must use the New-CsEdgeDomainPattern cmdlet when modifying the allowed or blocked domain lists. +String values (such as "fabrikam.com") cannot be directly passed to the cmdlets used to manage either of these lists. + Federation is a service that enables users to exchange IM and presence information with users from other domains. With Skype for Business Online, administrators can use the federation configuration settings to govern: @@ -48,7 +51,7 @@ Instead, you must create a domain object by using the New-CsEdgeDomainPattern cm ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -62,6 +65,9 @@ The second command then uses the Set-CsTenantFederationConfiguration cmdlet and ## PARAMETERS ### -Domain + +> Applicable: Microsoft Teams + Fully qualified domain name of the domain to be added to the allow list. For example: @@ -73,7 +79,6 @@ Note that you cannot use wildcards when specifying a domain name. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -100,4 +105,4 @@ The New-CsEdgeDomainPattern cmdlet creates new instances of the Microsoft.Rtc.Ma ## RELATED LINKS -[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/New-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsExternalAccessPolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsExternalAccessPolicy.md index 78f3038720..ba2a9e7a64 100644 --- a/teams/teams-ps/teams/New-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsExternalAccessPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy applicable: Microsoft Teams -title: New-CsExternalAccessPolicy -schema: 2.0.0 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy +schema: 2.0.0 +title: New-CsExternalAccessPolicy --- # New-CsExternalAccessPolicy @@ -15,12 +17,6 @@ ms.reviewer: rogupta Enables you to create a new external access policy. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. - -This cmdlet was introduced in Lync Server 2010. - -For information about external access in Microsoft Teams, see [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) and [Teams and Skype interoperability](https://learn.microsoft.com/microsoftteams/teams-skype-interop) for specific details. - ## SYNTAX ```powershell @@ -49,6 +45,9 @@ New-CsExternalAccessPolicy [-Identity] ## DESCRIPTION +This cmdlet was introduced in Lync Server 2010. + +For information about external access in Microsoft Teams, see [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) and [Teams and Skype interoperability](https://learn.microsoft.com/microsoftteams/teams-skype-interop) for specific details. When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. @@ -60,14 +59,14 @@ External access policies can grant (or revoke) the ability of your users to do a Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). this policy setting only applies if acs federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). this policy setting only applies if acs federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration). 3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. 4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. -5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. When you install Skype for Business Server, a global external access policy is automatically created for you. In addition to the global policy, you can also create custom external access policies at either the site or the per-user scope. @@ -83,7 +82,7 @@ The following parameters are not applicable to Skype for Business Online/Microso ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True -EnableOutsideAccess $True ``` @@ -91,7 +90,7 @@ New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True The command shown in Example 1 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. Note that this new policy sets both the EnableFederationAccess and the EnableOutsideAccess properties to True. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false @@ -99,7 +98,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederatio In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $True -EnableTeamsConsumerInbound $False ``` @@ -107,7 +106,7 @@ New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $Tr The command shown in Example 3 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. Note that this new policy enables communication with people using Teams with an account that's not managed by an organization and limits this to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people with this policy assigned. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` $x = New-CsExternalAccessPolicy -Identity RedmondAccessPolicy -InMemory @@ -127,7 +126,7 @@ Finally, the last command uses the Set-CsExternalAccessPolicy cmdlet to create a If you do not call the Set-CsExternalAccessPolicy cmdlet, then the virtual policy will disappear as soon as you end your Windows PowerShell session or delete the variable $x. Should that happen, an external access policy with the Identity RedmondAccessPolicy will never be created. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWithExternalOrgs "AllowSpecificExternalDomains" -AllowedExternalDomains @("example1.com", "example2.com") Set-CsTenantFederationConfiguration -CustomizeFederation $true @@ -137,32 +136,10 @@ In this example, we create an ExternalAccessPolicy named "GranularFederationExam ## PARAMETERS -### -Identity -Unique Identity to be assigned to the policy. New external access policies can be created at the site or per-user scope. - -To create a new site policy, use the prefix "site:" and the name of the site as your Identity. - -For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.` - -To create a new per-user policy, use an Identity similar to this: `-Identity SalesAccessPolicy.` - -Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsExternalAccessPolicy cmdlet instead. - -Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. If you need to make changes to an existing policy, use the Set-CsExternalAccessPolicy cmdlet. +### -AllowedExternalDomains -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedExternalDomains > [!NOTE] > Please note that this parameter is in Private Preview. @@ -172,7 +149,6 @@ Specifies the external domains allowed to communicate with users assigned to thi Type: List Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -181,6 +157,9 @@ Accept wildcard characters: False ``` ### -BlockedExternalDomains + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + > [!NOTE] > Please note that this parameter is in Private Preview. @@ -190,7 +169,6 @@ Specifies the external domains blocked from communicating with users assigned to Type: List Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -199,6 +177,9 @@ Accept wildcard characters: False ``` ### -CommunicationWithExternalOrgs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + > [!NOTE] > Please note that this parameter is in Private Preview. @@ -215,7 +196,6 @@ The setting is only applicable when `EnableFederationAccess` is set to true. Thi Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named Default value: OrganizationDefault @@ -255,6 +235,9 @@ Accept wildcard characters: False ``` ### -EnableAcsFederationAccess + +> Applicable: Microsoft Teams + Indicates whether Teams meetings organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. @@ -265,7 +248,6 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -396,12 +378,12 @@ Accept wildcard characters: False ### -FederatedBilateralChats This setting enables bi-lateral chats for the users included in the messaging policy. -Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. - -Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. - +Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. + +Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. + Users with bilateral policy applied are also removed from existing external group chats with more than two organizations. - + This policy doesn't apply to meetings, meeting chats, or channels. ```yaml @@ -431,6 +413,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique Identity to be assigned to the policy. New external access policies can be created at the site or per-user scope. + +To create a new site policy, use the prefix "site:" and the name of the site as your Identity. + +For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.` + +To create a new per-user policy, use an Identity similar to this: `-Identity SalesAccessPolicy.` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsExternalAccessPolicy cmdlet instead. + +Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. If you need to make changes to an existing policy, use the Set-CsExternalAccessPolicy cmdlet. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -521,10 +528,10 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Exte ## RELATED LINKS -[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) -[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/New-CsGroupPolicyAssignment.md similarity index 96% rename from teams/teams-ps/teams/New-CsGroupPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/New-CsGroupPolicyAssignment.md index efbf01984f..6ce675935e 100644 --- a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsGroupPolicyAssignment.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment -title: New-CsGroupPolicyAssignment -schema: 2.0.0 -author: tomkau ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment +schema: 2.0.0 +title: New-CsGroupPolicyAssignment --- # New-CsGroupPolicyAssignment @@ -43,7 +44,7 @@ Once a group policy assignment is created, the policy assignment will be propaga > - A given policy type can be assigned to at most 64 groups, across policy instances for that type. > - Policy assignments are only propagated to users that are direct members of the group; the assignments are not propagated to members of nested groups. > - Direct user assignments of policy take precedence over any group policy assignments for a given policy type. Group PolicyPolicy assignments only take effect to a user if that user does not have a direct policy assignment. -> - Get-CsOnlineUser only shows *direct* assignments of policy. It does not show the effect of group policy assignments. To view a specific user's effective policy, use `Get-CsUserPolicyAssignment`. This cmdlet shows whether the effective policy is from a direct assignment or from a group, as well as the ranked order of each group policy assignment in the case where a user is a member of more than 1 group with a group policy assignment of the same policy type. For example, to view all TeamsMeetingPolicy assignments for a given user, $user, run the following powershell cmdlet: `Get-CsUserPolicyAssignment -Identity $user -PolicyType TeamsMeetingPolicy|select -ExpandProperty PolicySource`. For details, see [Get-CsUserPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment). +> - Get-CsOnlineUser only shows *direct* assignments of policy. It does not show the effect of group policy assignments. To view a specific user's effective policy, use `Get-CsUserPolicyAssignment`. This cmdlet shows whether the effective policy is from a direct assignment or from a group, as well as the ranked order of each group policy assignment in the case where a user is a member of more than 1 group with a group policy assignment of the same policy type. For example, to view all TeamsMeetingPolicy assignments for a given user, $user, run the following powershell cmdlet: `Get-CsUserPolicyAssignment -Identity $user -PolicyType TeamsMeetingPolicy|select -ExpandProperty PolicySource`. For details, see [Get-CsUserPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicyassignment). > - Group policy assignment is currently not available in the Microsoft 365 DoD deployment. ## EXAMPLES @@ -99,6 +100,21 @@ e050ce51-54bc-45b7-b3e6-c00343d31274 TeamsMeetingPolicy AllOff 2 11/2/201 ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GroupId The ID of a batch policy assignment operation. @@ -114,17 +130,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -The type of policy to be assigned. +### -PassThru +Returns true when the command succeeds ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -144,32 +160,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PolicyType +The type of policy to be assigned. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns true when the command succeeds +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -190,21 +206,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -216,8 +217,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsUserPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment) +[Get-CsUserPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csuserpolicyassignment) -[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) +[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csgrouppolicyassignment) -[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/MicrosoftTeams/New-CsHybridTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/New-CsHybridTelephoneNumber.md new file mode 100644 index 0000000000..a2b32aed21 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/New-CsHybridTelephoneNumber.md @@ -0,0 +1,222 @@ +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cshybridtelephonenumber +schema: 2.0.0 +title: New-CsHybridTelephoneNumber +--- + +# New-CsHybridTelephoneNumber + +## SYNOPSIS +This cmdlet adds a hybrid telephone number to the tenant. + +## SYNTAX + +### New (Default) +``` +New-CsHybridTelephoneNumber -TelephoneNumber [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### NewViaIdentity +``` +New-CsHybridTelephoneNumber -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet adds a hybrid telephone number to the tenant that can be used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the **New-CsOnlineDirectRoutingTelephoneNumberUploadOrder** cmdlet to add a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md). + +## EXAMPLES + +### Example 1 +```powershell +New-CsHybridTelephoneNumber -TelephoneNumber +14025551234 +``` +This example adds the hybrid phone number +1 (402) 555-1234. + +## PARAMETERS + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The identity parameter. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: NewViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +The telephone number to add. The number should be specified with a prefixed "+". The phone number can't have "tel:" prefixed. + +```yaml +Type: System.String +Parameter Sets: New +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES + +The cmdlet is only available in GCC High and DoD cloud instances. + +## RELATED LINKS +[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cshybridtelephonenumber) + +[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/get-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/New-CsInboundBlockedNumberPattern.md similarity index 90% rename from teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/New-CsInboundBlockedNumberPattern.md index ba2c63af2f..39ac70988a 100644 --- a/teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern applicable: Microsoft Teams -title: New-CsInboundBlockedNumberPattern author: serdarsoysal -ms.author: serdars -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundblockednumberpattern schema: 2.0.0 +title: New-CsInboundBlockedNumberPattern --- # New-CsInboundBlockedNumberPattern @@ -43,6 +44,21 @@ This example adds a blocked number pattern to block inbound calls from +11234567 ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description A friendly description for the blocked number pattern to be created. @@ -134,21 +150,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -164,8 +165,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundblockednumberpattern) -[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundblockednumberpattern) -[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/New-CsInboundExemptNumberPattern.md similarity index 82% rename from teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/New-CsInboundExemptNumberPattern.md index 63ed383946..1a0523d778 100644 --- a/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern applicable: Microsoft Teams -title: New-CsInboundExemptNumberPattern -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundexemptnumberpattern +schema: 2.0.0 +title: New-CsInboundExemptNumberPattern --- # New-CsInboundExemptNumberPattern @@ -20,7 +20,7 @@ This cmdlet lets you configure a new number pattern that is exempt from tenant c ### Identity (Default) -```powershell +``` New-CsInboundExemptNumberPattern -Identity -Pattern [-Description ] [-Enabled ] [-WhatIf] [-Confirm] [] ``` @@ -30,6 +30,8 @@ New-CsInboundExemptNumberPattern -Identity -Pattern [-Descript New-CsInboundExemptNumberPattern -Pattern -Name [-Description ] [-Enabled ] [-WhatIf] [-Confirm] [] ``` +## DESCRIPTION +The `New-CsInboundExemptNumberPattern` cmdlet creates a new inbound exempt number pattern that allows specific phone numbers to bypass tenant call blocking. This is useful for ensuring that important numbers, such as emergency services or critical business contacts, are not inadvertently blocked by the tenant's call blocking policies. ## EXAMPLES @@ -43,6 +45,22 @@ Creates a new inbound exempt number pattern for the numbers 1 (312) 555-88882 an ## PARAMETERS +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Sets the description of the number pattern. @@ -136,22 +154,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -166,12 +168,12 @@ You can use Test-CsInboundBlockedNumberPattern to test your block and exempt pho ## RELATED LINKS -[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundexemptnumberpattern) -[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundexemptnumberpattern) -[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) -[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstance.md similarity index 85% rename from teams/teams-ps/teams/New-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstance.md index 0254f15626..cb4af42e4e 100644 --- a/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance applicable: Microsoft Teams -title: New-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance +schema: 2.0.0 +title: New-CsOnlineApplicationInstance --- # New-CsOnlineApplicationInstance @@ -26,7 +27,7 @@ This cmdlet is used to create an application instance in Microsoft Entra ID. Thi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell New-CsOnlineApplicationInstance -UserPrincipalName appinstance01@contoso.com -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" ``` @@ -35,46 +36,52 @@ This example creates a new application instance for an Auto Attendant with UserP ## PARAMETERS -### -UserPrincipalName -The user principal name. It will be used as the SIP URI too. The user principal name should have an online domain. +### -ApplicationId + +> Applicable: Microsoft Teams + +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml -Type: System.String +Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Microsoft Teams + The display name. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -84,13 +91,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -99,31 +108,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -UserPrincipalName + +> Applicable: Microsoft Teams + +The user principal name. It will be used as the SIP URI too. The user principal name should have an online domain. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -143,10 +156,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstance) -[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) -[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/sync-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation.md similarity index 91% rename from teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation.md index 9cc704f634..9488c48f99 100644 --- a/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation applicable: Microsoft Teams -title: New-CsOnlineApplicationInstanceAssociation -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation +schema: 2.0.0 +title: New-CsOnlineApplicationInstanceAssociation --- # New-CsOnlineApplicationInstanceAssociation @@ -28,7 +30,7 @@ You can get the Identity of the application instance from the ObjectId of the AD ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $applicationInstanceId = (Get-CsOnlineUser "main_auto_attendant@contoso.com").ObjectId # 76afc66a-5fe9-4a3d-ab7a-37c0e37b1f19 $autoAttendantId = (Get-CsAutoAttendant -NameFilter "Main Auto Attendant").Id # c2ee3e18-b738-5515-a97b-46be52dfc057 @@ -57,7 +59,7 @@ Get-CsAutoAttendant -Identity $autoAttendantId This example creates an association between an application instance that we have already created with UPN "main_auto_attendant@contoso.com" whose identity is "76afc66a-5fe9-4a3d-ab7a-37c0e37b1f19", and an auto attendant configuration that we created with display name "Main Auto Attendant" whose identity is "c2ee3e18-b738-5515-a97b-46be52dfc057". Once the association is created, the newly associated application instance would be listed under the `ApplicationInstances` property of the AA. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $applicationInstancesIdentities = (Find-CsOnlineApplicationInstance -SearchQuery "tel:+1206") | Select-Object -Property Id @@ -93,7 +95,7 @@ Get-CsAutoAttendant -Identity $autoAttendantId This example creates an association between multiple application instances that we had created before and to which we assigned phone numbers starting with "tel:+1206", and an auto attendant configuration that we created with display name "Main Auto Attendant" whose identity is "c2ee3e18-b738-5515-a97b-46be52dfc057". Once the associations are created, the newly associated application instances would listed under the `ApplicationInstances` property of the AA. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $applicationInstancesIdentities = (Find-CsOnlineApplicationInstance -SearchQuery "Main Auto Attendant") | Select-Object -Property Id @@ -112,30 +114,42 @@ This example creates an association between multiple application instances that ## PARAMETERS -### -Identities -The Identities parameter is the identities of application instances to be associated with the provided configuration ID. +### -CallPriority + +> Applicable: Microsoft Teams + +The call priority assigned to calls arriving on this application instance if a priority has not already been assigned. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 + +1 = Very High +2 = High +3 = Normal / Default +4 = Low +5 = Very Low ```yaml -Type: System.String[] +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: 3 Accept pipeline input: False Accept wildcard characters: False ``` ### -ConfigurationId + +> Applicable: Microsoft Teams + The ConfigurationId parameter is the identity of the configuration that would be associated with the provided application instances. ```yaml Type: System.string Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -145,6 +159,9 @@ Accept wildcard characters: False ``` ### -ConfigurationType + +> Applicable: Microsoft Teams + The ConfigurationType parameter denotes the type of the configuration that would be associated with the provided application instances. It can be one of two values: @@ -156,7 +173,6 @@ It can be one of two values: Type: System.string Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -165,37 +181,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallPriority -The call priority assigned to calls arriving on this application instance if a priority has not already been assigned. +### -Identities -PARAMVALUE: 1 | 2 | 3 | 4 | 5 +> Applicable: Microsoft Teams -1 = Very High -2 = High -3 = Normal / Default -4 = Low -5 = Very Low +The Identities parameter is the identities of application instances to be associated with the provided configuration ID. ```yaml -Type: Int16 +Type: System.String[] Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -219,8 +230,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation) -[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus) -[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineAudioConferencingRoutingPolicy.md similarity index 92% rename from teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineAudioConferencingRoutingPolicy.md index f38c088398..d26c74dde3 100644 --- a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,177 +1,178 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy -title: New-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# New-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet creates a Online Audio Conferencing Routing Policy. - -## SYNTAX - -```powershell -New-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-Description ] - [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. - -To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." - -The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. - -Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-CsOnlineAudioConferencingRoutingPolicy -Identity Test -``` - -Creates a new Online Audio Conferencing Routing Policy policy with an identity called "Test". - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Identity of the Online Audio Conferencing Routing Policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnlinePstnUsages - -A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteType - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) -[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) -[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) -[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: New-CsOnlineAudioConferencingRoutingPolicy +--- + +# New-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet creates a Online Audio Conferencing Routing Policy. + +## SYNTAX + +```powershell +New-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-Description ] + [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsOnlineAudioConferencingRoutingPolicy -Identity Test +``` + +Creates a new Online Audio Conferencing Routing Policy policy with an identity called "Test". + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnUsages + +A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/New-CsOnlineDateTimeRange.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDateTimeRange.md similarity index 90% rename from teams/teams-ps/teams/New-CsOnlineDateTimeRange.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineDateTimeRange.md index ad73e8f554..82f7121083 100644 --- a/teams/teams-ps/teams/New-CsOnlineDateTimeRange.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDateTimeRange.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange applicable: Microsoft Teams -title: New-CsOnlineDateTimeRange -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedatetimerange +schema: 2.0.0 +title: New-CsOnlineDateTimeRange --- # New-CsOnlineDateTimeRange @@ -50,34 +52,38 @@ This example creates a date-time range spanning from December 24, 2017 9AM to De ## PARAMETERS -### -Start -The Start parameter represents the start bound of the date-time range. +### -End + +> Applicable: Microsoft Teams + +The End parameter represents the end bound of the date-time range. + +If not present, the end bound of the date time range is set to 00:00 of the day after the start date. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -End -The End parameter represents the end bound of the date-time range. +### -Start -If not present, the end bound of the date time range is set to 00:00 of the day after the start date. +> Applicable: Microsoft Teams + +The Start parameter represents the start bound of the date-time range. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -86,11 +92,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -114,4 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) diff --git a/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md similarity index 91% rename from teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md index b7d52913b8..680bffd86a 100644 --- a/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder applicable: Microsoft Teams -title: New-CsOnlineDirectRoutingTelephoneNumberUploadOrder author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedirectroutingtelephonenumberuploadorder schema: 2.0.0 +title: New-CsOnlineDirectRoutingTelephoneNumberUploadOrder --- # New-CsOnlineDirectRoutingTelephoneNumberUploadOrder ## SYNOPSIS -This cmdlet creates a request to upload Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. The output of the cmdlet is the "orderId" of the asynchronous Direct Routing Number creation operation. A maximum of 10,000 phone numbers can be uploaded at a time. If more than 10,000 numbers need to be uploaded, the requests should be divided into multiple increments of up to 10,000 numbers. +This cmdlet creates a request to upload Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. ## SYNTAX @@ -23,7 +24,7 @@ New-CsOnlineDirectRoutingTelephoneNumberUploadOrder [-TelephoneNumber ] ``` ## DESCRIPTION -This cmdlet uploads Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. Once uploaded the phone numbers will be visible in Teams PowerShell as acquired Direct Routing phone numbers. +This cmdlet uploads Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. Once uploaded the phone numbers will be visible in Teams PowerShell as acquired Direct Routing phone numbers. The output of the cmdlet is the "orderId" of the asynchronous Direct Routing Number creation operation. A maximum of 10,000 phone numbers can be uploaded at a time. If more than 10,000 numbers need to be uploaded, the requests should be divided into multiple increments of up to 10,000 numbers. The cmdlet is an asynchronous operation and will return an OrderId as output. You can use the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to check the status of the OrderId, including any error or warning messages that might result from the operation: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. @@ -64,8 +65,8 @@ In this example, the content of a file with a list of Direct Routing telephone n ## PARAMETERS -### -TelephoneNumber -This is the Direct Routing telephone numbers you wish to upload to Microsoft Teams telephone number management inventory. It is comma delimited list of one or more Direct Routing telephone numbers. +### -EndingNumber +This is the ending number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. ```yaml Type: String @@ -79,11 +80,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartingNumber -This is the starting number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. +### -FileContent +This is the content of a .csv file that includes the Direct Routing telephone numbers to be uploaded to the Microsoft Teams telephone number management inventory. This parameter can be used to upload up to 10,000 numbers at a time. ```yaml -Type: String +Type: Byte[] Parameter Sets: (All) Aliases: @@ -94,8 +95,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EndingNumber -This is the ending number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. +### -StartingNumber +This is the starting number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. ```yaml Type: String @@ -109,11 +110,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileContent -This is the content of a .csv file that includes the Direct Routing telephone numbers to be uploaded to the Microsoft Teams telephone number management inventory. This parameter can be used to upload up to 10,000 numbers at a time. +### -TelephoneNumber +This is the Direct Routing telephone numbers you wish to upload to Microsoft Teams telephone number management inventory. It is comma delimited list of one or more Direct Routing telephone numbers. ```yaml -Type: Byte[] +Type: String Parameter Sets: (All) Aliases: @@ -142,4 +143,4 @@ The cmdlet is only available in commercial and GCC cloud instances. ## RELATED LINKS [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) -[New-CsOnlineTelephoneNumberReleaseOrder](./new-csonlinetelephonenumberreleaseorder.md) \ No newline at end of file +[New-CsOnlineTelephoneNumberReleaseOrder](./new-csonlinetelephonenumberreleaseorder.md) diff --git a/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisCivicAddress.md similarity index 91% rename from teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineLisCivicAddress.md index 18fa5f7f05..678cedff32 100644 --- a/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisCivicAddress.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: New-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineliscivicaddress +schema: 2.0.0 +title: New-CsOnlineLisCivicAddress --- # New-CsOnlineLisCivicAddress @@ -75,31 +75,52 @@ This example creates a new civic address described as "West Coast Headquarters": ## PARAMETERS -### -CompanyName -Specifies the name of your organization. +### -City + +> Applicable: Microsoft Teams + +Specifies the city of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CountryOrRegion -Specifies the country or region of the new civic address. -Needs to be a valid country code as contained in the ISO 3166-1 alpha-2 specification. +### -CityAlias + +> Applicable: Microsoft Teams + +Specifies the city alias of the new civic address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName + +> Applicable: Microsoft Teams + +Specifies the name of your organization. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -108,14 +129,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -City -Specifies the city of the new civic address. +### -CompanyTaxId + +> Applicable: Microsoft Teams + +Specifies the company tax identifier of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -124,14 +147,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias -Specifies the city alias of the new civic address. +### -Confidence +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -140,16 +162,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CompanyTaxId -Specifies the company tax identifier of the new civic address. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryOrRegion + +> Applicable: Microsoft Teams + +Specifies the country or region of the new civic address. +Needs to be a valid country code as contained in the ISO 3166-1 alpha-2 specification. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -157,13 +200,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -173,6 +218,9 @@ Accept wildcard characters: False ``` ### -Elin + +> Applicable: Microsoft Teams + Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. @@ -180,7 +228,6 @@ This is used in Direct Routing EGW scenarios. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -190,6 +237,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -198,7 +248,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -208,13 +257,15 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Microsoft Teams + Specifies the numeric portion of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -224,6 +275,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Microsoft Teams + Specifies the numeric suffix of the new civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". @@ -231,7 +285,21 @@ For example, if the property was multiplexed, the HouseNumberSuffix parameter wo Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAzureMapValidationRequired +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -241,13 +309,15 @@ Accept wildcard characters: False ``` ### -Latitude + +> Applicable: Microsoft Teams + Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. Required for all countries except Australia and Japan where it's optional. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -257,13 +327,15 @@ Accept wildcard characters: False ``` ### -Longitude + +> Applicable: Microsoft Teams + Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. Required for all countries except Australia and Japan where it's optional. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -273,13 +345,15 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Microsoft Teams + Specifies the postal code of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -289,6 +363,9 @@ Accept wildcard characters: False ``` ### -PostDirectional + +> Applicable: Microsoft Teams + Specifies the directional attribute of the new civic address which follows the street name. For example, "425 Smith Avenue NE". @@ -296,7 +373,6 @@ For example, "425 Smith Avenue NE". Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -306,6 +382,9 @@ Accept wildcard characters: False ``` ### -PreDirectional + +> Applicable: Microsoft Teams + Specifies the directional attribute of the new civic address which precedes the street name. For example, "425 NE Smith Avenue". @@ -313,7 +392,6 @@ For example, "425 NE Smith Avenue". Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -323,13 +401,15 @@ Accept wildcard characters: False ``` ### -StateOrProvince + +> Applicable: Microsoft Teams + Specifies the state or province of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -339,30 +419,15 @@ Accept wildcard characters: False ``` ### -StreetName -Specifies the street name of the new civic address. -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetSuffix -Specifies the street type of the new civic address. -The street suffix will typically be something like street, avenue, way, or boulevard. +Specifies the street name of the new civic address. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -371,23 +436,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confidence -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +### -StreetSuffix -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -IsAzureMapValidationRequired -This parameter is reserved for internal Microsoft use. +Specifies the street type of the new civic address. +The street suffix will typically be something like street, avenue, way, or boulevard. ```yaml Type: String @@ -417,6 +471,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -424,23 +481,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -460,8 +500,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliscivicaddress) -[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliscivicaddress) -[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/New-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisLocation.md similarity index 89% rename from teams/teams-ps/teams/New-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineLisLocation.md index 418b3f5aa2..9ba0a8210b 100644 --- a/teams/teams-ps/teams/New-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation applicable: Microsoft Teams -title: New-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinelislocation +schema: 2.0.0 +title: New-CsOnlineLisLocation --- # New-CsOnlineLisLocation @@ -34,48 +35,56 @@ This example creates a new location called "Office 101, 1st Floor" in the civic ## PARAMETERS -### -CivicAddressId -Specifies the unique identifier of the civic address that will contain the new location. Civic address identities can be discovered by using the Get-CsOnlineLisCivicAddress cmdlet. +### -City + +> Applicable: Microsoft Teams + +Specifies the city of the civic address. + +**Note:** This parameter is not supported and is deprecated. ```yaml -Type: Guid -Parameter Sets: (All) +Type: String +Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -Location -Specifies an administrator-defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". +### -CityAlias + +> Applicable: Microsoft Teams + +Specifies the city alias. + +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -CountryOrRegion -Specifies the country or region of the civic address. +### -CivicAddressId -**Note:** This parameter is not supported and is deprecated. +> Applicable: Microsoft Teams + +Specifies the unique identifier of the civic address that will contain the new location. Civic address identities can be discovered by using the Get-CsOnlineLisCivicAddress cmdlet. ```yaml -Type: String -Parameter Sets: CreateCivicAddress -Aliases: Country -Applicable: Microsoft Teams +Type: Guid +Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -84,26 +93,31 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -City -Specifies the city of the civic address. +### -CompanyName + +> Applicable: Microsoft Teams + +Specifies the name of your organization. **Note:** This parameter is not supported and is deprecated. ```yaml Type: String -Parameter Sets: CreateCivicAddress -Aliases: -Applicable: Microsoft Teams +Parameter Sets: (All) +Aliases: Name Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias -Specifies the city alias. +### -CompanyTaxId + +> Applicable: Microsoft Teams + +The company tax ID. **Note:** This parameter is not supported and is deprecated. @@ -111,7 +125,6 @@ Specifies the city alias. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -120,16 +133,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -CompanyName -Specifies the name of your organization. +### -Confidence -**Note:** This parameter is not supported and is deprecated. +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: Name -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -138,41 +151,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CompanyTaxId -The company tax ID. +### -Confirm -**Note:** This parameter is not supported and is deprecated. +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: None -Accept pipeline input: True +Default value: False +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confidence -This parameter is reserved for internal Microsoft use. +### -CountryOrRegion + +> Applicable: Microsoft Teams + +Specifies the country or region of the civic address. + +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Parameter Sets: CreateCivicAddress +Aliases: Country -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -181,7 +201,6 @@ Specifies an administrator defined description of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -191,13 +210,33 @@ Accept wildcard characters: False ``` ### -Elin + +> Applicable: Microsoft Teams + Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Microsoft Teams + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -207,6 +246,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Microsoft Teams + Specifies the numeric portion of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -215,7 +257,6 @@ Specifies the numeric portion of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -225,6 +266,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Microsoft Teams + Specifies the numeric suffix of the civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". @@ -234,7 +278,6 @@ For example, if the property was multiplexed, the HouseNumberSuffix parameter wo Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -244,6 +287,9 @@ Accept wildcard characters: False ``` ### -Latitude + +> Applicable: Microsoft Teams + Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. **Note:** This parameter is not supported and is deprecated. @@ -252,7 +298,6 @@ Specifies the angular distance of a place north or south of the earth's equator Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -261,7 +306,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Location + +> Applicable: Microsoft Teams + +Specifies an administrator-defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Longitude + +> Applicable: Microsoft Teams + Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. **Note:** This parameter is not supported and is deprecated. @@ -270,7 +336,6 @@ Specifies the angular distance of a place east or west of the meridian at Greenw Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -280,6 +345,9 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Microsoft Teams + Specifies the postal code of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -288,7 +356,6 @@ Specifies the postal code of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -298,6 +365,9 @@ Accept wildcard characters: False ``` ### -PostDirectional + +> Applicable: Microsoft Teams + Specifies the directional attribute of the civic address which follows the street name. For example, "425 Smith Avenue NE". **Note:** This parameter is not supported and is deprecated. @@ -306,7 +376,6 @@ Specifies the directional attribute of the civic address which follows the stree Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -316,6 +385,9 @@ Accept wildcard characters: False ``` ### -PreDirectional + +> Applicable: Microsoft Teams + Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue". **Note:** This parameter is not supported and is deprecated. @@ -324,7 +396,6 @@ Specifies the directional attribute of the civic address which precedes the stre Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -334,6 +405,9 @@ Accept wildcard characters: False ``` ### -StateOrProvince + +> Applicable: Microsoft Teams + Specifies the state or province of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -342,7 +416,6 @@ Specifies the state or province of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: State -Applicable: Microsoft Teams Required: False Position: Named @@ -352,6 +425,9 @@ Accept wildcard characters: False ``` ### -StreetName + +> Applicable: Microsoft Teams + Specifies the street name of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -360,7 +436,6 @@ Specifies the street name of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -370,6 +445,9 @@ Accept wildcard characters: False ``` ### -StreetSuffix + +> Applicable: Microsoft Teams + Specifies the modifier of the street name. The street suffix will typically be something like street, avenue, way, or boulevard. **Note:** This parameter is not supported and is deprecated. @@ -378,7 +456,6 @@ Specifies the modifier of the street name. The street suffix will typically be s Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -388,6 +465,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -395,7 +475,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -404,38 +483,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -447,8 +494,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelislocation) -[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelislocation) -[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelislocation) diff --git a/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlinePSTNGateway.md similarity index 94% rename from teams/teams-ps/teams/New-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlinePSTNGateway.md index 0eba7e7d17..f59a9f0973 100644 --- a/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlinePSTNGateway.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway applicable: Microsoft Teams -title: New-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinepstngateway +schema: 2.0.0 +title: New-CsOnlinePSTNGateway --- # New-CsOnlinePSTNGateway @@ -96,52 +98,6 @@ This example creates an SBC with FQDN sbc.contoso.com and signaling port 5061. F ## PARAMETERS -### -Identity -When creating a new SBC, the identity must be identical to the -FQDN parameter, described above. If the parameter is not defined the Identity will be copied from the -FQDN parameter. The Identity parameter is not mandatory. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fqdn -Limited to 63 characters, the FQDN registered for the SBC. Copied automatically to Identity of the SBC field. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SipSignalingPort -Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. Must be value between 1 and 65535. -Please note: Spelling of this parameter changed recently from SipSignallingPort to SipSignalingPort. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -BypassMode Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle. @@ -157,13 +113,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -172,13 +130,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Free-format string to describe the gateway. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -187,13 +147,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Microsoft Teams + Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC from service while it is being updated or during maintenance. Note if the parameter is not set the SBC will be created as disabled (default value -Enabled $false). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -202,6 +164,9 @@ Accept wildcard characters: False ``` ### -FailoverResponseCodes + +> Applicable: Microsoft Teams + If Direct Routing receives any 4xx or 6xx SIP error code in response to an outgoing Invite the call is considered completed by default. (Outgoing in this context is a call from a Teams client to the PSTN with traffic flow: Teams Client -> Direct Routing -> SBC -> Telephony network). Setting the SIP codes in this parameter forces Direct Routing on receiving the specified codes try another SBC (if another SBC exists in the voice routing policy of the user). Find more information in the "Reference" section of "Phone @@ -213,7 +178,6 @@ Setting this parameter overwrites the default values, so if you want to include Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 408, 503, 504 @@ -222,13 +186,15 @@ Accept wildcard characters: False ``` ### -FailoverTimeSeconds + +> Applicable: Microsoft Teams + When set to 10 (default value), outbound calls that are not answered by the gateway within 10 seconds are routed to the next available trunk; if there are no additional trunks, then the call is automatically dropped. In an organization with slow networks and slow gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 10 @@ -237,13 +203,15 @@ Accept wildcard characters: False ``` ### -ForwardCallHistory + +> Applicable: Microsoft Teams + Indicates whether call history information will be forwarded to the SBC. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -252,13 +220,49 @@ Accept wildcard characters: False ``` ### -ForwardPai + +> Applicable: Microsoft Teams + Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False). Setting this parameter to $true will render the from header anonymous, in accordance of RFC5379 and RFC3325. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams +Required: False +Position: Named +Default value: $false +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn + +> Applicable: Microsoft Teams + +Limited to 63 characters, the FQDN registered for the SBC. Copied automatically to Identity of the SBC field. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayLbrEnabledUserOverride + +> Applicable: Microsoft Teams + +Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: $false @@ -267,13 +271,15 @@ Accept wildcard characters: False ``` ### -GatewaySiteId + +> Applicable: Microsoft Teams + PSTN Gateway Site Id. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -282,6 +288,9 @@ Accept wildcard characters: False ``` ### -GatewaySiteLbrEnabled + +> Applicable: Microsoft Teams + Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is enabled ($True), the SBC will report the site name as defined by the tenant administrator. On an incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False). @@ -290,7 +299,6 @@ the user to make a routing decision. The parameter is mandatory for enabling Loc Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -298,23 +306,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewayLbrEnabledUserOverride -Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. +### -Identity + +> Applicable: Microsoft Teams + +When creating a new SBC, the identity must be identical to the -FQDN parameter, described above. If the parameter is not defined the Identity will be copied from the -FQDN parameter. The Identity parameter is not mandatory. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: $false +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundTeamsNumberTranslationRules -This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. +### -InboundPSTNNumberTranslationRules +Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. ```yaml Type: Object @@ -327,8 +337,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundPSTNNumberTranslationRules -Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. +### -InboundTeamsNumberTranslationRules +This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. ```yaml Type: Object @@ -356,13 +366,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentSessions + +> Applicable: Microsoft Teams + Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent sessions is 90% or higher than this value. If the parameter is not set, alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -371,13 +383,15 @@ Accept wildcard characters: False ``` ### -MediaBypass + +> Applicable: Microsoft Teams + Parameter indicates if the SBC supports Media Bypass and the administrator wants to use it for this SBC. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -386,13 +400,15 @@ Accept wildcard characters: False ``` ### -MediaRelayRoutingLocationOverride + +> Applicable: Microsoft Teams + Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -429,13 +445,15 @@ Accept wildcard characters: False ``` ### -PidfloSupported + +> Applicable: Microsoft Teams + Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -444,13 +462,15 @@ Accept wildcard characters: False ``` ### -ProxySbc + +> Applicable: Microsoft Teams + The FQDN of the proxy SBC. Used in Local Media Optimization configurations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -459,13 +479,15 @@ Accept wildcard characters: False ``` ### -SendSipOptions + +> Applicable: Microsoft Teams + Defines if an SBC will or will not send SIP Options messages. If disabled, the SBC will be excluded from the Monitoring and Alerting system. We highly recommend that you enable SIP Options. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $true @@ -473,7 +495,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SipSignalingPort + +> Applicable: Microsoft Teams + +Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. Must be value between 1 and 65535. +Please note: Spelling of this parameter changed recently from SipSignallingPort to SipSignalingPort. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -481,7 +524,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -504,8 +546,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstngateway) -[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstngateway) -[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinepstngateway) diff --git a/teams/teams-ps/teams/New-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineSchedule.md similarity index 88% rename from teams/teams-ps/teams/New-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineSchedule.md index 321a1e96c4..bfb80eadf7 100644 --- a/teams/teams-ps/teams/New-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule applicable: Microsoft Teams -title: New-CsOnlineSchedule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule +schema: 2.0.0 +title: New-CsOnlineSchedule --- # New-CsOnlineSchedule @@ -41,11 +43,11 @@ The New-CsOnlineSchedule cmdlet creates a new schedule for the Auto Attendant (A - For a fixed schedule, at most 10 date-time ranges can be specified. - You can create a new date-time range for a fixed schedule by using the New-CsOnlineDateTimeRange cmdlet. - The return type of this cmdlet composes a member for the underlying type/implementation. For example, in case of the weekly recurrent schedule, you can modify Monday's time ranges through the Schedule.WeeklyRecurrentSchedule.MondayHours property. Similarly, date-time ranges of a fixed schedule can be modified by using the Schedule.FixedSchedule.DateTimeRanges property. -- Schedules can then be used by [New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation). +- Schedules can then be used by [New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation). ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00 $tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00 @@ -54,7 +56,7 @@ $businessHours = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSch This example creates a weekly recurrent schedule that is active on Monday-Friday from 9AM-12PM and 1PM-5PM. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00 $tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00 @@ -63,7 +65,7 @@ $afterHours = New-CsOnlineSchedule -Name " After Hours" -WeeklyRecurrentSchedule This example creates a weekly recurrent schedule that is active at all times except Monday-Friday, 9AM-12PM and 1PM-5PM. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" $christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) @@ -71,7 +73,7 @@ $christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -Date This example creates a fixed schedule that is active from December 24, 2017 to December 26, 2017. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell $dtr1 = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" $dtr2 = New-CsOnlineDateTimeRange -Start "24/12/2018" -End "26/12/2018" @@ -80,7 +82,7 @@ $christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -Date This example creates a fixed schedule that is active from December 24, 2017 to December 26, 2017 and then from December 24, 2018 to December 26, 2018. -### -------------------------- Example 5 -------------------------- +### Example 5 ```powershell $notInEffectSchedule = New-CsOnlineSchedule -Name "NotInEffect" -FixedSchedule ``` @@ -89,62 +91,72 @@ This example creates a fixed schedule that is never active. ## PARAMETERS -### -Name -The Name parameter represents a unique friendly name for the schedule. +### -Complement + +> Applicable: Microsoft Teams + +The Complement parameter indicates how the schedule is used. +When Complement is enabled, the schedule is used as the inverse of the provided configuration. +For example, if Complement is enabled and the schedule only contains time ranges of Monday to Friday from 9AM to 5PM, then the schedule is active at all times other than the specified time ranges. ```yaml -Type: System.String -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WeeklyRecurrentSchedule -The WeeklyRecurrentSchedule parameter indicates that a weekly recurrent schedule is to be created. This parameter is mandatory when a weekly recurrent schedule is to be created. +### -DateTimeRanges + +> Applicable: Microsoft Teams + +List of date-time ranges for a fixed schedule. At most, 10 date-time ranges can be specified using this parameter. ```yaml -Type: SwitchParameter -Parameter Sets: WeeklyRecurrentSchedule +Type: System.Collections.Generic.List +Parameter Sets: FixedSchedule Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MondayHours -List of time ranges for that day. +### -FixedSchedule + +> Applicable: Microsoft Teams + +The FixedSchedule parameter indicates that a fixed schedule is to be created. ```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule +Type: SwitchParameter +Parameter Sets: FixedSchedule Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TuesdayHours +### -FridayHours + +> Applicable: Microsoft Teams + List of time ranges for that day. ```yaml Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -153,14 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WednesdayHours +### -MondayHours + +> Applicable: Microsoft Teams + List of time ranges for that day. ```yaml Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -169,30 +183,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ThursdayHours -List of time ranges for that day. +### -Name + +> Applicable: Microsoft Teams + +The Name parameter represents a unique friendly name for the schedule. ```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule +Type: System.String +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -FridayHours +### -SaturdayHours + +> Applicable: Microsoft Teams + List of time ranges for that day. ```yaml Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -201,14 +219,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SaturdayHours +### -SundayHours + +> Applicable: Microsoft Teams + List of time ranges for that day. ```yaml Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -217,14 +237,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SundayHours -List of time ranges for that day. +### -Tenant + +> Applicable: Microsoft Teams ```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule +Type: System.Guid +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -233,16 +253,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Complement -The Complement parameter indicates how the schedule is used. -When Complement is enabled, the schedule is used as the inverse of the provided configuration. -For example, if Complement is enabled and the schedule only contains time ranges of Monday to Friday from 9AM to 5PM, then the schedule is active at all times other than the specified time ranges. +### -ThursdayHours + +> Applicable: Microsoft Teams + +List of time ranges for that day. ```yaml -Type: SwitchParameter +Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -251,30 +271,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FixedSchedule -The FixedSchedule parameter indicates that a fixed schedule is to be created. +### -TuesdayHours + +> Applicable: Microsoft Teams + +List of time ranges for that day. ```yaml -Type: SwitchParameter -Parameter Sets: FixedSchedule +Type: System.Collections.Generic.List +Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DateTimeRanges -List of date-time ranges for a fixed schedule. At most, 10 date-time ranges can be specified using this parameter. +### -WednesdayHours + +> Applicable: Microsoft Teams + +List of time ranges for that day. ```yaml Type: System.Collections.Generic.List -Parameter Sets: FixedSchedule +Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -283,15 +307,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -WeeklyRecurrentSchedule + +> Applicable: Microsoft Teams + +The WeeklyRecurrentSchedule parameter indicates that a weekly recurrent schedule is to be created. This parameter is mandatory when a weekly recurrent schedule is to be created. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: WeeklyRecurrentSchedule Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -313,12 +340,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange) +[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetimerange) -[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange) +[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinedatetimerange) -[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallflow) -[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation) +[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation) -[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendant) diff --git a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberOrder.md similarity index 93% rename from teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberOrder.md index e60b5f483c..5bf5e73814 100644 --- a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberOrder.md @@ -1,13 +1,14 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: New-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder +schema: 2.0.0 +title: New-CsOnlineTelephoneNumberOrder --- # New-CsOnlineTelephoneNumberOrder @@ -35,7 +36,7 @@ Telephone numbers can be created with 3 ways: ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 1" -Description "Civic address search example" -Country "US" -NumberType "UserSubscriber" -Quantity 1 -CivicAddressId 3b175352-4131-431e-970c-273226b8fb46 PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId @@ -68,7 +69,7 @@ New York City +17182000004 This example demonstrates a civic address based telephone number search. Telephone number +17182000004 is found to belong to the given address and is reserved for purchase. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 2" -Description "Number prefix search example" -Country "US" -NumberType "UserSubscriber" -Quantity 1 -NumberPrefix 1425 PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId @@ -101,7 +102,7 @@ Bellevue +14252000004 This example demonstrates a number prefix based telephone number search. Telephone number +14252000004 is found to have the desired number prefix and is reserved for purchase. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 3" -Description "Area code selection search example" -Country "US" -NumberType "ConferenceTollFree" -Quantity 1 -AreaCode 800 PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId @@ -267,10 +268,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumbertype) -[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) -[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) -[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) -[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberReleaseOrder.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberReleaseOrder.md new file mode 100644 index 0000000000..8e87bbbe17 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberReleaseOrder.md @@ -0,0 +1,179 @@ +--- +applicable: Microsoft Teams +author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +ms.reviewer: pavellatif +online version: online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-csonlinetelephonenumberreleaseorder +schema: 2.0.0 +title: New-CsOnlineTelephoneNumberReleaseOrder +--- + +# New-CsOnlineTelephoneNumberReleaseOrder + +## SYNOPSIS + +This cmdlet creates a request to release telephone numbers from Microsoft Teams telephone number +management inventory. + +## SYNTAX + +``` +New-CsOnlineTelephoneNumberReleaseOrder [-TelephoneNumber ] [-StartingNumber ] + [-EndingNumber ] [-FileContent ] [] +``` + +## DESCRIPTION + +This cmdlet releases existing telephone numbers from Microsoft Teams telephone number management +inventory. Once released the phone numbers will not be visible in Teams PowerShell as acquired +telephone numbers. A maximum of 1,000 phone numbers can be released at a time. If more than 1,000 +numbers need to be released, the requests should be divided into multiple increments of up to 1,000 +numbers. + +The cmdlet is an asynchronous operation and will return an OrderId as output. You can use the +[Get-CsOnlineTelephoneNumberOrder](get-csonlinetelephonenumberorder.md) +cmdlet to check the status of the OrderId, including any error or warning messages that might result +from the operation: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a telephone number "+123456789" is being released from Microsoft Teams telephone +number management inventory. + +### Example 2 + +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789,+134567890,+145678901" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a list of telephone numbers are being released from Microsoft Teams telephone +number management. + +### Example 3 + +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -StartingNumber "+12000000" -EndingNumber "+12000009" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a range of telephone numbers from "+12000000" to "+12000009" are being released from Microsoft Teams telephone number management. + +### Example 4 + +```powershell +PS C:\> $drlist = [System.IO.File]::ReadAllBytes("C:\Users\testuser\DrNumber.csv") +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -FileContent $drlist +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, the content of a file with a list of telephone numbers are being released via file upload. The file should be in Comma Separated Values (CSV) file format and should only contain the list of telephone numbers to be released. The `New-CsOnlineTelephoneNumberReleaseOrder` cmdlet is only used to pass the content. + +## PARAMETERS + +### -EndingNumber + +This is the ending number of a range of telephone number you wish to release from your tenant in +Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileContent + +This is the content of a .csv file that includes the telephone numbers to be released from the +Microsoft Teams telephone number management inventory. This parameter can be used to release up to +1,000 numbers at a time. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartingNumber + +This is the starting number of a range of telephone number you wish to release from your tenant in +Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +This is the telephone number you wish to release from your tenant in Microsoft Teams telephone +number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES + +The cmdlet is available in Teams PowerShell module 6.7.1 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS + +[Get-CsOnlineTelephoneNumberOrder](get-csonlinetelephonenumberorder.md) + +[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](new-csonlinedirectroutingtelephonenumberuploadorder.md) diff --git a/teams/teams-ps/teams/New-CsOnlineTimeRange.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTimeRange.md similarity index 87% rename from teams/teams-ps/teams/New-CsOnlineTimeRange.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineTimeRange.md index e331b4ffe5..adafda55ff 100644 --- a/teams/teams-ps/teams/New-CsOnlineTimeRange.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTimeRange.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange applicable: Microsoft Teams -title: New-CsOnlineTimeRange -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinetimerange +schema: 2.0.0 +title: New-CsOnlineTimeRange --- # New-CsOnlineTimeRange @@ -31,14 +33,14 @@ The New-CsOnlineTimeRange cmdlet creates a new time range to be used with the Au ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $workdayTimeRange = New-CsOnlineTimeRange -Start 09:00 -End 17:00 ``` This example creates a time range for a 9AM to 5PM work day. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $allDayTimeRange = New-CsOnlineTimeRange -Start 00:00 -End 1.00:00 ``` @@ -47,14 +49,16 @@ This example creates a 24-hour time range. ## PARAMETERS -### -Start -The Start parameter represents the start bound of the time range. +### -End + +> Applicable: Microsoft Teams + +The End parameter represents the end bound of the time range. ```yaml Type: System.TimeSpan Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -63,14 +67,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -End -The End parameter represents the end bound of the time range. +### -Start + +> Applicable: Microsoft Teams + +The Start parameter represents the start bound of the time range. ```yaml Type: System.TimeSpan Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -81,11 +87,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoute.md similarity index 92% rename from teams/teams-ps/teams/New-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoute.md index 270d9deed1..d5a88b867c 100644 --- a/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoute.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute applicable: Microsoft Teams -title: New-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroute +schema: 2.0.0 +title: New-CsOnlineVoiceRoute --- # New-CsOnlineVoiceRoute ## SYNOPSIS -Creates a new online voice route. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). +Creates a new online voice route. ## SYNTAX @@ -34,27 +35,29 @@ New-CsOnlineVoiceRoute [-BridgeSourcePhoneNumber ] [-Description New-CsOnlineVoiceRoute -Identity Route1 ``` The command in this example creates a new online voice route with an Identity of Route1. All other properties will be set to the default values. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> New-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{add="Long Distance"} -OnlinePstnGatewayList @{add="sbc1.litwareinc.com"} ``` The command in this example creates a new online voice route with an Identity of Route1. It also adds the online PSTN usage Long Distance to the list of usages and the service ID PstnGateway sbc1.litwareinc.com to the list of online PSTN gateways. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> $x = (Get-CsOnlinePstnUsage).Usage @@ -242,8 +245,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy.md similarity index 90% rename from teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy.md index a4646da2fa..65001aba92 100644 --- a/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: New-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: New-CsOnlineVoiceRoutingPolicy --- # New-CsOnlineVoiceRoutingPolicy @@ -30,14 +31,14 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> New-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages "Long Distance" ``` The command shown in Example 1 creates a new online per-user voice routing policy with the Identity RedmondOnlineVoiceRoutingPolicy. This policy is assigned a single online PSTN usage: Long Distance. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> New-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages "Long Distance", "Local", "Internal" ``` @@ -151,10 +152,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoicemailPolicy.md similarity index 75% rename from teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineVoicemailPolicy.md index 04a4f92099..9d6632e22d 100644 --- a/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoicemailPolicy.md @@ -1,35 +1,44 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy applicable: Microsoft Teams -title: New-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoicemailpolicy +schema: 2.0.0 +title: New-CsOnlineVoicemailPolicy --- # New-CsOnlineVoicemailPolicy ## SYNOPSIS -Creates a new Online Voicemail policy. Online Voicemail policies determine whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. +Creates a new Online Voicemail policy. ## SYNTAX ### Identity (Default) -```powershell -New-CsOnlineVoicemailPolicy [-Identity] [-EnableEditingCallAnswerRulesSetting ] [-EnableTranscription ] -[-EnableTranscriptionProfanityMasking ] [-EnableTranscriptionTranslation ] [-MaximumRecordingLength ] -[-PostAmbleAudioFile ] [-PreambleAudioFile ] [-PreamblePostambleMandatory ] -[-PrimarySystemPromptLanguage ] [-SecondarySystemPromptLanguage ] [-ShareData ] [-WhatIf] [-Confirm] [-Description ] [] +``` +New-CsOnlineVoicemailPolicy [-Identity] [-EnableEditingCallAnswerRulesSetting ] + [-EnableTranscription ] [-EnableTranscriptionProfanityMasking ] + [-EnableTranscriptionTranslation ] [-MaximumRecordingLength ] + [-PostAmbleAudioFile ] [-PreambleAudioFile ] + [-PreamblePostambleMandatory ] [-PrimarySystemPromptLanguage ] + [-SecondarySystemPromptLanguage ] [-ShareData ] [-WhatIf] [-Confirm] + [-Description ] [] ``` ## DESCRIPTION -Cloud Voicemail service provides organizations with voicemail deposit capabilities for Phone System implementation. +Cloud Voicemail service provides organizations with voicemail deposit capabilities for Phone System +implementation. -By default, users enabled for Phone System will be enabled for Cloud Voicemail. The Online Voicemail policy controls whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. +By default, users enabled for Phone System will be enabled for Cloud Voicemail. The Online Voicemail +policy controls whether or not voicemail transcription, profanity masking for the voicemail +transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings +are enabled for a user. The policies also specify the voicemail maximum recording length for a user +and the primary and secondary voicemail system prompt languages. - Voicemail transcription is enabled by default - Transcription profanity masking is disabled by default @@ -42,7 +51,7 @@ Tenant admin would be able to create a customized online voicemail policy to mat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" -MaximumRecordingLength ([TimeSpan]::FromSeconds(60)) ``` @@ -51,29 +60,50 @@ The command shown in Example 1 creates a per-user online voicemail policy Custom ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -EnableEditingCallAnswerRulesSetting + +> Applicable: Microsoft Teams + Controls if editing call answer rule settings are enabled or disabled for a user. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -83,13 +113,15 @@ Accept wildcard characters: False ``` ### -EnableTranscription + +> Applicable: Microsoft Teams + Allows you to disable or enable voicemail transcription. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -99,13 +131,15 @@ Accept wildcard characters: False ``` ### -EnableTranscriptionProfanityMasking + +> Applicable: Microsoft Teams + Allows you to disable or enable profanity masking for the voicemail transcriptions. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -115,13 +149,15 @@ Accept wildcard characters: False ``` ### -EnableTranscriptionTranslation + +> Applicable: Microsoft Teams + Allows you to disable or enable translation for the voicemail transcriptions. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -130,14 +166,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -MaximumRecordingLength + +> Applicable: Microsoft Teams + A duration of voicemail maximum recording length. The length should be between 30 seconds to 10 minutes. ```yaml Type: Duration Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -147,13 +202,15 @@ Accept wildcard characters: False ``` ### -PostambleAudioFile + +> Applicable: Microsoft Teams + The audio file to play to the caller after the user's voicemail greeting has played and before the caller is allowed to leave a voicemail message. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -162,13 +219,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -PreambleAudioFile + +> Applicable: Microsoft Teams + The audio file to play to the caller before the user's voicemail greeting is played. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -178,13 +237,15 @@ Accept wildcard characters: False ``` ### -PreamblePostambleMandatory + +> Applicable: Microsoft Teams + Is playing the Pre- or Post-amble mandatory before the caller can leave a message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -194,13 +255,15 @@ Accept wildcard characters: False ``` ### -PrimarySystemPromptLanguage -The primary (or first) language that voicemail system prompts will be presented in. Must also set SecondarySystemPromptLanguage. When set, this overrides the user language choice. Please see [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. + +> Applicable: Microsoft Teams + +The primary (or first) language that voicemail system prompts will be presented in. Must also set SecondarySystemPromptLanguage. When set, this overrides the user language choice. Please see [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -210,13 +273,15 @@ Accept wildcard characters: False ``` ### -SecondarySystemPromptLanguage -The secondary language that voicemail system prompts will be presented in. Must also set PrimarySystemPromptLanguage and may not be the same value as PrimarySystemPromptanguage. When set, this overrides the user language choice. Please see [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. + +> Applicable: Microsoft Teams + +The secondary language that voicemail system prompts will be presented in. Must also set PrimarySystemPromptLanguage and may not be the same value as PrimarySystemPromptanguage. When set, this overrides the user language choice. Please see [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -226,13 +291,15 @@ Accept wildcard characters: False ``` ### -ShareData + +> Applicable: Microsoft Teams + Specifies whether voicemail and transcription data are shared with the service for training and improving accuracy. Possible values are Defer and Deny. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -242,45 +309,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -299,10 +336,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md b/teams/teams-ps/MicrosoftTeams/New-CsSdgBulkSignInRequest.md similarity index 99% rename from teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md rename to teams/teams-ps/MicrosoftTeams/New-CsSdgBulkSignInRequest.md index 3c44267712..d2ec0a7383 100644 --- a/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsSdgBulkSignInRequest.md @@ -1,10 +1,10 @@ --- +applicable: Microsoft Teams external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -online version: -title: New-CsSdgBulkSignInRequest schema: 2.0.0 +title: New-CsSdgBulkSignInRequest --- # New-CsSdgBulkSignInRequest diff --git a/teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsSharedCallQueueHistoryTemplate.md similarity index 85% rename from teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsSharedCallQueueHistoryTemplate.md index f71b11582d..b4fec57d17 100644 --- a/teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsSharedCallQueueHistoryTemplate.md @@ -1,22 +1,27 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/New-CsSharedCallQueueHistoryTemplate applicable: Microsoft Teams -title: New-CsSharedCallQueueHistoryTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: New-CsSharedCallQueueHistoryTemplate --- # New-CsSharedCallQueueHistoryTemplate +## SYNOPSIS +Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue History template. + ## SYNTAX -```powershell -New-CsSharedCallQueueHistoryTemplate -Name -Description [-IncomingMissedCalls ] [-AnsweredAndOutboundCalls ] [] -``` +``` +New-CsSharedCallQueueHistoryTemplate -Name -Description + [-IncomingMissedCalls ] [-AnsweredAndOutboundCalls ] [] +``` ## DESCRIPTION Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue History template. @@ -26,7 +31,7 @@ Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue Histor ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsSharedCallQueueHistoryTemplate -Name "Customer Service" -Description "Missed:All Answered:Auth" -IncomingMissedCall XXXXXX -AnsweredAndOutboundCalls XXXXX ``` @@ -35,30 +40,36 @@ This example creates a new Shared CallQueue History template where incoming miss ## PARAMETERS -### -Name -The name of the shared call queue history template. +### -AnsweredAndOutboundCalls + +> Applicable: Microsoft Teams + +A description for the shared call queue history template. + +PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents ```yaml -Type: System.String +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: Off Accept pipeline input: False Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + A description for the shared call queue history template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -68,6 +79,9 @@ Accept wildcard characters: False ``` ### -IncomingMissedCalls + +> Applicable: Microsoft Teams + A description for the shared call queue history template. PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents @@ -76,7 +90,6 @@ PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -85,20 +98,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AnsweredAndOutboundCalls -A description for the shared call queue history template. +### -Name -PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents +> Applicable: Microsoft Teams + +The name of the shared call queue history template. ```yaml -Type: Object +Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: Off +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsTeamTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamTemplate.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamTemplate.md index 4230e09bf3..02744985eb 100644 --- a/teams/teams-ps/teams/New-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamTemplate.md @@ -1,810 +1,813 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate -title: New-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# New-CsTeamTemplate - -## SYNOPSIS - -This cmdlet lets you provision a new team template for use in Microsoft Teams. To learn more about team templates, see [Get started with Teams templates in the admin center](https://learn.microsoft.com/microsoftteams/get-started-with-teams-templates-in-the-admin-console). - -NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. - -## SYNTAX - -### NewExpanded (Default) - -```powershell -New-CsTeamTemplate -Locale -DisplayName -ShortDescription - [-App ] [-Category ] [-Channel ] - [-Classification ] [-Description ] [-DiscoverySetting ] - [-FunSetting ] [-GuestSetting ] [-Icon ] - [-IsMembershipLimitedToOwner] [-MemberSetting ] - [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] - [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### New - -```powershell -New-CsTeamTemplate -Locale -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### NewViaIdentity - -```powershell -New-CsTeamTemplate -InputObject -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### NewViaIdentityExpanded - -```powershell -New-CsTeamTemplate -InputObject -DisplayName - -ShortDescription [-App ] [-Category ] - [-Channel ] [-Classification ] [-Description ] - [-DiscoverySetting ] [-FunSetting ] - [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] - [-MemberSetting ] [-MessagingSetting ] - [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] - [-Uri ] [-Visibility ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US') > input.json -# open json in your favorite editor, make changes - -PS C:\> New-CsTeamTemplate -Locale en-US -Body (Get-Content '.input.json' | Out-String) -``` - -Step 1: Create new template from copy of existing template. Gets the template JSON file of Template with specified OData ID, creates a JSON file user can make edits in. -Step 2: Create a new template from the JSON file named "input". - -### EXAMPLE 2 - -```powershell -PS C:\> $template = Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US' -PS C:\> $template | Format-List # show the output object as it would be accessed - -PS C:\> $template.Category = $null # unset category to copy from public template -PS C:\> $template.DisplayName = 'New Template from object' -PS C:\> $template.Channel[1].DisplayName += ' modified' -## add a new channel to the channel list -PS C:\> $template.Channel += ` -@{ ` - displayName="test"; ` - id="b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` - isFavoriteByDefault=$false; ` -} - -PS C:\> New-CsTeamTemplate -Locale en-US -Body $template -``` - -Create a template using a complex object syntax. - -### EXAMPLE 3 - -```powershell -PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` -DisplayName='New Template';` -ShortDescription='Short Definition';` -Description='New Description';` -App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` -Channel=@{` - displayName = "General";` - id= "General";` - isFavoriteByDefault= $true` - },` - @{` - displayName= "test";` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` - isFavoriteByDefault= $false` - }` -} - -PS C:\> New-CsTeamTemplate -Locale en-US -Body $template -``` - -Create template from scratch - -> [!Note] -> It can take up to 24 hours for Teams users to see a custom template change in the gallery. - -## PARAMETERS - -### -App - -Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. -To construct, see NOTES section for APP properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body - -The client input for a request to create a template. -Only admins from Config Api can perform this request. -To construct, see NOTES section for BODY properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate -Parameter Sets: New, NewViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category - -Gets or sets list of categories. - -```yaml -Type: System.String[] -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Channel - -Gets or sets the set of channel templates included in the team template. -To construct, see NOTES section for CHANNEL properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Classification - -Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Gets or sets the team's Description. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoverySetting - -Governs discoverability of a team. -To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName - -Gets or sets the team's DisplayName. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunSetting - -Governs use of fun media like giphy and stickers in the team. -To construct, see NOTES section for FUNSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestSetting - -Guest role settings for the team. -To construct, see NOTES section for GUESTSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Icon - -Gets or sets template icon. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity -Parameter Sets: NewViaIdentity, NewViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsMembershipLimitedToOwner - -Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Locale - -```yaml -Type: System.String -Parameter Sets: New, NewExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberSetting - -Member role settings for the team. -To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessagingSetting - -Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. -To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerUserObjectId - -Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishedBy - -Gets or sets published name. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShortDescription - -Gets or sets template short description. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Specialization - -The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateId - -Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri - -Gets or sets uri to be used for GetTemplate api call. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Visibility - -Used to control the scope of users who can view a group/team and its members, and ability to join. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateErrorResponse - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -APP : Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. - -- `[Id ]`: Gets or sets the app's ID in the global apps catalog. - -BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. - -- `DisplayName `: Gets or sets the team's DisplayName. -- `ShortDescription `: Gets or sets template short description. -- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. - - `[Id ]`: Gets or sets the app's ID in the global apps catalog. -- `[Category ]`: Gets or sets list of categories. -- `[Channel ]`: Gets or sets the set of channel templates included in the team template. - - `[Description ]`: Gets or sets channel description as displayed to users. - - `[DisplayName ]`: Gets or sets channel name as displayed to users. - - `[Id ]`: Gets or sets identifier for the channel template. - - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - - `[Configuration ]`: Represents the configuration of a tab. - - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. -- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. -- `[Description ]`: Gets or sets the team's Description. -- `[DiscoverySetting ]`: Governs discoverability of a team. - - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. -- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. - - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. - - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - - `GiphyContentRating `: Gets or sets the rating filter on giphy content. -- `[GuestSetting ]`: Guest role settings for the team. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. -- `[Icon ]`: Gets or sets template icon. -- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. -- `[MemberSetting ]`: Member role settings for the team. - - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. - - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. - - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. - - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. -- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. - - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. -- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. -- `[PublishedBy ]`: Gets or sets published name. -- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. -- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. -- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. -- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. - -CHANNEL : Gets or sets the set of channel templates included in the team template. - -- `[Description ]`: Gets or sets channel description as displayed to users. -- `[DisplayName ]`: Gets or sets channel name as displayed to users. -- `[Id ]`: Gets or sets identifier for the channel template. -- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. -- `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - - `[Configuration ]`: Represents the configuration of a tab. - - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. - -DISCOVERYSETTING \: Governs discoverability of a team. - -- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - -FUNSETTING \: Governs use of fun media like giphy and stickers in the team. - -- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. -- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. -- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. -- `GiphyContentRating `: Gets or sets the rating filter on giphy content. - -GUESTSETTING \: Guest role settings for the team. - -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. - -INPUTOBJECT \: Identity Parameter - -- `[Bssid ]`: -- `[ChassisId ]`: -- `[CivicAddressId ]`: Civic address id. -- `[Country ]`: -- `[GroupId ]`: The ID of a group whose policy assignments will be returned. -- `[Id ]`: -- `[Identity ]`: -- `[Locale ]`: -- `[LocationId ]`: Location id. -- `[OdataId ]`: A composite URI of a template. -- `[OperationId ]`: The ID of a batch policy assignment operation. -- `[OrderId ]`: -- `[PackageName ]`: The name of a specific policy package -- `[PolicyType ]`: The policy type for which group policy assignments will be returned. -- `[Port ]`: -- `[PortInOrderId ]`: -- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. -- `[SubnetId ]`: -- `[TenantId ]`: -- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -MEMBERSETTING \: Member role settings for the team. - -- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. -- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. -- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. -- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. -- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. - -MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. - -- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. -- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. -- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. -- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. -- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - -## RELATED LINKS - -- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamtemplate +schema: 2.0.0 +title: New-CsTeamTemplate +--- + +# New-CsTeamTemplate + +## SYNOPSIS + +This cmdlet lets you provision a new team template for use in Microsoft Teams. + +## SYNTAX + +### NewExpanded (Default) + +``` +New-CsTeamTemplate -Locale -DisplayName -ShortDescription + [-App ] [-Category ] [-Channel ] + [-Classification ] [-Description ] [-DiscoverySetting ] + [-FunSetting ] [-GuestSetting ] [-Icon ] + [-IsMembershipLimitedToOwner] [-MemberSetting ] + [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] + [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### New + +``` +New-CsTeamTemplate -Locale -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### NewViaIdentity + +``` +New-CsTeamTemplate -InputObject -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### NewViaIdentityExpanded + +``` +New-CsTeamTemplate -InputObject -DisplayName + -ShortDescription [-App ] [-Category ] + [-Channel ] [-Classification ] [-Description ] + [-DiscoverySetting ] [-FunSetting ] + [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] + [-MemberSetting ] [-MessagingSetting ] + [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] + [-Uri ] [-Visibility ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +To learn more about team templates, see [Get started with Teams templates in the admin center](/microsoftteams/get-started-with-teams-templates-in-the-admin-console). + +NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. + + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US') > input.json +# open json in your favorite editor, make changes + +PS C:\> New-CsTeamTemplate -Locale en-US -Body (Get-Content '.input.json' | Out-String) +``` + +Step 1: Create new template from copy of existing template. Gets the template JSON file of Template with specified OData ID, creates a JSON file user can make edits in. +Step 2: Create a new template from the JSON file named "input". + +### EXAMPLE 2 + +```powershell +PS C:\> $template = Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US' +PS C:\> $template | Format-List # show the output object as it would be accessed + +PS C:\> $template.Category = $null # unset category to copy from public template +PS C:\> $template.DisplayName = 'New Template from object' +PS C:\> $template.Channel[1].DisplayName += ' modified' +## add a new channel to the channel list +PS C:\> $template.Channel += ` +@{ ` + displayName="test"; ` + id="b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` + isFavoriteByDefault=$false; ` +} + +PS C:\> New-CsTeamTemplate -Locale en-US -Body $template +``` + +Create a template using a complex object syntax. + +### EXAMPLE 3 + +```powershell +PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` +DisplayName='New Template';` +ShortDescription='Short Definition';` +Description='New Description';` +App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` +Channel=@{` + displayName = "General";` + id= "General";` + isFavoriteByDefault= $true` + },` + @{` + displayName= "test";` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` + isFavoriteByDefault= $false` + }` +} + +PS C:\> New-CsTeamTemplate -Locale en-US -Body $template +``` + +Create template from scratch + +> [!Note] +> It can take up to 24 hours for Teams users to see a custom template change in the gallery. + +## PARAMETERS + +### -App + +Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. +To construct, see NOTES section for APP properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body + +The client input for a request to create a template. +Only admins from Config Api can perform this request. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate +Parameter Sets: New, NewViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break + +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category + +Gets or sets list of categories. + +```yaml +Type: System.String[] +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Channel + +Gets or sets the set of channel templates included in the team template. +To construct, see NOTES section for CHANNEL properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Classification + +Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Gets or sets the team's Description. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoverySetting + +Governs discoverability of a team. +To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName + +Gets or sets the team's DisplayName. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunSetting + +Governs use of fun media like giphy and stickers in the team. +To construct, see NOTES section for FUNSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestSetting + +Guest role settings for the team. +To construct, see NOTES section for GUESTSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend + +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend + +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Icon + +Gets or sets template icon. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: NewViaIdentity, NewViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsMembershipLimitedToOwner + +Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale + +```yaml +Type: System.String +Parameter Sets: New, NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberSetting + +Member role settings for the team. +To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingSetting + +Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. +To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerUserObjectId + +Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy + +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential + +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials + +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishedBy + +Gets or sets published name. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShortDescription + +Gets or sets template short description. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Specialization + +The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateId + +Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri + +Gets or sets uri to be used for GetTemplate api call. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Visibility + +Used to control the scope of users who can view a group/team and its members, and ability to join. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateErrorResponse + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +APP : Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. + +- `[Id ]`: Gets or sets the app's ID in the global apps catalog. + +BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. + +- `DisplayName `: Gets or sets the team's DisplayName. +- `ShortDescription `: Gets or sets template short description. +- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. + - `[Id ]`: Gets or sets the app's ID in the global apps catalog. +- `[Category ]`: Gets or sets list of categories. +- `[Channel ]`: Gets or sets the set of channel templates included in the team template. + - `[Description ]`: Gets or sets channel description as displayed to users. + - `[DisplayName ]`: Gets or sets channel name as displayed to users. + - `[Id ]`: Gets or sets identifier for the channel template. + - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. + - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration ]`: Represents the configuration of a tab. + - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. +- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. +- `[Description ]`: Gets or sets the team's Description. +- `[DiscoverySetting ]`: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. +- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. + - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. + - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. + - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. + - `GiphyContentRating `: Gets or sets the rating filter on giphy content. +- `[GuestSetting ]`: Guest role settings for the team. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. +- `[Icon ]`: Gets or sets template icon. +- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. +- `[MemberSetting ]`: Member role settings for the team. + - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. + - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. + - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. + - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. + - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. +- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. + - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. + - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. + - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. + - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. + - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. +- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. +- `[PublishedBy ]`: Gets or sets published name. +- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. +- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. +- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. +- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. + +CHANNEL : Gets or sets the set of channel templates included in the team template. + +- `[Description ]`: Gets or sets channel description as displayed to users. +- `[DisplayName ]`: Gets or sets channel name as displayed to users. +- `[Id ]`: Gets or sets identifier for the channel template. +- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. +- `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration ]`: Represents the configuration of a tab. + - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. + +DISCOVERYSETTING \: Governs discoverability of a team. + +- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. + +FUNSETTING \: Governs use of fun media like giphy and stickers in the team. + +- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. +- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. +- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. +- `GiphyContentRating `: Gets or sets the rating filter on giphy content. + +GUESTSETTING \: Guest role settings for the team. + +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. + +INPUTOBJECT \: Identity Parameter + +- `[Bssid ]`: +- `[ChassisId ]`: +- `[CivicAddressId ]`: Civic address id. +- `[Country ]`: +- `[GroupId ]`: The ID of a group whose policy assignments will be returned. +- `[Id ]`: +- `[Identity ]`: +- `[Locale ]`: +- `[LocationId ]`: Location id. +- `[OdataId ]`: A composite URI of a template. +- `[OperationId ]`: The ID of a batch policy assignment operation. +- `[OrderId ]`: +- `[PackageName ]`: The name of a specific policy package +- `[PolicyType ]`: The policy type for which group policy assignments will be returned. +- `[Port ]`: +- `[PortInOrderId ]`: +- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. +- `[SubnetId ]`: +- `[TenantId ]`: +- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +MEMBERSETTING \: Member role settings for the team. + +- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. +- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. +- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. +- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. +- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. + +MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. + +- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. +- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. +- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. +- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. +- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. + +## RELATED LINKS + +- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) diff --git a/teams/teams-ps/teams/New-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAIPolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAIPolicy.md index 4a7ff4af67..4ccd6704b4 100644 --- a/teams/teams-ps/teams/New-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: New-CsTeamsAIPolicy -online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsAIPolicy -schema: 2.0.0 author: Andy447 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: andywang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsTeamsAIPolicy +schema: 2.0.0 +title: New-CsTeamsAIPolicy --- # New-CsTeamsAIPolicy @@ -17,7 +18,7 @@ This cmdlet creates a Teams AI policy. ## SYNTAX ```powershell -New-CsTeamsAIPolicy -Identity +New-CsTeamsAIPolicy -Identity [-EnrollFace ] [-EnrollVoice ] [-SpeakerAttributionBYOD ] @@ -42,15 +43,15 @@ The newly created policy with value will be printed on success. ## PARAMETERS -### -Identity -Identity of the Teams AI policy. - +### -Description +Enables administrators to provide explanatory text about the Teams AI policy. +For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -87,32 +88,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpeakerAttributionBYOD -Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. +### -Identity +Identity of the Teams AI policy. ```yaml Type: String -Parameter Sets: ("Enabled","Disabled") +Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text about the Teams AI policy. -For example, the Description might indicate the users the policy should be assigned to. +### -SpeakerAttributionBYOD +Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. + ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: ("Enabled","Disabled") Aliases: -Required: False +Required: True Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` @@ -127,10 +128,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaipolicy) -[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaipolicy) -[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppPermissionPolicy.md similarity index 67% rename from teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAppPermissionPolicy.md index ff4308f76f..d2ab217f1b 100644 --- a/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppPermissionPolicy.md @@ -1,24 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsapppermissionpolicy applicable: Microsoft Teams -title: New-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: mhayrapetyan +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsapppermissionpolicy +schema: 2.0.0 +title: New-CsTeamsAppPermissionPolicy --- # New-CsTeamsAppPermissionPolicy ## SYNOPSIS - -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. - -As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . - -**This is only applicable for tenants who have not been migrated to ACM or UAM.** +As an admin, you can use app permission policies to allow or block apps for your users. ## SYNTAX @@ -41,9 +38,12 @@ New-CsTeamsAppPermissionPolicy [[-Identity] ] ## DESCRIPTION **NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. +While the cmdlet may succeed, the changes aren't applied to the tenant. As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppSetupPolicy.md similarity index 84% rename from teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAppSetupPolicy.md index ff00d0c8a6..2c40d2b3ca 100644 --- a/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppSetupPolicy.md @@ -1,19 +1,17 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsappsetuppolicy applicable: Microsoft Teams -title: New-CsTeamsAppSetupPolicy +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsappsetuppolicy schema: 2.0.0 +title: New-CsTeamsAppSetupPolicy --- # New-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. ## SYNTAX @@ -36,11 +34,21 @@ New-CsTeamsAppSetupPolicy [-Identity] ``` ## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this +cmdlet. We require that all creation and modification of app setup polices (not including the +assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business +Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that +are most important for your users. You choose the apps to pin and set the order that they appear. +App setup policies let you showcase apps that users in your organization need, including ones built +by third parties or by developers in your organization. You can also use app setup policies to +manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the +bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: +. ## EXAMPLES @@ -99,16 +107,16 @@ Create a new TeamsAppSetupPolicy and install VivaConnections App in users' perso ## PARAMETERS -### -Identity -Name of App setup policy. If empty, all Identities will be used by default. +### -AdditionalCustomizationApps +This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. ```yaml -Type: String -Parameter Sets: Identity +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -159,13 +167,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -AppPresetMeetingList +This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -174,13 +182,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the app setup policy. +### -Confirm +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -189,11 +197,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinnedAppBarApps -Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that are needed the most by users and promote ease of access. +### -Description +Description of the app setup policy. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] +Type: String Parameter Sets: (All) Aliases: @@ -204,26 +212,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinnedCallingBarApps -Determines the list of apps that are pre pinned for a participant in Calls. +### -Identity +Name of App setup policy. If empty, all Identities will be used by default. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PinnedMessageBarApps -Apps are pinned in messaging extensions and into the ellipsis menu. +### -PinnedAppBarApps +Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that are needed the most by users and promote ease of access. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] Parameter Sets: (All) Aliases: @@ -234,11 +242,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdditionalCustomizationApps -This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. +### -PinnedCallingBarApps +Determines the list of apps that are pre pinned for a participant in Calls. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] Parameter Sets: (All) Aliases: @@ -249,11 +257,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppPresetMeetingList -This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. +### -PinnedMessageBarApps +Apps are pinned in messaging extensions and into the ellipsis menu. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] Parameter Sets: (All) Aliases: diff --git a/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy.md similarity index 93% rename from teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy.md index e95b230bdc..f45e3a0df3 100644 --- a/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy -title: New-CsTeamsAudioConferencingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy schema: 2.0.0 +title: New-CsTeamsAudioConferencingPolicy --- # New-CsTeamsAudioConferencingPolicy @@ -53,6 +54,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. @@ -113,21 +129,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -156,8 +157,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy) -[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallHoldPolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCallHoldPolicy.md index 92744364e9..d261c5a834 100644 --- a/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy applicable: Microsoft Teams -title: New-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy +schema: 2.0.0 +title: New-CsTeamsCallHoldPolicy --- # New-CsTeamsCallHoldPolicy @@ -42,16 +43,31 @@ Any Microsoft Teams users who are assigned this policy will have their call hold ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new Teams call hold policy. +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -74,11 +90,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFileId -A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -89,16 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreamingSourceUrl -This parameter is reserved for internal Microsoft use. +### -Identity +Unique identifier to be assigned to the new Teams call hold policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -119,11 +135,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -150,21 +166,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -180,12 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallholdpolicy) -[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallholdpolicy) -[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallholdpolicy) -[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallholdpolicy) -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallParkPolicy.md similarity index 80% rename from teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCallParkPolicy.md index ba4ca721a7..475eac960f 100644 --- a/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallParkPolicy.md @@ -1,33 +1,40 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallparkpolicy applicable: Microsoft Teams -title: New-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallparkpolicy +schema: 2.0.0 +title: New-CsTeamsCallParkPolicy --- # New-CsTeamsCallParkPolicy ## SYNOPSIS - -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. - -NOTE: The call park feature currently available in desktop. mobile and web clients. Supported with TeamsOnly mode. +The New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. ## SYNTAX ### Identity (Default) -```powershell -New-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [[-Identity] ] [-PickupRangeStart ] [-PickupRangeEnd ] [-ParkTimeoutSeconds ] [-Force] [-WhatIf] [-Confirm] [-Description ] [] + +``` +New-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [[-Identity] ] + [-PickupRangeStart ] [-PickupRangeEnd ] [-ParkTimeoutSeconds ] [-Force] + [-WhatIf] [-Confirm] [-Description ] [] ``` ## DESCRIPTION -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different phone. The New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. +The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in +Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then +perform a number of actions on that call: transfer to another department, retrieve via the same +phone, or retrieve via a different phone. + +NOTE: The call park feature currently available in desktop. mobile and web clients. Supported with TeamsOnly mode. ## EXAMPLES @@ -84,6 +91,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppress all non-fatal errors. @@ -114,10 +136,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PickupRangeEnd -Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. - -Note: PickupRangeStart must be smaller than PickupRangeEnd. +### -ParkTimeoutSeconds +Specify the number of seconds to wait before ringing the parker when the parked call hasn't been picked up. Value can be from 120 to 1800 (seconds). ```yaml Type: Integer @@ -126,13 +146,15 @@ Aliases: Required: False Position: Named -Default value: 99 +Default value: 300 Accept pipeline input: False Accept wildcard characters: False ``` -### -ParkTimeoutSeconds -Specify the number of seconds to wait before ringing the parker when the parked call hasn't been picked up. Value can be from 120 to 1800 (seconds). +### -PickupRangeEnd +Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. + +Note: PickupRangeStart must be smaller than PickupRangeEnd. ```yaml Type: Integer @@ -141,7 +163,7 @@ Aliases: Required: False Position: Named -Default value: 300 +Default value: 99 Accept pipeline input: False Accept wildcard characters: False ``` @@ -194,21 +216,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallingPolicy.md similarity index 93% rename from teams/teams-ps/teams/New-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCallingPolicy.md index 638a131b09..eda358df5f 100644 --- a/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallingPolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy applicable: Microsoft Teams -title: New-CsTeamsCallingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars ms.reviewer: alejandramu +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy +schema: 2.0.0 +title: New-CsTeamsCallingPolicy --- # New-CsTeamsCallingPolicy @@ -72,22 +73,10 @@ values in the Global policy instance. ## PARAMETERS -### -Identity -Name of the policy instance being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter > [!NOTE] > This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -102,7 +91,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -112,13 +100,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToPhone + +> Applicable: Microsoft Teams + Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -128,13 +118,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToUser + +> Applicable: Microsoft Teams + Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -144,13 +136,15 @@ Accept wildcard characters: False ``` ### -AllowCallGroups + +> Applicable: Microsoft Teams + Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -160,6 +154,9 @@ Accept wildcard characters: False ``` ### -AllowCallRedirect + +> Applicable: Microsoft Teams + Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway. Valid options are: @@ -172,7 +169,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -182,13 +178,15 @@ Accept wildcard characters: False ``` ### -AllowCloudRecordingForCalls + +> Applicable: Microsoft Teams + Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -198,13 +196,15 @@ Accept wildcard characters: False ``` ### -AllowDelegation + +> Applicable: Microsoft Teams + Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -214,6 +214,9 @@ Accept wildcard characters: False ``` ### -AllowPrivateCalling + +> Applicable: Microsoft Teams + Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. @@ -221,7 +224,6 @@ If you use Skype for Business for calling, this policy will not affect calling f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -231,13 +233,15 @@ Accept wildcard characters: False ``` ### -AllowSIPDevicesCalling + +> Applicable: Microsoft Teams + Determines whether the user is allowed to use a SIP device for calling on behalf of a Teams client. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -247,13 +251,15 @@ Accept wildcard characters: False ``` ### -AllowTranscriptionForCalling + +> Applicable: Microsoft Teams + Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -263,6 +269,9 @@ Accept wildcard characters: False ``` ### -AllowVoicemail + +> Applicable: Microsoft Teams + Enables inbound calls to be routed to voicemail. Valid options are: @@ -275,7 +284,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -285,13 +293,15 @@ Accept wildcard characters: False ``` ### -AllowWebPSTNCalling + +> Applicable: Microsoft Teams + Allows PSTN calling from the Team web client. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -301,6 +311,9 @@ Accept wildcard characters: False ``` ### -AutoAnswerEnabledType + +> Applicable: Microsoft Teams + Setting this parameter allows you to enable or disable auto-answer for incoming meeting invites on Teams Phones. This setting applies only to incoming meeting invites and does not include support for other call types. Valid options are: @@ -312,7 +325,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -322,6 +334,9 @@ Accept wildcard characters: False ``` ### -BusyOnBusyEnabledType + +> Applicable: Microsoft Teams + Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. Valid options are: @@ -335,7 +350,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -345,6 +359,9 @@ Accept wildcard characters: False ``` ### -CallingSpendUserLimit + +> Applicable: Microsoft Teams + The maximum amount a user can spend on outgoing PSTN calls, including all calls made through Pay-as-you-go Calling Plans and any overages on plans with bundled minutes. Possible values: any positive integer @@ -353,7 +370,6 @@ Possible values: any positive integer Type: Long Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -362,13 +378,15 @@ Accept wildcard characters: False ``` ### -CallRecordingExpirationDays + +> Applicable: Microsoft Teams + Sets the expiration of the recorded 1:1 calls. Default is 60 days. ```yaml Type: Long Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -378,13 +396,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -394,6 +414,9 @@ Accept wildcard characters: False ``` ### -Copilot + +> Applicable: Microsoft Teams + Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call. Valid options are: @@ -405,7 +428,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -415,13 +437,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users to whom the policy should be assigned. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -431,6 +455,9 @@ Accept wildcard characters: False ``` ### -EnableSpendLimits + +> Applicable: Microsoft Teams + This setting allows an admin to enable or disable spend limits on PSTN calls for their user base. Possible values: @@ -442,7 +469,6 @@ Possible values: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: False @@ -466,13 +492,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -481,7 +509,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Name of the policy instance being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InboundFederatedCallRoutingTreatment + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound federated calls should be routed. Valid options are: @@ -497,7 +543,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -507,6 +552,9 @@ Accept wildcard characters: False ``` ### -InboundPstnCallRoutingTreatment + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound PSTN calls should be routed. Valid options are: @@ -522,7 +570,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -532,6 +579,9 @@ Accept wildcard characters: False ``` ### -LiveCaptionsEnabledTypeForCalling + +> Applicable: Microsoft Teams + Determines whether real-time captions are available for the user in Teams calls. Valid options are: @@ -543,7 +593,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -553,6 +602,9 @@ Accept wildcard characters: False ``` ### -MusicOnHoldEnabledType + +> Applicable: Microsoft Teams + Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold. Valid options are: @@ -565,7 +617,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -575,13 +626,15 @@ Accept wildcard characters: False ``` ### -PopoutAppPathForIncomingPstnCalls + +> Applicable: Microsoft Teams + Setting this parameter allows you to set the PopoutForIncomingPstnCalls setting's URL path of the website to launch upon receiving incoming PSTN calls. This parameter accepts an HTTPS URL with less than 1024 characters. The URL can contain a `{phone}` placeholder that is replaced with the caller's PSTN number in E.164 format when launched. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: "" @@ -590,13 +643,15 @@ Accept wildcard characters: False ``` ### -PopoutForIncomingPstnCalls + +> Applicable: Microsoft Teams + Setting this parameter allows you to control the tenant users' ability to launch an external website URL automatically in the browser window upon incoming PSTN calls for specific users or user groups. Valid options are Enabled and Disabled. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: Disabled @@ -605,6 +660,9 @@ Accept wildcard characters: False ``` ### -PreventTollBypass + +> Applicable: Microsoft Teams + Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. > [!NOTE] @@ -614,7 +672,6 @@ Setting this parameter to True will send calls through PSTN and incur charges ra Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -623,77 +680,85 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpamFilteringEnabledType -Determines Spam filtering mode. +### -RealTimeText -Possible values: +> Applicable: Microsoft Teams -- Enabled: Spam Filtering is fully enabled. Both Basic and Captcha Interactive Voice Response (IVR) checks are performed. In case the call is considered spam, the user will get a "Spam Likely" notification in Teams. -- Disabled: Spam Filtering is completely disabled. No checks are performed. A "Spam Likely" notification will not appear. -- EnabledWithoutIVR: Spam Filtering is partially enabled. Captcha IVR checks are disabled. A "Spam Likely" notification will appear. A call might get dropped if it gets a high score from Basic checks. +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceSimulationInInterpreter +### -SpamFilteringEnabledType ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. +> Applicable: Microsoft Teams -Enables the user to use the voice simulation feature while being AI interpreted. +Determines Spam filtering mode. -Possible Values: +Possible values: -- Disabled -- Enabled +- Enabled: Spam Filtering is fully enabled. Both Basic and Captcha Interactive Voice Response (IVR) checks are performed. In case the call is considered spam, the user will get a "Spam Likely" notification in Teams. +- Disabled: Spam Filtering is completely disabled. No checks are performed. A "Spam Likely" notification will not appear. +- EnabledWithoutIVR: Spam Filtering is partially enabled. Captcha IVR checks are disabled. A "Spam Likely" notification will appear. A call might get dropped if it gets a high score from Basic checks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeText +### -VoiceSimulationInInterpreter + +> Applicable: Microsoft Teams + >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. -Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. +Enables the user to use the voice simulation feature while being AI interpreted. Possible Values: -- Enabled: User is allowed to turn on real time text. -- Disabled: User is not allowed to turn on real time text. + +- Disabled +- Enabled ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: Enabled +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -701,7 +766,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -723,10 +787,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallingpolicy) -[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallingpolicy) -[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallingpolicy) -[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsChannelsPolicy.md similarity index 94% rename from teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsChannelsPolicy.md index fd19f2ca12..c34f091af6 100644 --- a/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsChannelsPolicy.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamschannelspolicy applicable: Microsoft Teams -title: New-CsTeamsChannelsPolicy +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamschannelspolicy schema: 2.0.0 +title: New-CsTeamsChannelsPolicy --- # New-CsTeamsChannelsPolicy @@ -36,8 +38,8 @@ This example shows creating a new policy with name "StudentPolicy" where Private ## PARAMETERS -### -EnablePrivateTeamDiscovery -Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. +### -AllowChannelSharingToExternalUser +Owners of a shared channel can invite external users to join the channel if Microsoft Entra external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml Type: Boolean @@ -51,13 +53,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowOrgWideTeamCreation +Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -66,10 +68,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Bypasses all non-fatal errors. +### -AllowPrivateChannelCreation +Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -80,26 +83,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy that you are creating. +### -AllowSharedChannelCreation +Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. ```yaml -Type: String -Parameter Sets: Identity +Type: Boolean +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -AllowUserToParticipateInExternalSharedChannel +Users and teams can be invited to external shared channels if Microsoft Entra external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml -Type: System.Guid +Type: Boolean Parameter Sets: (All) Aliases: @@ -110,13 +113,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -125,11 +128,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOrgWideTeamCreation -Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. +### -Description +Specifies the description of the policy. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -140,8 +143,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateChannelCreation -Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. +### -EnablePrivateTeamDiscovery +Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml Type: Boolean @@ -155,11 +158,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelSharingToExternalUser -Owners of a shared channel can invite external users to join the channel if Microsoft Entra external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). - +### -Force +Bypasses all non-fatal errors. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -170,26 +172,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedChannelCreation -Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. +### -Identity +Specify the name of the policy that you are creating. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserToParticipateInExternalSharedChannel -Users and teams can be invited to external shared channels if Microsoft Entra external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). +### -Tenant +Internal Microsoft use only. ```yaml -Type: Boolean +Type: System.Guid Parameter Sets: (All) Aliases: @@ -219,13 +221,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Specifies the description of the policy. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -249,10 +251,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamschannelspolicy) +[Set-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamschannelspolicy) -[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy) +[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamschannelspolicy) -[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy) +[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamschannelspolicy) -[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy) +[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamschannelspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication.md index a08b36dfb9..604a597600 100644 --- a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication applicable: Microsoft Teams -title: New-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication +schema: 2.0.0 +title: New-CsTeamsComplianceRecordingApplication --- # New-CsTeamsComplianceRecordingApplication @@ -110,193 +111,161 @@ Please refer to the documentation of the ComplianceRecordingPairedApplications p ## PARAMETERS -### -Identity -A name that uniquely identifies the application instance of the policy-based recording application. +### -ComplianceRecordingPairedApplications +Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. -Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -To do this association correctly, the Identity of these application instances must be \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. +In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. -### -Parent -The Identity of the Teams recording policy that this application instance of a policy-based recording application is associated with. -For example, the Parent of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy\", which indicates that the application instance is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey +Type: ComplianceRecordingPairedApplication[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Id -The ObjectId of the application instance of a policy-based recording application as exposed by the Get-CsOnlineApplicationInstance cmdlet. -For example, the Id of an application instance can be \"39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance has ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. +### -ConcurrentInvitationCount +Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: +In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. -### -RequiredBeforeMeetingJoin -Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. -If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. -The meeting will still continue for users who are in the meeting. +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. -If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: 1 Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredDuringMeeting -Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. - -If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. -The meeting will still continue for users who are in the meeting. - -If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredBeforeCallEstablishment -Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. - -If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. - -If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredDuringCall -Indicates whether the policy-based recording application must be in the call while the call is active. - -If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. - -If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. +### -Id +The ObjectId of the application instance of a policy-based recording application as exposed by the Get-CsOnlineApplicationInstance cmdlet. +For example, the Id of an application instance can be \"39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance has ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: String +Parameter Sets: ParentAndRelativeKey Aliases: -Required: False +Required: True Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentInvitationCount -Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. - -In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. +Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +To do this association correctly, the Identity of these application instances must be \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. +### -InMemory +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingPairedApplications -Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. - -In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. - -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. - -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. +### -Parent +The Identity of the Teams recording policy that this application instance of a policy-based recording application is associated with. +For example, the Parent of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy\", which indicates that the application instance is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. ```yaml -Type: ComplianceRecordingPairedApplication[] -Parameter Sets: (All) +Type: String +Parameter Sets: ParentAndRelativeKey Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -321,68 +290,100 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: +### -RequiredBeforeCallEstablishment +Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. -You can return your tenant ID by running this command: +If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. -Get-CsTenant | Select-Object DisplayName, TenantID +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeMeetingJoin +Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. + +If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. ```yaml -Type: System.Guid +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -RequiredDuringCall +Indicates whether the policy-based recording application must be in the call while the call is active. + +If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. + +If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -RequiredDuringMeeting +Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. + +If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: @@ -424,20 +425,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication.md similarity index 84% rename from teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication.md index d444f6ae79..293df49a22 100644 --- a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication applicable: Microsoft Teams -title: New-CsTeamsComplianceRecordingPairedApplication -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication +schema: 2.0.0 +title: New-CsTeamsComplianceRecordingPairedApplication --- # New-CsTeamsComplianceRecordingPairedApplication @@ -90,20 +91,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy.md similarity index 92% rename from teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy.md index e1caae78f9..6a73b4421d 100644 --- a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy applicable: Microsoft Teams -title: New-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: New-CsTeamsComplianceRecordingPolicy --- # New-CsTeamsComplianceRecordingPolicy @@ -64,38 +66,36 @@ Any Microsoft Teams users who are assigned this policy will have their calls and ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new Teams recording policy. +### -ComplianceRecordingApplications +A list of application instances of policy-based recording applications to assign to this policy. +The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. -Use the "Global" Identity if you wish to assign this policy to the entire tenant. +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. ```yaml -Type: XdsIdentity +Type: ComplianceRecordingApplication[] Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Controls whether this Teams recording policy is active or not. - -Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. - -Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -115,8 +115,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WarnUserOnRemoval -This parameter is reserved for future use. +### -CustomPromptsEnabled +Indicates whether compliance recording custom prompts feature is enabled for this tenant / user. ```yaml Type: Boolean @@ -125,13 +125,13 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. +### -CustomPromptsPackageId +Reference to custom prompts package. ```yaml Type: String @@ -145,15 +145,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingApplications -A list of application instances of policy-based recording applications to assign to this policy. -The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +### -Description +Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: ComplianceRecordingApplication[] +Type: String Parameter Sets: (All) Aliases: @@ -179,8 +175,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RecordReroutedCalls -Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. +### -Enabled +Controls whether this Teams recording policy is active or not. + +Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. ```yaml Type: Boolean @@ -194,22 +194,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -220,23 +209,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier to be assigned to the new Teams recording policy. + +Use the "Global" Identity if you wish to assign this policy to the entire tenant. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -InMemory +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter @@ -250,27 +242,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +### -RecordReroutedCalls +Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomPromptsEnabled -Indicates whether compliance recording custom prompts feature is enabled for this tenant / user. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: Boolean +Type: System.Guid Parameter Sets: (All) Aliases: @@ -281,17 +283,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomPromptsPackageId -Reference to custom prompts package. +### -WarnUserOnRemoval +This parameter is reserved for future use. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` @@ -327,20 +329,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCortanaPolicy.md similarity index 97% rename from teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCortanaPolicy.md index 247ea3b3a6..e4fa1420ed 100644 --- a/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy applicable: Microsoft Teams -title: New-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscortanapolicy +schema: 2.0.0 +title: New-CsTeamsCortanaPolicy --- # New-CsTeamsCortanaPolicy diff --git a/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCustomBannerText.md similarity index 87% rename from teams/teams-ps/teams/New-CsTeamsCustomBannerText.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCustomBannerText.md index 4ed97c99b6..bd0911904e 100644 --- a/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCustomBannerText.md @@ -1,10 +1,11 @@ --- -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext -title: New-CsTeamsCustomBannerText -schema: 2.0.0 author: saleens7 +Locale: en-US +Module Name: MicrosoftTeams ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscustombannertext +schema: 2.0.0 +title: New-CsTeamsCustomBannerText --- # New-CsTeamsCustomBannerText @@ -36,14 +37,27 @@ This example creates an instance of TeamsCustomBannerText with the name CustomTe ## PARAMETERS +### -Description +The description that the global admin would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id + +> Applicable: Microsoft Teams + The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. ```yaml Type: Guid Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -62,17 +76,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -The description that the global admin would like to set to identify what this text represents. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -88,8 +91,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy.md similarity index 88% rename from teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy.md index 0cc06eb366..efdcfd97d1 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: New-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manger: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc, vaddank +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: New-CsTeamsEmergencyCallRoutingPolicy --- # New-CsTeamsEmergencyCallRoutingPolicy @@ -46,28 +48,28 @@ This example overrides the global emergency numbers from the global instance. ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the name of the policy. +### -AllowEnhancedEmergencyServices +Flag to enable Enhanced Emergency Services. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEnhancedEmergencyServices -Flag to enable Enhanced Emergency Services. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -92,7 +94,7 @@ Accept wildcard characters: False ``` ### -EmergencyNumbers -One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) cmdlet. +One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencynumber) cmdlet. ```yaml Type: Object @@ -106,29 +108,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity +The Identity parameter is a unique identifier that designates the name of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -152,12 +154,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy) -[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy) -[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) +[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencynumber) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification.md index 693ea5b9cd..8b038320b3 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification applicable: Microsoft Teams -title: New-CsTeamsEmergencyCallingExtendedNotification author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingextendednotification schema: 2.0.0 +title: New-CsTeamsEmergencyCallingExtendedNotification --- # New-CsTeamsEmergencyCallingExtendedNotification @@ -50,8 +51,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationGroup -NotificationGroup is an email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 entries consisting of users and/or groups can be added to the NotificationGroup. The total number of users notified cannot exceed 50. +### -NotificationDialOutNumber +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. ```yaml Type: String @@ -65,8 +66,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationDialOutNumber -This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. +### -NotificationGroup +NotificationGroup is an email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 entries consisting of users and/or groups can be added to the NotificationGroup. The total number of users notified cannot exceed 50. ```yaml Type: String @@ -111,6 +112,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy) -[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy.md similarity index 93% rename from teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy.md index 60f9db0fb7..e891bb4b26 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: New-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy schema: 2.0.0 +title: New-CsTeamsEmergencyCallingPolicy --- # New-CsTeamsEmergencyCallingPolicy @@ -60,16 +62,16 @@ New-CsTeamsEmergencyCallingPolicy -Identity ECP2 -Description "Test ECP2" -Exter ## PARAMETERS -### -Identity - The Identity parameter is a unique identifier that designates the name of the policy +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -139,6 +141,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + The Identity parameter is a unique identifier that designates the name of the policy + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NotificationDialOutNumber This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. @@ -202,21 +219,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -232,12 +234,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy) -[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy) -[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy) -[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification) +[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingextendednotification) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyNumber.md similarity index 89% rename from teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyNumber.md index 9d89a4ced3..1745a5d46b 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyNumber.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber applicable: Microsoft Teams -title: New-CsTeamsEmergencyNumber author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc, pthota +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencynumber schema: 2.0.0 +title: New-CsTeamsEmergencyNumber --- # New-CsTeamsEmergencyNumber @@ -102,6 +104,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy) -[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEnhancedEncryptionPolicy.md similarity index 90% rename from teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEnhancedEncryptionPolicy.md index 94d8089d7a..41d1aec092 100644 --- a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEnhancedEncryptionPolicy.md @@ -1,189 +1,190 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy -title: New-CsTeamsEnhancedEncryptionPolicy -author: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# New-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Use this cmdlet to create a new Teams enhanced encryption policy. - -## SYNTAX - -``` -New-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] - [[-Identity] ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Use this cmdlet to create a new Teams enhanced encryption policy. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -``` - -Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the default values to its settings. - -### EXAMPLE 2 -```PowerShell -PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -MeetingEndToEndEncryption DisabledUserOverride -``` - -Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the provided values to its settings. - -## PARAMETERS - -### -Description -Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. - -For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallingEndtoEndEncryptionEnabledType -Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingEndToEndEncryption -Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling Set-CsTeamsEnhancedEncryptionPolicy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses all non-fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: New-CsTeamsEnhancedEncryptionPolicy +--- + +# New-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Use this cmdlet to create a new Teams enhanced encryption policy. + +## SYNTAX + +``` +New-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] + [[-Identity] ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Use this cmdlet to create a new Teams enhanced encryption policy. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy +``` + +Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the default values to its settings. + +### EXAMPLE 2 +```PowerShell +PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -MeetingEndToEndEncryption DisabledUserOverride +``` + +Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the provided values to its settings. + +## PARAMETERS + +### -CallingEndtoEndEncryptionEnabledType +Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. + +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling Set-CsTeamsEnhancedEncryptionPolicy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingEndToEndEncryption +Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEventsPolicy.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEventsPolicy.md index a584eb4601..11ed7d8a64 100644 --- a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEventsPolicy.md @@ -1,408 +1,409 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamseventspolicy -title: New-CsTeamsEventsPolicy -schema: 2.0.0 -ms.date: 04/23/2025 ---- - -# New-CsTeamsEventsPolicy - -## SYNOPSIS -This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. - -## SYNTAX - -```powershell -New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-AllowTownhalls ] [-ImmersiveEvents ] [-AllowEmailEditing ] [-Description ] -[-TownhallEventAttendeeAccess ] [-RecordingForTownhall ] [-RecordingForWebinar ] -[-TranscriptionForTownhall ] [-TranscriptionForWebinar ] [-AllowEventIntegrations ] [-TownhallChatExperience ] -[-UseMicrosoftECDN ] [-EventAccessType ] [-BroadcastPremiumApps ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsEventsPolicy -Identity DisablePublicWebinars -AllowWebinars Enabled -EventAccessType EveryoneInCompanyExcludingGuests -``` - -The command shown in Example 1 creates a new per-user Teams Events policy with the Identity DisablePublicWebinars. This policy disables a user from creating public webinars. - -### Example 2 -```powershell -PS C:\> New-CsTeamsEventsPolicy -Identity DisableWebinars -AllowWebinars Disabled -``` - -The command shown in Example 2 creates a new per-user Teams Events policy with the Identity DisableWebinars. This policy disables a user from creating webinars. - -## PARAMETERS - -### -AllowWebinars -This setting governs if a user can create webinars using Teams Events. -Possible values are: - - **Enabled**: Enables creating webinars. - - **Disabled**: Disables creating webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseMicrosoftECDN -This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTownhalls -This setting governs if a user can create town halls using Teams Events. -Possible values are: - - **Enabled**: Enables creating town halls. - - **Disabled**: Disables creating town hall. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmersiveEvents -This setting governs if a user can create Immersive Events using Teams Events. -Possible values are: - - **Enabled**: Enables creating Immersive Events. - - **Disabled**: Disables creating Immersive Events. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TownhallEventAttendeeAccess -This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. -Possible values are: - - **Everyone**: Anyone with the join link may enter the event. - - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Everyone -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEmailEditing -This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. -Possible values are: - - **Enabled**: Enables editing of communication emails. - - **Disabled**: Disables editing of communication emails. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventAccessType -This setting governs which users can access the Town hall event and access the event registration page or the event site to register for a Webinar. It also governs which user type is allowed to join the session or sessions in the event for both event types. - -Possible values are: - - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - - - **EveryoneInCompanyExcludingGuests**: For Webinar - enables creating events to allow only in-tenant users to register and join the event. For Town hall - enables creating events to allow only in-tenant users to join the event (Note: for Town hall, in-tenant users include guests; this parameter will disable public Town halls). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Everyone -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedQuestionTypesInRegistrationForm -This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. - -Possible values are: DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedTownhallTypesForRecordingPublish -This setting governs which types of town halls can have their recordings published. - -Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedWebinarTypesForRecordingPublish -This setting governs which types of webinars can have their recordings published. - -Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordingForTownhall -Determines whether recording is allowed in a user's townhall. -Possible values are: - - **Enabled**: Allow recording in user's townhalls. - - **Disabled**: Prohibit recording in user's townhalls. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` -### -RecordingForWebinar -Determines whether recording is allowed in a user's webinar. -Possible values are: - - **Enabled**: Allow recording in user's webinars. - - **Disabled**: Prohibit recording in user's webinars. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` -### -TranscriptionForTownhall -Determines whether transcriptions are allowed in a user's townhall. -Possible values are: - - **Enabled**: Allow transcriptions in user's townhalls. - - **Disabled**: Prohibit transcriptions in user's townhalls. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` -### -TranscriptionForWebinar -Determines whether transcriptions are allowed in a user's webinar. -Possible values are: - - **Enabled**: Allow transcriptions in user's webinars. - - **Disabled**: Prohibit transcriptions in user's webinars. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEventIntegrations -This setting governs the access to the integrations tab in the event creation workflow. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TownhallChatExperience -This setting governs if the user can enable the Comment Stream chat experience for Townhalls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BroadcastPremiumApps -This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. - -Possible values are: -- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall -- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch does not work with this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch does not work with this cmdlet. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.date: 04/23/2025 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamseventspolicy +schema: 2.0.0 +title: New-CsTeamsEventsPolicy +--- + +# New-CsTeamsEventsPolicy + +## SYNOPSIS +This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. + +## SYNTAX + +```powershell +New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-AllowTownhalls ] [-ImmersiveEvents ] [-AllowEmailEditing ] [-Description ] +[-TownhallEventAttendeeAccess ] [-RecordingForTownhall ] [-RecordingForWebinar ] +[-TranscriptionForTownhall ] [-TranscriptionForWebinar ] [-AllowEventIntegrations ] [-TownhallChatExperience ] +[-UseMicrosoftECDN ] [-EventAccessType ] [-BroadcastPremiumApps ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsEventsPolicy -Identity DisablePublicWebinars -AllowWebinars Enabled -EventAccessType EveryoneInCompanyExcludingGuests +``` + +The command shown in Example 1 creates a new per-user Teams Events policy with the Identity DisablePublicWebinars. This policy disables a user from creating public webinars. + +### Example 2 +```powershell +PS C:\> New-CsTeamsEventsPolicy -Identity DisableWebinars -AllowWebinars Disabled +``` + +The command shown in Example 2 creates a new per-user Teams Events policy with the Identity DisableWebinars. This policy disables a user from creating webinars. + +## PARAMETERS + +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. + +Possible values are: DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTownhallTypesForRecordingPublish +This setting governs which types of town halls can have their recordings published. + +Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedWebinarTypesForRecordingPublish +This setting governs which types of webinars can have their recordings published. + +Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailEditing +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. +Possible values are: + - **Enabled**: Enables editing of communication emails. + - **Disabled**: Disables editing of communication emails. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEventIntegrations +This setting governs the access to the integrations tab in the event creation workflow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTownhalls +This setting governs if a user can create town halls using Teams Events. +Possible values are: + - **Enabled**: Enables creating town halls. + - **Disabled**: Disables creating town hall. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWebinars +This setting governs if a user can create webinars using Teams Events. +Possible values are: + - **Enabled**: Enables creating webinars. + - **Disabled**: Disables creating webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastPremiumApps +This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. + +Possible values are: +- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall +- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventAccessType +This setting governs which users can access the Town hall event and access the event registration page or the event site to register for a Webinar. It also governs which user type is allowed to join the session or sessions in the event for both event types. + +Possible values are: + - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + + - **EveryoneInCompanyExcludingGuests**: For Webinar - enables creating events to allow only in-tenant users to register and join the event. For Town hall - enables creating events to allow only in-tenant users to join the event (Note: for Town hall, in-tenant users include guests; this parameter will disable public Town halls). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmersiveEvents +This setting governs if a user can create Immersive Events using Teams Events. +Possible values are: + - **Enabled**: Enables creating Immersive Events. + - **Disabled**: Disables creating Immersive Events. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForTownhall +Determines whether recording is allowed in a user's townhall. +Possible values are: + - **Enabled**: Allow recording in user's townhalls. + - **Disabled**: Prohibit recording in user's townhalls. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -RecordingForWebinar +Determines whether recording is allowed in a user's webinar. +Possible values are: + - **Enabled**: Allow recording in user's webinars. + - **Disabled**: Prohibit recording in user's webinars. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -TownhallChatExperience +This setting governs if the user can enable the Comment Stream chat experience for Townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallEventAttendeeAccess +This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. +Possible values are: + - **Everyone**: Anyone with the join link may enter the event. + - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranscriptionForTownhall +Determines whether transcriptions are allowed in a user's townhall. +Possible values are: + - **Enabled**: Allow transcriptions in user's townhalls. + - **Disabled**: Prohibit transcriptions in user's townhalls. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -TranscriptionForWebinar +Determines whether transcriptions are allowed in a user's webinar. +Possible values are: + - **Enabled**: Allow transcriptions in user's webinars. + - **Disabled**: Prohibit transcriptions in user's webinars. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMicrosoftECDN +This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch does not work with this cmdlet. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFeedbackPolicy.md similarity index 97% rename from teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsFeedbackPolicy.md index 97eb4b84ce..3101cf4a4c 100644 --- a/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFeedbackPolicy.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsfeedbackpolicy applicable: Microsoft Teams -title: New-CsTeamsFeedbackPolicy +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsfeedbackpolicy schema: 2.0.0 +title: New-CsTeamsFeedbackPolicy --- # New-CsTeamsFeedbackPolicy @@ -33,14 +35,13 @@ In this example, we create a feedback policy called New Hire Feedback Policy and ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowEmailCollection +Set this to TRUE to enable Email collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf - +Aliases: Required: False Position: Named Default value: None @@ -48,14 +49,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppress all non-fatal errors. +### -AllowLogCollection +Set this to TRUE to enable log collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -63,28 +63,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -A unique identifier. +### -AllowScreenshotCollection +Set this to TRUE to enable Screenshot collection. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: - Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -The InMemory parameter creates an object reference without actually committing the object as a permanent change. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -93,31 +92,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiveSurveysMode -Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. - -Possible values: - - Enabled - - Disabled - - EnabledUserOverride +### -EnableFeatureSuggestions + This setting will enable Tenant Admins to hide or show the Teams menu item “Help | Suggest a Feature”. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -Force +Suppress all non-fatal errors. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -128,33 +122,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserInitiatedMode - Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. - Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. - - Possible values: - - Enabled - - Disabled +### -Identity +A unique identifier. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: Enabled +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEmailCollection -Set this to TRUE to enable Email collection. +### -InMemory +The InMemory parameter creates an object reference without actually committing the object as a permanent change. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -162,27 +152,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowLogCollection -Set this to TRUE to enable log collection. +### -ReceiveSurveysMode +Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. + +Possible values: + - Enabled + - Disabled + - EnabledUserOverride ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: + Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowScreenshotCollection -Set this to TRUE to enable Screenshot collection. +### -Tenant +Internal Microsoft use only. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -190,17 +187,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFeatureSuggestions - This setting will enable Tenant Admins to hide or show the Teams menu item “Help | Suggest a Feature”. +### -UserInitiatedMode + Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. + Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. + + Possible values: + - Enabled + - Disabled ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFilesPolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsFilesPolicy.md index 96097f3869..02cdf64b03 100644 --- a/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFilesPolicy.md @@ -1,21 +1,20 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy -title: New-CsTeamsFilesPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsfilespolicy schema: 2.0.0 +title: New-CsTeamsFilesPolicy --- # New-CsTeamsFilesPolicy ## SYNOPSIS Creates a new teams files policy. -teams files policies determine whether or not files entry points to sharepoint enabled for a user. -The policies also specify third party app id to allow file storage(eg. Box). ## SYNTAX -```powershell +``` New-CsTeamsFilesPolicy [-NativeFileEntryPoints ] [-SPChannelFilesTab ] [-DefaultFileUploadAppId ] [-FileSharingInChatswithExternalUsers ] [-AutoShareFilesInExternalChats ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] @@ -36,24 +35,25 @@ The command shown in Example 1 creates a per-user teams files policy CustomTeams ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -AutoShareFilesInExternalChats + +Indicates if file scope will be changed automatically when sharing files and loops in chats with external or guest users. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NativeFileEntryPoints -This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . -Possible values are Enabled or Disabled. +### -DefaultFileUploadAppId +This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. + ```yaml Type: String Parameter Sets: (All) @@ -64,11 +64,11 @@ Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False - ``` -### -DefaultFileUploadAppId -This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. ```yaml Type: String @@ -98,26 +98,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileSharingInChatswithExternalUsers - -Indicates if file sharing in chats with external users is enabled. +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoShareFilesInExternalChats - -Indicates if file scope will be changed automatically when sharing files and loops in chats with external or guest users. - +### -NativeFileEntryPoints +This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . +Possible values are Enabled or Disabled. ```yaml Type: String Parameter Sets: (All) @@ -128,6 +126,7 @@ Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False + ``` ### -SPChannelFilesTab @@ -174,11 +173,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenMeetingTemplate.md similarity index 60% rename from teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenMeetingTemplate.md index afae69de7e..3178bb17d8 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenMeetingTemplate.md @@ -1,17 +1,18 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: New-CsTeamsHiddenMeetingTemplate -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsHiddenMeetingTemplate +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsTeamsHiddenMeetingTemplate schema: 2.0.0 +title: New-CsTeamsHiddenMeetingTemplate --- # New-CsTeamsHiddenMeetingTemplate ## SYNOPSIS -This cmdlet is used to create a `HiddenMeetingTemplate` object for use with the [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) and [Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) cmdlets. +This cmdlet is used to create a `HiddenMeetingTemplate` object. ## SYNTAX @@ -21,7 +22,9 @@ New-CsTeamsHiddenMeetingTemplate -Id [] ## DESCRIPTION -Creates an object that can be supplied as `HiddenMeetingTemplate` to the [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) and [Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) cmdlets. +Creates an object that can be supplied as `HiddenMeetingTemplate` to the +[New-CsTeamsMeetingTemplatePermissionPolicy](new-csteamsmeetingtemplatepermissionpolicy.md) and +[Set-CsTeamsMeetingTemplatePermissionPolicy](set-csteamsmeetingtemplatepermissionpolicy.md) cmdlets. ## EXAMPLES @@ -35,19 +38,20 @@ PS> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0 Creates a new HiddenMeetingTemplate object with the given template ID. -For more examples of how this can be used, see the examples for [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy). +For more examples of how this can be used, see the examples for [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy). ## PARAMETERS ### -Id +> Applicable: Microsoft Teams + ID of the meeting template to hide. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -65,8 +69,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy) -[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenTemplate.md similarity index 61% rename from teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenTemplate.md index 5df0f7b450..e706e97cba 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenTemplate.md @@ -1,20 +1,19 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate -title: New-CsTeamsHiddenTemplate author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddentemplate schema: 2.0.0 +title: New-CsTeamsHiddenTemplate --- # New-CsTeamsHiddenTemplate ## SYNOPSIS -This cmdlet is used to create a `HiddenTemplate` object for use with the [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) and [Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) cmdlets. - +This cmdlet is used to create a `HiddenTemplate` object. ## SYNTAX ``` @@ -22,7 +21,7 @@ New-CsTeamsHiddenTemplate -Id [] ``` ## DESCRIPTION -Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) and [Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) cmdlets. +Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTemplatePermissionPolicy](new-csteamstemplatepermissionpolicy.md) and [Set-CsTeamsTemplatePermissionPolicy](set-csteamstemplatepermissionpolicy.md) cmdlets. ## EXAMPLES @@ -31,7 +30,7 @@ Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTe PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject ``` -Creates a new hidden Teams template object. For more examples of how this can be used, see the examples for [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy). +Creates a new hidden Teams template object. For more examples of how this can be used, see the examples for [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy). ## PARAMETERS @@ -64,6 +63,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy) -[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsIPPhonePolicy.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsIPPhonePolicy.md index 93cdfa7a78..42de78fea6 100644 --- a/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsipphonepolicy applicable: Microsoft Teams -title: New-CsTeamsIPPhonePolicy author: tonywoodruff +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsipphonepolicy schema: 2.0.0 +title: New-CsTeamsIPPhonePolicy --- # New-CsTeamsIPPhonePolicy @@ -50,21 +51,6 @@ This example shows a new policy being created called "CommonAreaPhone" setting t ## PARAMETERS -### -Identity -The identity of the policy that you want to create. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowBetterTogether Determines whether Better Together mode is enabled, phones can lock and unlock in an integrated fashion when connected to their Windows PC running a 64-bit Teams desktop client. Possible values this parameter can take: @@ -179,6 +165,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +The identity of the policy that you want to create. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SearchOnCommonAreaPhoneMode Determines whether a user can search the Global Address List in Common Area Phone Mode. Set this to ENABLED to enable the feature. Set this to DISABLED to disable the feature. diff --git a/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMediaConnectivityPolicy.md similarity index 85% rename from teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMediaConnectivityPolicy.md index 3f141907b4..dcd649f436 100644 --- a/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: New-CsTeamsMediaConnectivityPolicy -online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMediaConnectivityPolicy -schema: 2.0.0 author: lirunping-MSFT +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: runli +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +title: New-CsTeamsMediaConnectivityPolicy --- # New-CsTeamsMediaConnectivityPolicy @@ -38,30 +39,30 @@ The newly created policy with value will be printed on success. ## PARAMETERS -### -Identity -Identity of the Teams media connectivity policy. +### -DirectConnection +This setting will enable Tenant Admins to control the Teams media connectivity behavior in Teams for both Meetings and 1:1 calls. If this setting is set to true, a direct media connection between the current user and a remote user is allowed which may improve the meeting quality and reduce the egress bandwidth usage for the customer. If this setting is set to disabled, no direct media connection will be allowed for the current user. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DirectConnection -This setting will enable Tenant Admins to control the Teams media connectivity behavior in Teams for both Meetings and 1:1 calls. If this setting is set to true, a direct media connection between the current user and a remote user is allowed which may improve the meeting quality and reduce the egress bandwidth usage for the customer. If this setting is set to disabled, no direct media connection will be allowed for the current user. +### -Identity +Identity of the Teams media connectivity policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -78,10 +79,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy) -[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy) -[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy) -[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy.md similarity index 92% rename from teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy.md index 6a2c7ee7cd..6f95d151b3 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy schema: 2.0.0 title: New-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # New-CsTeamsMeetingBrandingPolicy @@ -43,14 +43,13 @@ In this example, the command will create an empty meeting branding policy with t ## PARAMETERS -### -DefaultTheme -*This parameter is reserved for Microsoft internal use only.* -Identity of default meeting theme. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -59,11 +58,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingBackgroundImages -Enable custom meeting backgrounds. +### -DefaultTheme +*This parameter is reserved for Microsoft internal use only.* +Identity of default meeting theme. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -74,8 +74,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingOptionsThemeOverride -Allow organizer to control meeting theme. +### -EnableMeetingBackgroundImages +Enable custom meeting backgrounds. ```yaml Type: Boolean @@ -89,28 +89,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Identity of meeting branding policy that will be created. +### -EnableMeetingOptionsThemeOverride +Allow organizer to control meeting theme. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingBackgroundImages -*This parameter is reserved for Microsoft internal use only.* -List of meeting background images. -Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. +### -EnableNdiAssuranceSlate +This enables meeting Network Device Interface Assurance Slate branding. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) Aliases: @@ -121,13 +119,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingBrandingThemes -*This parameter is reserved for Microsoft internal use only.* -List of meeting branding themes. -Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -138,26 +134,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNdiAssuranceSlate -This enables meeting Network Device Interface Assurance Slate branding. +### -Identity +Identity of meeting branding policy that will be created. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NdiAssuranceSlateImages -Used to specify images that can be used as assurance slates during NDI (Network Device Interface) streaming in Teams meetings. This parameter allows administrators to define a set of images that can be displayed to participants to ensure that the NDI stream is functioning correctly. +### -MeetingBackgroundImages +*This parameter is reserved for Microsoft internal use only.* +List of meeting background images. +Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.NdiAssuranceSlate] +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -168,11 +166,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireBackgroundEffect -This mandates a meeting background for participants. +### -MeetingBrandingThemes +*This parameter is reserved for Microsoft internal use only.* +List of meeting branding themes. +Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -183,13 +183,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NdiAssuranceSlateImages +Used to specify images that can be used as assurance slates during NDI (Network Device Interface) streaming in Teams meetings. This parameter allows administrators to define a set of images that can be displayed to participants to ensure that the NDI stream is functioning correctly. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.NdiAssuranceSlate] Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -198,11 +198,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -RequireBackgroundEffect +This mandates a meeting background for participants. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -241,12 +241,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy.md similarity index 90% rename from teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy.md index 898cfcd848..ebde7b3258 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbroadcastpolicy applicable: Microsoft Teams -title: New-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: New-CsTeamsMeetingBroadcastPolicy --- # New-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS - -New-CsTeamsMeetingBroadcastPolicy \[-Identity\] \ \[-Tenant \\] \[-Description \\] \[-AllowBroadcastScheduling \\] \[-AllowBroadcastTranscription \\] \[-BroadcastAttendeeVisibilityMode \\] \[-BroadcastRecordingMode \\] \[-InMemory\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] +Use this cmdlet to create a new policy. ## SYNTAX @@ -26,7 +27,7 @@ New-CsTeamsMeetingBroadcastPolicy [-Tenant ] [-Description ] ``` ## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to create a new policy. +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## EXAMPLES diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingPolicy.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingPolicy.md index 531907c565..eeb72afd3f 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingPolicy.md @@ -1,23 +1,24 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingpolicy -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: New-CsTeamsMeetingPolicy -schema: 2.0.0 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.date: 02/26/2025 ms.reviewer: alejandramu -ms.date: 2/26/2025 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingpolicy +schema: 2.0.0 +title: New-CsTeamsMeetingPolicy --- # New-CsTeamsMeetingPolicy ## SYNOPSIS - The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. +The New-CsTeamsMeetingPolicy cmdlet allows administrators to define new meeting policies that can be assigned to particular users to control Teams features related to meetings. ## SYNTAX -```powershell +``` New-CsTeamsMeetingPolicy [-Identity] [-AIInterpreter ] [-AllowAnonymousUsersToDialOut ] @@ -130,10 +131,9 @@ New-CsTeamsMeetingPolicy [-Identity] ## DESCRIPTION The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. -The New-CsTeamsMeetingPolicy cmdlet allows administrators to define new meeting policies that can be assigned to particular users to control Teams features related to meetings. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $True ``` @@ -141,7 +141,7 @@ New-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $True The command shown in Example 1 uses the New-CsTeamsMeetingPolicy cmdlet to create a new meeting policy with the Identity SalesMeetingPolicy. This policy will use all the default values for a meeting policy except one: AllowTranscription; in this example, meetings for users with this policy can include real time or post meeting captions and transcriptions. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsTeamsMeetingPolicy -Identity HrMeetingPolicy -AutoAdmittedUsers "Everyone" -AllowMeetNow $False ``` @@ -152,22 +152,10 @@ All other policy properties will use the default values. ## PARAMETERS -### -Identity -Specify the name of the policy being created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -182,7 +170,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -191,11 +178,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsersToDialOut -Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to #prohibit anonymous users from dialing out. - -> [!NOTE] -> This parameter is temporarily disabled. +### -AllowAnnotations +This setting will allow admins to choose which users will be able to use the Annotation feature. ```yaml Type: Boolean @@ -209,12 +193,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsersToJoinMeeting +### -AllowAnonymousUsersToDialOut +Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to #prohibit anonymous users from dialing out. > [!NOTE] -> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check for details. - -Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting. +> This parameter is temporarily disabled. ```yaml Type: Boolean @@ -223,13 +206,17 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsersToStartMeeting -Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting +### -AllowAnonymousUsersToJoinMeeting + +> [!NOTE] +> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check for details. + +Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting. ```yaml Type: Boolean @@ -238,13 +225,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnnotations -This setting will allow admins to choose which users will be able to use the Annotation feature. +### -AllowAnonymousUsersToStartMeeting +Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting ```yaml Type: Boolean @@ -373,6 +360,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. + +Possible values are: + +- \ +- RTMP + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowedUsersForMeetingContext This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. @@ -389,6 +395,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowedUsersForMeetingDetails +Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. + +Possible Values: +- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. +- Everyone: All meeting participants can see the meeting info details. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: UsersAllowedToByPassTheLobby +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowEngagementReport Determines whether users are allowed to download the attendee engagement report. Set this to Enabled to allow the user to download the report. Set this to Disabled to prohibit the user to download it. ForceEnabled will enable attendee report generation and prohibit meeting organizer from disabling it. @@ -501,21 +526,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetNow -Determines whether a user can start ad-hoc meetings in a channel. Set this to TRUE to allow a user to start ad-hoc meetings in a channel. Set this to FALSE to prohibit the user from starting ad-hoc meetings in a channel. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: TRUE -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowMeetingCoach This setting will allow admins to allow users the option of turning on Meeting Coach during meetings, which provides users with private personalized feedback on their communication and inclusivity. If set to True, then users will see and be able to click the option for turning on Meeting Coach during calls. If set to False, then users will not have the option to turn on Meeting Coach during calls. @@ -566,6 +576,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowMeetNow +Determines whether a user can start ad-hoc meetings in a channel. Set this to TRUE to allow a user to start ad-hoc meetings in a channel. Set this to FALSE to prohibit the user from starting ad-hoc meetings in a channel. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowNDIStreaming This parameter is reserved for internal Microsoft use. @@ -626,8 +651,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetNow -Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc private meetings. Set this to FALSE to prohibit the user from starting ad-hoc private meetings. +### -AllowParticipantGiveRequestControl +Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting ```yaml Type: Boolean @@ -636,13 +661,13 @@ Aliases: Required: False Position: Named -Default value: TRUE +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowParticipantGiveRequestControl -Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting +### -AllowPowerPointSharing +Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit ```yaml Type: Boolean @@ -656,8 +681,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPowerPointSharing -Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit +### -AllowPrivateMeetingScheduling +Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -671,8 +696,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetingScheduling -Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. +### -AllowPrivateMeetNow +Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc private meetings. Set this to FALSE to prohibit the user from starting ad-hoc private meetings. ```yaml Type: Boolean @@ -681,7 +706,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: TRUE Accept pipeline input: False Accept wildcard characters: False ``` @@ -840,8 +865,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForScreenSharing -This setting allows scheduling meetings with watermarking for screen sharing enabled. +### -AllowWatermarkForCameraVideo +This setting allows scheduling meetings with watermarking for video enabled. ```yaml Type: Boolean @@ -855,8 +880,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForCameraVideo -This setting allows scheduling meetings with watermarking for video enabled. +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermarking for screen sharing enabled. ```yaml Type: Boolean @@ -885,25 +910,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedStreamingMediaInput -Enables the use of RTMP-In in Teams meetings. - -Possible values are: - -- \ -- RTMP - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AnonymousUserAuthenticationMethod Determines how anonymous users will be authenticated when joining a meeting. @@ -1054,18 +1060,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectToMeetingControls -Allows external connections of thirdparty apps to Microsoft Teams - -Possible values are: - -Enabled -Disabled +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -1074,13 +1075,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -ConnectToMeetingControls +Allows external connections of thirdparty apps to Microsoft Teams + +Possible values are: + +Enabled +Disabled ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -1213,7 +1219,7 @@ Accept wildcard characters: False ### -ExplicitRecordingConsent Set participant agreement and notification for Recording, Transcript, Copilot in Teams meetings. -Possible Values: +Possible Values: - Enabled: Explicit consent, requires participant agreement. - Disabled: Implicit consent, does not require participant agreement. @@ -1265,6 +1271,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Specify the name of the policy being created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InfoShownInReportMode This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. @@ -1325,13 +1346,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LiveInterpretationEnabledType -Allows meeting organizers to configure a meeting for language interpretation, selecting attendees of the meeting to become interpreters that other attendees can select and listen to the real-time translation they provide. - -Possible values are: - -DisabledUserOverride, if you would like users to be able to use interpretation in meetings but by default it is disabled. -Disabled, prevents the option to be enabled in Meeting Options. +### -LiveCaptionsEnabledType +Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit. ```yaml Type: String @@ -1345,8 +1361,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LiveCaptionsEnabledType -Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit. +### -LiveInterpretationEnabledType +Allows meeting organizers to configure a meeting for language interpretation, selecting attendees of the meeting to become interpreters that other attendees can select and listen to the real-time translation they provide. + +Possible values are: + +DisabledUserOverride, if you would like users to be able to use interpretation in meetings but by default it is disabled. +Disabled, prevents the option to be enabled in Meeting Options. ```yaml Type: String @@ -1434,6 +1455,9 @@ Accept wildcard characters: False ``` ### -MeetingInviteLanguages + +> Applicable: Microsoft Teams + Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed. > [!NOTE] @@ -1447,7 +1471,6 @@ The preliminary list of available languages is shown below: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1476,6 +1499,8 @@ Accept wildcard characters: False ### -NoiseSuppressionForDialInParticipants +> Applicable: Microsoft Teams + >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1491,7 +1516,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1517,6 +1541,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParticipantSlideControl + +> Applicable: Microsoft Teams + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Determines whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibited from giving control, or being given control, in a meeting. + +Possible Values: +- Everyone: Anyone in the meeting can give or take control +- EveryoneInOrganization: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control +- EveryoneInOrganizationAndGuests: Only those who are Guests to the tenant, MTO users, and internal AAD users can give or take control +- None: No one in the meeting can give or take control + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PreferredMeetingProviderForIslandsMode Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in. @@ -1547,6 +1598,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RealTimeText + +> Applicable: Microsoft Teams + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecordingStorageMode This parameter can take two possible values: @@ -1773,6 +1849,8 @@ Accept wildcard characters: False ### -VoiceSimulationInInterpreter +> Applicable: Microsoft Teams + > [!NOTE] > This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1787,7 +1865,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1871,73 +1948,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedUsersForMeetingDetails -Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. - -Possible Values: -- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. -- Everyone: All meeting participants can see the meeting info details. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: UsersAllowedToByPassTheLobby -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RealTimeText ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. - -Possible Values: -- Enabled: User is allowed to turn on real time text. -- Disabled: User is not allowed to turn on real time text. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParticipantSlideControl ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -Determines whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibited from giving control, or being given control, in a meeting. - -Possible Values: -- Everyone: Anyone in the meeting can give or take control -- EveryoneInOrganization: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control -- EveryoneInOrganizationAndGuests: Only those who are Guests to the tenant, MTO users, and internal AAD users can give or take control -- None: No one in the meeting can give or take control - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 78% rename from teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingTemplatePermissionPolicy.md index 48a5347d44..c8392699c3 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: New-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMeetingTemplatePermissionPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/New-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: New-CsTeamsMeetingTemplatePermissionPolicy --- # New-CsTeamsMeetingTemplatePermissionPolicy @@ -20,7 +21,7 @@ Creates a new instance of the TeamsMeetingTemplatePermissionPolicy. ``` ## DESCRIPTION -Creates a new instance of the policy with a name and a list of hidden meeting template IDs. The template IDs passed into the `HiddenMeetingTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamsMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplateconfiguration) and [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsfirstpartymeetingtemplateconfiguration) respectively. +Creates a new instance of the policy with a name and a list of hidden meeting template IDs. The template IDs passed into the `HiddenMeetingTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamsMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplateconfiguration) and [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfirstpartymeetingtemplateconfiguration) respectively. ## EXAMPLES @@ -44,15 +45,16 @@ Description : This is a test policy ## PARAMETERS -### -Identity +### -Description -Name of the new policy instance to be created. +> Applicable: Microsoft Teams + +Description of the new policy instance to be created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -62,14 +64,15 @@ Accept wildcard characters: False ### -HiddenMeetingTemplates +> Applicable: Microsoft Teams + The list of meeting template IDs to hide. -The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddenmeetingtemplate). ```yaml Type: HiddenMeetingTemplate[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -77,15 +80,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Description of the new policy instance to be created. +> Applicable: Microsoft Teams + +Name of the new policy instance to be created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -103,12 +107,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate) +[New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddenmeetingtemplate) -[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy) -[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMessagingPolicy.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMessagingPolicy.md index f25c5317c1..f421e0536e 100644 --- a/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMessagingPolicy.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmessagingpolicy applicable: Microsoft Teams -title: New-CsTeamsMessagingPolicy +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmessagingpolicy schema: 2.0.0 +title: New-CsTeamsMessagingPolicy --- # New-CsTeamsMessagingPolicy @@ -75,20 +77,6 @@ All other policy properties will use the default values. ## PARAMETERS -### -Identity -Unique identifier for the teams messaging policy to be created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` ### -AllowChatWithGroup This setting determines if users can chat with groups (Distribution, M365 and Security groups). Possible values: True, False @@ -648,6 +636,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique identifier for the teams messaging policy to be created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -InMemory Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. @@ -762,10 +764,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingpolicy) +[Set-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmessagingpolicy) -[Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy) +[Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmessagingpolicy) -[Grant-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmessagingpolicy) +[Grant-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmessagingpolicy) -[Remove-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmessagingpolicy) +[Remove-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmessagingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMobilityPolicy.md similarity index 96% rename from teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMobilityPolicy.md index 8bd31ac80b..0388da6660 100644 --- a/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmobilitypolicy applicable: Microsoft Teams -title: New-CsTeamsMobilityPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmobilitypolicy +schema: 2.0.0 +title: New-CsTeamsMobilityPolicy --- # New-CsTeamsMobilityPolicy @@ -82,6 +84,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Specify the name of the policy that you are creating. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IPAudioMobileMode When set to WifiOnly, prohibits the user from making and receiving calls or joining meetings using VoIP calls on the mobile device while on a cellular data connection. Possible values are: WifiOnly, AllNetworks. @@ -112,16 +129,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy that you are creating. +### -MobileDialerPreference +Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. +For more information, see [Manage user incoming calling policies](https://learn.microsoft.com/microsoftteams/operator-connect-mobile-configure#manage-user-incoming-calling-policies). ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -143,22 +161,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MobileDialerPreference -Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. -For more information, see [Manage user incoming calling policies](https://learn.microsoft.com/microsoftteams/operator-connect-mobile-configure#manage-user-incoming-calling-policies). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy.md similarity index 97% rename from teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy.md index 54b53972d8..f75b17c907 100644 --- a/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsnetworkroamingpolicy applicable: Microsoft Teams -title: New-CsTeamsNetworkRoamingPolicy author: TristanChen-msft -ms.author: jiaych -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsnetworkroamingpolicy schema: 2.0.0 +title: New-CsTeamsNetworkRoamingPolicy --- # New-CsTeamsNetworkRoamingPolicy @@ -50,63 +50,63 @@ The command shown in Example 2 creates a new teams network roaming policy with ## PARAMETERS -### -Identity -Unique identifier of the policy to be created. +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. +Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPVideo -Determines whether video is enabled in a user's meetings or calls. -Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. +### -Description +Description of the new policy to be created. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings. +### -Identity +Unique identifier of the policy to be created. ```yaml -Type: Integer +Type: XdsIdentity Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 50000 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the new policy to be created. +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. ```yaml -Type: String +Type: Integer Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: 50000 Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRecordingRollOutPolicy.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsRecordingRollOutPolicy.md index be3f26d1a2..2494dadd08 100644 --- a/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsrecordingrolloutpolicy -schema: 2.0.0 applicable: Microsoft Teams -title: New-CsTeamsRecordingRollOutPolicy -manager: yujin1 author: ronwa +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams ms.author: ronwa +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsrecordingrolloutpolicy +schema: 2.0.0 +title: New-CsTeamsRecordingRollOutPolicy --- # New-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 93% rename from teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsRoomVideoTeleConferencingPolicy.md index ad5c601ece..39da8904d1 100644 --- a/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,225 +1,228 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsroomvideoteleconferencingpolicy -title: New-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# New-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Creates a new TeamsRoomVideoTeleConferencingPolicy. - -## SYNTAX - -```powershell -New-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-AreaCode ] [-Description ] - [-Enabled ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] - [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -AreaCode - -GUID provided by the CVI partner that the customer signed the agreement with. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled - -The policy can exist for the tenant but it can be enabled or disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the policy to be modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceExternalCalls - -The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceInternalCalls - -The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveExternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveInternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: New-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# New-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Creates a new TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +``` +New-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-AreaCode ] [-Description ] + [-Enabled ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] + [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## EXAMPLES + +## PARAMETERS + +### -AreaCode + +GUID provided by the CVI partner that the customer signed the agreement with. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + +The policy can exist for the tenant but it can be enabled or disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceExternalCalls + +The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceInternalCalls + +The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveExternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveInternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSharedCallingRoutingPolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsSharedCallingRoutingPolicy.md index 1b61b77f9d..cb745646ea 100644 --- a/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy applicable: Microsoft Teams author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: -title: New-CsTeamsSharedCallingRoutingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy schema: 2.0.0 +title: New-CsTeamsSharedCallingRoutingPolicy --- # New-CsTeamsSharedCallingRoutingPolicy @@ -49,17 +48,20 @@ The command shown in Example 1 gets the identity and phone number assigned to th ## PARAMETERS -### -Identity -Unique identifier of the Teams shared calling routing policy to be created. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -102,69 +104,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceAccount -The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. +### -Force -The phone number assigned to the resource account must: -- Have the same phone number type and country as the emergency numbers configured in this policy instance. -- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. -- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. +> Applicable: Microsoft Teams -The same resource account can be used in multiple shared calling policy instances. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity +Unique identifier of the Teams shared calling routing policy to be created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -ResourceAccount +The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. + +The phone number assigned to the resource account must: +- Have the same phone number type and country as the emergency numbers configured in this policy instance. +- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) and the -LocationId parameter to set the location. +- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. + +The same resource account can be used in multiple shared calling policy instances. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -190,12 +195,12 @@ Shared Calling is not supported for Calling Plan service phone numbers in Romani This cmdlet was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS -[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy) -[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy) -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnection.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnection.md index f09cf35e77..a974b03ef3 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection schema: 2.0.0 +title: New-CsTeamsShiftsConnection --- # New-CsTeamsShiftsConnection @@ -128,6 +129,21 @@ TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ## PARAMETERS +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Body The request body. @@ -159,23 +175,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId -The WFM connector ID. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: NewExpanded -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connection name. +### -ConnectorId +The WFM connector ID. ```yaml Type: String @@ -204,13 +220,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline ```yaml -Type: SwitchParameter +Type: SendAsyncStep[] Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -219,8 +235,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline ```yaml Type: SendAsyncStep[] @@ -234,15 +250,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -Name +The connection name. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -324,21 +340,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -356,12 +357,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnection) -[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnection) -[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector) +[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionconnector) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionBatchTeamMap.md similarity index 89% rename from teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionBatchTeamMap.md index 0dcfcf6db0..4932e4be78 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionBatchTeamMap.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnectionBatchTeamMap -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectionbatchteammap schema: 2.0.0 +title: New-CsTeamsShiftsConnectionBatchTeamMap --- # New-CsTeamsShiftsConnectionBatchTeamMap @@ -23,7 +24,7 @@ New-CsTeamsShiftsConnectionBatchTeamMap -ConnectorInstanceId -TeamMappi ## DESCRIPTION -This cmdlet connects multiple Microsoft Teams teams and WFM teams to allow for synchronization of shifts related data. It initiates an asynchronous job to map the WFM teams to the Microsoft Teams teams. You can check the operation status by running [Get-CsTeamsShiftsConnectionOperation](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation). +This cmdlet connects multiple Microsoft Teams teams and WFM teams to allow for synchronization of shifts related data. It initiates an asynchronous job to map the WFM teams to the Microsoft Teams teams. You can check the operation status by running [Get-CsTeamsShiftsConnectionOperation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionoperation). ## EXAMPLES @@ -55,13 +56,14 @@ Sends 2 team mappings: one maps the Teams team with ID `eddc3b94-21d5-4ef0-a76a- ### -ConnectorInstanceId +> Applicable: Microsoft Teams + The connection instance ID used to map teams. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -71,13 +73,14 @@ Accept wildcard characters: False ### -TeamMapping +> Applicable: Microsoft Teams + The Teams mapping object list. ```yaml Type: TeamMap[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -97,4 +100,4 @@ Please check the example section for the format of TeamMap. ## RELATED LINKS -[Get-CsTeamsShiftsConnectionOperation](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation) +[Get-CsTeamsShiftsConnectionOperation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionoperation) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionInstance.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionInstance.md index 9570c08ad4..ea7bc5e45f 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: leonardospina external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnectionInstance -author: leonardospina ms.author: lespina -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance schema: 2.0.0 +title: New-CsTeamsShiftsConnectionInstance --- # New-CsTeamsShiftsConnectionInstance @@ -140,29 +141,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorAdminEmail -Gets or sets the list of connector admin email addresses. +### -ConnectionId +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). ```yaml -Type: String[] +Type: String Parameter Sets: NewExpanded Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId -Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -ConnectorAdminEmail +Gets or sets the list of connector admin email addresses. ```yaml -Type: String +Type: String[] Parameter Sets: NewExpanded Aliases: -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False @@ -183,36 +184,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Name +The connector instance name. ```yaml Type: String @@ -225,50 +226,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". - +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: Uri +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioSwapRequest -The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String @@ -281,11 +281,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -SyncFrequencyInMin +The sync frequency in minutes. ```yaml -Type: String +Type: Int32 Parameter Sets: NewExpanded Aliases: Required: True @@ -295,8 +295,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -309,36 +309,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connector instance name. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -351,49 +351,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -SyncScenarioSwapRequest +The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + ```yaml -Type: Uri -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: PSCredential -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -406,11 +407,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin -The sync frequency in minutes. +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Int32 +Type: String Parameter Sets: NewExpanded Aliases: Required: True @@ -452,12 +453,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance) -[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector) +[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionconnector) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsPolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsPolicy.md index 57a7c3e428..c44da9fe74 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsPolicy.md @@ -1,228 +1,243 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-teamsshiftspolicy -title: New-CsTeamsShiftsPolicy -schema: 2.0.0 ---- - -# New-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. - -## SYNTAX - -```powershell -New-CsTeamsShiftsPolicy [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] - [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] - [-EnableScheduleOwnerPermissions ] [-Identity] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, schedule owner permissions, and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -``` - -Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the default values to its settings. - -### Example 2 -```powershell -PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false -``` - -Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. - -## PARAMETERS - -### -Identity -Policy instance name. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessType -Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. -Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. -For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: UnrestrictedAccess_TeamsApp -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeFrequency -Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageType -The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. -'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. -'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. -'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. -'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. -'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. -'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. -'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. -'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. -'CustomMessage' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: DefaultMessage -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageCustom -Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessGracePeriodMinutes -Indicates the grace period time in minutes between when the first shift starts or last shift ends and when access is blocked. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableScheduleOwnerPermissions -Indicates whether a user can manage a Shifts schedule as a team member. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-teamsshiftspolicy +schema: 2.0.0 +title: New-CsTeamsShiftsPolicy +--- + +# New-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. + +## SYNTAX + +```powershell +New-CsTeamsShiftsPolicy [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] + [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] + [-EnableScheduleOwnerPermissions ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, schedule owner permissions, and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always +``` + +Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the default values to its settings. + +### Example 2 +```powershell +PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false +``` + +Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. + +## PARAMETERS + +### -AccessGracePeriodMinutes + +> Applicable: Microsoft Teams + +Indicates the grace period time in minutes between when the first shift starts or last shift ends and when access is blocked. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessType + +> Applicable: Microsoft Teams + +Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. +Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. +For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: UnrestrictedAccess_TeamsApp +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableScheduleOwnerPermissions + +> Applicable: Microsoft Teams + +Indicates whether a user can manage a Shifts schedule as a team member. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Microsoft Teams + +Policy instance name. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeFrequency + +> Applicable: Microsoft Teams + +Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageCustom + +> Applicable: Microsoft Teams + +Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageType + +> Applicable: Microsoft Teams + +The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. +'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. +'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. +'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. +'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. +'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. +'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. +'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. +'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. +'CustomMessage' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: DefaultMessage +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftspolicy) + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliance.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliance.md index e4ca073509..e7313c7241 100644 --- a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliance.md @@ -1,160 +1,165 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliance -title: New-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# New-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -New-CsTeamsSurvivableBranchAppliance [-Identity] [-Description ] [-Site ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey - -```powershell -New-CsTeamsSurvivableBranchAppliance [-Description ] [-Site ] - [-MsftInternalProcessingMode ] -Fqdn [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Free format text. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fqdn - -The FQDN of the SBA. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the SBA. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -The TenantNetworkSite where the SBA is located - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssurvivablebranchappliance +schema: 2.0.0 +title: New-CsTeamsSurvivableBranchAppliance +--- + +# New-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Creates a new Survivable Branch Appliance (SBA) object in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +New-CsTeamsSurvivableBranchAppliance [-Identity] [-Description ] [-Site ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey + +``` +New-CsTeamsSurvivableBranchAppliance [-Description ] [-Site ] + [-MsftInternalProcessingMode ] -Fqdn [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Free format text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn + +The FQDN of the SBA. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the SBA. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site + +The TenantNetworkSite where the SBA is located + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 91% rename from teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliancePolicy.md index 4fe55cb48c..f8af4e76c3 100644 --- a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,119 +1,124 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliancepolicy -title: New-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# New-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -New-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-BranchApplianceFqdns ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -BranchApplianceFqdns - -The FQDN of the SBA(s) in the site. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The unique identifier. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: New-CsTeamsSurvivableBranchAppliancePolicy +--- + +# New-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Creates a new Survivable Branch Appliance (SBA) policy object in the tenant. + +## SYNTAX + +```powershell +New-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-BranchApplianceFqdns ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -BranchApplianceFqdns + +The FQDN of the SBA(s) in the site. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The unique identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTemplatePermissionPolicy.md similarity index 86% rename from teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsTemplatePermissionPolicy.md index 88462d4a72..e06420aca1 100644 --- a/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTemplatePermissionPolicy.md @@ -1,163 +1,163 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy -title: New-CsTeamsTemplatePermissionPolicy -author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: -manager: weiliu2 -schema: 2.0.0 ---- - -# New-CsTeamsTemplatePermissionPolicy - -## SYNOPSIS -Creates a new instance of the TeamsTemplatePermissionPolicy. - -## SYNTAX - -``` -New-CsTeamsTemplatePermissionPolicy - [-HiddenTemplates ] - [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Creates a new instance of the policy with a name and a list of hidden Teams template IDs. The template IDs passed into the `HiddenTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist). - -## EXAMPLES - -### Example 1 - -Assuming there are two valid templates with IDs `com.microsoft.teams.template.ManageAProject` and `com.microsoft.teams.template.ManageAnEvent`, we will first create the `HiddenTemplate` objects. - -The next step would be to create the policy instance. -```powershell -PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent -PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject -PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) -PS >New-CsTeamsTemplatePermissionPolicy -Identity Foobar -HiddenTemplates $HiddenList -``` - -```output -Identity HiddenTemplates Description --------- --------------- ----------- -Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} -``` - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of the new policy instance to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. - -You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenTemplates -The list of Teams template IDs to hide. -The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). - -```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Name of the new policy instance to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### TeamsTemplatePermissionPolicy.Cmdlets.TeamsTemplatePermissionPolicy - -## NOTES - -## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) - -[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) - -[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) +--- +author: yishuaihuang4 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy +schema: 2.0.0 +title: New-CsTeamsTemplatePermissionPolicy +--- + +# New-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Creates a new instance of the TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +New-CsTeamsTemplatePermissionPolicy + [-HiddenTemplates ] + [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a new instance of the policy with a name and a list of hidden Teams template IDs. The template IDs passed into the `HiddenTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist). + +## EXAMPLES + +### Example 1 + +Assuming there are two valid templates with IDs `com.microsoft.teams.template.ManageAProject` and `com.microsoft.teams.template.ManageAnEvent`, we will first create the `HiddenTemplate` objects. + +The next step would be to create the policy instance. +```powershell +PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) +PS >New-CsTeamsTemplatePermissionPolicy -Identity Foobar -HiddenTemplates $HiddenList +``` + +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenTemplates +The list of Teams template IDs to hide. +The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddentemplate). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsTemplatePermissionPolicy.Cmdlets.TeamsTemplatePermissionPolicy + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTranslationRule.md similarity index 93% rename from teams/teams-ps/teams/New-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsTranslationRule.md index e760bec361..f376afd695 100644 --- a/teams/teams-ps/teams/New-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule applicable: Microsoft Teams -title: New-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstranslationrule +schema: 2.0.0 +title: New-CsTeamsTranslationRule --- # New-CsTeamsTranslationRule @@ -76,15 +77,16 @@ This example creates a rule that adds the last four digits of a phone number sta ## PARAMETERS -### -Identity -The Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: (Identity) -Aliases: -Required: True -Position: 1 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -105,58 +107,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Pattern -A regular expression that caller or callee number must match in order for this rule to be applied. +### -Identity +The Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (Identity) Aliases: - -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Translation -The regular expression pattern that will be applied to the number to convert it. +### -Name +The name of the rule. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (ParentAndRelativeKey) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The name of the rule. +### -Pattern +A regular expression that caller or callee number must match in order for this rule to be applied. ```yaml Type: String -Parameter Sets: (ParentAndRelativeKey) +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. +### -Translation +The regular expression pattern that will be applied to the number to convert it. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -165,13 +166,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -190,10 +191,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamstranslationrule) -[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstranslationrule) -[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstranslationrule) -[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUnassignedNumberTreatment.md similarity index 74% rename from teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsUnassignedNumberTreatment.md index cf47048628..0fd18acbb5 100644 --- a/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUnassignedNumberTreatment.md @@ -1,201 +1,253 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment -applicable: Microsoft Teams -title: New-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# New-CsTeamsUnassignedNumberTreatment - -## SYNOPSIS -Creates a new treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. - -## SYNTAX - -### Identity (Default) -``` -New-CsTeamsUnassignedNumberTreatment [-Identity] [-Description ] [-Pattern ] [-Target ] - [-TargetType ] [-TreatmentPriority ] - [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey -``` -New-CsTeamsUnassignedNumberTreatment -TreatmentId [-Description ] [-Pattern ] [-Target ] - [-TargetType ] [-TreatmentPriority ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet creates a treatment for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa@contoso.com).ObjectId -New-CsTeamsUnassignedNumberTreatment -Identity MainAA -Pattern "^\+15552223333$" -TargetType ResourceAccount -Target $RAObjectId -TreatmentPriority 1 -``` -This example creates a treatment that will route all calls to the number +1 (555) 222-3333 to the resource account aa@contoso.com. -That resource account is associated with an Auto Attendant (not part of the example). - -### Example 2 -```powershell -$Content = Get-Content "C:\Media\MainAnnoucement.wav" -Encoding byte -ReadCount 0 -$AudioFile = Import-CsOnlineAudioFile -FileName "MainAnnouncement.wav" -Content $Content -$Fid=[System.Guid]::Parse($audioFile.Id) -New-CsTeamsUnassignedNumberTreatment -Identity TR1 -Pattern "^\+1555333\d{4}$" -TargetType Announcement -Target $Fid.Guid -TreatmentPriority 2 -``` -This example creates a treatment that will route all calls to unassigned numbers in the range +1 (555) 333-0000 to +1 (555) 333-9999 to the announcement service, -where the audio file MainAnnouncement.wav will be played to the caller. - -### Example 3 -```powershell -$UserObjectId = (Get-CsOnlineUser -Identity user@contoso.com).Identity -New-CsTeamsUnassignedNumberTreatment -Identity TR2 -Pattern "^\+15552224444$" -TargetType User -Target $UserObjectId -TreatmentPriority 3 -``` -This example creates a treatment that will route all calls to the number +1 (555) 222-4444 to the user user@contoso.com. - -## PARAMETERS - -### -Description -Free format description of this treatment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Id of the treatment. - -```yaml -Type: System.String -Parameter Sets: (Identity) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern -A regular expression that the called number must match in order for the treatment to take effect. It is best practice to start the regular expression with the hat character and end it with the dollar character. -You can use various regular expression test sites on the Internet to validate the expression. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetType -The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatmentId -The identity of the treatment. - -```yaml -Type: System.String -Parameter Sets: (ParentAndRelativeKey) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatmentPriority -The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - -```yaml -Type: System.Integer -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.5.1 or later. - -The parameters Identity and TreatmentId are mutually exclusive. - -To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. - -To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. - -Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. - -If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to -the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains -a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. - -## RELATED LINKS -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) - -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) - -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) - -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) - -[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment +schema: 2.0.0 +title: New-CsTeamsUnassignedNumberTreatment +--- + +# New-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +Creates a new treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsUnassignedNumberTreatment -Identity [-Description ] [-Pattern ] + [-Target ] [-TargetType ] [-TreatmentPriority ] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsTeamsUnassignedNumberTreatment [-Description ] [-Pattern ] [-Target ] + [-TargetType ] [-TreatmentPriority ] [-MsftInternalProcessingMode ] + -TreatmentId [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet creates a treatment for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa@contoso.com).ObjectId +New-CsTeamsUnassignedNumberTreatment -Identity MainAA -Pattern "^\+15552223333$" -TargetType ResourceAccount -Target $RAObjectId -TreatmentPriority 1 +``` +This example creates a treatment that will route all calls to the number +1 (555) 222-3333 to the resource account aa@contoso.com. +That resource account is associated with an Auto Attendant (not part of the example). + +### Example 2 +```powershell +$Content = Get-Content "C:\Media\MainAnnoucement.wav" -Encoding byte -ReadCount 0 +$AudioFile = Import-CsOnlineAudioFile -FileName "MainAnnouncement.wav" -Content $Content +$Fid=[System.Guid]::Parse($audioFile.Id) +New-CsTeamsUnassignedNumberTreatment -Identity TR1 -Pattern "^\+1555333\d{4}$" -TargetType Announcement -Target $Fid.Guid -TreatmentPriority 2 +``` +This example creates a treatment that will route all calls to unassigned numbers in the range +1 (555) 333-0000 to +1 (555) 333-9999 to the announcement service, +where the audio file MainAnnouncement.wav will be played to the caller. + +### Example 3 +```powershell +$UserObjectId = (Get-CsOnlineUser -Identity user@contoso.com).Identity +New-CsTeamsUnassignedNumberTreatment -Identity TR2 -Pattern "^\+15552224444$" -TargetType User -Target $UserObjectId -TreatmentPriority 3 +``` +This example creates a treatment that will route all calls to the number +1 (555) 222-4444 to the user user@contoso.com. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free format description of this treatment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the treatment. + +```yaml +Type: System.String +Parameter Sets: Identity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that the called number must match in order for the treatment to take effect. It is best practice to start the regular expression with the hat character and end it with the dollar character. +You can use various regular expression test sites on the Internet to validate the expression. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetType +The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatmentId +The identity of the treatment. + +```yaml +Type: System.String +Parameter Sets: (ParentAndRelativeKey) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatmentPriority +The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +The parameters Identity and TreatmentId are mutually exclusive. + +To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. + +To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. + +Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. + +If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to +the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains +a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. + +## RELATED LINKS +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) + +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment) + +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment) + +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUpdateManagementPolicy.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsUpdateManagementPolicy.md index 940828e939..b26534d110 100644 --- a/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsupdatemanagementpolicy applicable: Microsoft Teams -title: New-CsTeamsUpdateManagementPolicy -schema: 2.0.0 author: vargasj-ms -ms.author: vargasj +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: gnamun +Module Name: MicrosoftTeams +ms.author: vargasj +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsupdatemanagementpolicy +schema: 2.0.0 +title: New-CsTeamsUpdateManagementPolicy --- # New-CsTeamsUpdateManagementPolicy @@ -44,41 +45,6 @@ Disable the in-product messages with the category "What's New". ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledInProductMessages -List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: - -| ID | Campaign Category | -| -- | -- | -| 91382d07-8b89-444c-bbcb-cfe43133af33| What's New | -| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | - -```yaml -Type: System.Management.Automation.PSListModifier`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowManagedUpdates Enables/Disables managed updates for the user. @@ -168,6 +134,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. @@ -184,12 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateDayOfWeek +### -DisabledInProductMessages +List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: - Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. +| ID | Campaign Category | +| -- | -- | +| 91382d07-8b89-444c-bbcb-cfe43133af33| What's New | +| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | ```yaml -Type: Int64 +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) Aliases: @@ -200,12 +185,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTime - -Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. +### -Force +Suppress all non-fatal errors. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -216,12 +200,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTimeOfDay +### -Identity +A unique identifier. -Machine local time. Can be set only when AllowManagedUpdates is set to True +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OCDIRedirect + +This setting controls whether users are redirected from teams.microsoft.com to the unified domain teams.cloud.microsoft. Possible values are: +- **Microsoft Default**, Microsoft will manage redirection behavior. If no explicit admin configuration is set, users may be redirected automatically. +- **Disabled**, Users will remain on teams.microsoft.com. Use this if your organization's apps are incompatible with the unified domain. +- **Enabled**, Users will be redirected to teams.cloud.microsoft. Use this only if your organization had previously opted out of redirection and now wants to opt back in. ```yaml -Type: DateTime +Type: String Parameter Sets: (All) Aliases: @@ -232,17 +234,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNewTeamsClient +### -UpdateDayOfWeek -This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. - If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. - If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. - If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. - If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. - If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. + Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. ```yaml -Type: String +Type: Int64 Parameter Sets: (All) Aliases: @@ -253,12 +250,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OCDIRedirect +### -UpdateTime -This setting controls whether users are redirected from teams.microsoft.com to the unified domain teams.cloud.microsoft. Possible values are: -- **Microsoft Default**, Microsoft will manage redirection behavior. If no explicit admin configuration is set, users may be redirected automatically. -- **Disabled**, Users will remain on teams.microsoft.com. Use this if your organization's apps are incompatible with the unified domain. -- **Enabled**, Users will be redirected to teams.cloud.microsoft. Use this only if your organization had previously opted out of redirection and now wants to opt back in. +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. ```yaml Type: String @@ -272,11 +266,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppress all non-fatal errors. +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) Aliases: @@ -287,16 +282,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -A unique identifier. +### -UseNewTeamsClient + +This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. + If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. + If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. + If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. + If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. + If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVdiPolicy.md similarity index 87% rename from teams/teams-ps/teams/New-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsVdiPolicy.md index a8a03debbe..cc843f54e9 100644 --- a/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVdiPolicy.md @@ -1,165 +1,164 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvdipolicy -title: New-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# New-CsTeamsVdiPolicy - -## SYNOPSIS -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -```powershell -New-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] - [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -The New-CsTeamsVdiPolicy cmdlet allows administrators to define new Vdi policies that can be assigned to particular users to control Teams features related to meetings on a VDI environment. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" -``` - -The command shown in Example 1 uses the New-CsTeamsVdiPolicy cmdlet to create a new Vdi policy with the Identity RestrictedUserPolicy. This policy will use all the default values for a vdi policy except one: VDI2Optimization; in this example, users with this policy will not be able to be VDI 2.0 optimized. - -### Example 2 -```powershell -PS C:\> New-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True -``` - -In Example 2, the New-CsTeamsVdiPolicy cmdlet is used to create a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the default values. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAudioVideoInCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VDI2Optimization -Determines whether a user can be VDI 2.0 optimized. -* Enabled - allow a user to be VDI 2.0 optimized. -* Disabled - disallow a user to be VDI 2.0 optimized. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvdipolicy +schema: 2.0.0 +title: New-CsTeamsVdiPolicy +--- + +# New-CsTeamsVdiPolicy + +## SYNOPSIS +The New-CsTeamsVdiPolicy cmdlet allows administrators to define new Vdi policies that can be assigned to particular users to control Teams features related to meetings on a VDI environment. + +## SYNTAX + +```powershell +New-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] + [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting for an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" +``` + +The command shown in Example 1 uses the New-CsTeamsVdiPolicy cmdlet to create a new Vdi policy with the Identity RestrictedUserPolicy. This policy will use all the default values for a vdi policy except one: VDI2Optimization; in this example, users with this policy will not be able to be VDI 2.0 optimized. + +### Example 2 +```powershell +PS C:\> New-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True +``` + +In Example 2, the New-CsTeamsVdiPolicy cmdlet is used to create a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the default values. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAudioVideoInCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VDI2Optimization +Determines whether a user can be VDI 2.0 optimized. +* Enabled - allow a user to be VDI 2.0 optimized. +* Disabled - disallow a user to be VDI 2.0 optimized. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVirtualAppointmentsPolicy.md similarity index 89% rename from teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsVirtualAppointmentsPolicy.md index e231df2c8c..decd4e93b4 100644 --- a/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy -title: New-CsTeamsVirtualAppointmentsPolicy -schema: 2.0.0 ms.author: erocha -author: emmanuelrocha001 -manager: sonaggarwal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy +schema: 2.0.0 +title: New-CsTeamsVirtualAppointmentsPolicy --- # New-CsTeamsVirtualAppointmentsPolicy @@ -66,13 +67,15 @@ Accept wildcard characters: False ``` ### -EnableSmsNotifications + +> Applicable: Microsoft Teams + This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment template meeting. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -140,10 +143,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVoiceApplicationsPolicy.md similarity index 97% rename from teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsVoiceApplicationsPolicy.md index fd60490292..95df93adaa 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVoiceApplicationsPolicy.md @@ -1,10 +1,11 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy -title: New-CsTeamsVoiceApplicationsPolicy -schema: 2.0.0 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy ROBOTS: NOINDEX +schema: 2.0.0 +title: New-CsTeamsVoiceApplicationsPolicy --- # New-CsTeamsVoiceApplicationsPolicy @@ -85,25 +86,25 @@ The command shown in Example 2 creates a new per-user Teams voice applications p ## PARAMETERS -### -Identity +### -AllowAutoAttendantAfterHoursGreetingChange -Unique identifier assigned to the policy when it was created. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True -Position: 2 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursGreetingChange +### -AllowAutoAttendantAfterHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. ```yaml Type: Boolean @@ -117,9 +118,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursGreetingChange +### -AllowAutoAttendantBusinessHoursChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. ```yaml Type: Boolean @@ -133,9 +134,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayGreetingChange +### -AllowAutoAttendantBusinessHoursGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -149,9 +150,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursChange +### -AllowAutoAttendantBusinessHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. ```yaml Type: Boolean @@ -165,9 +166,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidaysChange +### -AllowAutoAttendantHolidayGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. ```yaml Type: Boolean @@ -181,11 +182,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantTimeZoneChange - -_This feature is not currently available to authorized users._ +### -AllowAutoAttendantHolidayRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. ```yaml Type: Boolean @@ -199,11 +198,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantLanguageChange - -_This feature is not currently available to authorized users._ +### -AllowAutoAttendantHolidaysChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. ```yaml Type: Boolean @@ -217,9 +214,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursRoutingChange +### -AllowAutoAttendantLanguageChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. ```yaml Type: Boolean @@ -233,9 +232,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursRoutingChange +### -AllowAutoAttendantTimeZoneChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. ```yaml Type: Boolean @@ -249,9 +250,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayRoutingChange +### -AllowCallQueueAgentOptChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. ```yaml Type: Boolean @@ -265,9 +266,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange +### -AllowCallQueueConferenceModeChange -When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. ```yaml Type: Boolean @@ -281,9 +282,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMusicOnHoldChange +### -AllowCallQueueLanguageChange -When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. ```yaml Type: Boolean @@ -297,9 +300,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowSharedVoicemailGreetingChange +### -AllowCallQueueMembershipChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. ```yaml Type: Boolean @@ -313,9 +316,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutSharedVoicemailGreetingChange +### -AllowCallQueueMusicOnHoldChange -When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -347,11 +350,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange - -_This feature is not currently available to authorized users._ +### -AllowCallQueueNoAgentsRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -365,9 +366,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMembershipChange +### -AllowCallQueueOptOutChange -When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. ```yaml Type: Boolean @@ -381,9 +382,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +### -AllowCallQueueOverflowRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. ```yaml Type: Boolean @@ -397,9 +398,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueRoutingMethodChange +### -AllowCallQueueOverflowSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -429,25 +430,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOptOutChange - -When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallQueueOverflowRoutingChange +### -AllowCallQueueRoutingMethodChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. ```yaml Type: Boolean @@ -477,9 +462,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentsRoutingChange +### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -493,9 +478,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueAgentOptChange +### -AllowCallQueueWelcomeGreetingChange -When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -511,6 +496,8 @@ Accept wildcard characters: False ### -CallQueueAgentMonitorMode +> Applicable: Microsoft Teams + PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor call sessions. @@ -527,7 +514,6 @@ When set to `Takeover`, users affected by the policy will be allowed to monitor Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -538,6 +524,8 @@ Accept wildcard characters: False ### -CallQueueAgentMonitorNotificationMode +> Applicable: Microsoft Teams + PARAMVALUE: Disabled | Agent When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor agents during call sessions. @@ -548,7 +536,6 @@ When set to `Agent`, users affected by the policy will be allowed to monitor age Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -557,22 +544,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAutoAttendantMetricsPermission - -PARAMVALUE: Disabled | AuthorizedOnly | All - -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. - -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. +### -Confirm -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` won't be able to access real-time metrics. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Object -Parameter Sets: Dual -Aliases: -applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -581,22 +560,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeCallQueueMetricsPermission - -PARAMVALUE: Disabled | AuthorizedOnly | All - -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. - -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. +### -Description -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` won't be able to access real-time metrics. +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. ```yaml -Type: Object -Parameter Sets: Dual +Type: String +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -605,22 +576,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAgentMetricsPermission +### -HistoricalAgentMetricsPermission + +> Applicable: Microsoft Teams PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` won't be able to access real-time metrics. +When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -631,6 +602,8 @@ Accept wildcard characters: False ### -HistoricalAutoAttendantMetricsPermission +> Applicable: Microsoft Teams + PARAMVALUE: Disabled | AuthorizedOnly | All When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. @@ -643,7 +616,6 @@ When set to `All`, users affected by the policy will receive historical metrics Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -654,6 +626,8 @@ Accept wildcard characters: False ### -HistoricalCallQueueMetricsPermission +> Applicable: Microsoft Teams + PARAMVALUE: Disabled | AuthorizedOnly | All When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. @@ -666,7 +640,6 @@ When set to `All`, users affected by the policy will receive historical metrics Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -675,21 +648,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalAgentMetricsPermission +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAgentMetricsPermission + +> Applicable: Microsoft Teams PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. -When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. -When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -698,15 +689,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -RealTimeAutoAttendantMetricsPermission -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +> Applicable: Microsoft Teams + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: Object +Parameter Sets: Dual +Aliases: Required: False Position: Named @@ -715,14 +714,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -RealTimeCallQueueMetricsPermission -Prompts you for confirmation before running the cmdlet. +> Applicable: Microsoft Teams + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: Object +Parameter Sets: Dual +Aliases: Required: False Position: Named @@ -731,14 +739,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -WhatIf -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -761,10 +770,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy) -[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy) -[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy) -[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLoadPolicy.md similarity index 89% rename from teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLoadPolicy.md index e2f6188c48..db54e55a4f 100644 --- a/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLoadPolicy.md @@ -1,239 +1,240 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy -title: New-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# New-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet creates a Teams Workload Policy instance for the tenant. - -## SYNTAX - -```powershell -New-CsTeamsWorkLoadPolicy [-Identity] [-AllowCalling ] [-AllowCallingPinned ] - [-AllowMeeting ] [-AllowMeetingPinned ] [-AllowMessaging ] - [-AllowMessagingPinned ] [-Description ] [-MsftInternalProcessingMode ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-CsTeamsWorkLoadPolicy -Identity Test -``` - -Creates a new Teams Workload Policy with the specified identity of "Test". - -## PARAMETERS - -### -AllowCalling - -Determines if calling workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallingPinned - -Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeeting - -Determines if meetings workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetingPinned - -Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessaging - -Determines if messaging workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessagingPinned - -Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide explanatory text about the Teams Workload policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the Teams Workload Policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Microsoft Internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworkloadpolicy +schema: 2.0.0 +title: New-CsTeamsWorkLoadPolicy +--- + +# New-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet creates a Teams Workload Policy instance for the tenant. + +## SYNTAX + +```powershell +New-CsTeamsWorkLoadPolicy [-Identity] [-AllowCalling ] [-AllowCallingPinned ] + [-AllowMeeting ] [-AllowMeetingPinned ] [-AllowMessaging ] + [-AllowMessagingPinned ] [-Description ] [-MsftInternalProcessingMode ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsTeamsWorkLoadPolicy -Identity Test +``` + +Creates a new Teams Workload Policy with the specified identity of "Test". + +## PARAMETERS + +### -AllowCalling + +Determines if calling workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallingPinned + +Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeeting + +Determines if meetings workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingPinned + +Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessaging + +Determines if messaging workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessagingPinned + +Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the Teams Workload policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLocationDetectionPolicy.md similarity index 80% rename from teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLocationDetectionPolicy.md index c99f3955de..a4ea47d20b 100644 --- a/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLocationDetectionPolicy.md @@ -1,18 +1,19 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy -title: New-CsTeamsWorkLocationDetectionPolicy -schema: 2.0.0 ms.author: arkozlov -manager: prashibadkur -author: artemiykozlov +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy +schema: 2.0.0 +title: New-CsTeamsWorkLocationDetectionPolicy --- # New-CsTeamsWorkLocationDetectionPolicy ## SYNOPSIS -This cmdlet is used to create a new instance of the TeamsWorkLocationDetectionPolicy. The end user experience utilizing this policy has rolled out to the general public. You can see updates at [Microsoft 365 Roadmap | Microsoft 365](https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2Cset%2Cwork%2Clocation%22https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2cset%2cwork%2clocation%22) and to learn more on how to enable the end user experience, please see [Setting up Bookable Desks in Microsoft Teams - Microsoft Teams | Microsoft Learn.](https://learn.microsoft.com/microsoftteams/rooms/bookable-desks) +This cmdlet is used to create a new instance of the TeamsWorkLocationDetectionPolicy. ## SYNTAX @@ -25,6 +26,8 @@ New-CsTeamsWorkLocationDetectionPolicy [-EnableWorkLocationDetection ] Creates a new instance of the TeamsWorkLocationDetectionPolicy. This policy can be used to tailor the work location detection experience. The parameter `EnableWorkLocationDetection` allows your organization to collect the work location of users when they connect, interact, or are detected near your organization's networks and devices. It also captures the geographic location information users share from personal and mobile devices. This gives users the ability to consent to the use of this location data to set their current work location.Microsoft collects this information to provide users with a consistent location-based experience and to improve the hybrid work experience in Microsoft 365 according to the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839). +The end user experience utilizing this policy has rolled out to the general public. You can see updates at [Microsoft 365 Roadmap | Microsoft 365](https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2Cset%2Cwork%2Clocation%22https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2cset%2cwork%2clocation%22) and to learn more on how to enable the end user experience, please see [Setting up Bookable Desks in Microsoft Teams - Microsoft Teams | Microsoft Learn.](https://learn.microsoft.com/microsoftteams/rooms/bookable-desks). + ## EXAMPLES ### Example 1 @@ -142,10 +145,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy) -[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy) -[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy) -[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/New-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantDialPlan.md similarity index 85% rename from teams/teams-ps/teams/New-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantDialPlan.md index 3496d58772..ab95636a90 100644 --- a/teams/teams-ps/teams/New-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan applicable: Microsoft Teams -title: New-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan +schema: 2.0.0 +title: New-CsTenantDialPlan --- # New-CsTenantDialPlan @@ -27,18 +28,18 @@ You can use this cmdlet to create a new tenant dial plan. Tenant dial plans prov The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. A tenant dial plan determines such things as which normalization rules are applied. -You can add new normalization rules to a tenant dial plan by calling the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet. +You can add new normalization rules to a tenant dial plan by calling the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csvoicenormalizationrule) cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsTenantDialPlan -Identity vt1tenantDialPlan9 ``` This example creates a tenant dial plan that has an Identity of vt1tenantDialPlan9. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $nr2 = New-CsVoiceNormalizationRule -Identity Global/NR2 -Description "TestNR1" -Pattern '^(d{11})$' -Translation '+1' -InMemory New-CsTenantDialPlan -Identity vt1tenantDialPlan91 -NormalizationRules @{Add=$nr2} @@ -48,33 +49,16 @@ This example creates a new normalization rule and then applies that rule to a ne ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the name of the tenant dial plan. -Identity is an alphanumeric string that cannot exceed 49 characters. -Valid characters are alphabetic or numeric characters, hyphen (-) and dot (.). -The value should not begin with a (.) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Confirm -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confirm The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -84,6 +68,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to and any other information that helps to identify the purpose of the tenant dial plan. Maximum characters: 1040. @@ -91,7 +78,6 @@ Maximum characters: 1040. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -100,21 +86,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter is a unique identifier that designates the name of the tenant dial plan. +Identity is an alphanumeric string that cannot exceed 49 characters. +Valid characters are alphabetic or numeric characters, hyphen (-) and dot (.). +The value should not begin with a (.) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NormalizationRules + +> Applicable: Microsoft Teams + The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. -Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet, which creates the rule and then assign it to the specified tenant dial plan using [Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) cmdlet. +Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csvoicenormalizationrule) cmdlet, which creates the rule and then assign it to the specified tenant dial plan using [Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) cmdlet. Each time a new tenant dial plan is created, a new voice normalization rule with default settings is also created for that site, service, or per-user tenant dial plan. By default, the Identity of the new voice normalization rule is the tenant dial plan Identity followed by a slash and then followed by the name Prefix All. (For example, TAG:Redmond/Prefix All.) The number of normalization rules cannot exceed 50 per TenantDialPlan. -You can create a new normalization rule by calling the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet. +You can create a new normalization rule by calling the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csvoicenormalizationrule) cmdlet. ```yaml Type: List Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -SimpleName + +> Applicable: Microsoft Teams + The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. @@ -137,7 +149,6 @@ However, if you don't provide a value, a default value matching the Identity of Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -147,6 +158,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -154,7 +168,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -176,10 +189,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cstenantdialplan) -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan) -[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) -[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantdialplan) diff --git a/teams/teams-ps/teams/New-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkRegion.md similarity index 85% rename from teams/teams-ps/teams/New-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkRegion.md index 33bb7d2c2d..99f6e134d5 100644 --- a/teams/teams-ps/teams/New-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkRegion.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion applicable: Microsoft Teams -title: New-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworkregion +schema: 2.0.0 +title: New-CsTenantNetworkRegion --- # New-CsTenantNetworkRegion ## SYNOPSIS -As an admin, you can use the Teams PowerShell command, New-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. +Creates a new network region. ## SYNTAX @@ -30,6 +31,8 @@ New-CsTenantNetworkRegion -NetworkRegionID [-BypassID ] [-Centr ``` ## DESCRIPTION +A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. + Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. ## EXAMPLES @@ -43,22 +46,22 @@ The command shown in Example 1 creates the network region 'RegionA' with no desc ## PARAMETERS -### -Identity -Unique identifier for the network region to be created. +### -BypassID +This parameter is not used. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassID +### -CentralSite This parameter is not used. ```yaml @@ -73,13 +76,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CentralSite -This parameter is not used. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -103,30 +106,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -The name of the network region. This must be a string that is unique. You cannot specify an NetworkRegionID and an Identity at the same time. +### -Identity +Unique identifier for the network region to be created. ```yaml Type: String -Parameter Sets: ParentAndRelativeKey +Parameter Sets: Identity Aliases: Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkRegionID +The name of the network region. This must be a string that is unique. You cannot specify an NetworkRegionID and an Identity at the same time. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -163,8 +166,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworkregion) -[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworkregion) -[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/New-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSite.md similarity index 96% rename from teams/teams-ps/teams/New-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSite.md index 81412644a9..da04e430ab 100644 --- a/teams/teams-ps/teams/New-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite applicable: Microsoft Teams -title: New-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksite +schema: 2.0.0 +title: New-CsTenantNetworkSite --- # New-CsTenantNetworkSite @@ -66,16 +67,16 @@ PS C:\> New-CsTenantNetworkSite -NetworkSiteID "site3" -Description "site 3" -Ne The command shown in Example 3 creates the network site 'site3' with the description 'site 3'. This site is enabled for network roaming capabilities. The example associates the site with network region 'RedmondRegion' and network roaming policy 'TestNetworkRoamingPolicy'. ## PARAMETERS -### -Identity -Unique identifier for the network site to be created. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -96,8 +97,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmergencyCallRoutingPolicy -This parameter is used to assign a custom emergency call routing policy to a network site. For more information, see [Assign a custom emergency call routing policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). +### -EmergencyCallingPolicy +This parameter is used to assign a custom emergency calling policy to a network site. For more information see [Assign a custom emergency calling policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). ```yaml Type: String @@ -111,8 +112,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmergencyCallingPolicy -This parameter is used to assign a custom emergency calling policy to a network site. For more information see [Assign a custom emergency calling policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). +### -EmergencyCallRoutingPolicy +This parameter is used to assign a custom emergency call routing policy to a network site. For more information, see [Assign a custom emergency call routing policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). ```yaml Type: String @@ -141,6 +142,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique identifier for the network site to be created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocationPolicy This parameter is reserved for Microsoft internal use. @@ -216,21 +232,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -257,8 +258,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) -[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksite) -[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksite) diff --git a/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSubnet.md similarity index 80% rename from teams/teams-ps/teams/New-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSubnet.md index 0639975119..d6738ebcfe 100644 --- a/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSubnet.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet applicable: Microsoft Teams -title: New-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksubnet +schema: 2.0.0 +title: New-CsTenantNetworkSubnet --- # New-CsTenantNetworkSubnet ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, New-CsTenantNetworkSubnet to define network subnets and assign them to network sites. Each internal subnet may only be associated with one site. Tenant network subnet is used for Location Based Routing. +Creates a new network subnet. ## SYNTAX @@ -30,7 +31,7 @@ New-CsTenantNetworkSubnet -MaskBits -SubnetID [-Description ] -IPAddress [-MaskB ## DESCRIPTION External trusted IPs are the Internet external IPs of the enterprise network and are used to determine if the user's endpoint is inside the corporate network before checking for a specific site match. If the user's external IP matches one defined in the trusted list, then Location-Based Routing will check to determine which internal subnet the user's endpoint is located. If the user's external IP doesn't match one defined in the trusted list, the endpoint will be classified as being at an unknown and any PSTN calls to/from an LBR enabled user are blocked. -Both IPv4 and IPv6 trusted IP addresses are supported. +Both IPv4 and IPv6 trusted IP addresses are supported. You can define an unlimited number of external subnets for a tenant. ## EXAMPLES @@ -108,21 +108,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IPAddress -The name of the IP address. This must be a unique and valid IPv4 or IPv6 address. You cannot specify an IP address and an Identity at the same time. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier for the IP address to be created. @@ -153,6 +138,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IPAddress +The name of the IP address. This must be a unique and valid IPv4 or IPv6 address. You cannot specify an IP address and an Identity at the same time. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MaskBits This parameter determines the length of bits to mask to the subnet. diff --git a/teams/teams-ps/teams/New-CsUserCallingDelegate.md b/teams/teams-ps/MicrosoftTeams/New-CsUserCallingDelegate.md similarity index 75% rename from teams/teams-ps/teams/New-CsUserCallingDelegate.md rename to teams/teams-ps/MicrosoftTeams/New-CsUserCallingDelegate.md index bcb61efbcc..90b9401956 100644 --- a/teams/teams-ps/teams/New-CsUserCallingDelegate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsUserCallingDelegate.md @@ -1,137 +1,155 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate -applicable: Microsoft Teams -title: New-CsUserCallingDelegate -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# New-CsUserCallingDelegate - -## SYNOPSIS -This cmdlet will add a new delegate for calling in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -```powershell -New-CsUserCallingDelegate -Identity -Delegate -MakeCalls -ReceiveCalls -ManageSettings [] -``` - -## DESCRIPTION -This cmdlet adds a new delegate with given permissions for the specified user. - -## EXAMPLES - -### Example 1 -```powershell -New-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -ReceiveCalls $true -ManageSettings $true -``` - -## PARAMETERS - -### -Delegate -The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. - -A user can have up to 25 delegates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeCalls - -Specifies whether delegate is allowed to make calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: True -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManageSettings - -Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: True -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveCalls - -Specifies whether delegate is allowed to receive calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: True -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, -and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -The specified user need to have the Microsoft Phone System license assigned. - -You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. - -## RELATED LINKS -[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csusercallingdelegate +schema: 2.0.0 +title: New-CsUserCallingDelegate +--- + +# New-CsUserCallingDelegate + +## SYNOPSIS +This cmdlet will add a new delegate for calling in Microsoft Teams. + +## SYNTAX + +``` +New-CsUserCallingDelegate -Identity -Delegate -MakeCalls -ManageSettings + -ReceiveCalls [-HttpPipelinePrepend ] [] +``` + +## DESCRIPTION +This cmdlet adds a new delegate with given permissions for the specified user. + +## EXAMPLES + +### Example 1 +```powershell +New-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -ReceiveCalls $true -ManageSettings $true +``` + +## PARAMETERS + +### -Delegate +The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. + +A user can have up to 25 delegates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeCalls + +Specifies whether delegate is allowed to make calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageSettings + +Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveCalls + +Specifies whether delegate is allowed to receive calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +The specified user need to have the Microsoft Phone System license assigned. + +You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. + +## RELATED LINKS +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csusercallingsettings) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/New-CsVideoInteropServiceProvider.md similarity index 94% rename from teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/New-CsVideoInteropServiceProvider.md index 06ece90114..de166c02f0 100644 --- a/teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsVideoInteropServiceProvider.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csvideointeropserviceprovider applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: New-CsVideoInteropServiceProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csvideointeropserviceprovider +schema: 2.0.0 +title: New-CsVideoInteropServiceProvider --- # New-CsVideoInteropServiceProvider ## SYNOPSIS -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. +Use the New-CsVideoInteropServiceProvider to specify information about a supported CVI partner your organization would like to use. ## SYNTAX @@ -35,8 +36,6 @@ New-CsVideoInteropServiceProvider [-Tenant ] -Name [-AadAp ## DESCRIPTION Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. -Use the New-CsVideoInteropServiceProvider to specify information about a supported CVI partner your organization would like to use. - Important note: New-CsVideoInteropServiceProvider does not do a check on the -Identity to be one of the Identity (without tag:) from the Get-CsTeamsVideoInteropServicePolicy, however if this is not set to match, the VTC coordinates will not added to the meetings correctly. Make sure that your "Identity" matches a valid policy identity. ## EXAMPLES diff --git a/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md b/teams/teams-ps/MicrosoftTeams/New-CsVoiceNormalizationRule.md similarity index 85% rename from teams/teams-ps/teams/New-CsVoiceNormalizationRule.md rename to teams/teams-ps/MicrosoftTeams/New-CsVoiceNormalizationRule.md index 50a147a31f..d672b68c5b 100644 --- a/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsVoiceNormalizationRule.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule applicable: Microsoft Teams -title: New-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csvoicenormalizationrule +schema: 2.0.0 +title: New-CsVoiceNormalizationRule --- # New-CsVoiceNormalizationRule @@ -14,11 +16,6 @@ ms.author: serdars ## SYNOPSIS Creates a new voice normalization rule. -Voice normalization rules are used to convert a telephone dialing requirement (for example, dialing 9 to access an outside line) to the E.164 phone number format used by -Skype for Business Server or Microsoft Teams. - -This cmdlet was introduced in Lync Server 2010. - ## SYNTAX ### Identity (Default) @@ -36,7 +33,11 @@ New-CsVoiceNormalizationRule [-Tenant ] -Parent -Name [- ``` ## DESCRIPTION -This cmdlet creates a named voice normalization rule. + +This cmdlet was introduced in Lync Server 2010. + +Voice normalization rules are used to convert a telephone dialing requirement (for example, dialing 9 to access an outside line) to the E.164 phone number format used by Skype for Business Server or Microsoft Teams. + These rules are a required part of phone authorization and call routing. They define the requirements for converting (or translating) numbers from an internal format to a standard (E.164) format. An understanding of regular expressions is helpful in order to define number patterns that will be translated. @@ -51,7 +52,7 @@ the `New-CsTenantDialPlan` or `Set-CsTenantDialPlan` cmdlets. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" ``` @@ -64,7 +65,7 @@ If the rule name does not contain a space you don't need to enclose the Identity Keep in mind that a dial plan for the Redmond site must exist for this command to succeed. You can create a new dial plan by calling the `New-CsDialPlan` cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoiceNormalizationRule -Parent SeattleUser -Name SeattleFourDigit -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' ``` @@ -81,7 +82,7 @@ Single quotes are required for these values; double quotes (or no quotes) will n As in Example 1, a dial plan with the given scope must exist. In this case, that means a dial plan with the Identity SeattleUser must already exist. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $nr1=New-CsVoiceNormalizationRule -Identity dp1/nr1 -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' -InMemory New-CsTenantDialPlan -Identity DP1 -NormalizationRules @{Add=$nr1} @@ -91,64 +92,49 @@ This example creates a new in-memory voice normalization rule and then adds it t ## PARAMETERS -### -Identity -A unique identifier for the rule. -The Identity specified must include the scope followed by a slash and then the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. -The name portion will automatically be stored in the Name property. -You cannot specify values for Identity and Name in the same command. - -For Lync and Skype for Business Server, voice normalization rules can be created at the following scopes: global, site, service (Registrar and PSTNGateway only) and per user. -A dial plan with an Identity matching the scope of the normalization rule must already exist before a new rule can be created. -(To retrieve a list of dial plans, call the `Get-CsDialPlan` cmdlet.) +### -Confirm -For Microsoft Teams, voice normalization rules can be created at the following scopes: global and tag. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -The Identity parameter is required unless the Parent parameter is specified. -You cannot include the Identity parameter and the Parent parameter in the same command. +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The name of the rule. -This parameter is required if a value has been specified for the Parent parameter. -If no value has been specified for the Parent parameter, Name defaults to the name specified in the Identity parameter. -For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. -The Name parameter and the Identity parameter cannot be used in the same command. +### -Description +A friendly description of the normalization rule. + +Maximum string length: 512 characters. ```yaml Type: String -Parameter Sets: ParentAndRelativeKey +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -The scope at which the new normalization rule will be created. -This value must be global; site:\, where \ is the name of the Skype for Business Server site; PSTN gateway or Registrar service, such as -PSTNGateway:redmond.litwareinc.com; or a string designating a per user rule. -A dial plan with the specified scope must already exist or the command will fail. +### -Force -The Parent parameter is required unless the Identity parameter is specified. -You cannot include the Identity parameter and the Parent parameter in the same command. -If you include the Parent parameter, the Name parameter is also required. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -159,35 +145,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A friendly description of the normalization rule. +### -Identity +A unique identifier for the rule. +The Identity specified must include the scope followed by a slash and then the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +The name portion will automatically be stored in the Name property. +You cannot specify values for Identity and Name in the same command. -Maximum string length: 512 characters. +For Lync and Skype for Business Server, voice normalization rules can be created at the following scopes: global, site, service (Registrar and PSTNGateway only) and per user. +A dial plan with an Identity matching the scope of the normalization rule must already exist before a new rule can be created. +(To retrieve a list of dial plans, call the `Get-CsDialPlan` cmdlet.) + +For Microsoft Teams, voice normalization rules can be created at the following scopes: global and tag. + +The Identity parameter is required unless the Parent parameter is specified. +You cannot include the Identity parameter and the Parent parameter in the same command. ```yaml -Type: String -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IsInternalExtension -If True, the result of applying this rule will be a number internal to the organization. -If False, applying the rule results in an external number. -This value is ignored if the value of the OptimizeDeviceDialing property of the associated dial plan/tenant dial plan is set to False. +### -InMemory -Default: False +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. + +For Lync or Skype for Business Server, if you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the +object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -196,16 +193,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Pattern -A regular expression that the dialed number must match in order for this rule to be applied. +### -IsInternalExtension -Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +If True, the result of applying this rule will be a number internal to the organization. +If False, applying the rule results in an external number. +This value is ignored if the value of the OptimizeDeviceDialing property of the associated dial plan/tenant dial plan is set to False. + +Default: False ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -214,34 +215,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -The order in which rules are applied. -A phone number might match more than one rule. -This parameter sets the order in which the rules are tested against the number. +### -Name +The name of the rule. +This parameter is required if a value has been specified for the Parent parameter. +If no value has been specified for the Parent parameter, Name defaults to the name specified in the Identity parameter. +For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. +The Name parameter and the Identity parameter cannot be used in the same command. ```yaml -Type: Int32 -Parameter Sets: (All) +Type: String +Parameter Sets: ParentAndRelativeKey Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Translation -The regular expression pattern that will be applied to the number to convert it to E.164 format. +### -Parent +The scope at which the new normalization rule will be created. +This value must be global; site:\, where \ is the name of the Skype for Business Server site; PSTN gateway or Registrar service, such as +PSTNGateway:redmond.litwareinc.com; or a string designating a per user rule. +A dial plan with the specified scope must already exist or the command will fail. -Default: +$1 (The default prefixes the number with a plus sign \[+\].) +The Parent parameter is required unless the Identity parameter is specified. +You cannot include the Identity parameter and the Parent parameter in the same command. +If you include the Parent parameter, the Name parameter is also required. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -250,14 +256,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Pattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +A regular expression that the dialed number must match in order for this rule to be applied. + +Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -266,17 +276,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. +### -Priority -For Lync or Skype for Business Server, if you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the -object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +The order in which rules are applied. +A phone number might match more than one rule. +This parameter sets the order in which the rules are tested against the number. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -285,27 +296,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Tenant -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +For internal Microsoft usage. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -314,14 +314,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Translation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +The regular expression pattern that will be applied to the number to convert it to E.164 format. + +Default: +$1 (The default prefixes the number with a plus sign \[+\].) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -330,14 +334,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal Microsoft usage. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -363,10 +369,10 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Po ## RELATED LINKS -[Test-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/test-csvoicenormalizationrule) +[Test-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/microsoftteams/test-csvoicenormalizationrule) -[Get-CsDialPlan](https://learn.microsoft.com/powershell/module/teams/get-csdialplan) +[Get-CsDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-csdialplan) -[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan) -[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) diff --git a/teams/teams-ps/teams/New-Team.md b/teams/teams-ps/MicrosoftTeams/New-Team.md similarity index 97% rename from teams/teams-ps/teams/New-Team.md rename to teams/teams-ps/MicrosoftTeams/New-Team.md index 5ca7ae7b5c..d9756ee326 100644 --- a/teams/teams-ps/teams/New-Team.md +++ b/teams/teams-ps/MicrosoftTeams/New-Team.md @@ -1,24 +1,18 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-team -title: New-Team -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-team +schema: 2.0.0 +title: New-Team --- # New-Team ## SYNOPSIS This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. -Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. - -If you want these groups to appear in Outlook clients, you can use the [Set-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/set-unifiedgroup) cmdlet in the Exchange Powershell Module to disable the switch parameter `HiddenFromExchangeClientsEnabled` (-HiddenFromExchangeClientsEnabled:$false). - -Note: The Teams application may need to be open by an Owner for up to two hours before changes are reflected. - ## SYNTAX ### CreateTeam (Default) @@ -48,6 +42,12 @@ New-Team -GroupId [-Owner ] [-AllowGiphy ] [-GiphyCont ## DESCRIPTION Creates a new team with user specified settings, and returns a Group object with a GroupID property. +Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. + +If you want these groups to appear in Outlook clients, you can use the [Set-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/set-unifiedgroup) cmdlet in the Exchange Powershell Module to disable the switch parameter `HiddenFromExchangeClientsEnabled` (-HiddenFromExchangeClientsEnabled:$false). + +Note: The Teams application may need to be open by an Owner for up to two hours before changes are reflected. + ## EXAMPLES ### Example 1 @@ -79,109 +79,23 @@ This example creates a team, adds three members to it, and creates three channel ## PARAMETERS -### -MailNickName -The MailNickName parameter specifies the alias for the associated Office 365 Group. -This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. -The value of the MailNickName parameter has to be unique across your tenant. -Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. - -For more details about the naming conventions see here: [New-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Classification -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Team description. Characters Limit - 1024. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Team display name. Characters Limit - 256. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Template -If you have an EDU license, you can use this parameter to specify which template you'd like to use for creating your group. -Do not use this parameter when converting an existing group. - -Valid values are: "EDU_Class" or "EDU_PLC" - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Owner -An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. -This user will be added as both a member and an owner of the group. -If not specified, the user who creates the team will be added as both a member and an owner. -Please note: This parameter is mandatory, if connected using Certificate Based Authentication. +### -AllowAddRemoveApps +Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) +Default value: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAddRemoveApps -Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. +### -AllowChannelMentions +Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. ```yaml Type: Boolean @@ -195,17 +109,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelMentions -Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. +### -AllowCreatePrivateChannels +Determines whether private channel creation is allowed for the team. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: CreateTeam Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -405,6 +319,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Classification +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Team description. Characters Limit - 1024. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Team display name. Characters Limit - 256. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -GiphyContentRating Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" @@ -436,8 +395,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Visibility -Set to Public to allow all users in your organization to join the group by default. Set to Private to require that an owner approve the join request. +### -MailNickName +The MailNickName parameter specifies the alias for the associated Office 365 Group. +This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. +The value of the MailNickName parameter has to be unique across your tenant. +Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. + +For more details about the naming conventions see here: [New-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. ```yaml Type: String @@ -446,23 +410,26 @@ Aliases: Required: False Position: Named -Default value: Private +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ShowInTeamsSearchAndSuggestions -Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. +### -Owner +An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. +This user will be added as both a member and an owner of the group. +If not specified, the user who creates the team will be added as both a member and an owner. +Please note: This parameter is mandatory, if connected using Certificate Based Authentication. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -481,18 +448,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreatePrivateChannels -Determines whether private channel creation is allowed for the team. +### -ShowInTeamsSearchAndSuggestions +Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. ```yaml Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Template +If you have an EDU license, you can use this parameter to specify which template you'd like to use for creating your group. +Do not use this parameter when converting an existing group. + +Valid values are: "EDU_Class" or "EDU_PLC" + +```yaml +Type: String Parameter Sets: CreateTeam Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Visibility +Set to Public to allow all users in your organization to join the group by default. Set to Private to require that an owner approve the join request. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: Private +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -509,8 +509,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Remove-Team](https://learn.microsoft.com/powershell/module/teams/remove-team) +[Remove-Team](https://learn.microsoft.com/powershell/module/microsoftteams/remove-team) -[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-Team](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) -[Set-Team](https://learn.microsoft.com/powershell/module/teams/set-team) +[Set-Team](https://learn.microsoft.com/powershell/module/microsoftteams/set-team) diff --git a/teams/teams-ps/teams/New-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/New-TeamChannel.md similarity index 93% rename from teams/teams-ps/teams/New-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/New-TeamChannel.md index 579b2c7209..9d20e98d8c 100644 --- a/teams/teams-ps/teams/New-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/New-TeamChannel.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-teamchannel -title: New-TeamChannel -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-teamchannel +schema: 2.0.0 +title: New-TeamChannel --- # New-TeamChannel @@ -41,15 +41,16 @@ Create a private channel with display name as "Engineering" ## PARAMETERS -### -GroupId -GroupId of the team +### -Description +Channel description. +Channel description can be up to 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) @@ -72,16 +73,15 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Description -Channel description. -Channel description can be up to 1024 characters. +### -GroupId +GroupId of the team ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) @@ -123,7 +123,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, DisplayName, Description, MembershipType, Owner +### GroupId + +### DisplayName + +### Description + +### MembershipType + +### Owner ## OUTPUTS diff --git a/teams/teams-ps/teams/New-TeamsApp.md b/teams/teams-ps/MicrosoftTeams/New-TeamsApp.md similarity index 93% rename from teams/teams-ps/teams/New-TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/New-TeamsApp.md index 1ba731d7b5..5550f815a7 100644 --- a/teams/teams-ps/teams/New-TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/New-TeamsApp.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-teamsapp -title: New-TeamsApp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-teamsapp schema: 2.0.0 +title: New-TeamsApp --- # New-TeamsApp diff --git a/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber.md similarity index 86% rename from teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber.md index e2c1985c62..6b53e7a96e 100644 --- a/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/register-csonlinedialinconferencingservicenumber applicable: Microsoft Teams -title: Register-CsOnlineDialInConferencingServiceNumber -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/register-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Register-CsOnlineDialInConferencingServiceNumber --- # Register-CsOnlineDialInConferencingServiceNumber ## SYNOPSIS -When you buy Audio Conferencing licenses, Microsoft is hosting your audio conferencing bridge for your organization. The audio conferencing bridge gives out dial-in phone numbers from different locations so that meeting organizers and participants can use them to join Microsoft Teams meetings using a phone. -In addition to the phone numbers already assigned to your conferencing bridge, you can get additional service numbers (toll and toll-free numbers used for audio conferencing) from other locations, and then assign them to the conferencing bridge so you can expand coverage for your users. The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. +The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. ## SYNTAX @@ -35,9 +36,12 @@ Register-CsOnlineDialInConferencingServiceNumber [-Instance] Applicable: Microsoft Teams + +PARAMVALUE: Guid ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: ConferencingServiceNumber +### -BridgeName + +> Applicable: Microsoft Teams + +PARAMVALUE: String ```yaml -Type: ConferencingServiceNumber +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeId -PARAMVALUE: Guid +### -DomainController + +> Applicable: Microsoft Teams + +PARAMVALUE: Fqdn ```yaml -Type: Guid +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False Position: Named @@ -94,14 +104,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeName -PARAMVALUE: String +### -Force + +> Applicable: Microsoft Teams + +PARAMVALUE: SwitchParameter ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -110,46 +122,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -PARAMVALUE: Fqdn +### -Identity + +> Applicable: Microsoft Teams + +PARAMVALUE: String ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Instance + +> Applicable: Microsoft Teams + +PARAMVALUE: ConferencingServiceNumber ```yaml -Type: SwitchParameter +Type: ConferencingServiceNumber Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -159,13 +177,15 @@ Accept wildcard characters: False ``` ### -TenantDomain + +> Applicable: Microsoft Teams + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsApplicationAccessPolicy.md similarity index 80% rename from teams/teams-ps/teams/Remove-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsApplicationAccessPolicy.md index 29aebeff75..a69e78a7d2 100644 --- a/teams/teams-ps/teams/Remove-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csapplicationaccesspolicy applicable: Microsoft Teams -title: Remove-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni author: frankpeng7 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csapplicationaccesspolicy +schema: 2.0.0 +title: Remove-CsApplicationAccessPolicy --- # Remove-CsApplicationAccessPolicy @@ -67,7 +68,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) -[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) -[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) -[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csapplicationaccesspolicy) diff --git a/teams/teams-ps/teams/Remove-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Remove-CsAutoAttendant.md similarity index 79% rename from teams/teams-ps/teams/Remove-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsAutoAttendant.md index a847c6ab1f..c1bdf99466 100644 --- a/teams/teams-ps/teams/Remove-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant applicable: Microsoft Teams -title: Remove-CsAutoAttendant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant +schema: 2.0.0 +title: Remove-CsAutoAttendant --- # Remove-CsAutoAttendant @@ -15,9 +17,6 @@ ms.reviewer: williamlooney ## SYNOPSIS Use the Remove-CsAutoAttendant cmdlet to delete an Auto Attendant (AA). -> [!NOTE] -> Remove any associated resource accounts with [Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) before attempting to delete the Auto Attendant (AA). - ## SYNTAX ``` @@ -27,9 +26,12 @@ Remove-CsAutoAttendant -Identity [-Tenant ] [] ## DESCRIPTION The Remove-CsAutoAttendant cmdlet deletes an AA that is specified by the Identity parameter. +> [!NOTE] +> Remove any associated resource accounts with [Remove-CsOnlineApplicationInstanceAssociation](remove-csonlineapplicationinstanceassociation.md) before attempting to delete the Auto Attendant (AA). + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Remove-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" ``` @@ -39,13 +41,15 @@ This example deletes the AA that has an identity of fa9081d6-b4f3-5c96-baec-0b00 ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the AA to be removed. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -56,11 +60,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -85,8 +90,8 @@ The Remove-CsAutoAttendant cmdlet accepts a string as the Identity parameter. ## RELATED LINKS -[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendant) -[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant) -[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant) diff --git a/teams/teams-ps/teams/Remove-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/Remove-CsCallQueue.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsCallQueue.md index b4138debb8..f2bc36394b 100644 --- a/teams/teams-ps/teams/Remove-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsCallQueue.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cscallqueue applicable: Microsoft Teams -title: Remove-CsCallQueue -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallqueue +schema: 2.0.0 +title: Remove-CsCallQueue --- # Remove-CsCallQueue @@ -27,7 +28,7 @@ The Remove-CsCallQueue cmdlet deletes an existing Call Queue specified by the Id ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCallQueue -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` @@ -37,13 +38,15 @@ This example removes the Call Queue with the identity 5e3a575e-1faa-49ff-83c2-5c ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -53,13 +56,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Remove-CsCallingLineIdentity.md similarity index 82% rename from teams/teams-ps/teams/Remove-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsCallingLineIdentity.md index 0a95b6cbed..b368c5418a 100644 --- a/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity applicable: Microsoft Teams -title: Remove-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallinglineidentity +schema: 2.0.0 +title: Remove-CsCallingLineIdentity --- # Remove-CsCallingLineIdentity @@ -26,7 +27,7 @@ This cmdlet will remove a Caller ID policy from your organization or resets the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsCallingLineIdentity -Identity Anonymous ``` @@ -35,46 +36,52 @@ This example removes a Caller ID policy. ## PARAMETERS -### -Identity -The Identity parameter identifies the Caller ID policy. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter identifies the Caller ID policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -WhatIf + +> Applicable: Microsoft Teams + +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -94,10 +101,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallinglineidentity) -[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cscallinglineidentity) -[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallinglineidentity) -[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/Remove-CsComplianceRecordingForCallQueueTemplate.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsComplianceRecordingForCallQueueTemplate.md index 8d0edf2cca..2403795091 100644 --- a/teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsComplianceRecordingForCallQueueTemplate.md @@ -1,17 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsComplianceRecordingForCallQueueTemplate applicable: Microsoft Teams -title: Remove-CsComplianceRecordingForCallQueueTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: Remove-CsComplianceRecordingForCallQueueTemplate --- # Remove-CsComplianceRecordingForCallQueueTemplate +## SYNOPSIS +Use the Remove-CsComplianceRecordingForCallQueueTemplate cmdlet to delete a Compliance Recording for Call Queues template. + ## SYNTAX ```powershell @@ -26,7 +30,7 @@ Use the Remove-CsComplianceRecordingForCallQueueTemplate cmdlet to delete a Comp ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` @@ -36,13 +40,15 @@ This example deletes the Compliance Recording for Call Queue template with the i ## PARAMETERS ### -Id + +> Applicable: Microsoft Teams + The Id parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Remove-CsCustomPolicyPackage.md similarity index 83% rename from teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsCustomPolicyPackage.md index c5fbbf878d..c4820ee128 100644 --- a/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsCustomPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: sunguchuan external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: Remove-CsCustomPolicyPackage -author: sunguchuan ms.author: gucsun -manager: dasosby -online version: https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscustompolicypackage schema: 2.0.0 +title: Remove-CsCustomPolicyPackage --- # Remove-CsCustomPolicyPackage @@ -38,13 +39,14 @@ Deletes a custom package named "MyPackage". ### -Identity +> Applicable: Microsoft Teams + The name of the custom package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -64,8 +66,8 @@ Default packages created by Microsoft cannot be deleted. ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage) +[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscustompolicypackage) -[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage) +[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/update-cscustompolicypackage) diff --git a/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsExternalAccessPolicy.md similarity index 84% rename from teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsExternalAccessPolicy.md index a801caa0bb..46cb77a34f 100644 --- a/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsExternalAccessPolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy applicable: Microsoft Teams -title: Remove-CsExternalAccessPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csexternalaccesspolicy +schema: 2.0.0 +title: Remove-CsExternalAccessPolicy --- # Remove-CsExternalAccessPolicy ## SYNOPSIS Enables you to remove an existing external access policy. -External access policies determine whether or not your users can: 1) Communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) Communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Windows Live; 3) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop) and 4) Access Skype for Business Server over the Internet, without having to log on to your internal network. -This cmdlet was introduced in Lync Server 2010. ## SYNTAX @@ -25,6 +25,8 @@ Remove-CsExternalAccessPolicy [-Tenant ] [-Identity] [-Force ``` ## DESCRIPTION +This cmdlet was introduced in Lync Server 2010. + When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. @@ -36,7 +38,7 @@ External access policies can grant (or revoke) the ability of your users to do a Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -3. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). +3. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration). 4. Communicate with people who have SIP accounts with a public instant messaging service such as Windows Live. @@ -53,7 +55,7 @@ Instead, the properties of the global policy will simply be reset to their defau ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsExternalAccessPolicy -Identity site:Redmond ``` @@ -61,7 +63,7 @@ Remove-CsExternalAccessPolicy -Identity site:Redmond In Example 1, the external access policy with the Identity site:Redmond is deleted. After the policy is removed, users in the Redmond site will have their external access permissions governed by the global policy. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsExternalAccessPolicy -Filter site:* | Remove-CsExternalAccessPolicy ``` @@ -70,7 +72,7 @@ Example 2 deletes all the external access policies that have been configured at To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of policies configured at the site scope; the filter value "site:*" limits the returned data to external access policies that have an Identity that begins with the string value "site:". The filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} | Remove-CsExternalAccessPolicy ``` @@ -80,7 +82,7 @@ To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet to r This collection is then piped to the `Where-Object` cmdlet, which picks out only those policies where the EnableFederationAccess property is equal to True. This filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -or $_.EnablePublicCloudAccess -eq $True} | Remove-CsExternalAccessPolicy ``` @@ -96,37 +98,34 @@ To delete all the policies where both EnableFederationAccess and EnablePublicClo ## PARAMETERS -### -Identity -Unique identifier for the external access policy to be removed. -External access policies can be configured at the global, site, or per-user scopes. -To "remove" the global policy, use this syntax: `-Identity global`. -(Note that the global policy cannot actually be removed. -Instead, all the properties in the global policy will be reset to their default values.) To remove a site policy, use syntax similar to this: `-Identity site:Redmond`. -To remove a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. +### -Confirm -Note that wildcards are not allowed when specifying an Identity. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -135,35 +134,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Unique identifier for the external access policy to be removed. +External access policies can be configured at the global, site, or per-user scopes. +To "remove" the global policy, use this syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. +Instead, all the properties in the global policy will be reset to their default values.) To remove a site policy, use syntax similar to this: `-Identity site:Redmond`. +To remove a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. -### -Confirm -Prompts you for confirmation before executing the command. +Note that wildcards are not allowed when specifying an Identity. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -189,6 +181,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -209,10 +219,10 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo ## RELATED LINKS -[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/Remove-CsGroupPolicyAssignment.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsGroupPolicyAssignment.md index db975cb1bc..740084b301 100644 --- a/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsGroupPolicyAssignment.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment -title: Remove-CsGroupPolicyAssignment -schema: 2.0.0 -author: tomkau ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csgrouppolicyassignment +schema: 2.0.0 +title: Remove-CsGroupPolicyAssignment --- # Remove-CsGroupPolicyAssignment @@ -54,47 +55,47 @@ In this example, the policy assignment with rank 2 is removed. As a result, the ## PARAMETERS -### -GroupId -The ID of the group from which the assignment will be removed. +### -Break +Wait for .NET debugger to attach ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -The policy type of the assignment to be removed from the group. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach +### -GroupId +The ID of the group from which the assignment will be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -144,6 +145,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyType +The policy type of the assignment to be removed from the group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Proxy The URI for the proxy server to use @@ -205,21 +221,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -231,8 +232,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csgrouppolicyassignment) -[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) +[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csgrouppolicyassignment) -[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csgrouppolicyassignment) diff --git a/teams/teams-ps/MicrosoftTeams/Remove-CsHybridTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Remove-CsHybridTelephoneNumber.md new file mode 100644 index 0000000000..3820b89f33 --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsHybridTelephoneNumber.md @@ -0,0 +1,237 @@ +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cshybridtelephonenumber +schema: 2.0.0 +title: Remove-CsHybridTelephoneNumber +--- + +# Remove-CsHybridTelephoneNumber + +## SYNOPSIS +This cmdlet removes a hybrid telephone number. + +## SYNTAX + +### Remove (Default) +``` +Remove-CsHybridTelephoneNumber -TelephoneNumber [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### RemoveViaIdentity +``` +Remove-CsHybridTelephoneNumber -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet removes a hybrid telephone number used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the new **New-CsOnlineTelephoneNumberReleaseOrder** cmdlet to remove a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineTelephoneNumberReleaseOrder](new-csonlinetelephonenumberreleaseorder.md). + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsHybridTelephoneNumber -TelephoneNumber 14025551234 +``` +This example removes the hybrid phone number +1 (402) 555-1234. + +## PARAMETERS + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +{{ Fill InputObject Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: RemoveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +The telephone number to remove. The number should be specified without a prefixed "+". The phone number can't have "tel:" prefixed. + +```yaml +Type: System.String +Parameter Sets: Remove +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES + +The cmdlet is only available in GCC High and DoD cloud instances. + +## RELATED LINKS + +[New-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/new-cshybridtelephonenumber) + +[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/get-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern.md index c41907981c..12a1f8a6df 100644 --- a/teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern applicable: Microsoft Teams -title: Remove-CsInboundBlockedNumberPattern author: serdarsoysal -ms.author: serdars -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundblockednumberpattern schema: 2.0.0 +title: Remove-CsInboundBlockedNumberPattern --- # Remove-CsInboundBlockedNumberPattern @@ -35,6 +36,21 @@ This example removes a blocked number pattern identified as "BlockAutomatic". ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity A unique identifier specifying the blocked number pattern to be removed. @@ -66,21 +82,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -92,8 +93,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundblockednumberpattern) -[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundblockednumberpattern) -[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundExemptNumberPattern.md similarity index 82% rename from teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsInboundExemptNumberPattern.md index 2abeb0572b..3b713cac0f 100644 --- a/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern applicable: Microsoft Teams -title: Remove-CsInboundExemptNumberPattern -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern +schema: 2.0.0 +title: Remove-CsInboundExemptNumberPattern --- # Remove-CsInboundExemptNumberPattern @@ -35,6 +35,21 @@ This removes the exempt number patterns with Identity Exempt1. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier for the exempt number pattern to be listed. @@ -66,21 +81,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -93,12 +93,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable You can use Test-CsInboundBlockedNumberPattern to test your call block and exempt phone number ranges. ## RELATED LINKS -[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern) +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundexemptnumberpattern) -[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundexemptnumberpattern) -[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundexemptnumberpattern) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) -[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation.md similarity index 82% rename from teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation.md index 1fb51dfc00..baa0fc9cd3 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation applicable: Microsoft Teams -title: Remove-CsOnlineApplicationInstanceAssociation -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation +schema: 2.0.0 +title: Remove-CsOnlineApplicationInstanceAssociation --- # Remove-CsOnlineApplicationInstanceAssociation @@ -28,7 +30,7 @@ This is useful when you want to associate this application instance with another ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Remove-CsOnlineApplicationInstanceAssociation -Identities "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` @@ -38,13 +40,15 @@ This example removes the configuration association for the application instance ## PARAMETERS ### -Identities + +> Applicable: Microsoft Teams + The identities for the application instances whose configuration associations are to be removed. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -55,11 +59,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -84,8 +89,8 @@ The Remove-CsOnlineApplicationInstanceAssociation cmdlet accepts a string array ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation) -[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus) -[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioConferencingRoutingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioConferencingRoutingPolicy.md index b9ca408b21..285353fcd0 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,128 +1,129 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudioconferencingroutingpolicy -title: Remove-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# Remove-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet deletes an instance of the Online Audio Conferencing Routing Policy. - -## SYNTAX - -```powershell -Remove-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. - -To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." - -The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. - -Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Remove-CsOnlineAudioConferencingRoutingPolicy -Identity "Test" -``` - -Deletes an Online Audio Conferencing Routing policy instance with the identity "Test". - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) -[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) -[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) -[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Remove-CsOnlineAudioConferencingRoutingPolicy +--- + +# Remove-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet deletes an instance of the Online Audio Conferencing Routing Policy. + +## SYNTAX + +```powershell +Remove-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsOnlineAudioConferencingRoutingPolicy -Identity "Test" +``` + +Deletes an Online Audio Conferencing Routing policy instance with the identity "Test". + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Remove-CsOnlineAudioFile.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioFile.md similarity index 70% rename from teams/teams-ps/teams/Remove-CsOnlineAudioFile.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioFile.md index 61f7bace1f..ef2290df7a 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineAudioFile.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioFile.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile applicable: Microsoft Teams -title: Remove-CsOnlineAudioFile -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineaudiofile +schema: 2.0.0 +title: Remove-CsOnlineAudioFile --- # Remove-CsOnlineAudioFile @@ -17,9 +17,8 @@ Marks an audio file of application type TenantGlobal for deletion and later remo ## SYNTAX -```powershell -Remove-CsOnlineAudioFile -Identity [] - +``` +Remove-CsOnlineAudioFile -Identity [-HttpPipelinePrepend ] [] ``` ## DESCRIPTION @@ -35,6 +34,21 @@ This cmdlet marks the audio file with Id dcfcc31daa9246f29d94d0a715ef877e for de ## PARAMETERS +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The Id of the specific audio file that you would like to mark for deletion. @@ -44,13 +58,14 @@ Parameter Sets: (All) Aliases: Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -69,8 +84,8 @@ The cmdlet is available in Teams PS module 2.4.0-preview or later. ## RELATED LINKS -[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile) +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/export-csonlineaudiofile) -[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineaudiofile) -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings.md index 09faa588af..145288f16b 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinedialinconferencingtenantsettings applicable: Microsoft Teams -title: Remove-CsOnlineDialInConferencingTenantSettings -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinedialinconferencingtenantsettings +schema: 2.0.0 +title: Remove-CsOnlineDialInConferencingTenantSettings --- # Remove-CsOnlineDialInConferencingTenantSettings @@ -28,7 +30,7 @@ You can modify the settings using `Set-CsOnlineDialInConferencingTenantSettings` ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineDialInConferencingTenantSettings ``` @@ -37,30 +39,16 @@ This example reverts the tenant level dial-in conferencing settings to their ori ## PARAMETERS -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -Confirm -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confirm The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -70,6 +58,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -78,7 +69,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -87,14 +77,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -104,6 +114,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -111,7 +124,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisCivicAddress.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisCivicAddress.md index e78d109481..38137f3937 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisCivicAddress.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress applicable: Microsoft Teams -title: Remove-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliscivicaddress +schema: 2.0.0 +title: Remove-CsOnlineLisCivicAddress --- # Remove-CsOnlineLisCivicAddress @@ -45,6 +46,9 @@ This example removes all the emergency civic addresses in the city of Redmond. ## PARAMETERS ### -CivicAddressId + +> Applicable: Microsoft Teams + Specifies the unique identifier of the civic address to be deleted. You can find civic address identifiers by using the Get-CsOnlineLisCivicAddress cmdlet. @@ -52,7 +56,6 @@ You can find civic address identifiers by using the Get-CsOnlineLisCivicAddress Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -61,16 +64,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -79,15 +82,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. +### -Force + +> Applicable: Microsoft Teams + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -96,14 +102,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -WhatIf + +> Applicable: Microsoft Teams + +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -127,8 +136,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliscivicaddress) -[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineliscivicaddress) -[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisLocation.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisLocation.md index 4006964361..48af105cc5 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation applicable: Microsoft Teams -title: Remove-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelislocation +schema: 2.0.0 +title: Remove-CsOnlineLisLocation --- # Remove-CsOnlineLisLocation @@ -37,31 +38,16 @@ This example removes the location specified by its identity. ## PARAMETERS -### -LocationId -Specifies the unique identifier of the location to be deleted. -Location identities can be discovered by using the Get-CsOnlineLisLocation cmdlet. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confirm The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -71,6 +57,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -79,7 +68,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -88,7 +76,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationId + +> Applicable: Microsoft Teams + +Specifies the unique identifier of the location to be deleted. +Location identities can be discovered by using the Get-CsOnlineLisLocation cmdlet. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -96,7 +106,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -120,8 +129,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelislocation) -[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelislocation) -[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinelislocation) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisPort.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisPort.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsOnlineLisPort.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisPort.md index 6e1665a058..f119fd2f3b 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisPort.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisPort.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport applicable: Microsoft Teams -title: Remove-CsOnlineLisPort -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisport +schema: 2.0.0 +title: Remove-CsOnlineLisPort --- # Remove-CsOnlineLisPort @@ -38,13 +39,15 @@ Example 1 removes the location information for port 12174 with ChassisID 0B-23-C ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -53,16 +56,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -PortID -This parameter identifies the ID of the port. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -70,6 +75,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -78,7 +86,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -88,13 +95,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -104,13 +113,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,30 +130,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore -This parameter is reserved for internal Microsoft use. +### -PortID + +> Applicable: Microsoft Teams + +This parameter identifies the ID of the port. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -152,6 +167,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -159,7 +177,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -185,6 +202,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport) +[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisport) -[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport) +[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisport) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSubnet.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSubnet.md index eec633e37e..0c421973af 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSubnet.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelissubnet applicable: Microsoft Teams -title: Remove-CsOnlineLisSubnet -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelissubnet +schema: 2.0.0 +title: Remove-CsOnlineLisSubnet --- # Remove-CsOnlineLisSubnet @@ -26,14 +27,14 @@ Enhanced 9-1-1 (E9-1-1) allows an emergency operator to identify the location of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineLisSubnet -Subnet 10.10.10.10 ``` Example 1 removes the Location Information Service subnet "10.10.10.10". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Remove-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e ``` @@ -43,13 +44,15 @@ Example 1 removes the Location Information Service subnet "2001:4898:e8:6c:90d2: ## PARAMETERS ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -59,6 +62,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -67,7 +73,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -77,13 +82,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -93,13 +100,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -109,13 +118,15 @@ Accept wildcard characters: False ``` ### -Subnet + +> Applicable: Microsoft Teams + The IP address of the subnet. This value can be either IPv4 or IPv6 format. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 1 @@ -125,13 +136,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -141,13 +154,15 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 @@ -157,6 +172,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -164,7 +182,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSwitch.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSwitch.md index be82fd7ba5..682853fd4a 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSwitch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch applicable: Microsoft Teams -title: Remove-CsOnlineLisSwitch -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisswitch +schema: 2.0.0 +title: Remove-CsOnlineLisSwitch --- # Remove-CsOnlineLisSwitch @@ -36,13 +37,15 @@ Example 1 removes the switch with Chassis ID "0B-23-CD-16-AA-CC". ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -51,7 +54,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -60,7 +84,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -70,13 +93,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -86,13 +111,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -102,13 +129,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -117,23 +146,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -141,7 +157,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -167,6 +182,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch) +[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisswitch) -[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch) +[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisswitch) diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint.md index ff2c7da4d7..8d03c86be1 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint applicable: Microsoft Teams -title: Remove-CsOnlineLisWirelessAccessPoint -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliswirelessaccesspoint +schema: 2.0.0 +title: Remove-CsOnlineLisWirelessAccessPoint --- # Remove-CsOnlineLisWirelessAccessPoint @@ -47,13 +48,15 @@ Example 2 removes the Location Information Server (LIS) wireless access point wi ## PARAMETERS ### -BSSID + +> Applicable: Microsoft Teams + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. It can be presented in wildcard format. The wildcard '*' can be on either the last one or two character(s). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -62,7 +65,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -71,7 +95,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -81,13 +104,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -97,13 +122,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -113,13 +140,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -128,23 +157,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -152,7 +168,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -176,6 +191,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint) +[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliswirelessaccesspoint) -[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint) +[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliswirelessaccesspoint) diff --git a/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlinePSTNGateway.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlinePSTNGateway.md index 6af2287599..5e869c3ef1 100644 --- a/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlinePSTNGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway applicable: Microsoft Teams -title: Remove-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinepstngateway +schema: 2.0.0 +title: Remove-CsOnlinePSTNGateway --- # Remove-CsOnlinePSTNGateway @@ -35,13 +36,15 @@ This example removes SBC with Identity (and FQDN) sbc.contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The parameter is mandatory for the cmdlet. The Identity is the same as the SBC FQDN. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -62,8 +65,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstngateway) -[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinepstngateway) -[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstngateway) diff --git a/teams/teams-ps/teams/Remove-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineSchedule.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineSchedule.md index 6dc49f8900..c72b991afe 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineschedule applicable: Microsoft Teams -title: Remove-CsOnlineSchedule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineschedule +schema: 2.0.0 +title: Remove-CsOnlineSchedule --- # Remove-CsOnlineSchedule @@ -25,7 +27,7 @@ The Remove-CsOnlineSchedule cmdlet deletes a schedule that is specified by using ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" ``` @@ -35,13 +37,15 @@ This example deletes the schedule that has an Id of fa9081d6-b4f3-5c96-baec-0b00 ## PARAMETERS ### -Id + +> Applicable: Microsoft Teams + The Id for the schedule to be removed. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -52,11 +56,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -81,6 +86,6 @@ The Remove-CsOnlineSchedule cmdlet accepts a string as the Id parameter. ## RELATED LINKS -[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) -[Set-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/set-csonlineschedule) +[Set-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineschedule) diff --git a/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineTelephoneNumber.md similarity index 92% rename from teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineTelephoneNumber.md index 4c26d98627..56112491b0 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineTelephoneNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinetelephonenumber applicable: Microsoft Teams -title: Remove-CsOnlineTelephoneNumber -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinetelephonenumber +schema: 2.0.0 +title: Remove-CsOnlineTelephoneNumber --- # Remove-CsOnlineTelephoneNumber @@ -26,7 +27,7 @@ This cmdlet removes one or more unassigned telephone numbers from your tenant. I ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineTelephoneNumber -TelephoneNumber 14258884567 ``` @@ -38,7 +39,7 @@ NumberIdsDeleted NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManage This example removes the specified telephone number from the tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` [string[]]$tns="+14255551234","+14255551233" Remove-CsOnlineTelephoneNumber -TelephoneNumber $tns @@ -54,28 +55,30 @@ This example removes the specified list of telephone numbers from the tenant. ## PARAMETERS -### -TelephoneNumber -Specifies the telephone number(s) to remove. The format can be with or without the prefixed +, but needs to include country code etc. +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml -Type: String[] +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -84,17 +87,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -TelephoneNumber +Specifies the telephone number(s) to remove. The format can be with or without the prefixed +, but needs to include country code etc. ```yaml -Type: SwitchParameter +Type: String[] Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -134,4 +135,4 @@ None If one or more of the telephone numbers are assigned to a user or a service, the cmdlet will display an error message and none of the telephone numbers specified will be removed from your tenant. ## RELATED LINKS -[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber) +[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinetelephonenumber) diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoute.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoute.md index c2487ee802..7477590ac3 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute applicable: Microsoft Teams -title: Remove-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroute +schema: 2.0.0 +title: Remove-CsOnlineVoiceRoute --- # Remove-CsOnlineVoiceRoute @@ -27,21 +28,21 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsOnlineVoiceRoute -Identity Route1 ``` Removes the settings for the online voice route with the identity Route1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\ Get-CsOnlineVoiceRoute | Remove-CsOnlineVoiceRoute ``` This command removes all online voice routes from the organization. First all online voice routes are retrieved by the `Get-CsOnlineVoiceRoute` cmdlet. These online voice routes are then piped to the `Remove-CsOnlineVoiceRoute` cmdlet, which removes each one. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\ Get-CsOnlineVoiceRoute -Filter *Redmond* | Remove-CsOnlineVoiceRoute ``` @@ -108,8 +109,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroute) -[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy.md index a92e803b2c..cc61a8333c 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Remove-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Remove-CsOnlineVoiceRoutingPolicy --- # Remove-CsOnlineVoiceRoutingPolicy @@ -29,21 +30,21 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" ``` The command shown in Example 1 deletes the online voice routing policy RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy -Filter "tag:*" | Remove-CsOnlineVoiceRoutingPolicy ``` In Example 2, all the online voice routing policies configured at the per-user scope are removed. To do this, the command first calls the `Get-CsOnlineVoiceRoutingPolicy` cmdlet along with the Filter parameter; the filter value "tag:\*" limits the returned data to online voice routing policies configured at the per-user scope. Those per-user policies are then piped to and removed by, the `Remove-CsOnlineVoiceRoutingPolicy` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Long Distance"} | Remove-CsOnlineVoiceRoutingPolicy ``` @@ -52,6 +53,21 @@ In Example 3, all the online voice routing polices that include the online PSTN ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier assigned to the policy when it was created. @@ -83,21 +99,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -110,10 +111,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy) -[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy.md similarity index 83% rename from teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy.md index 37611ecdb3..f0f199b9b2 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy applicable: Microsoft Teams -title: Remove-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy +schema: 2.0.0 +title: Remove-CsOnlineVoicemailPolicy --- # Remove-CsOnlineVoicemailPolicy @@ -26,7 +27,7 @@ Deletes an existing Online Voicemail policy or resets the Global policy instance ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" ``` @@ -34,46 +35,52 @@ The command shown in Example 1 deletes a per-user online voicemail policy Custom ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Microsoft Teams + +A unique identifier specifying the scope, and in some cases the name, of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -93,10 +100,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable You are not able to delete the pre-configured policy instances Default, TranscriptionProfanityMaskingEnabled and TranscriptionDisabled ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberAssignment.md similarity index 81% rename from teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberAssignment.md index b49552c75f..b599742e58 100644 --- a/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberAssignment.md @@ -1,162 +1,168 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment -applicable: Microsoft Teams -title: Remove-CsPhoneNumberAssignment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Remove-CsPhoneNumberAssignment - -## SYNOPSIS -This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). - -## SYNTAX - -### RemoveSome (Default) -```powershell -Remove-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType -Notify [] -``` - -### RemoveAll -```powershell -Remove-CsPhoneNumberAssignment -Identity -RemoveAll -Notify [] -``` - -## DESCRIPTION -This cmdlet removes/unassigns a phone number from a user or resource account. The phone number continues to be available in the tenant. - -Unassigning a phone number from a user or resource account will automatically set EnterpriseVoiceEnabled to False. - -If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a -Code string parameter and a Message string parameter with additional details of the failure. Email notification to end user is a best effort operation. No error message will be displayed if the email fails to send. - - -**Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an -exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also -now support the -ErrorAction parameter to control the execution after an error has occurred. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan -``` -This example removes/unassigns the Microsoft Calling Plan telephone number +1 (206) 555-1234 from the user user1@contoso.com. - -### Example 2 -```powershell -Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll -``` -This example removes/unassigns all the telephone number from user2@contoso.com. - -### Example 3 -```powershell -Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan -Notify -``` -This example removes/unassigns the Microsoft Calling Plan phone number +1 (206) 555-1234 from the user user1@contoso.com and also sends an email notification to the user about the removal of telephone number. - -### Example 4 -```powershell -Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll -Notify -``` -This example removes/unassigns all the telephone number from user2@contoso.com and also sends an email notification to the user about the change. - -## PARAMETERS - -### -Identity -The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or -resource account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -The phone number to unassign from the user or resource account. Supports E.164 format and non-E.164 format. Needs to be without the prefixed "tel:". - -```yaml -Type: System.String -Parameter Sets: (RemoveSome) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumberType -The type of phone number to unassign from the user or resource account. The supported values are DirectRouting, CallingPlan and OperatorConnect. - -```yaml -Type: System.String -Parameter Sets: (RemoveSome) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveAll -Unassigns the phone number from the user or resource account. - -```yaml -Type: Switch -Parameter Sets: (RemoveAll) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notify -Sends a best-effort email notification when a phone number is removed. Failures to send email are not reported. - -```yaml -Type: Switch -Parameter Sets: (RemoveSome, RemoveAll) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 3.0.0 or later. - -The cmdlet is only available in commercial and GCC cloud instances. - -## RELATED LINKS -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) - -[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment +schema: 2.0.0 +title: Remove-CsPhoneNumberAssignment +--- + +# Remove-CsPhoneNumberAssignment + +## SYNOPSIS +This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). + +## SYNTAX + +### RemoveSome (Default) +``` +Remove-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType + [-HttpPipelinePrepend ] [] +``` + +### RemoveAll +``` +Remove-CsPhoneNumberAssignment -Identity [-HttpPipelinePrepend ] [-RemoveAll] + [] +``` + +## DESCRIPTION +This cmdlet removes/unassigns a phone number from a user or resource account. The phone number continues to be available in the tenant. + +Unassigning a phone number from a user or resource account will automatically set EnterpriseVoiceEnabled to False. + +If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a +Code string parameter and a Message string parameter with additional details of the failure. Email notification to end user is a best effort operation. No error message will be displayed if the email fails to send. + + +**Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an +exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also +now support the -ErrorAction parameter to control the execution after an error has occurred. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan +``` +This example removes/unassigns the Microsoft Calling Plan telephone number +1 (206) 555-1234 from the user user1@contoso.com. + +### Example 2 +```powershell +Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll +``` +This example removes/unassigns all the telephone number from user2@contoso.com. + +### Example 3 +```powershell +Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan +``` +This example removes/unassigns the Microsoft Calling Plan phone number +1 (206) 555-1234 from the user user1@contoso.com and also sends an email notification to the user about the removal of telephone number. + +### Example 4 +```powershell +Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll +``` +This example removes/unassigns all the telephone number from user2@contoso.com and also sends an email notification to the user about the change. + +## PARAMETERS + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or +resource account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumber +The phone number to unassign from the user or resource account. Supports E.164 format and non-E.164 format. Needs to be without the prefixed "tel:". + +```yaml +Type: System.String +Parameter Sets: RemoveSome +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumberType +The type of phone number to unassign from the user or resource account. The supported values are DirectRouting, CallingPlan and OperatorConnect. + +```yaml +Type: System.String +Parameter Sets: RemoveSome +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAll +Unassigns the phone number from the user or resource account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemoveAll +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 3.0.0 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) + +[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Remove-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberTag.md similarity index 91% rename from teams/teams-ps/teams/Remove-CsPhoneNumberTag.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberTag.md index 38cda0282c..7b336cff3c 100644 --- a/teams/teams-ps/teams/Remove-CsPhoneNumberTag.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberTag.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/remove-csphonenumbertag applicable: Microsoft Teams -title: Remove-CsPhoneNumberTag author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumbertag schema: 2.0.0 +title: Remove-CsPhoneNumberTag --- # Remove-CsPhoneNumberTag @@ -23,7 +24,7 @@ Remove-CsPhoneNumberTag -Tag [-PhoneNumber ] [ [] ``` @@ -26,7 +30,7 @@ Use the Remove-CsSharedCallQueueHistoryTemplate cmdlet to delete a Shared Call Q ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsSharedCallQueueHistoryTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` @@ -36,13 +40,15 @@ This example deletes the Shared Call Queue History template with the identity 5e ## PARAMETERS ### -Id + +> Applicable: Microsoft Teams + The Id parameter is the unique identifier assigned to the Shared Call Queue History template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTeamTemplate.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamTemplate.md similarity index 91% rename from teams/teams-ps/teams/Remove-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamTemplate.md index ee73ec6d3d..f4fe5c56f8 100644 --- a/teams/teams-ps/teams/Remove-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamTemplate.md @@ -1,273 +1,276 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate -title: Remove-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: farahf -schema: 2.0.0 ---- - -# Remove-CsTeamTemplate - -## SYNOPSIS - -This cmdlet deletes a specified Team Template from Microsoft Teams. - -## SYNTAX - -### Delete (Default) - -```powershell -Remove-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### DeleteViaIdentity - -```powershell -Remove-CsTeamTemplate -InputObject [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> Remove-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US' -``` - -Removes template with OData Id '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US'. - -### EXAMPLE 2 - -```powershell -PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Remove-CsTeamTemplate -OdataId $_.OdataId} -``` - -Removes template that meets the following specifications: 1) Locale set to en-US. 2) Name contains 'test'. - -## PARAMETERS - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OdataId - -A composite URI of a template. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IAny - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - -- `[Bssid ]`: -- `[ChassisId ]`: -- `[CivicAddressId ]`: Civic address id. -- `[Country ]`: -- `[GroupId ]`: The ID of a group whose policy assignments will be returned. -- `[Id ]`: -- `[Identity ]`: -- `[Locale ]`: -- `[LocationId ]`: Location id. -- `[OdataId ]`: A composite URI of a template. -- `[OperationId ]`: The ID of a batch policy assignment operation. -- `[OrderId ]`: -- `[PackageName ]`: The name of a specific policy package -- `[PolicyType ]`: The policy type for which group policy assignments will be returned. -- `[Port ]`: -- `[PortInOrderId ]`: -- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. -- `[SubnetId ]`: -- `[TenantId ]`: -- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -## RELATED LINKS - -[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) - -[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) - -[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) - -[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) - -[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: farahf +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamtemplate +schema: 2.0.0 +title: Remove-CsTeamTemplate +--- + +# Remove-CsTeamTemplate + +## SYNOPSIS +This cmdlet deletes a specified Team Template from Microsoft Teams. + +## SYNTAX + +### Delete (Default) + +``` +Remove-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity + +``` +Remove-CsTeamTemplate -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet deletes a specified Team Template from Microsoft Teams. The template can be identified by its OData ID or by using the Identity parameter. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> Remove-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US' +``` + +Removes template with OData Id '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US'. + +### EXAMPLE 2 + +```powershell +PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Remove-CsTeamTemplate -OdataId $_.OdataId} +``` + +Removes template that meets the following specifications: 1) Locale set to en-US. 2) Name contains 'test'. + +## PARAMETERS + +### -Break + +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend + +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend + +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OdataId + +A composite URI of a template. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy + +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential + +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials + +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IAny + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT \: Identity Parameter + +- `[Bssid ]`: +- `[ChassisId ]`: +- `[CivicAddressId ]`: Civic address id. +- `[Country ]`: +- `[GroupId ]`: The ID of a group whose policy assignments will be returned. +- `[Id ]`: +- `[Identity ]`: +- `[Locale ]`: +- `[LocationId ]`: Location id. +- `[OdataId ]`: A composite URI of a template. +- `[OperationId ]`: The ID of a batch policy assignment operation. +- `[OrderId ]`: +- `[PackageName ]`: The name of a specific policy package +- `[PolicyType ]`: The policy type for which group policy assignments will be returned. +- `[Port ]`: +- `[PortInOrderId ]`: +- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. +- `[SubnetId ]`: +- `[TenantId ]`: +- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +## RELATED LINKS + +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) + +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplate) + +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamtemplate) + +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamtemplate) + +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAIPolicy.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAIPolicy.md index 01ddbc1bcc..524da05c3f 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Remove-CsTeamsAIPolicy -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsAIPolicy -schema: 2.0.0 author: Andy447 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: andywang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsTeamsAIPolicy +schema: 2.0.0 +title: Remove-CsTeamsAIPolicy --- # Remove-CsTeamsAIPolicy @@ -64,10 +65,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaipolicy) -[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaipolicy) -[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy.md similarity index 74% rename from teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy.md index 409570c300..3fbe3ba680 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy.md @@ -1,26 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsapppermissionpolicy applicable: Microsoft Teams -title: Remove-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: mhayrapetyan +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsapppermissionpolicy +schema: 2.0.0 +title: Remove-CsTeamsAppPermissionPolicy --- # Remove-CsTeamsAppPermissionPolicy ## SYNOPSIS - -**NOTE**: You can use this cmdlet to remove a specific custom policy from a user. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. - -As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . - -This cmdlet allows you to remove app permission policies that have been created within your organization. If you run `Remove-CsTeamsAppPermissionPolicy` on the Global policy, it will be reset to the defaults provided for new organizations. - -**This is only applicable for tenants who have not been migrated to ACM or UAM.** +This cmdlet allows you to remove app permission policies that have been created within your organization. ## SYNTAX @@ -36,6 +31,8 @@ As an admin, you can use app permission policies to enable or block specific app This cmdlet allows you to remove app permission policies that have been created within your organization. If you run Remove-CsTeamsAppPermissionPolicy on the Global policy, it will be reset to the defaults provided for new organizations. +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + ## EXAMPLES ### Example 1 @@ -47,33 +44,34 @@ Deletes a custom policy that has already been created in the organization. ## PARAMETERS -### -Identity -Unique identifier for the policy to be removed. -To "remove" the global policy, use the following syntax: `-Identity global`. -(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. -You cannot use wildcards when specifying a policy Identity. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -82,30 +80,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Microsoft Teams + +Unique identifier for the policy to be removed. +To "remove" the global policy, use the following syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. +You cannot use wildcards when specifying a policy Identity. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Microsoft Teams + +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -114,14 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -WhatIf + +> Applicable: Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy.md similarity index 73% rename from teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy.md index fa290e6383..fae66e7260 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy.md @@ -1,25 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsappsetuppolicy applicable: Microsoft Teams -title: Remove-CsTeamsAppSetupPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsappsetuppolicy +schema: 2.0.0 +title: Remove-CsTeamsAppSetupPolicy --- # Remove-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: You can use this cmdlet to remove custom app setup policies. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -If you run Remove-CsTeamsAppSetupPolicy on the Global policy, it will be reset to the defaults provided for new organizations. +You can use this cmdlet to remove custom app setup policies. ## SYNTAX @@ -48,33 +44,34 @@ Deletes a custom policy that has already been created in the organization. ## PARAMETERS -### -Identity -Unique identifier for the policy to be removed. -To "remove" the global policy, use the following syntax: `-Identity global`. -(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. -You cannot use wildcards when specifying a policy Identity. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -83,30 +80,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Microsoft Teams + +Unique identifier for the policy to be removed. +To "remove" the global policy, use the following syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. +You cannot use wildcards when specifying a policy Identity. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Microsoft Teams + +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -115,14 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -WhatIf + +> Applicable: Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy.md index 5866a31e39..532fd43779 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy -title: Remove-CsTeamsAudioConferencingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaudioconferencingpolicy schema: 2.0.0 +title: Remove-CsTeamsAudioConferencingPolicy --- # Remove-CsTeamsAudioConferencingPolicy @@ -32,6 +33,21 @@ In the example shown above, the command will delete the "Emea Users" audio confe ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. Suppresses any confirmation prompts that would otherwise be displayed before making changes. @@ -63,21 +79,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -107,8 +108,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy) -[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy.md index e735cc0dc3..4a01c1b807 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy applicable: Microsoft Teams -title: Remove-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallholdpolicy +schema: 2.0.0 +title: Remove-CsTeamsCallHoldPolicy --- # Remove-CsTeamsCallHoldPolicy @@ -48,18 +49,18 @@ The Filter value "Tag:*" limits the returned data to Teams call hold policies co ## PARAMETERS -### -Identity -Unique identifier of the Teams call hold policy to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -78,29 +79,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity +Unique identifier of the Teams call hold policy to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -122,10 +123,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy) -[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallholdpolicy) -[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallholdpolicy) -[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallholdpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallParkPolicy.md similarity index 92% rename from teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallParkPolicy.md index 8504928e7c..17db311865 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallParkPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallparkpolicy applicable: Microsoft Teams -title: Remove-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallparkpolicy +schema: 2.0.0 +title: Remove-CsTeamsCallParkPolicy --- # Remove-CsTeamsCallParkPolicy @@ -39,33 +41,34 @@ Deletes a custom policy that has already been created in the organization. ## PARAMETERS -### -Identity -Unique identifier for the client policy to be removed. -To "remove" the global policy, use the following syntax: `-Identity global`. -(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. -You cannot use wildcards when specifying a policy Identity. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -74,30 +77,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Microsoft Teams + +Unique identifier for the client policy to be removed. +To "remove" the global policy, use the following syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. +You cannot use wildcards when specifying a policy Identity. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Microsoft Teams + +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -106,14 +116,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -WhatIf + +> Applicable: Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallingPolicy.md similarity index 86% rename from teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallingPolicy.md index f22acb63d5..8a566bb862 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallingpolicy schema: 2.0.0 +title: Remove-CsTeamsCallingPolicy --- # Remove-CsTeamsCallingPolicy @@ -41,33 +42,33 @@ This example resets the Global Policy instance to the default values. ## PARAMETERS -### -Identity - The Identity parameter is the unique identifier of the Teams Calling Policy instance to remove or reset. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity + The Identity parameter is the unique identifier of the Teams Calling Policy instance to remove or reset. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -100,10 +101,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallingpolicy) -[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallingpolicy) -[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallingpolicy) -[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsChannelsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsChannelsPolicy.md index 1adb7d3231..950b555a5a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsChannelsPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy applicable: Microsoft Teams -title: Remove-CsTeamsChannelsPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamschannelspolicy +schema: 2.0.0 +title: Remove-CsTeamsChannelsPolicy --- # Remove-CsTeamsChannelsPolicy @@ -39,34 +41,16 @@ Deletes a custom policy that has already been created in the organization. ## PARAMETERS -### -Identity -The name of the policy to be removed. Wildcards are not supported. - -To remove a custom policy, use syntax similar to this: `-Identity "Student Policy"`. - -To "remove" the global policy, use the following syntax: `-Identity Global`. You can't actually remove the global policy. Instead, all properties will be reset to their default values as shown in the default policy (`Tag:Default`). - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -Confirm -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -76,13 +60,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -91,14 +77,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +The name of the policy to be removed. Wildcards are not supported. + +To remove a custom policy, use syntax similar to this: `-Identity "Student Policy"`. + +To "remove" the global policy, use the following syntax: `-Identity Global`. You can't actually remove the global policy. Instead, all properties will be reset to their default values as shown in the default policy (`Tag:Default`). + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Tenant + +> Applicable: Microsoft Teams + Internal Microsoft use only. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -108,13 +118,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication.md index 05cb425285..1e18077eff 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication applicable: Microsoft Teams -title: Remove-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication +schema: 2.0.0 +title: Remove-CsTeamsComplianceRecordingApplication --- # Remove-CsTeamsComplianceRecordingApplication @@ -55,6 +56,36 @@ The command shown in Example 2 deletes all existing associations between applica ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity A name that uniquely identifies the application instance of the policy-based recording application. @@ -100,36 +131,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -161,20 +162,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy.md similarity index 86% rename from teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy.md index c121ab2692..2aae88bb8e 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: Remove-CsTeamsComplianceRecordingPolicy --- # Remove-CsTeamsComplianceRecordingPolicy @@ -56,6 +57,36 @@ The Filter value "Tag:*" limits the returned data to Teams recording policies co ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier to be assigned to the new Teams recording policy. @@ -99,36 +130,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -160,20 +161,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCortanaPolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCortanaPolicy.md index bac8a3df1d..70da0afba6 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy applicable: Microsoft Teams -title: Remove-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscortanapolicy +schema: 2.0.0 +title: Remove-CsTeamsCortanaPolicy --- # Remove-CsTeamsCortanaPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCustomBannerText.md similarity index 81% rename from teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCustomBannerText.md index 8619d8cca2..f53e25f2f6 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCustomBannerText.md @@ -1,16 +1,16 @@ --- -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText -title: Remove-CsTeamsCustomBannerText -schema: 2.0.0 author: saleens7 +Locale: en-US +Module Name: MicrosoftTeams ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsTeamsCustomBannerText +schema: 2.0.0 +title: Remove-CsTeamsCustomBannerText --- # Remove-CsTeamsCustomBannerText ## SYNOPSIS - Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call. ## SYNTAX @@ -27,6 +27,7 @@ Removes a single instance of custom banner text. ## EXAMPLES ### Example 1 +```powershell PS C:\> Remove-CsTeamsCustomBannerText -Identity CustomText ``` @@ -35,13 +36,15 @@ This example removes a TeamsCustomBannerText instance with the name "CustomText" ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + Policy instance name (optional). ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -64,8 +67,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy.md similarity index 83% rename from teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy.md index 09e839d382..c9cb715046 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Remove-CsTeamsEmergencyCallRoutingPolicy --- # Remove-CsTeamsEmergencyCallRoutingPolicy @@ -42,6 +44,21 @@ This example resets the Teams Emergency Call Routing Global policy instance to i ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The Identity parameter is the unique identifier of the Teams Emergency Call Routing policy to remove. @@ -73,21 +90,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -99,10 +101,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy) -[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy) -[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy.md similarity index 84% rename from teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy.md index 0f35301904..d023e900fd 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy schema: 2.0.0 +title: Remove-CsTeamsEmergencyCallingPolicy --- # Remove-CsTeamsEmergencyCallingPolicy @@ -41,6 +43,21 @@ This example resets the Global Policy instance to the default values. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The Identity parameter is the unique identifier of the Teams Emergency Calling policy to remove. @@ -72,21 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -102,10 +104,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy) -[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy) -[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEnhancedEncryptionPolicy.md similarity index 86% rename from teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEnhancedEncryptionPolicy.md index 2e310c4d61..d21aab0d52 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEnhancedEncryptionPolicy.md @@ -1,128 +1,129 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy -title: Remove-CsTeamsEnhancedEncryptionPolicy -author: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Remove-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Use this cmdlet to remove an existing Teams enhanced encryption policy. - -## SYNTAX - -``` -Remove-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Use this cmdlet to remove an existing Teams enhanced encryption policy. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> Remove-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerTeamsEnhancedEncryptionPolicy' -``` - -The command shown in Example 1 deletes the Teams enhanced encryption policy ContosoPartnerTeamsEnhancedEncryptionPolicy. - -### EXAMPLE 2 -```PowerShell -PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Filter 'Tag:*' | Remove-CsTeamsEnhancedEncryptionPolicy -``` - -In Example 2, all the Teams enhanced encryption policies configured at the per-user scope are removed. The Filter value "Tag:*" limits the returned data to Teams enhanced encryption policies configured at the per-user scope. Those per-user policies are then removed. - -## PARAMETERS - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Suppresses all non-fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Remove-CsTeamsEnhancedEncryptionPolicy +--- + +# Remove-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Use this cmdlet to remove an existing Teams enhanced encryption policy. + +## SYNTAX + +``` +Remove-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Use this cmdlet to remove an existing Teams enhanced encryption policy. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> Remove-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerTeamsEnhancedEncryptionPolicy' +``` + +The command shown in Example 1 deletes the Teams enhanced encryption policy ContosoPartnerTeamsEnhancedEncryptionPolicy. + +### EXAMPLE 2 +```PowerShell +PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Filter 'Tag:*' | Remove-CsTeamsEnhancedEncryptionPolicy +``` + +In Example 2, all the Teams enhanced encryption policies configured at the per-user scope are removed. The Filter value "Tag:*" limits the returned data to Teams enhanced encryption policies configured at the per-user scope. Those per-user policies are then removed. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy) + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEventsPolicy.md similarity index 92% rename from teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEventsPolicy.md index adc94c0242..517c39816e 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEventsPolicy.md @@ -1,94 +1,95 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamseventspolicy -title: Remove-CsTeamsEventsPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsEventsPolicy - -## SYNOPSIS -The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. - -## SYNTAX - -``` -Remove-CsTeamsEventsPolicy [-Identity] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Deletes a previously created TeamsEventsPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsEventsPolicy -Identity DisablePublicWebinars -``` - -In this example, the command will delete the DisablePublicWebinars policy from the organization's list of policies. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamseventspolicy +schema: 2.0.0 +title: Remove-CsTeamsEventsPolicy +--- + +# Remove-CsTeamsEventsPolicy + +## SYNOPSIS +The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. + +## SYNTAX + +``` +Remove-CsTeamsEventsPolicy [-Identity] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Deletes a previously created TeamsEventsPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsEventsPolicy -Identity DisablePublicWebinars +``` + +In this example, the command will delete the DisablePublicWebinars policy from the organization's list of policies. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy.md index c001e0e880..fe1c14b60a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Remove-CsTeamsFeedbackPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsfeedbackpolicy +schema: 2.0.0 +title: Remove-CsTeamsFeedbackPolicy --- # Remove-CsTeamsFeedbackPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFilesPolicy.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFilesPolicy.md index 8b2f609c8e..6fb3c9e4dc 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFilesPolicy.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy -title: Remove-CsTeamsFilesPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsfilespolicy schema: 2.0.0 +title: Remove-CsTeamsFilesPolicy --- # Remove-CsTeamsFilesPolicy @@ -58,11 +59,11 @@ You are not able to delete the pre-configured policy instances Default, Transcri ## RELATED LINKS -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy.md index f31fdeafd5..f2e7cec78a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsipphonepolicy applicable: Microsoft Teams -title: Remove-CsTeamsIPPhonePolicy author: tonywoodruff +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsipphonepolicy schema: 2.0.0 +title: Remove-CsTeamsIPPhonePolicy --- # Remove-CsTeamsIPPhonePolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMediaConnectivityPolicy.md similarity index 82% rename from teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMediaConnectivityPolicy.md index a2b3b79a34..4e4a1dd7d4 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Remove-CsTeamsMediaConnectivityPolicy -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMediaConnectivityPolicy -schema: 2.0.0 author: lirunping-MSFT +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: runli +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +title: Remove-CsTeamsMediaConnectivityPolicy --- # Remove-CsTeamsMediaConnectivityPolicy @@ -62,8 +63,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy) -[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy) -[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy.md index ac3f34c82e..49a2313c07 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Remove-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # Remove-CsTeamsMeetingBrandingPolicy @@ -35,20 +35,6 @@ In this example, the command deletes the `policy test` meeting branding policy f ## PARAMETERS -### -Identity -Unique identifier of the policy to be deleted. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -79,6 +65,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique identifier of the policy to be deleted. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -WhatIf Describes what would happen if you executed the command without actually executing the command. @@ -107,12 +107,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy.md index 3b8ee0ebd4..3bcd894698 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy.md @@ -1,19 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbroadcastpolicy applicable: Microsoft Teams -title: Remove-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Remove-CsTeamsMeetingBroadcastPolicy --- # Remove-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS -Remove-CsTeamsMeetingBroadcastPolicy \[-Identity\] \ \[-Tenant \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] +Deletes an existing Teams meeting broadcast policy in your tenant. ## SYNTAX @@ -23,7 +25,7 @@ Remove-CsTeamsMeetingBroadcastPolicy [-Tenant ] [-Identity] ``` ## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to delete an existing policy. +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## EXAMPLES diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingPolicy.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingPolicy.md index afc4b6bca6..e4a899e0bf 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingpolicy +schema: 2.0.0 +title: Remove-CsTeamsMeetingPolicy --- # Remove-CsTeamsMeetingPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 84% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md index b813ff072b..85c5c31122 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Remove-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Remove-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Remove-CsTeamsMeetingTemplatePermissionPolicy --- # Remove-CsTeamsMeetingTemplatePermissionPolicy @@ -54,13 +55,14 @@ At line:1 char:1 ### -Identity +> Applicable: Microsoft Teams + Identity of the policy instance to be deleted. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -78,10 +80,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy) -[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMessagingPolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMessagingPolicy.md index 1529b4300f..3b29832b50 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMessagingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmessagingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsMessagingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmessagingpolicy +schema: 2.0.0 +title: Remove-CsTeamsMessagingPolicy --- # Remove-CsTeamsMessagingPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMobilityPolicy.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMobilityPolicy.md index 8cce132f98..c37a73085b 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmobilitypolicy applicable: Microsoft Teams -title: Remove-CsTeamsMobilityPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmobilitypolicy +schema: 2.0.0 +title: Remove-CsTeamsMobilityPolicy --- # Remove-CsTeamsMobilityPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy.md index 5192c02bc6..24b864bac3 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnetworkroamingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsNetworkRoamingPolicy author: TristanChen-msft -ms.author: jiaych -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsnetworkroamingpolicy schema: 2.0.0 +title: Remove-CsTeamsNetworkRoamingPolicy --- # Remove-CsTeamsNetworkRoamingPolicy @@ -32,7 +32,7 @@ More on the impact of bit rate setting on bandwidth can be found [here](https:// ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsTeamsNetworkRoamingPolicy -Identity OfficePolicy ``` diff --git a/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNotificationAndFeedsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNotificationAndFeedsPolicy.md index 172211f455..0e3a9dad82 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNotificationAndFeedsPolicy.md @@ -1,109 +1,110 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnotificationandfeedspolicy -title: Remove-CsTeamsNotificationAndFeedsPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsNotificationAndFeedsPolicy - -## SYNOPSIS -Deletes an existing Teams Notification and Feeds Policy - -## SYNTAX - -```powershell -Remove-CsTeamsNotificationAndFeedsPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsNotificationAndFeedsPolicy -``` - -Remove an existing Notifications and Feeds Policy - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the policy when it was created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsnotificationandfeedspolicy +schema: 2.0.0 +title: Remove-CsTeamsNotificationAndFeedsPolicy +--- + +# Remove-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS +Deletes an existing Teams Notification and Feeds Policy + +## SYNTAX + +```powershell +Remove-CsTeamsNotificationAndFeedsPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsNotificationAndFeedsPolicy +``` + +Remove an existing Notifications and Feeds Policy + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRecordingRollOutPolicy.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRecordingRollOutPolicy.md index 6a51b6ae29..c654410d6a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsrecordingrolloutpolicy -schema: 2.0.0 applicable: Microsoft Teams -title: Remove-CsTeamsRecordingRollOutPolicy -manager: yujin1 author: ronwa +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams ms.author: ronwa +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsrecordingrolloutpolicy +schema: 2.0.0 +title: Remove-CsTeamsRecordingRollOutPolicy --- # Remove-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md index e1a8839e41..730c849119 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,107 +1,110 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsroomvideoteleconferencingpolicy -title: Remove-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Deletes an existing TeamsRoomVideoTeleConferencingPolicy. - -## SYNTAX - -```powershell -Remove-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the policy to be modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Remove-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Remove-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Deletes an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +``` +Remove-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSharedCallingRoutingPolicy.md similarity index 86% rename from teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSharedCallingRoutingPolicy.md index 536843d50b..31de502225 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsSharedCallingRoutingPolicy -schema: 2.0.0 author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy +schema: 2.0.0 +title: Remove-CsTeamsSharedCallingRoutingPolicy --- # Remove-CsTeamsSharedCallingRoutingPolicy @@ -44,29 +43,31 @@ and removed by the Remove-CsTeamsSharedCallingRoutingPolicy cmdlet. ## PARAMETERS -### -Identity -Unique identifier assigned to the policy when it is created. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -75,29 +76,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity +Unique identifier assigned to the policy when it is created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -117,10 +118,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable This cmdlet was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS -[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy) -[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy) -[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnection.md similarity index 84% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnection.md index a86968dfd2..e1b5bf16cf 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: stepfitz Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: stepfitz -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnection +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnection schema: 2.0.0 +title: Remove-CsTeamsShiftsConnection --- # Remove-CsTeamsShiftsConnection @@ -23,7 +24,7 @@ Remove-CsTeamsShiftsConnection -ConnectionId -InputObject Applicable: Microsoft Teams + The ID of the connection that you want to delete. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -95,8 +97,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection) -[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnection) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionInstance.md similarity index 77% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionInstance.md index 843cf262ce..736d85f320 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsConnectionInstance -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Remove-CsTeamsShiftsConnectionInstance --- # Remove-CsTeamsShiftsConnectionInstance @@ -23,7 +24,7 @@ Remove-CsTeamsShiftsConnectionInstance -ConnectorInstanceId [ Applicable: Microsoft Teams + The ID of the connection instance that you want to delete. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -63,8 +65,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionTeamMap.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionTeamMap.md index 48935f7bec..f0aee82c92 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionTeamMap.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsConnectionTeamMap -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectionteammap +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectionteammap schema: 2.0.0 +title: Remove-CsTeamsShiftsConnectionTeamMap --- # Remove-CsTeamsShiftsConnectionTeamMap @@ -23,7 +24,7 @@ Remove-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId -TeamId Applicable: Microsoft Teams The ID of the connection instance that you want to delete. @@ -60,7 +47,6 @@ The ID of the connection instance that you want to delete. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -100,6 +86,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamId + +> Applicable: Microsoft Teams + +The ID of the connection instance that you want to delete. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -111,6 +114,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap) +[Get-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectionteammap) -[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap) +[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectionbatchteammap) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsPolicy.md similarity index 82% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsPolicy.md index f7201e43a2..9433535351 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsPolicy.md @@ -1,70 +1,73 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsshiftspolicy -title: Remove-CsTeamsShiftsPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsShiftsPolicy - -## SYNOPSIS - -The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. - -Note: A TeamsShiftsPolicy needs to be unassigned from all the users before it can be deleted. - -## SYNTAX - -``` -Remove-CsTeamsShiftsPolicy [-Identity] [] -``` - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -``` - -In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". - -## PARAMETERS - -### -Identity -Policy instance name. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-teamsshiftspolicy +schema: 2.0.0 +title: Remove-CsTeamsShiftsPolicy +--- + +# Remove-CsTeamsShiftsPolicy + +## SYNOPSIS +The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. + +## SYNTAX + +``` +Remove-CsTeamsShiftsPolicy [-Identity] [] +``` + +## DESCRIPTION +Note: A TeamsShiftsPolicy needs to be unassigned from all the users before it can be deleted. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage +``` + +In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". + +## PARAMETERS + +### -Identity + +> Applicable: Microsoft Teams + +Policy instance name. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftspolicy) + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsScheduleRecord.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsScheduleRecord.md index 5c64fec405..b1ec41e3fd 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsScheduleRecord.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsScheduleRecord -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsschedulerecord +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsschedulerecord schema: 2.0.0 +title: Remove-CsTeamsShiftsScheduleRecord --- # Remove-CsTeamsShiftsScheduleRecord @@ -47,29 +48,29 @@ Removes the Shifts schedule record of swapRequest and openShiftRequest scenarios ## PARAMETERS -### -ClearSchedulingGroup -A value indicating whether to clear schedule group. +### -Body +The request body. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: IClearScheduleRequest +Parameter Sets: Remove Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -DateRangeEndDate -The end date of removing schedule record. +### -Break +Wait for .NET debugger to attach. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + Required: False Position: Named Default value: None @@ -77,29 +78,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DateRangeStartDate -The start date of removing schedule record. +### -ClearSchedulingGroup + +> Applicable: Microsoft Teams + +A value indicating whether to clear schedule group. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -The user ID of designated actor. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: RemoveExpanded -Aliases: -Applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + Required: False Position: Named Default value: None @@ -107,59 +110,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EntityType -The entity types. +### -DateRangeEndDate + +> Applicable: Microsoft Teams + +The end date of removing schedule record. ```yaml -Type: String[] -Parameter Sets: RemoveExpanded +Type: String +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamId -The Teams team ID where you want to remove schedule record. +### -DateRangeStartDate + +> Applicable: Microsoft Teams + +The start date of removing schedule record. ```yaml Type: String -Parameter Sets: RemoveExpanded +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Body -The request body. - -```yaml -Type: IClearScheduleRequest -Parameter Sets: Remove -Aliases: +### -DesignatedActorId -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Break -Wait for .NET debugger to attach. +The user ID of designated actor. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: RemoveExpanded Aliases: - Required: False Position: Named Default value: None @@ -167,15 +161,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -EntityType -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +> Applicable: Microsoft Teams -Required: False +The entity types. + +```yaml +Type: String[] +Parameter Sets: RemoveExpanded +Aliases: +Required: True Position: Named Default value: None Accept pipeline input: False @@ -272,6 +268,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamId + +> Applicable: Microsoft Teams + +The Teams team ID where you want to remove schedule record. + +```yaml +Type: String +Parameter Sets: RemoveExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TimeZone The Timezone parameter ensures that the shifts are displayed in the correct time zone based on your team's location. diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliance.md similarity index 73% rename from teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliance.md index ec60890b7b..5a871abaeb 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliance.md @@ -1,103 +1,112 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliance -title: Remove-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# Remove-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Remove-CsTeamsSurvivableBranchAppliance [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] - [-Confirm] [] -``` - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The Identity parameter is the unique identifier for the SBA. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssurvivablebranchappliance +schema: 2.0.0 +title: Remove-CsTeamsSurvivableBranchAppliance +--- + +# Remove-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Removes a Survivable Branch Appliance (SBA) from the tenant. + +## SYNTAX + +``` +Remove-CsTeamsSurvivableBranchAppliance [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, +allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during +service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session +Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets +will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The Identity parameter is the unique identifier for the SBA. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md index 6aa49338fb..e33aac4d51 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,103 +1,108 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliancepolicy -title: Remove-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Remove-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Policy instance name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Remove-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Remove-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Removes a Survivable Branch Appliance (SBA) policy from the tenant. + +## SYNTAX + +``` +Remove-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Policy instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTargetingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTargetingPolicy.md index 669d6bc872..08e7368f74 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTargetingPolicy.md @@ -1,120 +1,121 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy -title: Remove-CsTeamsTargetingPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsTargetingPolicy - -## SYNOPSIS - -The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. - -## SYNTAX - -```powershell -Remove-CsTeamsTargetingPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -Deletes a previously created TeamsTargetingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Remove-CsTeamsMeetingPolicy -Identity StudentTagPolicy -``` - -In the example shown above, the command will delete the student tag policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the teams meeting policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity StudentTagPolicy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) -[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstargetingpolicy +schema: 2.0.0 +title: Remove-CsTeamsTargetingPolicy +--- + +# Remove-CsTeamsTargetingPolicy + +## SYNOPSIS + +The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsTargetingPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Deletes a previously created TeamsTargetingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsMeetingPolicy -Identity StudentTagPolicy +``` + +In the example shown above, the command will delete the student tag policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the teams meeting policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity StudentTagPolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstargetingpolicy) +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTemplatePermissionPolicy.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTemplatePermissionPolicy.md index 28ecb18cd4..50084252ca 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTemplatePermissionPolicy.md @@ -1,135 +1,135 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy -title: Remove-CsTeamsTemplatePermissionPolicy -author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: -manager: weiliu2 -schema: 2.0.0 ---- - -# Remove-CsTeamsTemplatePermissionPolicy - -## SYNOPSIS -Deletes an instance of TeamsTemplatePermissionPolicy. - -## SYNTAX - -``` -Remove-CsTeamsTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Deletes an instance of TeamsTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. - -## EXAMPLES - -### Example 1 -```powershell -PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar -``` - -Deletes a policy instance with the Identity *Foobar*. - -### Example 2 -```powershell -PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar -``` - -```output -Remove-CsTeamsTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users or groups. Ensure policy is not assigned before removing. Please refer to documentation. CorrelationId: 8622aac5-00c3-4071-b6d0-d070db8f663f -At line:1 char:1 -+ Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar ... -+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsTemplatePermissionPolicy], PolicyRpException - + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsTemplatePermissionPolicyCmdlet -``` - -Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. - -You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Name of the policy instance to be deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) - -[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) - -[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) +--- +author: yishuaihuang4 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy +schema: 2.0.0 +title: Remove-CsTeamsTemplatePermissionPolicy +--- + +# Remove-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Deletes an instance of TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +Remove-CsTeamsTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes an instance of TeamsTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +### Example 1 +```powershell +PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` + +Deletes a policy instance with the Identity *Foobar*. + +### Example 2 +```powershell +PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` + +```output +Remove-CsTeamsTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users or groups. Ensure policy is not assigned before removing. Please refer to documentation. CorrelationId: 8622aac5-00c3-4071-b6d0-d070db8f663f +At line:1 char:1 ++ Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsTemplatePermissionPolicy], PolicyRpException + + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsTemplatePermissionPolicyCmdlet +``` + +Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the policy instance to be deleted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy) + +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTranslationRule.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTranslationRule.md index a1cc4fdcae..3c4d85c496 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule applicable: Microsoft Teams -title: Remove-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstranslationrule +schema: 2.0.0 +title: Remove-CsTeamsTranslationRule --- # Remove-CsTeamsTranslationRule @@ -42,6 +43,21 @@ This example removes all translation rules with Identifier starting with tst. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Identifier of the rule. This parameter is required. @@ -72,21 +88,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -97,10 +98,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstranslationrule) -[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstranslationrule) -[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstranslationrule) -[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUnassignedNumberTreatment.md similarity index 79% rename from teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUnassignedNumberTreatment.md index 118a64f812..8bf1e3ee3c 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUnassignedNumberTreatment.md @@ -1,74 +1,73 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment -applicable: Microsoft Teams -title: Remove-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Remove-CsTeamsUnassignedNumberTreatment - -## SYNOPSIS -Removes a treatment for how calls to an unassigned number range should be routed. - -## SYNTAX - -``` -Remove-CsTeamsUnassignedNumberTreatment [-Identity] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet removes a treatment for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsTeamsUnassignedNumberTreatment -Identity MainAA -``` -This example removes the treatment MainAA. - -## PARAMETERS - -### -Identity -The Id of the specific treatment to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: ByPropertyName -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.5.1 or later. - -## RELATED LINKS -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) - -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) - -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) - -[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment +schema: 2.0.0 +title: Remove-CsTeamsUnassignedNumberTreatment +--- + +# Remove-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +Removes a treatment for how calls to an unassigned number range should be routed. + +## SYNTAX + +``` +Remove-CsTeamsUnassignedNumberTreatment [-Identity] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet removes a treatment for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsTeamsUnassignedNumberTreatment -Identity MainAA +``` +This example removes the treatment MainAA. + +## PARAMETERS + +### -Identity +The Id of the specific treatment to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: ByPropertyName +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +## RELATED LINKS +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment) + +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment) + +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUpdateManagementPolicy.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUpdateManagementPolicy.md index e558236294..3ebed226fd 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsupdatemanagementpolicy applicable: Microsoft Teams -title: Remove-CsTeamsUpdateManagementPolicy -schema: 2.0.0 author: vargasj-ms -ms.author: vargasj +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: gnamun +Module Name: MicrosoftTeams +ms.author: vargasj +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsupdatemanagementpolicy +schema: 2.0.0 +title: Remove-CsTeamsUpdateManagementPolicy --- # Remove-CsTeamsUpdateManagementPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVdiPolicy.md similarity index 93% rename from teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVdiPolicy.md index 66afd2e7e6..79dd7426cf 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVdiPolicy.md @@ -1,108 +1,109 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvdipolicy -title: Remove-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsVdiPolicy - -## SYNOPSIS -This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. - -## SYNTAX - -```powershell -Remove-CsTeamsVdiPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Deletes a previously created TeamsVdiPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should assign a different policy to them before. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsMeetingPolicy -Identity RestrictedUserPolicy -``` - -In the example shown above, the command will delete the restricted user policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the teams Vdi policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity RestrictedUserPolicy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvdipolicy +schema: 2.0.0 +title: Remove-CsTeamsVdiPolicy +--- + +# Remove-CsTeamsVdiPolicy + +## SYNOPSIS +This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsVdiPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a previously created TeamsVdiPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should assign a different policy to them before. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsMeetingPolicy -Identity RestrictedUserPolicy +``` + +In the example shown above, the command will delete the restricted user policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the teams Vdi policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity RestrictedUserPolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVirtualAppointmentsPolicy.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVirtualAppointmentsPolicy.md index a1a3852ec4..0d24c97b0a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy -title: Remove-CsTeamsVirtualAppointmentsPolicy -schema: 2.0.0 ms.author: erocha -author: emmanuelrocha001 -manager: sonaggarwal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy +schema: 2.0.0 +title: Remove-CsTeamsVirtualAppointmentsPolicy --- # Remove-CsTeamsVirtualAppointmentsPolicy @@ -109,10 +110,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy) -[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVoiceApplicationsPolicy.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVoiceApplicationsPolicy.md index 8458e8f402..5d603635c2 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy -title: Remove-CsTeamsVoiceApplicationsPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy schema: 2.0.0 +title: Remove-CsTeamsVoiceApplicationsPolicy --- # Remove-CsTeamsVoiceApplicationsPolicy @@ -37,6 +38,21 @@ In Example 2, all Teams voice applications policies configured at the per-user s ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier assigned to the policy when it was created. @@ -68,21 +84,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -97,10 +98,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy) -[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy) -[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLoadPolicy.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLoadPolicy.md index c32aafbb08..375513c4fa 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLoadPolicy.md @@ -1,125 +1,126 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy -title: Remove-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet deletes a Teams Workload Policy instance. - -## SYNTAX - -```powershell -Remove-CsTeamsWorkLoadPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Remove-CsTeamsWorkLoadPolicy -Identity "Test" -``` - -Deletes a Teams Workload policy instance with the identity of "Test". - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Identity of the Teams Workload Policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Microsoft Internal Use Only - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworkloadpolicy +schema: 2.0.0 +title: Remove-CsTeamsWorkLoadPolicy +--- + +# Remove-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet deletes a Teams Workload Policy instance. + +## SYNTAX + +```powershell +Remove-CsTeamsWorkLoadPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsWorkLoadPolicy -Identity "Test" +``` + +Deletes a Teams Workload policy instance with the identity of "Test". + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft Internal Use Only + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLocationDetectionPolicy.md similarity index 85% rename from teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLocationDetectionPolicy.md index fd2938fd43..bf82c7158c 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy -title: Remove-CsTeamsWorkLocationDetectionPolicy -schema: 2.0.0 ms.author: arkozlov -manager: prashibadkur -author: artemiykozlov +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy +schema: 2.0.0 +title: Remove-CsTeamsWorkLocationDetectionPolicy --- # Remove-CsTeamsWorkLocationDetectionPolicy @@ -112,10 +113,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy) -[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy) -[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy) -[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantDialPlan.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantDialPlan.md index 41c2e91c20..ca0759ae95 100644 --- a/teams/teams-ps/teams/Remove-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan applicable: Microsoft Teams -title: Remove-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantdialplan +schema: 2.0.0 +title: Remove-CsTenantDialPlan --- # Remove-CsTenantDialPlan @@ -32,7 +33,7 @@ If no tenant dial plan is assigned to an organization, the Global dial plan is u ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsTenantDialPlan -Identity Vt1TenantDialPlan2 ``` @@ -41,46 +42,52 @@ This example removes the Vt1TenantDialPlan2. ## PARAMETERS -### -Identity -The Identity parameter is the unique identifier of the tenant dial plan to remove. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm parameter prompts you for confirmation before the command is executed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm parameter prompts you for confirmation before the command is executed. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter is the unique identifier of the tenant dial plan to remove. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -102,10 +109,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cstenantdialplan) -[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan) -[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan) -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkRegion.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkRegion.md index 5e4b94b289..b3acfe35fc 100644 --- a/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion applicable: Microsoft Teams -title: Remove-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworkregion +schema: 2.0.0 +title: Remove-CsTenantNetworkRegion --- # Remove-CsTenantNetworkRegion @@ -36,33 +37,33 @@ The command shown in Example 1 removes 'RedmondRegion'. ## PARAMETERS -### -Identity -Unique identifier for the network region to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network region to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -94,8 +95,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworkregion) -[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworkregion) -[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSite.md similarity index 88% rename from teams/teams-ps/teams/Remove-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSite.md index a21acb85be..ceb55656bb 100644 --- a/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite applicable: Microsoft Teams -title: Remove-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksite +schema: 2.0.0 +title: Remove-CsTenantNetworkSite --- # Remove-CsTenantNetworkSite @@ -37,33 +38,33 @@ The command shown in Example 1 removes 'site1'. ## PARAMETERS -### -Identity -Unique identifier for the network site to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network site to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -95,8 +96,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksite) -[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) -[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSubnet.md similarity index 89% rename from teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSubnet.md index 2e8c9def13..61c2284540 100644 --- a/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet applicable: Microsoft Teams -title: Remove-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksubnet +schema: 2.0.0 +title: Remove-CsTenantNetworkSubnet --- # Remove-CsTenantNetworkSubnet @@ -37,33 +38,33 @@ The command shown in Example 1 removes '192.168.0.1'. ## PARAMETERS -### -Identity -Unique identifier for the network subnet to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network subnet to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -93,8 +94,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksubnet) -[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksubnet) -[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet) +[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksubnet) diff --git a/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantTrustedIPAddress.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantTrustedIPAddress.md index 36eb4e2803..b3aef26e1f 100644 --- a/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantTrustedIPAddress.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenanttrustedipaddress applicable: Microsoft Teams -title: Remove-CsTenantTrustedIPAddress -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenanttrustedipaddress +schema: 2.0.0 +title: Remove-CsTenantTrustedIPAddress --- # Remove-CsTenantTrustedIPAddress diff --git a/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md b/teams/teams-ps/MicrosoftTeams/Remove-CsUserCallingDelegate.md similarity index 70% rename from teams/teams-ps/teams/Remove-CsUserCallingDelegate.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsUserCallingDelegate.md index 56d6d9bce2..41b799defd 100644 --- a/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsUserCallingDelegate.md @@ -1,91 +1,106 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate -applicable: Microsoft Teams -title: Remove-CsUserCallingDelegate -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Remove-CsUserCallingDelegate - -## SYNOPSIS -This cmdlet will remove a delegate for calling in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -```powershell -Remove-CsUserCallingDelegate -Identity -Delegate [] -``` - -## DESCRIPTION -This cmdlet will remove a delegate for the specified user. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -``` -This example shows removing the delegate user2@contoso.com. - -## PARAMETERS - -### -Delegate -The Identity of the delegate to remove. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to remove a delegate for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, -and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -The specified user need to have the Microsoft Phone System license assigned. - -You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. - -## RELATED LINKS -[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csusercallingdelegate +schema: 2.0.0 +title: Remove-CsUserCallingDelegate +--- + +# Remove-CsUserCallingDelegate + +## SYNOPSIS +This cmdlet will remove a delegate for calling in Microsoft Teams. + +## SYNTAX + +``` +Remove-CsUserCallingDelegate -Identity -Delegate [-HttpPipelinePrepend ] + [] +``` + +## DESCRIPTION +This cmdlet will remove a delegate for the specified user. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com +``` +This example shows removing the delegate user2@contoso.com. + +## PARAMETERS + +### -Delegate +The Identity of the delegate to remove. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to remove a delegate for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +The specified user need to have the Microsoft Phone System license assigned. + +You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. + +## RELATED LINKS +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csusercallingdelegate) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md b/teams/teams-ps/MicrosoftTeams/Remove-CsUserLicenseGracePeriod.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsUserLicenseGracePeriod.md index 8ba1f83cc3..6ea72c3041 100644 --- a/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsUserLicenseGracePeriod.md @@ -1,13 +1,14 @@ --- +author: serdarsoysal +description: This cmdlet expedites the delicensing operation for an account's assigned plans by removing the grace period, permanently deleting the assigned plans. external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars +ms.date: 02/01/2024 online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserlicensegraceperiod -title: Remove-CsUserLicenseGracePeriod -description: This cmdlet expedites the delicensing operation for an account's assigned plans by removing the grace period, permanently deleting the assigned plans. schema: 2.0.0 -ms.date: 02/01/2024 -author: serdarsoysal -ms.author: serdars +title: Remove-CsUserLicenseGracePeriod --- # Remove-CsUserLicenseGracePeriod @@ -63,19 +64,35 @@ In Example 2, the capability specified refers to plans assigned to the user(s) u ## PARAMETERS -### -Identity +### -Action -Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan. +Used to specify which action should be taken. ```yaml Type: String Parameter Sets: (All) Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body + +Specifies the body of the request. + +```yaml +Type: IUserDelicensingAccelerationPatch +Parameter Sets: (All) +Aliases: + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName,ByValue) +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -111,19 +128,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Identity -Returns the results of the command. By default, this cmdlet does not generate any output. +Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName,ByValue) Accept wildcard characters: False ``` @@ -143,12 +160,12 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Action +### -PassThru -Used to specify which action should be taken. +Returns the results of the command. By default, this cmdlet does not generate any output. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -159,22 +176,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Body - -Specifies the body of the request. - -```yaml -Type: IUserDelicensingAccelerationPatch -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -189,4 +190,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineuser) diff --git a/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/Remove-CsVideoInteropServiceProvider.md similarity index 79% rename from teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsVideoInteropServiceProvider.md index 9344dcff1d..87c04e1285 100644 --- a/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsVideoInteropServiceProvider.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csvideointeropserviceprovider applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Remove-CsVideoInteropServiceProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csvideointeropserviceprovider +schema: 2.0.0 +title: Remove-CsVideoInteropServiceProvider --- # Remove-CsVideoInteropServiceProvider ## SYNOPSIS -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. +Use the Remove-CsVideoInteropServiceProvider to remove all provider information about a provider that your organization no longer uses. ## SYNTAX @@ -30,7 +31,7 @@ Remove-CsVideoInteropServiceProvider [[-Identity] ] ## DESCRIPTION Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. -Use the Remove-CsVideoInteropServiceProvider to remove all provider information about a provider that your organization no longer uses. The only input is Identity - the provider you wish to remove. +The only input is Identity - the provider you wish to remove. ## EXAMPLES diff --git a/teams/teams-ps/teams/Remove-SharedWithTeam.md b/teams/teams-ps/MicrosoftTeams/Remove-SharedWithTeam.md similarity index 88% rename from teams/teams-ps/teams/Remove-SharedWithTeam.md rename to teams/teams-ps/MicrosoftTeams/Remove-SharedWithTeam.md index e143bc6c3c..8ff065c637 100644 --- a/teams/teams-ps/teams/Remove-SharedWithTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-SharedWithTeam.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-sharedwithteam -title: Remove-SharedWithTeam -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-sharedwithteam +schema: 2.0.0 +title: Remove-SharedWithTeam --- # Remove-SharedWithTeam @@ -34,8 +35,8 @@ Unshares a channel with a team. ## PARAMETERS -### -HostTeamId -Team ID of the host team (Group ID). +### -ChannelId +Thread ID of the shared channel. ```yaml Type: String @@ -49,8 +50,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ChannelId -Thread ID of the shared channel. +### -HostTeamId +Team ID of the host team (Group ID). ```yaml Type: String @@ -84,11 +85,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### HostTeamId, ChannelId, SharedWithTeamId +### HostTeamId + +### ChannelId + +### SharedWithTeamId ## OUTPUTS ## NOTES ## RELATED LINKS -[Remove-Team](https://learn.microsoft.com/powershell/module/teams/remove-team) +[Remove-Team](https://learn.microsoft.com/powershell/module/microsoftteams/remove-team) diff --git a/teams/teams-ps/teams/Remove-Team.md b/teams/teams-ps/MicrosoftTeams/Remove-Team.md similarity index 87% rename from teams/teams-ps/teams/Remove-Team.md rename to teams/teams-ps/MicrosoftTeams/Remove-Team.md index b379c99308..9cd5325395 100644 --- a/teams/teams-ps/teams/Remove-Team.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-Team.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-team -title: Remove-Team -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-team +schema: 2.0.0 +title: Remove-Team --- # Remove-Team @@ -62,4 +62,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) +[New-Team](https://learn.microsoft.com/powershell/module/microsoftteams/new-team) diff --git a/teams/teams-ps/teams/Remove-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannel.md similarity index 94% rename from teams/teams-ps/teams/Remove-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamChannel.md index 9ab0da2703..6c1315d525 100644 --- a/teams/teams-ps/teams/Remove-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannel.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-teamchannel -title: Remove-TeamChannel -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-teamchannel +schema: 2.0.0 +title: Remove-TeamChannel --- # Remove-TeamChannel @@ -14,11 +14,6 @@ ms.reviewer: ## SYNOPSIS Delete a channel. -This will not delete content in associated tabs. - -Note: The channel will be "soft deleted", meaning the contents are not permanently deleted for a time. -So a subsequent call to Add-TeamChannel using the same channel name will fail if enough time has not passed. - ## SYNTAX ``` @@ -26,6 +21,10 @@ Remove-TeamChannel -GroupId -DisplayName [] ``` ## DESCRIPTION +This will not delete content in associated tabs. + +Note: The channel will be "soft deleted", meaning the contents are not permanently deleted for a time. +So a subsequent call to Add-TeamChannel using the same channel name will fail if enough time has not passed. > [!IMPORTANT] > Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here `https://www.poshtestgallery.com/packages/MicrosoftTeams`. @@ -39,8 +38,8 @@ Remove-TeamChannel -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "T ## PARAMETERS -### -GroupId -GroupId of the team +### -DisplayName +Channel name to be deleted ```yaml Type: String @@ -54,8 +53,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Channel name to be deleted +### -GroupId +GroupId of the team ```yaml Type: String diff --git a/teams/teams-ps/teams/Remove-TeamChannelUser.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannelUser.md similarity index 79% rename from teams/teams-ps/teams/Remove-TeamChannelUser.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamChannelUser.md index 5593e0c440..11624d3a06 100644 --- a/teams/teams-ps/teams/Remove-TeamChannelUser.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannelUser.md @@ -1,21 +1,16 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-teamchanneluser -title: Remove-TeamChannelUser +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-teamchanneluser schema: 2.0.0 +title: Remove-TeamChannelUser --- # Remove-TeamChannelUser ## SYNOPSIS -> [!Note] -> The command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. - -To turn an existing Owner into a Member, specify role parameter as Owner. - -> [!Note] -> Last owner cannot be removed from the private channel. +Removes a user from a channel in Microsoft Teams. ## SYNTAX @@ -26,20 +21,28 @@ Remove-TeamChannelUser -GroupId -DisplayName -User [- ## DESCRIPTION -> [!Note] -> This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). +> [!NOTE] +> This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](/microsoftteams/teams-powershell-release-notes). + +The command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. + +To turn an existing Owner into a Member, specify role parameter as Owner. + +> [!NOTE] +> Last owner cannot be removed from the private channel. ## EXAMPLES ### Example 1 + ``` Remove-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com ``` ## PARAMETERS -### -GroupId -GroupId of the team +### -DisplayName +Display name of the private channel ```yaml Type: String @@ -53,8 +56,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Display name of the private channel +### -GroupId +GroupId of the team ```yaml Type: String @@ -68,31 +71,31 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -User -User's email address (e.g. -johndoe@example.com) +### -Role +Use this to demote a user from owner to member of the team ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Role -Use this to demote a user from owner to member of the team +### -User +User's email address (e.g. +johndoe@example.com) ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) diff --git a/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamTargetingHierarchy.md similarity index 91% rename from teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamTargetingHierarchy.md index 01e2e675e0..b0e482b4ce 100644 --- a/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamTargetingHierarchy.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams -title: Remove-TeamTargetingHierarchy -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/connect-microsoftteams +schema: 2.0.0 +title: Remove-TeamTargetingHierarchy --- # Remove-TeamTargetingHierarchy @@ -61,4 +61,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy) +[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/microsoftteams/set-teamtargetinghierarchy) diff --git a/teams/teams-ps/teams/Remove-TeamUser.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamUser.md similarity index 95% rename from teams/teams-ps/teams/Remove-TeamUser.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamUser.md index 489e626447..cfdaf883c9 100644 --- a/teams/teams-ps/teams/Remove-TeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamUser.md @@ -1,25 +1,19 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-teamuser -title: Remove-TeamUser -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-teamuser +schema: 2.0.0 +title: Remove-TeamUser --- # Remove-TeamUser ## SYNOPSIS - Remove an owner or member from a team, and from the unified group which backs the team. -Note: The command will return immediately, but the Teams application will not reflect the update immediately. -The Teams application may need to be open for up to an hour before changes are reflected. - -Note: The last owner cannot be removed from the team. - ## SYNTAX ``` @@ -27,6 +21,11 @@ Remove-TeamUser -GroupId -User [-Role ] [ Applicable: Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowRemoveParticipantAppIds +### -Force -A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). +> Applicable: Teams + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -103,46 +106,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +Unique identifier of the application meeting configuration settings to be returned. +Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Set-CsApplicationMeetingConfiguration cmdlet. +However, you can use the following syntax to retrieve the global settings: -Identity global. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Teams -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Teams + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Teams +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Teams +Aliases: wi Required: False Position: Named @@ -169,4 +178,4 @@ The `Set-CsApplicationMeetingConfiguration` cmdlet does not return any objects o ## RELATED LINKS -[Get-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csapplicationmeetingconfiguration) +[Get-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csapplicationmeetingconfiguration) diff --git a/teams/teams-ps/teams/Set-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Set-CsAutoAttendant.md similarity index 91% rename from teams/teams-ps/teams/Set-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Set-CsAutoAttendant.md index f1241561ad..8d94531a40 100644 --- a/teams/teams-ps/teams/Set-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csautoattendant applicable: Microsoft Teams -title: Set-CsAutoAttendant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant +schema: 2.0.0 +title: Set-CsAutoAttendant --- # Set-CsAutoAttendant @@ -26,7 +28,7 @@ The Set-CsAutoAttendant cmdlet lets you modify the properties of an auto attenda ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" @@ -48,7 +50,7 @@ Set-CsAutoAttendant -Instance $autoAttendant This example adds a Christmas holiday to an AA that has an Identity of fa9081d6-b4f3-5c96-baec-0b00077709e5. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" @@ -78,7 +80,7 @@ Set-CsAutoAttendant -Instance $autoAttendant This example modifies the Christmas holiday greeting for the AA that has an Identity of fa9081d6-b4f3-5c96-baec-0b00077709e5. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" $autoAttendant.CallHandlingAssociations @@ -117,6 +119,9 @@ This example modifies an existing AA, removing the Christmas holiday call handli ## PARAMETERS ### -Instance + +> Applicable: Microsoft Teams + The Instance parameter is the object reference to the AA to be modified. You can retrieve an object reference to an existing AA by using the Get-CsAutoAttendant cmdlet and assigning the returned value to a variable. @@ -125,7 +130,6 @@ You can retrieve an object reference to an existing AA by using the Get-CsAutoAt Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -136,11 +140,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -166,12 +171,12 @@ The modified instance of the `Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAtt ## RELATED LINKS -[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/new-csautoattendant) -[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant) -[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus) -[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant) -[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/update-csautoattendant) diff --git a/teams/teams-ps/teams/Set-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/Set-CsCallQueue.md similarity index 95% rename from teams/teams-ps/teams/Set-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/Set-CsCallQueue.md index 8f93fc3973..c937a33d56 100644 --- a/teams/teams-ps/teams/Set-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsCallQueue.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cscallqueue applicable: Microsoft Teams -title: Set-CsCallQueue -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallqueue +schema: 2.0.0 +title: Set-CsCallQueue --- # Set-CsCallQueue @@ -68,46 +69,32 @@ Note that this cmdlet is in the Skype for Business Online PowerShell module and ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -UseDefaultMusicOnHold $true ``` This example updates the Call Queue with identity e7e00636-47da-449c-a36b-1b3d6ee04440 by making it use the default music on hold. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -MusicOnHoldAudioFileId $audioFile.Id ``` -This example updates the Call Queue with new distribution lists and references a new music on hold audio file using the audio file ID from the stored variable $audioFile created with the [Import-CsOnlineAudioFile cmdlet](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +This example updates the Call Queue with new distribution lists and references a new music on hold audio file using the audio file ID from the stored variable $audioFile created with the [Import-CsOnlineAudioFile cmdlet](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) ## PARAMETERS -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -AgentAlertTime -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AgentAlertTime The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. ```yaml Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -117,13 +104,15 @@ Accept wildcard characters: False ``` ### -AllowOptOut + +> Applicable: Microsoft Teams + The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -132,14 +121,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DistributionLists -The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. +### -AuthorizedUsers + +> Applicable: Microsoft Teams + +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -148,14 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MusicOnHoldAudioFileId -The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. +### -CallbackEmailNotificationTarget + +> Applicable: Microsoft Teams + +The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -164,14 +157,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the Call Queue. +### -CallbackOfferAudioFilePromptResourceId + +> Applicable: Microsoft Teams + +The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -180,14 +175,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OboResourceAccountIds -The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. +### -CallbackOfferTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: List +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -196,32 +193,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowAction -The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. +### -CallbackRequestDtmf -PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail +The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: + +- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. +- ToneStar - Corresponds to DTMF tone *. +- TonePound - Corresponds to DTMF tone #. + +This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: Object +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: DisconnectWithBusy +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. +### -CallToAgentRatioThresholdBeforeOfferingCallback + +The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This conditon applies to calls arriving at the call queue. Minimum value of one (1). Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -230,26 +233,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -If the OverflowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. +### -ChannelId -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +> Applicable: Microsoft Teams -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +Id of the channel to connect a call queue to. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -258,66 +251,79 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowThreshold -The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. +### -ChannelUserObjectId + +> Applicable: Microsoft Teams + +The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team that the channel belongs to. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: 50 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RoutingMethod -The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called. +### -ComplianceRecordingForCallQueueTemplateId +_Voice applications private preview customers only._ -PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. ```yaml -Type: Object +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Attendant +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutAction -The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. +### -ConferenceMode -PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail +> Applicable: Microsoft Teams + +The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: + +- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. + +- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionTarget -The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. +### -CustomAudioFileAnnouncementForCR + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -326,26 +332,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ +### -CustomAudioFileAnnouncementForCRFailure -If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. +> Applicable: Microsoft Teams -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +_Voice applications private preview customers only._ -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -354,143 +354,124 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutThreshold -The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. -The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. +### -DistributionLists + +> Applicable: Microsoft Teams + +The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. ```yaml -Type: Int16 +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: 1200 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentApplyTo -The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. +### -EnableNoAgentSharedVoicemailSystemPromptSuppression -PARAMVALUE: AllCalls | NewCalls +> Applicable: Microsoft Teams + +The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentAction -The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. +### -EnableNoAgentSharedVoicemailTranscription -PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail +> Applicable: Microsoft Teams + +The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentActionTarget -The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this field is optional. +### -EnableOverflowSharedVoicemailSystemPromptSuppression + +> Applicable: Microsoft Teams + +The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. +### -EnableOverflowSharedVoicemailTranscription -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +> Applicable: Microsoft Teams -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: Int16 +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDefaultMusicOnHold -The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. +### -EnableTimeoutSharedVoicemailSystemPromptSuppression + +> Applicable: Microsoft Teams + +The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeMusicAudioFileId -The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. +### -EnableTimeoutSharedVoicemailTranscription + +> Applicable: Microsoft Teams + +The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PresenceBasedRouting -The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -499,34 +480,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConferenceMode -The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: +### -HideAuthorizedUsers -- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. +> Applicable: Microsoft Teams -- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml -Type: Boolean +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Users -The User parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). +### -Identity + +> Applicable: Microsoft Teams + +PARAMVALUE: Guid ```yaml -Type: List +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -535,14 +518,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for Microsoft internal use only. +### -IsCallbackEnabled + +The IsCallbackEnabled parameter is used to turn on/off callback. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -552,6 +535,9 @@ Accept wildcard characters: False ``` ### -LanguageId + +> Applicable: Microsoft Teams + The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter If either OverflowAction or TimeoutAction is set to SharedVoicemail. You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. @@ -560,7 +546,6 @@ You can query the supported languages using the Get-CsAutoAttendantSupportedLang Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -570,13 +555,15 @@ Accept wildcard characters: False ``` ### -LineUri + +> Applicable: Microsoft Teams + This parameter is reserved for Microsoft internal use only. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -585,14 +572,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectAudioFilePrompt -The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. +### -MusicOnHoldAudioFileId + +> Applicable: Microsoft Teams + +The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -601,14 +590,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectTextToSpeechPrompt -The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. +### -Name + +> Applicable: Microsoft Teams + +The Name parameter specifies a unique name for the Call Queue. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -617,34 +608,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentAction -The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. +> Applicable: Microsoft Teams + +The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. + +PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentActionCallPriority -The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -653,14 +658,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppAudioFilePrompt -The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentActionTarget + +> Applicable: Microsoft Teams + +The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this field is optional. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -669,30 +676,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppTextToSpeechPrompt -The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentApplyTo + +> Applicable: Microsoft Teams + +The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. + +PARAMVALUE: AllCalls | NewCalls ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberAudioFilePrompt -The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -NoAgentDisconnectAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -701,14 +714,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberTextToSpeechPrompt -The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -NoAgentDisconnectTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -717,16 +732,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailAudioFilePrompt +### -NoAgentRedirectPersonAudioFilePrompt + +> Applicable: Microsoft Teams + _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. +The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -735,16 +752,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailTextToSpeechPrompt +### -NoAgentRedirectPersonTextToSpeechPrompt + +> Applicable: Microsoft Teams + _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. +The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -753,14 +772,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailTextToSpeechPrompt -The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. +### -NoAgentRedirectPhoneNumberAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -769,14 +790,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailAudioFilePrompt -The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. +### -NoAgentRedirectPhoneNumberTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -785,46 +808,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailTranscription -The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -NoAgentRedirectVoiceAppAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailSystemPromptSuppression -The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -NoAgentRedirectVoiceAppTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectAudioFilePrompt -The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. +### -NoAgentRedirectVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -833,14 +864,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectTextToSpeechPrompt -The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. +### -NoAgentRedirectVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -849,14 +884,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonAudioFilePrompt -The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. +### -NoAgentSharedVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + +The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -865,16 +902,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentSharedVoicemailTextToSpeechPrompt -The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. +> Applicable: Microsoft Teams + +The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -883,16 +920,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NumberOfCallsInQueueBeforeOfferingCallback -The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. +The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -901,14 +938,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppTextToSpeechPrompt -The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. +### -OboResourceAccountIds + +> Applicable: Microsoft Teams + +The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -917,30 +956,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberAudioFilePrompt -The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowAction + +> Applicable: Microsoft Teams + +The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. + +PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: DisconnectWithBusy Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberTextToSpeechPrompt -The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowActionCallPriority + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the OverflowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -949,16 +1006,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowActionTarget -The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. +> Applicable: Microsoft Teams + +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -967,16 +1024,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowDisconnectAudioFilePrompt -The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. +> Applicable: Microsoft Teams + +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -985,14 +1042,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailTextToSpeechPrompt -The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. +### -OverflowDisconnectTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1001,14 +1060,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailAudioFilePrompt -The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. +### -OverflowRedirectPersonAudioFilePrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1017,46 +1080,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailTranscription -The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. +### -OverflowRedirectPersonTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailSystemPromptSuppression -The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -OverflowRedirectPhoneNumberAudioFilePrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectTextToSpeechPrompt -The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. +### -OverflowRedirectPhoneNumberTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1065,14 +1136,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectAudioFilePrompt -The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. +### -OverflowRedirectVoiceAppAudioFilePrompt + +> Applicable: Microsoft Teams + +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1081,16 +1154,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -OverflowRedirectVoiceAppTextToSpeechPrompt -The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. +> Applicable: Microsoft Teams + +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1099,16 +1172,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonAudioFilePrompt +### -OverflowRedirectVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1117,14 +1192,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppTextToSpeechPrompt -The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. +### -OverflowRedirectVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1133,14 +1212,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppAudioFilePrompt -The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. +### -OverflowSharedVoicemailAudioFilePrompt + +> Applicable: Microsoft Teams + +The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1149,14 +1230,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberTextToSpeechPrompt -The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -OverflowSharedVoicemailTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1165,32 +1248,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberAudioFilePrompt -The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -OverflowThreshold + +> Applicable: Microsoft Teams + +The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: 50 Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -PresenceBasedRouting -The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. +> Applicable: Microsoft Teams + +The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. ```yaml -Type: String +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingMethod + +> Applicable: Microsoft Teams + +The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called. + +PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Attendant +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceLevelThresholdResponseTimeInSecond + +The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. + +A value of `$null` indicates that a service level percentage will not be calculated for this call queue. + +```yaml +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1199,16 +1322,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailAudioFilePrompt +### -SharedCallQueueHistoryTemplateId +_Voice applications private preview customers only._ + _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. +The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1217,14 +1341,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailTextToSpeechPrompt -The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. +### -ShiftsSchedulingGroupId + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Scheduling Group to connect a call queue to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1233,14 +1363,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailAudioFilePrompt -The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. +### -ShiftsTeamId + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Team containing the Scheduling Group to connect a call queue to. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1249,14 +1385,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailTranscription -The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -ShouldOverwriteCallableChannelProperty + +A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1265,30 +1401,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailSystemPromptSuppression -The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -Tenant + +> Applicable: Microsoft Teams + +This parameter is reserved for Microsoft internal use only. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelId -Id of the channel to connect a call queue to. +### -TextAnnouncementForCR + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1297,14 +1441,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelUserObjectId -The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team that the channel belongs to. +### -TextAnnouncementForCRFailure + +> Applicable: Microsoft Teams + +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1313,38 +1463,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShiftsTeamId -_Voice applications private preview customers only._ +### -TimeoutAction -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -Id of the Team containing the Scheduling Group to connect a call queue to. +The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. + +PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -ShiftsSchedulingGroupId -_Voice applications private preview customers only._ +### -TimeoutActionCallPriority -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -Id of the Scheduling Group to connect a call queue to. +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1353,14 +1513,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthorizedUsers -This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +### -TimeoutActionTarget + +> Applicable: Microsoft Teams + +The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. ```yaml -Type: List +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1369,16 +1531,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HideAuthorizedUsers -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -TimeoutDisconnectAudioFilePrompt -This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +> Applicable: Microsoft Teams + +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. ```yaml -Type: List +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1387,8 +1549,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeTextToSpeechPrompt -This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. +### -TimeoutDisconnectTextToSpeechPrompt + +> Applicable: Microsoft Teams + +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. ```yaml Type: String @@ -1402,12 +1567,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsCallbackEnabled +### -TimeoutRedirectPersonAudioFilePrompt -The IsCallbackEnabled parameter is used to turn on/off callback. +> Applicable: Microsoft Teams + +The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: @@ -1418,15 +1585,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackRequestDtmf +### -TimeoutRedirectPersonTextToSpeechPrompt -The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: +> Applicable: Microsoft Teams -- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. -- ToneStar - Corresponds to DTMF tone *. -- TonePound - Corresponds to DTMF tone #. +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. ```yaml Type: String @@ -1440,14 +1605,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WaitTimeBeforeOfferingCallbackInSecond +### -TimeoutRedirectPhoneNumberAudioFilePrompt -The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: @@ -1458,14 +1623,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberOfCallsInQueueBeforeOfferingCallback +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt -The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: @@ -1476,14 +1641,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallToAgentRatioThresholdBeforeOfferingCallback +### -TimeoutRedirectVoiceAppAudioFilePrompt -The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This conditon applies to calls arriving at the call queue. Minimum value of one (1). Set to null ($null) to disable this condition. +> Applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: @@ -1494,15 +1661,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferAudioFilePromptResourceId +### -TimeoutRedirectVoiceAppTextToSpeechPrompt -The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. +> Applicable: Microsoft Teams + +The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1511,15 +1679,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferTextToSpeechPrompt +### -TimeoutRedirectVoicemailAudioFilePrompt -The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1528,15 +1699,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackEmailNotificationTarget +### -TimeoutRedirectVoicemailTextToSpeechPrompt -The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. +> Applicable: Microsoft Teams + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1545,14 +1719,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceLevelThresholdResponseTimeInSecond +### -TimeoutSharedVoicemailAudioFilePrompt -The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. +> Applicable: Microsoft Teams -A value of `$null` indicates that a service level percentage will not be calculated for this call queue. +The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: @@ -1563,15 +1737,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingForCallQueueTemplateId -_Voice applications private preview customers only._ +### -TimeoutSharedVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. +The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. ```yaml -Type: List +Type: String Parameter Sets: (All) Aliases: @@ -1582,38 +1755,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextAnnouncementForCR -_Voice applications private preview customers only._ +### -TimeoutThreshold -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. +The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. +The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: 1200 Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomAudioFileAnnouncementForCR -_Voice applications private preview customers only._ +### -UseDefaultMusicOnHold -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. +The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1622,18 +1792,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextAnnouncementForCRFailure -_Voice applications private preview customers only._ +### -Users -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. +The User parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1642,18 +1810,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomAudioFileAnnouncementForCRFailure -_Voice applications private preview customers only._ +### -WaitTimeBeforeOfferingCallbackInSecond -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. -The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1662,15 +1828,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharedCallQueueHistoryTemplateId -_Voice applications private preview customers only._ +### -WelcomeMusicAudioFileId -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +> Applicable: Microsoft Teams -The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. +The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: @@ -1681,18 +1846,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShouldOverwriteCallableChannelProperty - -A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. +### -WelcomeTextToSpeechPrompt +This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Set-CsCallingLineIdentity.md similarity index 91% rename from teams/teams-ps/teams/Set-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Set-CsCallingLineIdentity.md index 16e76a4a04..cbb5068444 100644 --- a/teams/teams-ps/teams/Set-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity applicable: Microsoft Teams -title: Set-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cscallinglineidentity +schema: 2.0.0 +title: Set-CsCallingLineIdentity --- # Set-CsCallingLineIdentity @@ -66,6 +67,9 @@ This example modifies the Caller ID policy and allows Teams users to make anonym ## PARAMETERS ### -BlockIncomingPstnCallerID + +> Applicable: Microsoft Teams + The BlockIncomingPstnCallerID switch determines whether to block the incoming Caller ID. The default value is false. The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. If this is set to True and if this policy is assigned to a Teams user, then Caller ID for incoming calls is suppressed/anonymous. @@ -74,7 +78,6 @@ The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN c Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -CallingIDSubstitute + +> Applicable: Microsoft Teams + The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The possible values are Anonymous, LineUri and Resource. @@ -91,7 +97,6 @@ The possible values are Anonymous, LineUri and Resource. Type: CallingIDSubstituteType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -101,13 +106,33 @@ Accept wildcard characters: False ``` ### -CompanyName + +> Applicable: Microsoft Teams + This parameter sets the Calling party name (typically referred to as CNAM) on the outgoing PSTN call. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -117,13 +142,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + The Description parameter briefly describes the Caller ID policy. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -133,6 +160,9 @@ Accept wildcard characters: False ``` ### -EnableUserOverride + +> Applicable: Microsoft Teams + The EnableUserOverride parameter gives Microsoft Teams users the option under Settings and Calls to hide their phone number when making outgoing calls. The CallerID will be Anonymous. If CallingIDSubstitute is set to Anonymous, the EnableUserOverride parameter has no effect, and the caller ID is always set to Anonymous. @@ -143,7 +173,6 @@ EnableUserOverride has precedence over other settings in the policy unless subst Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -153,13 +182,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter identifies the Caller ID policy. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -169,13 +200,15 @@ Accept wildcard characters: False ``` ### -ResourceAccount + +> Applicable: Microsoft Teams + This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -185,6 +218,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -192,23 +228,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -227,10 +246,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/get-cscallinglineidentity) -[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cscallinglineidentity) -[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscallinglineidentity) -[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/Set-CsComplianceRecordingForCallQueueTemplate.md similarity index 86% rename from teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md rename to teams/teams-ps/MicrosoftTeams/Set-CsComplianceRecordingForCallQueueTemplate.md index 2ee33ba19c..6acf6f65cf 100644 --- a/teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsComplianceRecordingForCallQueueTemplate.md @@ -1,17 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsComplianceRecordingForCallQueueTemplate applicable: Microsoft Teams -title: Set-CsComplianceRecordingForCallQueueTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: Set-CsComplianceRecordingForCallQueueTemplate --- # Set-CsComplianceRecordingForCallQueueTemplate +## SYNOPSIS +Use the Set-CsComplianceRecordingForCallQueueTemplate cmdlet to make changes to an existing Compliance Recording for Call Queues template. + ## SYNTAX ```powershell @@ -26,7 +30,7 @@ Use the Set-CsComplianceRecordingForCallQueueTemplate cmdlet to make changes to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $template = CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 $template.BotId = 14732826-8206-42e3-b51e-6693e2abb698 @@ -38,13 +42,15 @@ The Set-CsComplianceRecordingForCallQueueTemplate cmdlet lets you modify the pro ## PARAMETERS ### -Instance + +> Applicable: Microsoft Teams + The Instance parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsExternalAccessPolicy.md similarity index 84% rename from teams/teams-ps/teams/Set-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsExternalAccessPolicy.md index afa75f770a..44a3aaa384 100644 --- a/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsExternalAccessPolicy.md @@ -1,19 +1,18 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy applicable: Microsoft Teams -title: Set-CsExternalAccessPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy +schema: 2.0.0 +title: Set-CsExternalAccessPolicy --- # Set-CsExternalAccessPolicy ## SYNOPSIS Enables you to modify the properties of an existing external access policy. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. - -This cmdlet was introduced in Lync Server 2010. ## SYNTAX @@ -66,6 +65,8 @@ Set-CsExternalAccessPolicy [-Instance ] ``` ## DESCRIPTION +This cmdlet was introduced in Lync Server 2010. + When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with people who have SIP accounts in your Active Directory Domain Services. In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. @@ -77,7 +78,7 @@ External access policies can grant (or revoke) the ability of your users to do a Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). this policy setting only applies if acs federation has been enabled at the tenant level using the [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) cmdlet. +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). this policy setting only applies if acs federation has been enabled at the tenant level using the [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration) cmdlet. 3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. @@ -86,7 +87,7 @@ This enables your users to use Skype for Business and log on to Skype for Busine The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, Instance, PipelineVariable, and Tenant -5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) cmdlet or Teams admin center under the External Access setting. +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration) cmdlet or Teams admin center under the External Access setting. After an external access policy has been created, you can use the `Set-CsExternalAccessPolicy` cmdlet to change the property values of that policy. For example, by default the global policy does not allow users to communicate with people who have accounts with a federated organization. @@ -94,7 +95,7 @@ If you would like to grant this capability to all of your users you can call the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederationAccess $True ``` @@ -102,7 +103,7 @@ Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederati The command shown in Example 1 modifies the per-user external access policy that has the Identity RedmondExternalAccessPolicy. In this example, the command changes the value of the EnableFederationAccess property to True. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsExternalAccessPolicy | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` @@ -111,7 +112,7 @@ In Example 2, federation access is enabled for all the external access policies To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet without any parameters; this returns a collection of all the external policies currently configured for use. That collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which changes the value of the EnableFederationAccess property for each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsExternalAccessPolicy -Filter tag:* | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` @@ -121,7 +122,7 @@ To carry out this task, the first thing the command does is use the `Get-CsExter (The filter value "tag:*" limits returned data to policies that have an Identity that begins with the string value "tag:". Any policy with an Identity that begins with "tag:" has been configured at the per-user scope.) The filtered collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which modifies the EnableFederationAccess property for each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $false New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAccess $true @@ -129,7 +130,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAc In this example, the Global policy is updated to disallow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation enabled and which can be assigned to selected users for which Team-ACS federation will be allowed. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false @@ -137,7 +138,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederatio In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. -### -------------------------- Example 6 ------------------------ +### Example 6 ``` New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWithExternalOrgs "AllowSpecificExternalDomains" -AllowedExternalDomains @("example1.com", "example2.com") Set-CsTenantFederationConfiguration -CustomizeFederation $true @@ -146,46 +147,10 @@ In this example, we create an ExternalAccessPolicy named "GranularFederationExam ## PARAMETERS -### -Identity -Unique identifier for the external access policy to be modified. -External access policies can be configured at the global, site, or per-user scopes. -To modify the global policy, use this syntax: `-Identity global`. -To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. -To modify a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. -If this parameter is not specified then the global policy will be modified. - -Note that wildcards are not allowed when specifying an Identity. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -AllowedExternalDomains -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowedExternalDomains > [!NOTE] > Please note that this parameter is in Private Preview. @@ -194,7 +159,6 @@ Specifies the external domains allowed to communicate with users assigned to thi Type: List Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -204,6 +168,9 @@ Accept wildcard characters: False ``` ### -BlockedExternalDomains + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + > [!NOTE] > Please note that this parameter is in Private Preview. @@ -212,7 +179,6 @@ Specifies the external domains blocked from communicating with users assigned to Type: List Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -222,6 +188,9 @@ Accept wildcard characters: False ``` ### -CommunicationWithExternalOrgs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + > [!NOTE] > Please note that this parameter is in Private Preview. @@ -238,7 +207,6 @@ The setting is only applicable when `EnableFederationAccess` is set to true. Thi Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -248,13 +216,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -264,6 +234,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. @@ -271,7 +244,6 @@ For example, the Description might include information about the users the polic Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -281,6 +253,9 @@ Accept wildcard characters: False ``` ### -EnableAcsFederationAccess + +> Applicable: Microsoft Teams + Indicates whether Teams meeting organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. @@ -293,7 +268,6 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -302,6 +276,9 @@ Accept wildcard characters: False ``` ### -EnableFederationAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization. Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. @@ -310,7 +287,6 @@ The default value is True. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -320,6 +296,9 @@ Accept wildcard characters: False ``` ### -EnableOutsideAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. The default value is False. @@ -327,7 +306,6 @@ The default value is False. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -337,6 +315,9 @@ Accept wildcard characters: False ``` ### -EnablePublicCloudAudioVideoAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. When set to False, audio and video options in Skype for Business will be disabled any time a user is communicating with a public Internet connectivity contact. The default value is False. @@ -345,7 +326,6 @@ The default value is False. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -355,6 +335,9 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + (Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. @@ -366,7 +349,6 @@ The default value is True. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -376,6 +358,9 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerInbound + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + (Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user. To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. @@ -387,7 +372,6 @@ The default value is True. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -413,6 +397,9 @@ Accept wildcard characters: False ``` ### -EnableXmppAccess + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. The default value is False. @@ -420,7 +407,6 @@ The default value is False. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -432,12 +418,12 @@ Accept wildcard characters: False ### -FederatedBilateralChats This setting enables bi-lateral chats for the users included in the messaging policy. -Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. - -Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. - +Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. + +Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. + Users with bilateral policy applied are also removed from existing external group chats with more than two organizations. - + This policy doesn't apply to meetings, meeting chats, or channels. ```yaml @@ -453,13 +439,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -468,6 +456,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the external access policy to be modified. +External access policies can be configured at the global, site, or per-user scopes. +To modify the global policy, use this syntax: `-Identity global`. +To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. +To modify a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. +If this parameter is not specified then the global policy will be modified. + +Note that wildcards are not allowed when specifying an Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -RestrictTeamsConsumerAccessToExternalUserProfiles Defines if a user is restriced to collaboration with Teams Consumer (TFL) user only in Extended Directory Possible Values: True, False @@ -507,13 +538,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -541,10 +574,10 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl ## RELATED LINKS -[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Set-CsInboundBlockedNumberPattern.md similarity index 89% rename from teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Set-CsInboundBlockedNumberPattern.md index 010cb41526..5d6b3e2e5d 100644 --- a/teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern applicable: Microsoft Teams -title: Set-CsInboundBlockedNumberPattern author: serdarsoysal -ms.author: serdars -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundblockednumberpattern schema: 2.0.0 +title: Set-CsInboundBlockedNumberPattern --- # Set-CsInboundBlockedNumberPattern @@ -37,6 +38,21 @@ This example modifies a blocked number pattern to block inbound calls from +1123 ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description A friendly description for the blocked number pattern to be modified. @@ -113,21 +129,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -139,8 +140,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundblockednumberpattern) -[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundblockednumberpattern) -[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Set-CsInboundExemptNumberPattern.md similarity index 87% rename from teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Set-CsInboundExemptNumberPattern.md index 592cc10d0f..59eea50441 100644 --- a/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern applicable: Microsoft Teams -title: Set-CsInboundExemptNumberPattern -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csinboundexemptnumberpattern +schema: 2.0.0 +title: Set-CsInboundExemptNumberPattern --- # Set-CsInboundExemptNumberPattern @@ -48,6 +48,22 @@ Disables the exempt number pattern from usage in call blocking ## PARAMETERS +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Sets the description of the number pattern. @@ -126,22 +142,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -156,12 +156,12 @@ You can use Test-CsInboundBlockedNumberPattern to test your block and exempt pho ## RELATED LINKS -[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/get-csinboundexemptnumberpattern) -[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern) +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/new-csinboundexemptnumberpattern) -[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) -[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineApplicationInstance.md similarity index 84% rename from teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineApplicationInstance.md index 4e64fee3fa..8bd14ac852 100644 --- a/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance applicable: Microsoft Teams -title: Set-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineapplicationinstance +schema: 2.0.0 +title: Set-CsOnlineApplicationInstance --- # Set-CsOnlineApplicationInstance @@ -15,8 +16,6 @@ ms.reviewer: ## SYNOPSIS Updates an application instance in Microsoft Entra ID. -**Note**: The use of this cmdlet for assigning phone numbers in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. - ## SYNTAX ``` @@ -26,9 +25,11 @@ Set-CsOnlineApplicationInstance [-Identity] [[-OnpremPhoneNumber] Applicable: Microsoft Teams + The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -87,29 +71,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcsResourceId -The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Microsoft Teams + The display name. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +108,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -134,31 +125,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity + +> Applicable: Microsoft Teams + +The URI or ID of the application instance to update. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnpremPhoneNumber + +> Applicable: Microsoft Teams + +**Note**: Using this parameter has been deprecated in commercial and GCC cloud instances. Use the new Set-CsPhoneNumberAssignment cmdlet instead. + +Assigns a hybrid (on-premise) telephone number to the application instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -178,10 +193,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) -[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/sync-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineAudioConferencingRoutingPolicy.md similarity index 92% rename from teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineAudioConferencingRoutingPolicy.md index a1b9ec1f59..2cd5a40efd 100644 --- a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,177 +1,178 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineaudioconferencingroutingpolicy -title: Set-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# Set-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. - -## SYNTAX - -```powershell -Set-CsOnlineAudioConferencingRoutingPolicy [-Description ] [[-Identity] ] - [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. - -To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." - -The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. - -Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsOnlineAudioConferencingRoutingPolicy -Identity "Policy 1" -OnlinePstnUsages "US and Canada" -``` - -Sets the Online Audio Conferencing Routing Policy "Policy 1" value of "OnlinePstnUsages" to "US and Canada". - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the Online Audio Conferencing Routing Policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnlinePstnUsages - -A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio conferencing routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteType - -For internal use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) -[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) -[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) -[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Set-CsOnlineAudioConferencingRoutingPolicy +--- + +# Set-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. + +## SYNTAX + +```powershell +Set-CsOnlineAudioConferencingRoutingPolicy [-Description ] [[-Identity] ] + [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsOnlineAudioConferencingRoutingPolicy -Identity "Policy 1" -OnlinePstnUsages "US and Canada" +``` + +Sets the Online Audio Conferencing Routing Policy "Policy 1" value of "OnlinePstnUsages" to "US and Canada". + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnUsages + +A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio conferencing routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType + +For internal use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge.md similarity index 91% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge.md index a0d2c3d32d..68ba0dc9ec 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingbridge applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingBridge -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinedialinconferencingbridge +schema: 2.0.0 +title: Set-CsOnlineDialInConferencingBridge --- # Set-CsOnlineDialInConferencingBridge @@ -43,14 +45,14 @@ The `Set-CsOnlineDialInConferencingBridge` cmdlet can be used to set the default ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingBridge -Name "Conference Bridge" -DefaultServiceNumber 14255551234 ``` This example sets the default dial-in phone number to 14255551234 for the audio conferencing bridge named "Conference Bridge". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $bridge = Get-CsOnlineDialInConferencingBridge -Name "Conference Bridge" @@ -63,46 +65,61 @@ This example changes the name of a conference bridge by creating a conference br ## PARAMETERS -### -Identity -Specifies the globally-unique identifier (GUID) for the audio conferencing bridge to be modified. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to a Microsoft audio conferencing bridge object to the cmdlet rather than set individual parameter values. +### -DefaultServiceNumber + +> Applicable: Microsoft Teams + +Specifies the default phone number to be used on the Microsoft audio conferencing bridge. +The default number is used in meeting invitations. + +The DefaultServiceNumber must be assigned to the audio conferencing bridge. +Also, when the default service number is changed, the service number of existing users will not be changed. ```yaml -Type: ConferencingBridge +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Specifies the name of the audio conferencing bridge to be modified. +### -DomainController + +> Applicable: Microsoft Teams + +Specifies the domain controller that's used by the cmdlet to read or write the specified data. +Valid inputs for this parameter include: + +Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com. + +Computer name: -DomainController atl-cs-001 ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False Position: Named @@ -111,14 +128,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Force + +> Applicable: Microsoft Teams + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -127,57 +148,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultServiceNumber -Specifies the default phone number to be used on the Microsoft audio conferencing bridge. -The default number is used in meeting invitations. +### -Identity -The DefaultServiceNumber must be assigned to the audio conferencing bridge. -Also, when the default service number is changed, the service number of existing users will not be changed. +> Applicable: Microsoft Teams + +Specifies the globally-unique identifier (GUID) for the audio conferencing bridge to be modified. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter include: +### -Instance -Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com. +> Applicable: Microsoft Teams -Computer name: -DomainController atl-cs-001 +Allows you to pass a reference to a Microsoft audio conferencing bridge object to the cmdlet rather than set individual parameter values. ```yaml -Type: Fqdn +Type: ConferencingBridge Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Name + +> Applicable: Microsoft Teams + +Specifies the name of the audio conferencing bridge to be modified. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -187,13 +203,15 @@ Accept wildcard characters: False ``` ### -SetDefault + +> Applicable: Microsoft Teams + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -203,13 +221,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -219,13 +239,15 @@ Accept wildcard characters: False ``` ### -TenantDomain + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -235,6 +257,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -242,7 +267,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber.md similarity index 93% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber.md index a64dcc2c2b..660b0be139 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingservicenumber applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingServiceNumber -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Set-CsOnlineDialInConferencingServiceNumber --- # Set-CsOnlineDialInConferencingServiceNumber @@ -87,7 +89,7 @@ Ukrainian ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingServiceNumber -Identity +14255551234 -PrimaryLanguage de-de -SecondaryLanguages en-us, ja-jp, en-gb ``` @@ -96,47 +98,59 @@ This example sets the primary language to German (Germany) and the secondary lan ## PARAMETERS -### -Identity -Specifies the default dial-in service number string. -The service number can be specified in the following formats: E.164 number, +\ and tel:\. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to the Office 365 audio service number object to the cmdlet rather than set individual parameter values. +### -DomainController + +> Applicable: Microsoft Teams + +Specifies the domain controller that's used by the cmdlet to read or write the specified data. +Valid inputs for this parameter include: + +Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com. + +Computer name: -DomainController atl-cs-001 ```yaml -Type: ConferencingServiceNumber +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Force + +> Applicable: Microsoft Teams + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -145,46 +159,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter include: +### -Identity -Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com. +> Applicable: Microsoft Teams -Computer name: -DomainController atl-cs-001 +Specifies the default dial-in service number string. +The service number can be specified in the following formats: E.164 number, +\ and tel:\. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Instance + +> Applicable: Microsoft Teams + +Allows you to pass a reference to the Office 365 audio service number object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter +Type: ConferencingServiceNumber Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PrimaryLanguage + +> Applicable: Microsoft Teams + Specifies the primary language that is used when users call into a meeting. The culture ID is used. For example, en-US for US English, ja-JP for Japanese, or es-ES for Spanish. @@ -195,7 +210,6 @@ Use the `Get-CsOnlineDialInConferencingLanguagesSupported` cmdlet to get a list Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -205,13 +219,15 @@ Accept wildcard characters: False ``` ### -RestoreDefaultLanguages + +> Applicable: Microsoft Teams + Including this switch restores all of the default languages for the audio conferencing service number. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -221,6 +237,9 @@ Accept wildcard characters: False ``` ### -SecondaryLanguages + +> Applicable: Microsoft Teams + Specifies the secondary languages that can be used when users call into a meeting. The culture ID is used. For example, en-US for US English, ja-JP for Japanese, or es-ES for Spanish. @@ -233,7 +252,6 @@ Use the `Get-CsOnlineDialInConferencingLanguagesSupported` cmdlet to get a list Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -243,13 +261,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -259,6 +279,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -266,7 +289,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings.md similarity index 94% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings.md index 26cf1b24c2..d995355ff2 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingtenantsettings applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingTenantSettings +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinedialinconferencingtenantsettings schema: 2.0.0 +title: Set-CsOnlineDialInConferencingTenantSettings --- # Set-CsOnlineDialInConferencingTenantSettings @@ -41,7 +43,7 @@ The following parameters are not applicable to Teams: EnableDialOutJoinConfirmat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingTenantSettings -EnableEntryExitNotifications $True -EnableNameRecording $True -PinLength 7 ``` @@ -49,7 +51,7 @@ Set-CsOnlineDialInConferencingTenantSettings -EnableEntryExitNotifications $True This example sets the tenant's conferencing settings to enable entry and exit notifications supported by name recording. The PIN length is set to 7. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineDialInConferencingTenantSettings -SendEmailFromOverride $true -SendEmailFromAddress admin@contoso.com -SendEmailFromDisplayName "Conferencing Administrator" ``` @@ -93,7 +95,7 @@ Accept wildcard characters: False ### -AllowFederatedUsersToDialOutToThirdParty -Specifies at this scope if dial out to third party participants is allowed. Possible settings are [No|Yes|RequireSameEnterpriseUser]. +Specifies at this scope if dial out to third party participants is allowed. Possible settings are [No|Yes|RequireSameEnterpriseUser]. This parameter is Microsoft internal use only. ```yaml @@ -109,6 +111,9 @@ Accept wildcard characters: False ``` ### -AllowPSTNOnlyMeetingsByDefault + +> Applicable: Microsoft Teams + Specifies the default value that gets assigned to the "AllowPSTNOnlyMeetings" setting of users when they are enabled for dial-in conferencing, or when a user's dial-in conferencing provider is set to Microsoft. If set to $true, the "AllowPSTNOnlyMeetings" setting of the user will also be set to true. If $false, the user setting will be false. @@ -126,7 +131,6 @@ For more information on the "AllowPSTNOnlyMeetings" user setting, see `Set-CsOnl Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -137,6 +141,8 @@ Accept wildcard characters: False ### -AutomaticallyMigrateUserMeetings +> Applicable: Microsoft Teams + Specifies if meetings of users in the tenant should automatically be rescheduled via the Meeting Migration Service when there's a change in the users' Cloud PSTN Confernecing coordinates, e.g. when a user is provisioned, de-provisoned, assigned a new default service number etc. If this is false, users will need to manually migrate their conferences using the Meeting Migration tool. PARAMVALUE: $true | $false @@ -144,7 +150,6 @@ PARAMVALUE: $true | $false Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -155,6 +160,8 @@ Accept wildcard characters: False ### -AutomaticallyReplaceAcpProvider +> Applicable: Microsoft Teams + Specifies if a user already enabled for a 3rd party Audio Conferencing Provider (ACP) should automatically be converted to Microsoft's Online DialIn Conferencing service when a license for Microsoft's service is assigned to the user. If this is false, tenant admins will need to manually provision the user with the Enable-CsOnlineDialInConferencingUser cmdlet with the -ReplaceProvider switch present. PARAMVALUE: $true | $false @@ -162,7 +169,6 @@ PARAMVALUE: $true | $false Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -172,6 +178,9 @@ Accept wildcard characters: False ``` ### -AutomaticallySendEmailsToUsers + +> Applicable: Microsoft Teams + Specifies whether advisory emails will be sent to users when the events listed below occur. Setting the parameter to $true enables the emails to be sent, $false disables the emails. The default is $true. @@ -188,7 +197,6 @@ Changes to either the user's conference ID, or the user's default dial-in confer Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -198,13 +206,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -231,6 +241,8 @@ Accept wildcard characters: False ### -EnableEntryExitNotifications +> Applicable: Microsoft Teams + Specifies if, by default, announcements are made as users enter and exit a conference call. Set to $true to enable notifications, $false to disable notifications. The default is $true. @@ -241,7 +253,6 @@ This setting can be overridden on a meeting by meeting basis when a user joins a Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -252,6 +263,8 @@ Accept wildcard characters: False ### -EnableNameRecording +> Applicable: Microsoft Teams + Specifies whether the name of a user is recorded on entry to the conference. This recording is used during entry and exit notifications. Set to $true to enable name recording, set to $false to bypass name recording. @@ -261,7 +274,6 @@ The default is $true. Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -272,6 +284,8 @@ Accept wildcard characters: False ### -EntryExitAnnouncementsType +> Applicable: Microsoft Teams + Specifies if the Entry and Exit Announcement Uses names or tones only. PARAMVALUE: UseNames | ToneOnly @@ -279,7 +293,6 @@ PARAMVALUE: UseNames | ToneOnly Type: EntryExitAnnouncementsType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -289,6 +302,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -297,7 +313,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -307,13 +322,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -323,13 +340,15 @@ Accept wildcard characters: False ``` ### -IncludeTollFreeNumberInMeetingInvites + +> Applicable: Microsoft Teams + This parameter is obsolete and not functional. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -339,13 +358,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Microsoft Teams + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -354,8 +375,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MaskPstnNumbersType +This parameter allows tenant administrators to configure masking of PSTN participant phone numbers in the roster view for Microsoft Teams meetings enabled for Audio Conferencing, scheduled within the organization. + +Possible values are: +- MaskedForExternalUsers (masked to external users) +- MaskedForAllUsers (masked for everyone) +- NoMasking (visible to everyone) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: MaskedForExternalUsers +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MigrateServiceNumbersOnCrossForestMove +> Applicable: Microsoft Teams + Specifies whether service numbers assigned to the tenant should be migrated to the new forest of the tenant when the tenant is migrated cross region. If false, service numbers will be released back to stock once the migration completes. This settings does not apply to ported-in numbers that are always migrated. PARAMVALUE: $true | $false @@ -363,7 +406,6 @@ PARAMVALUE: $true | $false Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -389,6 +431,9 @@ Accept wildcard characters: False ``` ### -PinLength + +> Applicable: Microsoft Teams + Specifies the number of digits in the automatically generated PINs. Organizers can enter their PIN to start a meeting they scheduled if they join via phone and are the first person to join. The minimum value is 4, the maximum is 12, and the default is 5. @@ -400,7 +445,6 @@ The PIN of a user that did not schedule the meeting will not enable that user to Type: UInt32 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -410,6 +454,9 @@ Accept wildcard characters: False ``` ### -SendEmailFromAddress + +> Applicable: Microsoft Teams + Specifies the email address to use in the "From" contact information on emails that are sent to users to notify them of their dial-in conferencing settings, or when their settings change. The email address needs to be in the form \@\. For example, "KenMyer@Contoso.com" or "Admin@Contoso.com". @@ -422,7 +469,6 @@ Note: The parameter has been deprecated and may be removed in future versions. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -432,6 +478,9 @@ Accept wildcard characters: False ``` ### -SendEmailFromDisplayName + +> Applicable: Microsoft Teams + Specifies the display name to use in the "From" contact information on emails that are sent to users to notify them of their dial-in conferencing settings, or when their settings change. The SendEmailFromDisplayName value is used only if the SendEmailFromDisplayName setting is specified, and the SendEmailFromOverride setting is $true. @@ -442,7 +491,6 @@ Note: The parameter has been deprecated and may be removed in future versions. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -452,6 +500,9 @@ Accept wildcard characters: False ``` ### -SendEmailFromOverride + +> Applicable: Microsoft Teams + Specifies if the contact information on dial-in conferencing notifications will be the default generated by Office 365, or administrator defined values. Setting SendEmailFromOverride to $true enables the system to use the SendEmailFromAddress and SendEmailFromDisplayName parameter inputs as the "From" contact information. Setting this parameter to $false will cause email notifications to be sent with the system generated default. @@ -467,7 +518,6 @@ Note: The parameter has been deprecated and may be removed in future versions. Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -477,13 +527,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -494,6 +546,8 @@ Accept wildcard characters: False ### -UseUniqueConferenceIds +> Applicable: Microsoft Teams + Specifies if Private Meetings are enabled for the users in this tenant. PARAMVALUE: $true | $false @@ -501,7 +555,6 @@ PARAMVALUE: $true | $false Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -510,27 +563,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaskPstnNumbersType -This parameter allows tenant administrators to configure masking of PSTN participant phone numbers in the roster view for Microsoft Teams meetings enabled for Audio Conferencing, scheduled within the organization. - -Possible values are: -- MaskedForExternalUsers (masked to external users) -- MaskedForAllUsers (masked for everyone) -- NoMasking (visible to everyone) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +### -WhatIf -Required: False -Position: Named -Default value: MaskedForExternalUsers -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -WhatIf The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -538,7 +574,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named @@ -557,6 +592,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings) +[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantsettings) -[Remove-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/remove-csonlinedialinconferencingtenantsettings) +[Remove-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinedialinconferencingtenantsettings) diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingUser.md similarity index 89% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingUser.md index a0768687dc..0ba11ffd6a 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingUser.md @@ -1,18 +1,17 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencinguser applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingUser +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinedialinconferencinguser schema: 2.0.0 +title: Set-CsOnlineDialInConferencingUser --- # Set-CsOnlineDialInConferencingUser ## SYNOPSIS -> [!NOTE] -> The AllowPSTNOnlyMeetings, ResetConferenceId, and ConferenceId parameters will be deprecated on Jan 31, 2022. To allow Teams meeting participants joining via the PSTN to bypass the lobby, use the AllowPSTNUsersToBypassLobby of the [Set-CsTeamsMeetingPolicy cmdlet](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingpolicy). The capabilities associated with the ResetConferenceId and ConferenceId parameters are no longer supported. - Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of a user that has been enabled for Microsoft's audio conferencing service. ## SYNTAX @@ -40,16 +39,19 @@ The `Set-CsOnlineDialInConferencingUser` cmdlet is used to modify properties for This cmdlet will not work for users with third-party conferencing providers. The cmdlet will verify that the correct license is assigned to the user. +> [!NOTE] +> The AllowPSTNOnlyMeetings, ResetConferenceId, and ConferenceId parameters will be deprecated on Jan 31, 2022. To allow Teams meeting participants joining via the PSTN to bypass the lobby, use the AllowPSTNUsersToBypassLobby of the [Set-CsTeamsMeetingPolicy cmdlet](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingpolicy). The capabilities associated with the ResetConferenceId and ConferenceId parameters are no longer supported. + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -ResetLeaderPin -ServiceNumber 14255037265 ``` This example shows how to reset the meeting leader's PIN and set the audio conferencing provider default meeting phone number. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conference Bridge" ``` @@ -58,34 +60,37 @@ This example sets a user's conference bridge assignment. ## PARAMETERS -### -Identity -Specifies the Identity of the user account to be to be modified. -A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. +### -AllowPSTNOnlyMeetings + +> Applicable: Microsoft Teams + +If true, non-authenticated users can start meetings. +If false, non-authenticated callers wait in the lobby until an authenticated user joins, thereby starting the meeting. +An authenticated user is a user who joins the meeting using a Skype for Business client, or the organizer that joined the meeting via dial-in conferencing and was authenticated by a PIN number. +The default is false. ```yaml -Type: UserIdParameter +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantDomain -Specifies the domain name for the tenant or organization. +### -AllowTollFreeDialIn -This parameter is reserved for internal Microsoft use. +> Applicable: Microsoft Teams + +If toll-free numbers are available in your Microsoft Audio Conferencing bridge, this parameter controls if they can be used to join the meetings of a given user. This setting can ONLY be managed using the TeamsAudioConferencingPolicy. By default, AllowTollFreeDialin is always set to True. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -94,17 +99,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPSTNOnlyMeetings -If true, non-authenticated users can start meetings. -If false, non-authenticated callers wait in the lobby until an authenticated user joins, thereby starting the meeting. -An authenticated user is a user who joins the meeting using a Skype for Business client, or the organizer that joined the meeting via dial-in conferencing and was authenticated by a PIN number. -The default is false. - +### -AsJob +The parameter is used to run commands as background jobs. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -114,13 +114,15 @@ Accept wildcard characters: False ``` ### -BridgeId + +> Applicable: Microsoft Teams + Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -130,13 +132,15 @@ Accept wildcard characters: False ``` ### -BridgeName + +> Applicable: Microsoft Teams + Specifies the name of the audio conferencing bridge. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -146,13 +150,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -162,6 +168,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter include: @@ -175,7 +184,6 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -185,6 +193,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -193,7 +204,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -202,14 +212,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +Specifies the Identity of the user account to be to be modified. +A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). +You can also reference a user account by using the user's Active Directory distinguished name. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResetLeaderPin + +> Applicable: Microsoft Teams + Specifies whether to reset the meeting organizer or leaders PIN for meetings. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -219,13 +251,15 @@ Accept wildcard characters: False ``` ### -SendEmail + +> Applicable: Microsoft Teams + Send an email to the user containing their Audio Conference information. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -235,13 +269,15 @@ Accept wildcard characters: False ``` ### -SendEmailFromAddress + +> Applicable: Microsoft Teams + You can specify the From Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmailFromDisplayName and -SendEmail. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -251,13 +287,15 @@ Accept wildcard characters: False ``` ### -SendEmailFromDisplayName + +> Applicable: Microsoft Teams + You can specify the Display Name to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmailFromAddress and -SendEmail. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -267,13 +305,15 @@ Accept wildcard characters: False ``` ### -SendEmailToAddress + +> Applicable: Microsoft Teams + You can specify the To Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmail. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -283,6 +323,9 @@ Accept wildcard characters: False ``` ### -ServiceNumber + +> Applicable: Microsoft Teams + Specifies the default service number for the user. The default number is used in meeting invitations. The cmdlet will verify that the service number is assigned to the user's current conference bridge, or the one the user is being assigned to. @@ -293,7 +336,6 @@ The service number can be specified in the following formats: E.164 number, +\ Applicable: Microsoft Teams + Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` @@ -313,7 +358,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -322,14 +366,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TollFreeServiceNumber -Specifies a toll-free phone number to be used by the user. This number is then used in meeting invitations. The toll-free number can be specified in the following formats: E.164 number, +\ and tel:\. +### -TenantDomain + +> Applicable: Microsoft Teams + +Specifies the domain name for the tenant or organization. + +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -338,30 +386,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf parameter is not implemented for this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +### -TollFreeServiceNumber -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AllowTollFreeDialIn -If toll-free numbers are available in your Microsoft Audio Conferencing bridge, this parameter controls if they can be used to join the meetings of a given user. This setting can ONLY be managed using the TeamsAudioConferencingPolicy. By default, AllowTollFreeDialin is always set to True. +Specifies a toll-free phone number to be used by the user. This number is then used in meeting invitations. The toll-free number can be specified in the following formats: E.164 number, +\ and tel:\. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -370,12 +404,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -The parameter is used to run commands as background jobs. +### -WhatIf + +> Applicable: Microsoft Teams + +The WhatIf parameter is not implemented for this cmdlet. + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -395,6 +433,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy) -[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md similarity index 92% rename from teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md index 289ee4575e..9816a0ca9f 100644 --- a/teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md @@ -1,18 +1,30 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineenhancedemergencyservicedisclaimer applicable: Microsoft Teams -title: Set-CsOnlineEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Set-CsOnlineEnhancedEmergencyServiceDisclaimer --- # Set-CsOnlineEnhancedEmergencyServiceDisclaimer ## SYNOPSIS +You can use Get-CsOnlineEnhancedEmergencyServiceDisclaimer to see the status of the emergency service disclaimer. + +## SYNTAX + +``` +Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion [-Version ] [-ForceAccept] + [-Tenant ] [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION When using Microsoft Teams PSTN Calling Services you need to record your organization's acceptance of the enhanced emergency service terms and conditions. This is done per country/region and it needs to be done before you can provide PSTN calling services to Microsoft Teams users in the country/region. @@ -22,23 +34,15 @@ when you create an emergency address in a country/region. Any tenant administrator can accept the terms and conditions and it only needs to be done once per country/region. -As the output the cmdlet will show the emergency service disclaimer and that it has been accepted. You can use Get-CsOnlineEnhancedEmergencyServiceDisclaimer to see the status of the emergency service disclaimer. - -## SYNTAX +As the output the cmdlet will show the emergency service disclaimer and that it has been accepted. -``` -Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion [-Version ] [-ForceAccept] - [-Tenant ] [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION You must run this cmdlet prior to assigning Microsoft Calling Plan phone numbers and locations to voice enabled users or accept the similar disclaimer in the Teams admin center. Microsoft Calling Plan phone numbers are available in several countries/regions, see [Country and region availability for Audio Conferencing and Calling Plans](https://learn.microsoft.com/MicrosoftTeams/country-and-region-availability-for-audio-conferencing-and-calling-plans/country-and-region-availability-for-audio-conferencing-and-calling-plans) ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion US ``` @@ -48,13 +52,13 @@ version of the enhanced emergency service terms and conditions. ## PARAMETERS -### -CountryOrRegion -Specifies the region or country whose terms and conditions you wish to accept. You need to use the ISO 31661-1 alpha-2 2 letter code for the country. For example for the United States it must be specified as "US" and for Denmark it must be specified as "DK". +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -63,13 +67,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -CountryOrRegion +Specifies the region or country whose terms and conditions you wish to accept. You need to use the ISO 31661-1 alpha-2 2 letter code for the country. For example for the United States it must be specified as "US" and for Denmark it must be specified as "DK". ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -181,4 +185,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/teams/get-csonlineenhancedemergencyservicedisclaimer) +[Get-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineenhancedemergencyservicedisclaimer) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisCivicAddress.md similarity index 89% rename from teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisCivicAddress.md index 49f8ab38fe..bb65946698 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisCivicAddress.md @@ -1,26 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress applicable: Microsoft Teams -title: Set-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliscivicaddress +schema: 2.0.0 +title: Set-CsOnlineLisCivicAddress --- # Set-CsOnlineLisCivicAddress ## SYNOPSIS -Use the \`Set-CsOnlineLisCivicAddress\` cmdlet to modify an existing civic address which has not been validated. -Validated civic addresses cannot be modified. - -> [!IMPORTANT] -> Due to a current issue, the parameters **-CompanyName** and **-CountryOrRegion** are required as an interim workaround for this cmdlet. - -> [!Note] -> This cmdlet is only available for public use with limited countries and certain fields. The remaining countries and fields are for Microsoft internal use only. +Use the cmdlet to modify an existing civic address which has not been validated. ## SYNTAX @@ -35,6 +29,11 @@ Set-CsOnlineLisCivicAddress -CivicAddressId [-CompanyName ] [-Com ``` ## DESCRIPTION +Validated civic addresses cannot be modified. + +> [!IMPORTANT] +> Due to a current issue, the parameters **-CompanyName** and **-CountryOrRegion** are required as an interim workaround for this cmdlet. + Use the `Set-CsOnlineLisCivicAddress` cmdlet to modify limited fields of an existing civic address. Editing address using this cmdlet is restricted to the following countries/regions: @@ -42,6 +41,9 @@ Australia, Brazil, Canada, Croatia, Czech Republic, Estonia, Hong Kong, Hungary, If the user runs this cmdlet on one of the unsupported countries, it may interfere with number assignment and potentially is against regulatory requirements, so public use of the API is limited to the above countries/regions. +> [!NOTE] +> This cmdlet is only available for public use with limited countries and certain fields. The remaining countries and fields are for Microsoft internal use only. + ## EXAMPLES ### Example 1 @@ -60,30 +62,35 @@ This example modifies the latitude, longitude and ELIN name of the civic address ## PARAMETERS -### -CivicAddressId -Specifies the unique identifier of the civic address to be modified. +### -City + +> Applicable: Microsoft Teams + +Specifies a new city for the civic address. Publicly editable. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -City -Specifies a new city for the civic address. Publicly editable. +### -CityAlias + +> Applicable: Microsoft Teams + +Short form of the city name. +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -92,17 +99,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias -Short form of the city name. -This parameter is reserved for internal Microsoft use. +### -CivicAddressId + +> Applicable: Microsoft Teams + +Specifies the unique identifier of the civic address to be modified. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -110,13 +118,15 @@ Accept wildcard characters: False ``` ### -CompanyName + +> Applicable: Microsoft Teams + Specifies a new company name for the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -126,14 +136,31 @@ Accept wildcard characters: False ``` ### -CompanyTaxId -Used to store TaxId for regulatory reasons. + +> Applicable: Microsoft Teams + +Used to store TaxId for regulatory reasons. +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confidence This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -143,13 +170,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -159,8 +188,11 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies a new country or region for the civic address. -For public use, restricted to the following countries: +For public use, restricted to the following countries: **AU, BR, CA, HR, CZ, EE, HK, HU, IL, JP, LV, LT, MX, NZ, PL, PR, RO, SG, KR, SI, ZA, US** @@ -168,7 +200,6 @@ For public use, restricted to the following countries: Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -178,13 +209,34 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies a new description for the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Elin + +> Applicable: Microsoft Teams + +Specifies the Emergency Location Identification Number. +This is used in Direct Routing EGW scenarios. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -194,6 +246,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -202,7 +257,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -212,13 +266,15 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Microsoft Teams + Specifies the new numeric portion of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -228,6 +284,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Microsoft Teams + Specifies the new numeric suffix of the new civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". @@ -237,7 +296,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -246,14 +304,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PostalCode -Specifies the new postal code of the civic address. Publicly editable. +### -IsAzureMapValidationRequired +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -262,17 +319,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PostDirectional -Specifies the new directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". +### -Latitude -This parameter is reserved for internal Microsoft use. +> Applicable: Microsoft Teams + +Specifies the angular distance of a place north or south of the earth's equator in the decimal degrees format. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -281,17 +337,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PreDirectional -Specifies the new directional attribute of the civic address which precedes the street name. -For example, "425 NE Smith Avenue ". +### -Longitude -This parameter is reserved for internal Microsoft use. +> Applicable: Microsoft Teams + +Specifies the angular distance of a place east or west of the meridian at Greenwich, England, in the decimal degrees format. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -300,14 +355,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StateOrProvince -Specifies the new state or province of the civic address. Publicly editable. +### -PostalCode + +> Applicable: Microsoft Teams + +Specifies the new postal code of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -316,14 +373,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreetName -Specifies the new street name of the civic address. Publicly editable. +### -PostDirectional + +> Applicable: Microsoft Teams + +Specifies the new directional attribute of the civic address which follows the street name. +For example, "425 Smith Avenue NE". + +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -332,9 +394,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreetSuffix -Specifies the new modifier of the street name of the new civic address. -The street suffix will typically be something like street, avenue, way, or boulevard. +### -PreDirectional + +> Applicable: Microsoft Teams + +Specifies the new directional attribute of the civic address which precedes the street name. +For example, "425 NE Smith Avenue ". This parameter is reserved for internal Microsoft use. @@ -342,7 +407,6 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -351,14 +415,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ValidationStatus -Microsoft internal use only +### -StateOrProvince + +> Applicable: Microsoft Teams + +Specifies the new state or province of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -367,25 +433,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +### -StreetName -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confidence -This parameter is reserved for internal Microsoft use. +Specifies the new street name of the civic address. Publicly editable. ```yaml Type: String @@ -399,31 +451,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Elin -Specifies the Emergency Location Identification Number. -This is used in Direct Routing EGW scenarios. +### -StreetSuffix -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Specifies the new modifier of the street name of the new civic address. +The street suffix will typically be something like street, avenue, way, or boulevard. -### -Latitude -Specifies the angular distance of a place north or south of the earth's equator in the decimal degrees format. Publicly editable. +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -432,14 +472,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Longitude -Specifies the angular distance of a place east or west of the meridian at Greenwich, England, in the decimal degrees format. Publicly editable. +### -ValidationStatus + +> Applicable: Microsoft Teams + +Microsoft internal use only ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -448,17 +490,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsAzureMapValidationRequired -This parameter is reserved for internal Microsoft use. +### -WhatIf + +> Applicable: Microsoft Teams + +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -474,8 +520,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliscivicaddress) -[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineliscivicaddress) -[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliscivicaddress) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisLocation.md similarity index 91% rename from teams/teams-ps/teams/Set-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisLocation.md index d93fd56f49..341e732273 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation applicable: Microsoft Teams -title: Set-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelislocation +schema: 2.0.0 +title: Set-CsOnlineLisLocation --- # Set-CsOnlineLisLocation @@ -45,77 +46,69 @@ This example changes the location description of the location specified by its l ## PARAMETERS -### -CivicAddressId -Specifies the unique identifier of the civic address that contains the location to be modified. -Civic address identities can be discovered by using the \`Get-CsOnlineLisCivicAddress\` cmdlet. +### -City + +> Applicable: Microsoft Teams + +Specifies the city of the civic address. **Note:** This parameter is not supported and will be deprecated. ```yaml -Type: Guid +Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -Specifies the unique identifier of the location to be modified. Location identities can be discovered by using the \`Get-CsOnlineLisLocation\` cmdlet. - -```yaml -Type: Guid -Parameter Sets: UseLocationId -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +### -CityAlias -### -City -Specifies the city of the civic address. +> Applicable: Microsoft Teams -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. ```yaml Type: String -Parameter Sets: UseCivicAddressId +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias +### -CivicAddressId -**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. +> Applicable: Microsoft Teams + +Specifies the unique identifier of the civic address that contains the location to be modified. +Civic address identities can be discovered by using the \`Get-CsOnlineLisCivicAddress\` cmdlet. + +**Note:** This parameter is not supported and will be deprecated. ```yaml -Type: String -Parameter Sets: (All) +Type: Guid +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` ### -CompanyName + +> Applicable: Microsoft Teams + Specifies the name of your organization. **Note:** This parameter is not supported and will be deprecated. @@ -124,7 +117,6 @@ Specifies the name of your organization. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -134,6 +126,9 @@ Accept wildcard characters: False ``` ### -CompanyTaxId + +> Applicable: Microsoft Teams + The company tax ID. **Note:** This parameter is not supported and will be deprecated. @@ -142,7 +137,6 @@ The company tax ID. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -153,13 +147,14 @@ Accept wildcard characters: False ### -Confidence +> Applicable: Microsoft Teams + **Note:** This parameter is not supported and will be deprecated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -168,7 +163,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies the country or region of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -177,7 +193,6 @@ Specifies the country or region of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -195,7 +213,6 @@ Specifies an administrator defined description of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -205,6 +222,9 @@ Accept wildcard characters: False ``` ### -Elin + +> Applicable: Microsoft Teams + Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. **Note:** You can set or change the ELIN, but you can't clear its value. If you need to clear the value, you should recreate the location. @@ -213,7 +233,6 @@ Specifies the Emergency Location Identification Number. This is used in Direct R Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -222,7 +241,30 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Force + +> Applicable: Microsoft Teams + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HouseNumber + +> Applicable: Microsoft Teams + Specifies the numeric portion of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -231,7 +273,6 @@ Specifies the numeric portion of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -241,6 +282,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Microsoft Teams + Specifies the numeric suffix of the civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". @@ -250,7 +294,6 @@ For example, if the property was multiplexed, the HouseNumberSuffix parameter wo Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -259,26 +302,29 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -Latitude -Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. +### -IsAzureMapValidationRequired -**Note:** This parameter is not supported and will be deprecated. +> Applicable: Microsoft Teans + +This parameter is reserved for internal Microsoft use. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -Longitude -Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. +### -Latitude + +> Applicable: Microsoft Teams + +Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. **Note:** This parameter is not supported and will be deprecated. @@ -286,7 +332,6 @@ Specifies the angular distance of a place east or west of the meridian at Greenw Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -294,14 +339,17 @@ Default value: None Accept pipeline input: True Accept wildcard characters: False ``` + ### -Location + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". ```yaml Type: String Parameter Sets: UseLocationId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -310,35 +358,36 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -PostalCode -Specifies the postal code of the civic address. +### -LocationId -**Note:** This parameter is not supported and will be deprecated. +> Applicable: Microsoft Teams + +Specifies the unique identifier of the location to be modified. Location identities can be discovered by using the \`Get-CsOnlineLisLocation\` cmdlet. ```yaml -Type: String -Parameter Sets: UseCivicAddressId +Type: Guid +Parameter Sets: UseLocationId Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -PostDirectional -Specifies the directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". +### -Longitude + +> Applicable: Microsoft Teams + +Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. **Note:** This parameter is not supported and will be deprecated. ```yaml Type: String -Parameter Sets: UseCivicAddressId +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -346,9 +395,11 @@ Default value: None Accept pipeline input: True Accept wildcard characters: False ``` +### -PostalCode -### -PreDirectional -Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue ". +> Applicable: Microsoft Teams + +Specifies the postal code of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -356,7 +407,6 @@ Specifies the directional attribute of the civic address which precedes the stre Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -365,8 +415,12 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -StateOrProvince -Specifies the state or province of the civic address. +### -PostDirectional + +> Applicable: Microsoft Teams + +Specifies the directional attribute of the civic address which follows the street name. +For example, "425 Smith Avenue NE". **Note:** This parameter is not supported and will be deprecated. @@ -374,7 +428,6 @@ Specifies the state or province of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -383,8 +436,11 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -StreetName -Specifies the street name of the civic address. +### -PreDirectional + +> Applicable: Microsoft Teams + +Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue ". **Note:** This parameter is not supported and will be deprecated. @@ -392,7 +448,6 @@ Specifies the street name of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -401,8 +456,11 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -StreetSuffix -Specifies a modifier of the street name of the civic address. The street suffix will typically be something like street, avenue, way, or boulevard. +### -StateOrProvince + +> Applicable: Microsoft Teams + +Specifies the state or province of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -410,7 +468,6 @@ Specifies a modifier of the street name of the civic address. The street suffix Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teans Required: False Position: Named @@ -419,41 +476,50 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -IsAzureMapValidationRequired -This parameter is reserved for internal Microsoft use. +### -StreetName + +> Applicable: Microsoft Teams + +Specifies the street name of the civic address. + +**Note:** This parameter is not supported and will be deprecated. ```yaml Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teans Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -StreetSuffix + +> Applicable: Microsoft Teans + +Specifies a modifier of the street name of the civic address. The street suffix will typically be something like street, avenue, way, or boulevard. + +**Note:** This parameter is not supported and will be deprecated. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -461,23 +527,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -497,8 +546,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinelislocation) -[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelislocation) -[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelislocation) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisPort.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisPort.md similarity index 91% rename from teams/teams-ps/teams/Set-CsOnlineLisPort.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisPort.md index 39f8049001..b23506958f 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisPort.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisPort.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport applicable: Microsoft Teams -title: Set-CsOnlineLisPort -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisport +schema: 2.0.0 +title: Set-CsOnlineLisPort --- # Set-CsOnlineLisPort @@ -50,13 +51,15 @@ Example 3 creates the association between port "12174" and LocationId "efd7273e- ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + If ChassisID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise, (different sub type, such as Interface Name), then this value must be in a string format as set on the switch ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -65,32 +68,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -Specifies the unique identifier of the location to be modified. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -PortID -If the PortID subtype is a MAC Address, this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise (different subtype, such as Interface Name), this value must be in a string format as set on the switch. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -98,13 +87,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the port. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -114,6 +105,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -122,7 +116,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -132,13 +125,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -147,14 +142,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationId + +> Applicable: Microsoft Teams + +Specifies the unique identifier of the location to be modified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -163,30 +178,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore -This parameter is reserved for internal Microsoft use. +### -PortID + +> Applicable: Microsoft Teams + +If the PortID subtype is a MAC Address, this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise (different subtype, such as Interface Name), this value must be in a string format as set on the switch. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -196,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -203,7 +225,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -229,6 +250,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport) +[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisport) -[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport) +[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisport) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSubnet.md similarity index 92% rename from teams/teams-ps/teams/Set-CsOnlineLisSubnet.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSubnet.md index ae42f3ce2d..a6373a4613 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSubnet.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelissubnet applicable: Microsoft Teams -title: Set-CsOnlineLisSubnet -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelissubnet +schema: 2.0.0 +title: Set-CsOnlineLisSubnet --- # Set-CsOnlineLisSubnet @@ -48,13 +49,15 @@ Example 2 creates the Location Information Service subnet in IPv6 format "2001:4 ## PARAMETERS ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the Location Information Service subnet. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -80,6 +85,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -88,7 +96,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -98,13 +105,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -114,13 +123,15 @@ Accept wildcard characters: False ``` ### -LocationId + +> Applicable: Microsoft Teams + Specifies the unique identifier of the location to be modified. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -130,13 +141,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -146,13 +159,15 @@ Accept wildcard characters: False ``` ### -Subnet + +> Applicable: Microsoft Teams + The IP address of the subnet. This value can be either IPv4 or IPv6 format. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 1 @@ -162,13 +177,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -178,13 +195,15 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 0 @@ -194,6 +213,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -201,7 +223,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSwitch.md similarity index 90% rename from teams/teams-ps/teams/Set-CsOnlineLisSwitch.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSwitch.md index 71e862e8a2..d70cf60b81 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSwitch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch applicable: Microsoft Teams -title: Set-CsOnlineLisSwitch -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinelisswitch +schema: 2.0.0 +title: Set-CsOnlineLisSwitch --- # Set-CsOnlineLisSwitch @@ -36,6 +37,9 @@ Example 1 creates a switch with Chassis ID "B8-BE-BF-4A-A3-00", and associates i ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + If ChassisID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise, (different sub type, such as Interface Name), then this value must be in a string format as set on the switch @@ -43,7 +47,6 @@ Otherwise, (different sub type, such as Interface Name), then this value must be Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -52,16 +55,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -The name for this location. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -69,13 +74,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the switch. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -85,6 +92,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -93,7 +103,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +112,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -118,30 +129,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NCSApiUrl -This parameter is reserved for internal Microsoft use. +### -LocationId + +> Applicable: Microsoft Teams + +The name for this location. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore +### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -150,14 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -167,6 +184,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -174,7 +194,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -200,6 +219,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch) +[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinelisswitch) -[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch) +[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinelisswitch) diff --git a/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint.md similarity index 91% rename from teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint.md index 75045602f9..328a5f0a27 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint applicable: Microsoft Teams -title: Set-CsOnlineLisWirelessAccessPoint -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineliswirelessaccesspoint +schema: 2.0.0 +title: Set-CsOnlineLisWirelessAccessPoint --- # Set-CsOnlineLisWirelessAccessPoint @@ -47,13 +48,15 @@ Example 2 creates the wireless access point with Chassis ID "F0-6E-0B-C2-04-*", ## PARAMETERS ### -BSSID + +> Applicable: Microsoft Teams + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. If an entry with the specified BSSID value does not exist, a new WAP will be created. If an entry with the specified BSSID already exists, that entry will be replaced. It can be presented in wildcard format. The wildcard '*' can be on either the last one or two character(s). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -62,16 +65,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -The name for this location. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the WAP. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -95,6 +102,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -103,7 +113,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -113,13 +122,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -128,30 +139,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NCSApiUrl -This parameter is reserved for internal Microsoft use. +### -LocationId + +> Applicable: Microsoft Teams + +The name for this location. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore +### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -160,14 +175,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -177,6 +194,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -184,7 +204,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -210,6 +229,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint) +[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineliswirelessaccesspoint) -[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint) +[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineliswirelessaccesspoint) diff --git a/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePSTNGateway.md similarity index 93% rename from teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlinePSTNGateway.md index 845a593cc5..3b137b465b 100644 --- a/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePSTNGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway applicable: Microsoft Teams -title: Set-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstngateway +schema: 2.0.0 +title: Set-CsOnlinePSTNGateway --- # Set-CsOnlinePSTNGateway @@ -30,7 +31,7 @@ Set-CsOnlinePSTNGateway [[-Identity] ] [-GatewayLbrEnabledUserOverride ] [-GatewaySiteId ] [-GatewaySiteLbrEnabled ] - [-IPAddressVersion ] + [-IPAddressVersion ] [-InboundPstnNumberTranslationRules ] [-InboundTeamsNumberTranslationRules ] [-MaxConcurrentSessions ] @@ -67,21 +68,6 @@ This example modifies the configuration of an SBC with identity (and FQDN) sbc. ## PARAMETERS -### -Identity -The parameter is mandatory when modifying an existing SBC. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -BypassMode Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle. @@ -97,13 +83,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -112,13 +100,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Free-format string to describe the gateway. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -127,13 +117,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Microsoft Teams + Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC from service while it is being updated or during maintenance. Note if the parameter is not set the SBC will be created as disabled (default value -Enabled $false). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -142,6 +134,9 @@ Accept wildcard characters: False ``` ### -FailoverResponseCodes + +> Applicable: Microsoft Teams + If Direct Routing receives any 4xx or 6xx SIP error code in response on outgoing Invite (outgoing means call from a Teams client to PSTN with traffic flow :Teams Client -> Direct Routing -> SBC -> Telephony network) the call is considered completed by default. Setting the SIP codes in this parameter forces Direct Routing on receiving the specified codes try another SBC (if another SBC exists in the voice routing policy of the user). @@ -153,7 +148,6 @@ Setting this parameter overwrites the default values, so if you want to include Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 408, 503, 504 @@ -162,13 +156,15 @@ Accept wildcard characters: False ``` ### -FailoverTimeSeconds + +> Applicable: Microsoft Teams + When set to 10 (default value), outbound calls that are not answered by the gateway within 10 seconds are routed to the next available trunk; if there are no additional trunks, then the call is automatically dropped. In an organization with slow networks and slow gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 10 @@ -177,13 +173,15 @@ Accept wildcard characters: False ``` ### -ForwardCallHistory + +> Applicable: Microsoft Teams + Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -192,13 +190,15 @@ Accept wildcard characters: False ``` ### -ForwardPai + +> Applicable: Microsoft Teams + Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False). Setting this parameter to $true will render the from header anonymous, in accordance of RFC5379 and RFC3325. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -206,44 +206,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewaySiteId -PSTN Gateway Site Id. +### -GatewayLbrEnabledUserOverride + +> Applicable: Microsoft Teams + +Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: $false Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewayLbrEnabledUserOverride -Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. +### -GatewaySiteId + +> Applicable: Microsoft Teams + +PSTN Gateway Site Id. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: $false +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -GatewaySiteLbrEnabled + +> Applicable: Microsoft Teams + Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is turned on, the SBC will report the site name as defined by tenant administrator. On incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -251,8 +257,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundTeamsNumberTranslationRules -This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. +### -Identity + +> Applicable: Microsoft Teams + +The parameter is mandatory when modifying an existing SBC. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundPSTNNumberTranslationRules +Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. ```yaml Type: Object @@ -265,8 +288,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundPSTNNumberTranslationRules -Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. +### -InboundTeamsNumberTranslationRules +This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. ```yaml Type: Object @@ -294,13 +317,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentSessions + +> Applicable: Microsoft Teams + Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent session is 90% or higher than this value. If this parameter is not set, the alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -309,13 +334,15 @@ Accept wildcard characters: False ``` ### -MediaBypass + +> Applicable: Microsoft Teams + Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -325,13 +352,14 @@ Accept wildcard characters: False ### -MediaRelayRoutingLocationOverride +> Applicable: Microsoft Teams + Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -339,8 +367,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundTeamsNumberTranslationRules -Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction. +### -OutboundPSTNNumberTranslationRules +Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction. ```yaml Type: Object @@ -353,8 +381,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundPSTNNumberTranslationRules -Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction. +### -OutboundTeamsNumberTranslationRules +Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction. ```yaml Type: Object @@ -368,13 +396,15 @@ Accept wildcard characters: False ``` ### -PidfloSupported + +> Applicable: Microsoft Teams + Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -383,13 +413,15 @@ Accept wildcard characters: False ``` ### -ProxySbc + +> Applicable: Microsoft Teams + The FQDN of the proxy SBC. Used in Local Media Optimization configurations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -398,13 +430,15 @@ Accept wildcard characters: False ``` ### -SendSipOptions + +> Applicable: Microsoft Teams + Defines if an SBC will or will not send the SIP options. If disabled, the SBC will be excluded from Monitoring and Alerting system. We highly recommend that you enable SIP options. Default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $true @@ -413,13 +447,15 @@ Accept wildcard characters: False ``` ### -SipSignalingPort + +> Applicable: Microsoft Teams + Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. The value must be between 1 and 65535. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -428,6 +464,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -435,7 +474,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -456,8 +494,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinepstngateway) -[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstngateway) -[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinepstngateway) diff --git a/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePstnUsage.md similarity index 89% rename from teams/teams-ps/teams/Set-CsOnlinePstnUsage.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlinePstnUsage.md index 549dcdcc10..3a2e9594ec 100644 --- a/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePstnUsage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstnusage applicable: Microsoft Teams -title: Set-CsOnlinePstnUsage -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinepstnusage +schema: 2.0.0 +title: Set-CsOnlinePstnUsage --- # Set-CsOnlinePstnUsage @@ -29,28 +30,28 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsOnlinePstnUsage -Identity global -Usage @{add="International"} ``` This command adds the string "International" to the current list of available PSTN usages. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsOnlinePstnUsage -Identity global -Usage @{remove="Local"} ``` This command removes the string "Local" from the list of available PSTN usages. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Set-CsOnlinePstnUsage -Usage @{remove="Local"} ``` The command in this example performs the exact same action as the command in Example 2: it removes the "Local" PSTN usage. This example shows the command without the Identity parameter specified. The only Identity available to the Set-CsOnlinePstnUsage cmdlet is the Global identity; omitting the Identity parameter defaults to Global. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> Set-CsOnlinePstnUsage -Usage @{replace="International","Restricted"} ``` @@ -134,4 +135,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstnusage) +[Get-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinepstnusage) diff --git a/teams/teams-ps/teams/Set-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineSchedule.md similarity index 88% rename from teams/teams-ps/teams/Set-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineSchedule.md index 7f4392b0fa..99378400fc 100644 --- a/teams/teams-ps/teams/Set-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineschedule applicable: Microsoft Teams -title: Set-CsOnlineSchedule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineschedule +schema: 2.0.0 +title: Set-CsOnlineSchedule --- # Set-CsOnlineSchedule @@ -25,7 +27,7 @@ The Set-CsOnlineSchedule cmdlet lets you modify the properties of a schedule. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $schedule = Get-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" $schedule.Name = "Christmas Holiday" @@ -34,7 +36,7 @@ Set-CsOnlineSchedule -Instance $schedule This example modifies the name of the schedule that has a Id of fa9081d6-b4f3-5c96-baec-0b00077709e5. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $schedule = Get-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" @@ -57,13 +59,15 @@ This example updates an existing holiday schedule, adding a new date/time range ## PARAMETERS ### -Instance + +> Applicable: Microsoft Teams + The Instance parameter is the object reference to the schedule to be modified. ```yaml Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -74,11 +78,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -103,6 +108,6 @@ The modified instance of the `Microsoft.Rtc.Management.Hosted.Online.Models.Sche ## RELATED LINKS -[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineschedule) -[Remove-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/remove-csonlineschedule) +[Remove-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlineschedule) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance.md similarity index 90% rename from teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance.md index f62687992e..1b69298b70 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance.md @@ -1,22 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceapplicationinstance applicable: Microsoft Teams -title: Set-CsOnlineVoiceApplicationInstance -ms.reviewer: -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceapplicationinstance +schema: 2.0.0 +title: Set-CsOnlineVoiceApplicationInstance --- # Set-CsOnlineVoiceApplicationInstance ## SYNOPSIS -The `Set-CsOnlineVoiceApplicationInstance` modifies an application instance in Microsoft Entra ID. - -**Note**: This cmdlet has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and -[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. +The cmdlet modifies an application instance in Microsoft Entra ID. ## SYNTAX ``` @@ -33,6 +31,9 @@ Set-CsOnlineVoiceApplicationInstance [[-Identity] ] ## DESCRIPTION This cmdlet is used to modify an application instance in Microsoft Entra ID. +**Note**: This cmdlet has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) and +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) cmdlets instead. + ## EXAMPLES ### Example 1 @@ -172,4 +173,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoute.md similarity index 95% rename from teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoute.md index e88a324e6f..cc24ec7a5e 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoute.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute applicable: Microsoft Teams -title: Set-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroute +schema: 2.0.0 +title: Set-CsOnlineVoiceRoute --- # Set-CsOnlineVoiceRoute @@ -31,21 +33,21 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -Description "Test Route" ``` This command sets the Description of the Route1 online voice route to "Test Route." -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{add="Long Distance"} ``` The command in this example modifies the online voice route with the identity Route1 to add the online PSTN usage Long Distance to the list of usages for this voice route. Long Distance must be in the list of global online PSTN usages (which can be retrieved with a call to the `Get-CsOnlinePstnUsage` cmdlet). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> $x = (Get-CsOnlinePstnUsage).Usage @@ -214,8 +216,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroute) -[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroute) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy.md index c541ead593..39f6ca7600 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Set-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Set-CsOnlineVoiceRoutingPolicy --- # Set-CsOnlineVoiceRoutingPolicy @@ -31,21 +32,21 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages @{Add="Long Distance"} ``` The command shown in Example 1 adds the online PSTN usage "Long Distance" to the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages @{Remove="Local"} ``` In Example 2, the online PSTN usage "Local" is removed from the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Set-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Local"} | Set-CsOnlineVoiceRoutingPolicy -OnlinePstnUsages @{Remove="Local"} ``` @@ -165,10 +166,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy) -[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceUser.md similarity index 88% rename from teams/teams-ps/teams/Set-CsOnlineVoiceUser.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceUser.md index d7f09686d0..3d9db13679 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceuser applicable: Microsoft Teams -title: Set-CsOnlineVoiceUser -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoiceuser +schema: 2.0.0 +title: Set-CsOnlineVoiceUser --- # Set-CsOnlineVoiceUser @@ -15,10 +16,6 @@ ms.reviewer: ## SYNOPSIS Use the `Set-CsOnlineVoiceUser` cmdlet to set the PSTN specific parameters (like telephone numbers and emergency response locations.) -**Note**: This cmdlet has been deprecated. Use the new -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and -[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. - ## SYNTAX ``` @@ -27,17 +24,20 @@ Set-CsOnlineVoiceUser [-Identity] [-Tenant ] [-Telephone ``` ## DESCRIPTION +**Note**: This cmdlet has been deprecated. Use the new +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) and +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) cmdlets instead. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineVoiceUser -Identity 3c37e1c7-78f9-4703-82ee-a6b68516794e -TelephoneNumber +14255037311 -LocationID c7c5a17f-00d7-47c0-9ddb-3383229d606b ``` This example sets the telephone number and location for a user identified by the user ObjectID. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineVoiceUser -Identity user@domain.com -TelephoneNumber $null ``` @@ -46,39 +46,16 @@ This example removes the telephone number for a user identified by the user's SI ## PARAMETERS -### -Identity -Specifies the identity of the target user. -Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -You can use the `Get-CsOnlineUser` cmdlet to identify the users you want to modify. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +### -Confirm -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confirm The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -applicable: Microsoft Teams Required: False Position: Named @@ -88,13 +65,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: DC -applicable: Microsoft Teams Required: False Position: Named @@ -104,6 +83,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -112,7 +94,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -121,7 +102,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +Specifies the identity of the target user. +Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +You can use the `Get-CsOnlineUser` cmdlet to identify the users you want to modify. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocationID + +> Applicable: Microsoft Teams + Specifies the unique identifier of the emergency location to assign to the user. Location identities can be discovered by using the `Get-CsOnlineLisLocation` cmdlet. @@ -131,7 +142,6 @@ This parameter is required for users based in the US. Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -141,6 +151,9 @@ Accept wildcard characters: False ``` ### -TelephoneNumber + +> Applicable: Microsoft Teams + Specifies the telephone number to be assigned to the user. The value must be in E.164 format: +14255043920. Setting the value to $Null clears the user's telephone number. @@ -149,7 +162,6 @@ Setting the value to $Null clears the user's telephone number. Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -159,13 +171,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -175,13 +189,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf parameter is not implemented for this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailPolicy.md similarity index 84% rename from teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailPolicy.md index e5f0a4f436..6aaf292eb4 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailPolicy.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy applicable: Microsoft Teams -title: Set-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailpolicy +schema: 2.0.0 +title: Set-CsOnlineVoicemailPolicy --- # Set-CsOnlineVoicemailPolicy ## SYNOPSIS -Modifies an existing Online Voicemail policy. Online Voicemail policies determine whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. +Modifies an existing Online Voicemail policy. ## SYNTAX @@ -41,14 +42,14 @@ Tenant admin would be able to create a customized online voicemail policy to mat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" -MaximumRecordingLength ([TimeSpan]::FromSeconds(60)) ``` The command shown in Example 1 changes the MaximumRecordingLength to 60 seconds for the per-user online voicemail policy CustomOnlineVoicemailPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineVoicemailPolicy -EnableTranscriptionProfanityMasking $false ``` @@ -57,30 +58,49 @@ The command shown in Example 2 changes the EnableTranscriptionProfanityMasking t ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -EnableEditingCallAnswerRulesSetting + +> Applicable: Microsoft Teams + Controls if editing call answer rule settings are enabled or disabled for a user. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -90,13 +110,15 @@ Accept wildcard characters: False ``` ### -EnableTranscription + +> Applicable: Microsoft Teams + Allows you to disable or enable voicemail transcription. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -106,13 +128,15 @@ Accept wildcard characters: False ``` ### -EnableTranscriptionProfanityMasking + +> Applicable: Microsoft Teams + Allows you to disable or enable profanity masking for the voicemail transcriptions. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -122,13 +146,15 @@ Accept wildcard characters: False ``` ### -EnableTranscriptionTranslation + +> Applicable: Microsoft Teams + Allows you to disable or enable translation for the voicemail transcriptions. Possible values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -137,14 +163,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MaximumRecordingLength + +> Applicable: Microsoft Teams + A duration of voicemail maximum recording length. The length should be between 30 seconds to 10 minutes. ```yaml Type: Duration Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -154,13 +200,15 @@ Accept wildcard characters: False ``` ### -PostambleAudioFile + +> Applicable: Microsoft Teams + The audio file to play to the caller after the user's voicemail greeting has played and before the caller is allowed to leave a voicemail message. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -168,13 +216,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -PreambleAudioFile + +> Applicable: Microsoft Teams + The audio file to play to the caller before the user's voicemail greeting is played. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -183,13 +233,15 @@ Accept wildcard characters: False ``` ### -PreamblePostambleMandatory + +> Applicable: Microsoft Teams + Is playing the Pre- or Post-amble mandatory before the caller can leave a message. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named Default value: False @@ -198,13 +250,15 @@ Accept wildcard characters: False ``` ### -PrimarySystemPromptLanguage -The primary (or first) language that voicemail system prompts will be presented in. Must also set SecondarySystemPromptLanguage. When set, this overrides the user language choice. See [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. + +> Applicable: Microsoft Teams + +The primary (or first) language that voicemail system prompts will be presented in. Must also set SecondarySystemPromptLanguage. When set, this overrides the user language choice. See [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -214,13 +268,15 @@ Accept wildcard characters: False ``` ### -SecondarySystemPromptLanguage -The secondary language that voicemail system prompts will be presented in. Must also set PrimarySystemPromptLanguage and may not be the same value as PrimarySystemPromptanguage. When set, this overrides the user language choice. See [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. + +> Applicable: Microsoft Teams + +The secondary language that voicemail system prompts will be presented in. Must also set PrimarySystemPromptLanguage and may not be the same value as PrimarySystemPromptanguage. When set, this overrides the user language choice. See [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -230,13 +286,15 @@ Accept wildcard characters: False ``` ### -ShareData + +> Applicable: Microsoft Teams + Specifies whether voicemail and transcription data are shared with the service for training and improving accuracy. Possible values are Defer and Deny. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -246,44 +304,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -302,10 +331,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings.md similarity index 92% rename from teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings.md index 679bea74c8..3c4eb2413a 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings applicable: Microsoft Teams -title: Set-CsOnlineVoicemailUserSettings -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlinevoicemailusersettings +schema: 2.0.0 +title: Set-CsOnlineVoicemailUserSettings --- # Set-CsOnlineVoicemailUserSettings @@ -31,35 +32,35 @@ For example, tenant admin could enable/disable voicemail, change voicemail promp ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineVoicemailUserSettings -Identity sip:user1@contoso.com -VoicemailEnabled $true ``` This example changes VoicemailEnabled setting to true for the user with SIP URI sip:user1@contoso.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineVoicemailUserSettings -Identity user2@contoso.com -PromptLanguage "en-US" -OofGreetingFollowCalendarEnabled $false ``` This example changes PromptLanguage setting to "en-US" and OofGreetingFollowCalendarEnabled setting to false for user2@contoso.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsOnlineVoicemailUserSettings -Identity user3@contoso.com -CallAnswerRule PromptOnlyWithTransfer -TransferTarget sip:user4@contoso.com ``` This example changes CallAnswerRule setting to PromptOnlyWithTransfer and set TransferTarget to "sip:user4@contoso.com" for user3@contoso.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsOnlineVoicemailUserSettings -Identity user5@contoso.com -CallAnswerRule VoicemailWithTransferOption -TransferTarget "+14255551234" ``` This example changes CallAnswerRule setting to VoicemailWithTransferOption and set TransferTarget to "+14255551234" for user5@contoso.com.. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Set-CsOnlineVoicemailUserSettings -Identity user6@contoso.com -DefaultGreetingPromptOverwrite "Hi, I am currently not available." ``` @@ -68,36 +69,40 @@ This example changes DefaultGreetingPromptOverwrite setting to "Hi, I am current ## PARAMETERS -### -Identity -The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. +### -CallAnswerRule + +> Applicable: Microsoft Teams + +The CallAnswerRule parameter represents the value of the call answer rule, which can be any of the following: + +- DeclineCall +- PromptOnly +- PromptOnlyWithTransfer +- RegularVoicemail +- VoicemailWithTransferOption ```yaml -Type: System.String +Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CallAnswerRule -The CallAnswerRule parameter represents the value of the call answer rule, which can be any of the following: +### -Confirm -- DeclineCall -- PromptOnly -- PromptOnlyWithTransfer -- RegularVoicemail -- VoicemailWithTransferOption +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -DefaultGreetingPromptOverwrite + +> Applicable: Microsoft Teams + The DefaultGreetingPromptOverwrite parameter represents the contents that overwrite the default normal greeting prompt. If the user's normal custom greeting is not set and DefaultGreetingPromptOverwrite is not empty, the voicemail service will play this overwrite greeting instead of the default normal greeting in the voicemail deposit scenario. @@ -114,7 +122,6 @@ If the user's normal custom greeting is not set and DefaultGreetingPromptOverwri Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -DefaultOofGreetingPromptOverwrite + +> Applicable: Microsoft Teams + The DefaultOofGreetingPromptOverwrite parameter represents the contents that overwrite the default out-of-office greeting prompt. If the user's out-of-office custom greeting is not set and DefaultOofGreetingPromptOverwrite is not empty, the voicemail service will play this overwrite greeting instead of the default out-of-office greeting in the voicemail deposit scenario. @@ -131,7 +141,6 @@ If the user's out-of-office custom greeting is not set and DefaultOofGreetingPro Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -155,14 +164,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OofGreetingEnabled + +> Applicable: Microsoft Teams + The OofGreetingEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -172,13 +201,15 @@ Accept wildcard characters: False ``` ### -OofGreetingFollowAutomaticRepliesEnabled + +> Applicable: Microsoft Teams + The OofGreetingFollowAutomaticRepliesEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario when user set automatic replies in Outlook. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -188,6 +219,9 @@ Accept wildcard characters: False ``` ### -PromptLanguage + +> Applicable: Microsoft Teams + The PromptLanguage parameter represents the language that is used to play voicemail prompts. The following languages are supported: @@ -251,7 +285,6 @@ The following languages are supported: Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -261,13 +294,15 @@ Accept wildcard characters: False ``` ### -ShareData + +> Applicable: Microsoft Teams + Specifies whether voicemail and transcription data is shared with the service for training and improving accuracy. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -277,6 +312,9 @@ Accept wildcard characters: False ``` ### -TransferTarget + +> Applicable: Microsoft Teams + The TransferTarget parameter represents the target to transfer the call when call answer rule set to PromptOnlyWithTransfer or VoicemailWithTransferOption. Value of this parameter should be a SIP URI of another user in your organization. For user with Enterprise Voice enabled, a valid telephone number could also be accepted as TransferTarget. @@ -285,7 +323,6 @@ For user with Enterprise Voice enabled, a valid telephone number could also be a Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -295,13 +332,15 @@ Accept wildcard characters: False ``` ### -VoicemailEnabled + +> Applicable: Microsoft Teams + The VoicemailEnabled parameter represents whether to enable voicemail service. If set to $false, the user has no voicemail service. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -311,29 +350,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -357,4 +382,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailusersettings) +[Get-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlinevoicemailusersettings) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberAssignment.md similarity index 82% rename from teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md rename to teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberAssignment.md index b90380feb3..bc75b516d8 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberAssignment.md @@ -1,330 +1,360 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment -applicable: Microsoft Teams -title: Set-CsPhoneNumberAssignment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsPhoneNumberAssignment - -## SYNOPSIS -This cmdlet will assign a phone number to a user or a resource account (online application instance). - -## SYNTAX - -### LocationUpdate (Default) -```powershell -Set-CsPhoneNumberAssignment -PhoneNumber -LocationId [] -``` - -### NetworkSiteUpdate -```powershell -Set-CsPhoneNumberAssignment -PhoneNumber -NetworkSiteId [] -``` - -### Assignment -```powershell -Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType - [-LocationId ] [-NetworkSiteId ] [-AssignmentCategory ] [] -``` - -### Attribute -```powershell -Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled [] -``` - -### ReverseNumberLookup -```powershell -Set-CsPhoneNumberAssignment -PhoneNumber -ReverseNumberLookup [] -``` - -### Notify -```powershell -Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType -Notify [] -``` - -## DESCRIPTION -This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. - -You can also assign a location to a phone number. - -To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlet. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan -``` -This example assigns the Microsoft Calling Plan phone number +1 (206) 555-1234 to the user user1@contoso.com. - -### Example 2 -```powershell -$loc=Get-CsOnlineLisLocation -City Vancouver -Set-CsPhoneNumberAssignment -Identity user2@contoso.com -PhoneNumber +12065551224 -PhoneNumberType CallingPlan -LocationId $loc.LocationId -``` -This example finds the emergency location defined for the corporate location Vancouver and assigns the Microsoft Calling Plan phone number +1 (206) 555-1224 and location to the user user2@contoso.com. - -### Example 3 -```powershell -Set-CsPhoneNumberAssignment -Identity user3@contoso.com -EnterpriseVoiceEnabled $true -``` -This example sets the EnterpriseVoiceEnabled flag on the user user3@contoso.com. - -### Example 4 -```powershell -Set-CsPhoneNumberAssignment -Identity user3@contoso.com -LocationId 'null' -PhoneNumber +12065551226 -PhoneNumberType OperatorConnect -``` -This example removes the emergency location from the phone number for user user3@contoso.com. - -### Example 5 -```powershell -Set-CsPhoneNumberAssignment -Identity cq1@contoso.com -PhoneNumber +14255551225 -PhoneNumberType DirectRouting -``` -This example assigns the Direct Routing phone number +1 (425) 555-1225 to the resource account cq1@contoso.com. - -### Example 6 -```powershell -Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -``` -This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 to the user user4@contoso.com. - -### Example 7 -```powershell -Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occurred } -``` -This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. - -### Example 8 -```powershell -$TempUser = "tempuser@contoso.com" -$OldLoc=Get-CsOnlineLisLocation -City Vancouver -$NewLoc=Get-CsOnlineLisLocation -City Seattle -$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment -foreach ($No in $Numbers) { - Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId - Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -} -``` -This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers, assigning each phone number temporarily with the new location to a user, and then unassigning the phone number again from the user. - -### Example 9 -```powershell -$loc=Get-CsOnlineLisLocation -City Toronto -Set-CsPhoneNumberAssignment -PhoneNumber +12065551224 -LocationId $loc.LocationId -``` -This example shows how to set the location on a phone number. - -### Example 10 -```powershell -$OldLocationId = "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" -$NewLocationId = "951fac72-955e-4734-ab74-cc4c0f761c0b" -# Get all phone numbers in old location -$pns = Get-CsPhoneNumberAssignment -LocationId $OldLocationId -Write-Host $pns.count numbers found in old location $OldLocationId -# Move all those phone numbers to the new location -foreach ($pn in $pns) { - Try { - Set-CsPhoneNumberAssignment -PhoneNumber $pn.TelephoneNumber -LocationId $NewLocationId -ErrorAction Stop - Write-Host $pn.TelephoneNumber was updated to have location $NewLocationId - } - Catch { - Write-Host Could not update $pn.TelephoneNumber with location $NewLocationId - } -} -Write-Host (Get-CsPhoneNumberAssignment -LocationId $OldLocationId).Count numbers found in old location $OldLocationId -Write-Host (Get-CsPhoneNumberAssignment -LocationId $NewLocationId).Count numbers found in new location $NewLocationId -``` -This Example shows how to update the LocationID from an old location to a new location for a set of phone numbers. - -### Example 11 -```powershell -Set-CsPhoneNumberAssignment -Identity user3@contoso.com -PhoneNumber +12065551226 -ReverseNumberLookup 'SkipInternalVoip' -``` -This example shows how to turn off reverse number lookup (RNL) on a phone number. When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. This example is only applicable for Direct Routing phone numbers. - -### Example 12 -```powershell -Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -AssignmentCategory Private -``` -This example shows how to assign a private phone number (incoming calls only) to a user. -### Example 13 -```powershell -Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -LocationId "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" -Notify -``` -This example shows how to send an email to Teams phone users informing them about the new telephone number assignment. Note: For assignment of India telephone numbers provided by Airtel, Teams Phone users will automatically receive an email outlining the usage guidelines and restrictions. This notification is mandatory and cannot be opted out of. - -## PARAMETERS - -### -AssignmentCategory -This parameter indicates the phone number assignment category if it isn't the primary phone number. For example, a Private line can be assigned to a user using '-AssignmentCategory Private'. - -```yaml -Type: System.String -Parameter Sets: (Assignment) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnterpriseVoiceEnabled -Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. - -This parameter is mutual exclusive with PhoneNumber. - -```yaml -Type: System.Boolean -Parameter Sets: (Attribute) -Aliases: -Applicable: Microsoft Teams - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or -resource account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationId -The LocationId of the location to assign to the specific user. You can get it using Get-CsOnlineLisLocation. You can set the location on both assigned and unassigned -phone numbers. - -Removal of location from a phone number is supported for Direct Routing numbers and Operator Connect numbers that are not managed by the Service Desk. -If you want to remove the location, use the string value null for LocationId. - -```yaml -Type: System.String -Parameter Sets: (Assignment, LocationUpdate) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSiteId -ID of a network site. A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. - -```yaml -Type: System.String -Parameter Sets: (Assignment) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can't have "tel:" prefixed. - -We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. - -Setting a phone number will automatically set EnterpriseVoiceEnabled to True. - -```yaml -Type: System.String -Parameter Sets: (Assignment, LocationUpdate) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumberType -The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. - -```yaml -Type: System.String -Parameter Sets: (Assignment) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReverseNumberLookup -This parameter is used to control the behavior of reverse number lookup (RNL) for a phone number.When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. - -```yaml -Type: String -Parameter Sets: (ReverseNumberLookupUpdate, Assignment) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notify -Sends an email to Teams phone user about new telephone number assignment. - -```yaml -Type: Switch -Parameter Sets: (Assignment) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 3.0.0 or later. The parameter set LocationUpdate was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The parameter set NetworkSiteUpdate was introduced in Teams PowerShell module 5.5.1-preview. - -The cmdlet is only available in commercial and GCC cloud instances. - -If a user or resource account has a phone number set in Active Directory on-premises and synched into Microsoft 365, you can't use Set-CsPhoneNumberAssignment to set the phone number. You will have to clear the phone number from the on-premises Active Directory and let that change sync into Microsoft 365 first. - -The previous command for assigning phone numbers to users Set-CsUser had the parameter HostedVoiceMail. Setting HostedVoiceMail for Microsoft Teams users is no longer -necessary and that is why the parameter is not available on Set-CsPhoneNumberAssignment. - -## RELATED LINKS -[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) - -[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment +schema: 2.0.0 +title: Set-CsPhoneNumberAssignment +--- + +# Set-CsPhoneNumberAssignment + +## SYNOPSIS +This cmdlet will assign a phone number to a user or a resource account (online application instance). + +## SYNTAX + +### LocationUpdate (Default) +``` +Set-CsPhoneNumberAssignment -PhoneNumber -LocationId [-HttpPipelinePrepend ] + [] +``` + +### NetworkSiteUpdate +``` +Set-CsPhoneNumberAssignment -PhoneNumber [-HttpPipelinePrepend ] + -NetworkSiteId [] +``` + +### ReverseNumberLookupUpdate +``` +Set-CsPhoneNumberAssignment -PhoneNumber [-HttpPipelinePrepend ] + -ReverseNumberLookup [] +``` + +### Assignment +``` +Set-CsPhoneNumberAssignment -PhoneNumber [-LocationId ] + [-HttpPipelinePrepend ] -Identity -PhoneNumberType + [-NetworkSiteId ] [-AssignmentCategory ] [-ReverseNumberLookup ] [] +``` + +### Attribute +``` +Set-CsPhoneNumberAssignment [-HttpPipelinePrepend ] -Identity + -EnterpriseVoiceEnabled [] +``` + +## DESCRIPTION +This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. + +You can also assign a location to a phone number. + +To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan +``` +This example assigns the Microsoft Calling Plan phone number +1 (206) 555-1234 to the user user1@contoso.com. + +### Example 2 +```powershell +$loc=Get-CsOnlineLisLocation -City Vancouver +Set-CsPhoneNumberAssignment -Identity user2@contoso.com -PhoneNumber +12065551224 -PhoneNumberType CallingPlan -LocationId $loc.LocationId +``` +This example finds the emergency location defined for the corporate location Vancouver and assigns the Microsoft Calling Plan phone number +1 (206) 555-1224 and location to the user user2@contoso.com. + +### Example 3 +```powershell +Set-CsPhoneNumberAssignment -Identity user3@contoso.com -EnterpriseVoiceEnabled $true +``` +This example sets the EnterpriseVoiceEnabled flag on the user user3@contoso.com. + +### Example 4 +```powershell +Set-CsPhoneNumberAssignment -Identity user3@contoso.com -LocationId 'null' -PhoneNumber +12065551226 -PhoneNumberType OperatorConnect +``` +This example removes the emergency location from the phone number for user user3@contoso.com. + +### Example 5 +```powershell +Set-CsPhoneNumberAssignment -Identity cq1@contoso.com -PhoneNumber +14255551225 -PhoneNumberType DirectRouting +``` +This example assigns the Direct Routing phone number +1 (425) 555-1225 to the resource account cq1@contoso.com. + +### Example 6 +```powershell +Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting +``` +This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 to the user user4@contoso.com. + +### Example 7 +```powershell +Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occurred } +``` +This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. + +### Example 8 +```powershell +$TempUser = "tempuser@contoso.com" +$OldLoc=Get-CsOnlineLisLocation -City Vancouver +$NewLoc=Get-CsOnlineLisLocation -City Seattle +$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment +foreach ($No in $Numbers) { + Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId + Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber +} +``` +This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers, assigning each phone number temporarily with the new location to a user, and then unassigning the phone number again from the user. + +### Example 9 +```powershell +$loc=Get-CsOnlineLisLocation -City Toronto +Set-CsPhoneNumberAssignment -PhoneNumber +12065551224 -LocationId $loc.LocationId +``` +This example shows how to set the location on a phone number. + +### Example 10 +```powershell +$OldLocationId = "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" +$NewLocationId = "951fac72-955e-4734-ab74-cc4c0f761c0b" +# Get all phone numbers in old location +$pns = Get-CsPhoneNumberAssignment -LocationId $OldLocationId +Write-Host $pns.count numbers found in old location $OldLocationId +# Move all those phone numbers to the new location +foreach ($pn in $pns) { + Try { + Set-CsPhoneNumberAssignment -PhoneNumber $pn.TelephoneNumber -LocationId $NewLocationId -ErrorAction Stop + Write-Host $pn.TelephoneNumber was updated to have location $NewLocationId + } + Catch { + Write-Host Could not update $pn.TelephoneNumber with location $NewLocationId + } +} +Write-Host (Get-CsPhoneNumberAssignment -LocationId $OldLocationId).Count numbers found in old location $OldLocationId +Write-Host (Get-CsPhoneNumberAssignment -LocationId $NewLocationId).Count numbers found in new location $NewLocationId +``` +This Example shows how to update the LocationID from an old location to a new location for a set of phone numbers. + +### Example 11 +```powershell +Set-CsPhoneNumberAssignment -Identity user3@contoso.com -PhoneNumber +12065551226 -ReverseNumberLookup 'SkipInternalVoip' +``` +This example shows how to turn off reverse number lookup (RNL) on a phone number. When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. This example is only applicable for Direct Routing phone numbers. + +### Example 12 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -AssignmentCategory Private +``` +This example shows how to assign a private phone number (incoming calls only) to a user. + +### Example 13 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -LocationId "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" -Notify +``` +This example shows how to send an email to Teams phone users informing them about the new telephone number assignment. Note: For assignment of India telephone numbers provided by Airtel, Teams Phone users will automatically receive an email outlining the usage guidelines and restrictions. This notification is mandatory and cannot be opted out of. + +## PARAMETERS + +### -AssignmentCategory + +> Applicable: Microsoft Teams + +This parameter indicates the phone number assignment category if it isn't the primary phone number. For example, a Private line can be assigned to a user using '-AssignmentCategory Private'. + + +```yaml +Type: System.String +Parameter Sets: Assignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseVoiceEnabled + +> Applicable: Microsoft Teams + +Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. + +This parameter is mutual exclusive with PhoneNumber. + +```yaml +Type: System.Boolean +Parameter Sets: Attribute +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or +resource account. + +```yaml +Type: System.String +Parameter Sets: Assignment, Attribute +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationId +The LocationId of the location to assign to the specific user. You can get it using Get-CsOnlineLisLocation. You can set the location on both assigned and unassigned +phone numbers. + +Removal of location from a phone number is supported for Direct Routing numbers and Operator Connect numbers that are not managed by the Service Desk. +If you want to remove the location, use the string value null for LocationId. + +```yaml +Type: System.String +Parameter Sets: LocationUpdate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteId + +> Applicable: Microsoft Teams + +ID of a network site. A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. + +```yaml +Type: System.String +Parameter Sets: Assignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.String +Parameter Sets: NetworkSiteUpdate, Assignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumber +The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can't have "tel:" prefixed. + +We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. + +Setting a phone number will automatically set EnterpriseVoiceEnabled to True. + +```yaml +Type: System.String +Parameter Sets: LocationUpdate, NetworkSiteUpdate, ReverseNumberLookupUpdate, Assignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumberType +The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. + +```yaml +Type: System.String +Parameter Sets: Assignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseNumberLookup +This parameter is used to control the behavior of reverse number lookup (RNL) for a phone number.When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. + +```yaml +Type: System.String +Parameter Sets: ReverseNumberLookupUpdate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 3.0.0 or later. The parameter set LocationUpdate was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The parameter set NetworkSiteUpdate was introduced in Teams PowerShell module 5.5.1-preview. + +The cmdlet is only available in commercial and GCC cloud instances. + +If a user or resource account has a phone number set in Active Directory on-premises and synched into Microsoft 365, you can't use Set-CsPhoneNumberAssignment to set the phone number. You will have to clear the phone number from the on-premises Active Directory and let that change sync into Microsoft 365 first. + +The previous command for assigning phone numbers to users Set-CsUser had the parameter HostedVoiceMail. Setting HostedVoiceMail for Microsoft Teams users is no longer +necessary and that is why the parameter is not available on Set-CsPhoneNumberAssignment. + +## RELATED LINKS +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) + +[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberTag.md similarity index 80% rename from teams/teams-ps/teams/Set-CsPhoneNumberTag.md rename to teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberTag.md index c571a93910..26ec20868d 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberTag.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberTag.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/set-csphonenumbertag applicable: Microsoft Teams -title: Set-CsPhoneNumberTag author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumbertag schema: 2.0.0 +title: Set-CsPhoneNumberTag --- # Set-CsPhoneNumberTag @@ -23,7 +24,7 @@ Set-CsPhoneNumberTag -PhoneNumber -Tag [] ``` ## DESCRIPTION -This cmdlet allows telephone number administrators to create and assign tags to phone numbers. Tags can be up to 50 characters long, including spaces, and can contain multiple words. They are not case-sensitive. Each phone number can have up to 50 tags assigned. To improve readability, it is recommended to avoid assigning too many tags to a single phone number. If the desired tag already exist, the telephone number will get assigned the existing tag. If the tag is not already available, a new tag will be created. [Get-CsPhoneNumberTag](https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag) can be used to check a list of already existing tags. The tags can be used as a filter for [Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) to filter on certain list. +This cmdlet allows telephone number administrators to create and assign tags to phone numbers. Tags can be up to 50 characters long, including spaces, and can contain multiple words. They are not case-sensitive. Each phone number can have up to 50 tags assigned. To improve readability, it is recommended to avoid assigning too many tags to a single phone number. If the desired tag already exist, the telephone number will get assigned the existing tag. If the tag is not already available, a new tag will be created. [Get-CsPhoneNumberTag](https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumbertag) can be used to check a list of already existing tags. The tags can be used as a filter for [Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumberassignment) to filter on certain list. ## EXAMPLES @@ -31,7 +32,7 @@ This cmdlet allows telephone number administrators to create and assign tags to ```powershell PS C:\> Set-CsPhoneNumberTag -PhoneNumber +123456789 -Tag "HR" ``` -Above example shows how to set a "HR" tag to +123456789 number. +Above example shows how to set a "HR" tag to +123456789 number. ## PARAMETERS diff --git a/teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/Set-CsSharedCallQueueHistoryTemplate.md similarity index 87% rename from teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md rename to teams/teams-ps/MicrosoftTeams/Set-CsSharedCallQueueHistoryTemplate.md index 5cd82bcea2..55bb1a52b0 100644 --- a/teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsSharedCallQueueHistoryTemplate.md @@ -1,20 +1,24 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsSharedCallQueueHistoryTemplate applicable: Microsoft Teams -title: Set-CsSharedCallQueueHistoryTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: Set-CsSharedCallQueueHistoryTemplate --- # Set-CsSharedCallQueueHistoryTemplate +## SYNOPSIS +Use the Set-CsSharedCallQueueHistoryTemplate cmdlet to change a Shared Call Queue History template + ## SYNTAX -```powershell +``` Set-CsSharedCallQueueHistoryTemplate -Instance [] ``` @@ -26,7 +30,7 @@ Use the Set-SharedCallQueueHistory cmdlet to change a Shared Call Queue History ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $SharedCQHistory = Get-CsSharedCallQueueHistory -Id 66f0dc32-d344-4bb1-b524-027d4635515c $SharedCQHisotry.AnsweredAndOutboundCalls = "AuthorizedUsersAndAgents" @@ -38,13 +42,15 @@ This example sets the AnsweredOutboundCalls value in the Shared Call History Tem ## PARAMETERS ### -Instance + +> Applicable: Microsoft Teams + The instance of the shared call queue history template to change. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: Named @@ -53,7 +59,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAIPolicy.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAIPolicy.md index 2c43c43e51..caa9cad7f9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Set-CsTeamsAIPolicy -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsAIPolicy -schema: 2.0.0 author: Andy447 +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: andywang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsTeamsAIPolicy +schema: 2.0.0 +title: Set-CsTeamsAIPolicy --- # Set-CsTeamsAIPolicy @@ -99,15 +100,15 @@ Set Teams AI policy "SpeakerAttributionBYOD" value to "Disabled" for identity "T ## PARAMETERS -### -Identity -Identity of the Teams AI policy. - +### -Description +Enables administrators to provide explanatory text about the Teams AI policy. +For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -144,32 +145,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpeakerAttributionBYOD -Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. +### -Identity +Identity of the Teams AI policy. ```yaml Type: String -Parameter Sets: ("Enabled","Disabled") +Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text about the Teams AI policy. -For example, the Description might indicate the users the policy should be assigned to. +### -SpeakerAttributionBYOD +Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. + ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: ("Enabled","Disabled") Aliases: -Required: False +Required: True Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` @@ -185,10 +186,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaipolicy) -[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsaipolicy) -[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaipolicy) -[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAcsFederationConfiguration.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAcsFederationConfiguration.md index dcc0f7acf6..b311a9c415 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAcsFederationConfiguration.md @@ -1,11 +1,12 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsAcsFederationConfiguration -author: tomkau ms.author: tomkau -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration schema: 2.0.0 +title: Set-CsTeamsAcsFederationConfiguration --- # Set-CsTeamsAcsFederationConfiguration @@ -58,18 +59,6 @@ Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowedAcsResources ## PARAMETERS -### -EnableAcsUsers - -Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. - -```yaml -Type: Boolean -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowAllAcsResources DEPRECATED. Do not use. @@ -82,9 +71,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockedAcsResources +### -AllowedAcsResources -List of blocked Azure Communication Services resources. +The list of the ACS resources (at least one) for which federation is enabled, when EnableAcsUsers is set to true. If EnableAcsUsers is set to false, then this list is ignored and should be null/empty. The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. @@ -96,9 +85,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedAcsResources +### -BlockedAcsResources -The list of the ACS resources (at least one) for which federation is enabled, when EnableAcsUsers is set to true. If EnableAcsUsers is set to false, then this list is ignored and should be null/empty. +List of blocked Azure Communication Services resources. The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. @@ -110,21 +99,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LabelForAllowedAcsUsers - -This configuration controls the user label that is displayed for Azure Communication Services users when they join Teams meetings or calls. Possible values are: Unverified, External. When the value is set to Unverified, the ACS user label is displayed as 'Unverified' when an ACS user joins Teams meetings or calls. When the value is set to External, if an ACS user joins a Teams meeting or call from a resource listed in AllowAllAcsResources, their label should be displayed as 'External'. - -```yaml -Type: String -Position: Named -Default value: Unverified -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireAcsFederationForMeeting +### -EnableAcsUsers -This configuration controls whether ACS Federation is required for meetings. Possibles values are: True, False. +Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. ```yaml Type: Boolean @@ -162,6 +139,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LabelForAllowedAcsUsers + +This configuration controls the user label that is displayed for Azure Communication Services users when they join Teams meetings or calls. Possible values are: Unverified, External. When the value is set to Unverified, the ACS user label is displayed as 'Unverified' when an ACS user joins Teams meetings or calls. When the value is set to External, if an ACS user joins a Teams meeting or call from a resource listed in AllowAllAcsResources, their label should be displayed as 'External'. + +```yaml +Type: String +Position: Named +Default value: Unverified +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireAcsFederationForMeeting + +This configuration controls whether ACS Federation is required for meetings. Possibles values are: True, False. + +```yaml +Type: Boolean +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -173,10 +174,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration) +[Get-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsacsfederationconfiguration) -[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy.md index 58ff1553f7..f7f47218fc 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsapppermissionpolicy applicable: Microsoft Teams -title: Set-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: mhayrapetyan -manager: prkosh author: serdarsoysal +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: prkosh +Module Name: MicrosoftTeams ms.author: serdars +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsapppermissionpolicy +schema: 2.0.0 +title: Set-CsTeamsAppPermissionPolicy --- # Set-CsTeamsAppPermissionPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. - -As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . +Cmdlet to set the app permission policy for Teams. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppSetupPolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppSetupPolicy.md index 1e6e8b5c3a..2ff01ce2cd 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppSetupPolicy.md @@ -1,24 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsappsetuppolicy applicable: Microsoft Teams -title: Set-CsTeamsAppSetupPolicy +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsappsetuppolicy schema: 2.0.0 +title: Set-CsTeamsAppSetupPolicy --- # Set-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Cmdlet to set the app setup policy for Teams. ## SYNTAX ### Identity (Default) -```powershell +``` Set-CsTeamsAppSetupPolicy [[-Identity] ] [-AllowSideLoading ] [-AllowUserPinning ] @@ -37,7 +35,7 @@ Set-CsTeamsAppSetupPolicy [[-Identity] ] ``` ### Instance -```powershell +``` Set-CsTeamsAppSetupPolicy [-Instance ] [-AllowSideLoading ] [-AllowUserPinning ] @@ -118,33 +116,18 @@ Step 3: Settings to install these apps in your users' personal Teams environment ## PARAMETERS -### -Identity -Name of app setup policy. If empty, all identities will be used by default. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Do not use. +### -AdditionalCustomizationApps +This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -193,21 +176,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdditionalCustomizationApps -This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. - -```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AppPresetMeetingList This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. @@ -268,6 +236,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Name of app setup policy. If empty, all identities will be used by default. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Do not use. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -PinnedAppBarApps Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that users need the most and promote ease of access. diff --git a/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy.md index aee67a3709..f14ae209f8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy -title: Set-CsTeamsAudioConferencingPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy schema: 2.0.0 +title: Set-CsTeamsAudioConferencingPolicy --- # Set-CsTeamsAudioConferencingPolicy @@ -62,6 +63,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. @@ -123,21 +139,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -167,8 +168,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy) -[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallHoldPolicy.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallHoldPolicy.md index 27aaba2f36..c801cf5fce 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy applicable: Microsoft Teams -title: Set-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallholdpolicy +schema: 2.0.0 +title: Set-CsTeamsCallHoldPolicy --- # Set-CsTeamsCallHoldPolicy @@ -54,16 +55,31 @@ This policy is re-assigned the description from its existing value to "country m ## PARAMETERS -### -Identity -Unique identifier of the Teams call hold policy being modified. +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -86,11 +102,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFileId -A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -101,16 +117,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreamingSourceUrl -This parameter is reserved for internal Microsoft use. +### -Identity +Unique identifier of the Teams call hold policy being modified. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -131,11 +147,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -162,21 +178,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -192,12 +193,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallholdpolicy) -[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallholdpolicy) -[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallholdpolicy) -[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallholdpolicy) -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallParkPolicy.md similarity index 86% rename from teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallParkPolicy.md index 14c75e129a..2046a276bb 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallParkPolicy.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallparkpolicy applicable: Microsoft Teams -title: Set-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallparkpolicy +schema: 2.0.0 +title: Set-CsTeamsCallParkPolicy --- # Set-CsTeamsCallParkPolicy ## SYNOPSIS - -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. - -NOTE: The call park feature is currently available in desktop, mobile, and web clients. Supported with TeamsOnly mode. +The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. ## SYNTAX @@ -39,7 +38,12 @@ Set-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [-I ``` ## DESCRIPTION -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different phone. The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. +The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in +Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then +perform a number of actions on that call: transfer to another department, retrieve via the same +phone, or retrieve via a different phone. + +NOTE: The call park feature is currently available in desktop, mobile, and web clients. Supported with TeamsOnly mode. ## EXAMPLES @@ -96,6 +100,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +Description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppress all non-fatal errors @@ -141,19 +160,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -PickupRangeEnd -Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. - -Note: PickupRangeStart must be smaller than PickupRangeEnd. +### -MsftInternalProcessingMode +For Internal use only. ```yaml -Type: Integer +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 99 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -173,8 +190,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PickupRangeStart -Specify the minimum value that a rendered pickup code can take. Value can be from 10 to 9999. +### -PickupRangeEnd +Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. Note: PickupRangeStart must be smaller than PickupRangeEnd. @@ -185,47 +202,33 @@ Aliases: Required: False Position: Named -Default value: 10 +Default value: 99 Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -PickupRangeStart +Specify the minimum value that a rendered pickup code can take. Value can be from 10 to 9999. -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Note: PickupRangeStart must be smaller than PickupRangeEnd. ```yaml -Type: SwitchParameter +Type: Integer Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named -Default value: None +Default value: 10 Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the policy. +### -Tenant +Internal Microsoft use only. ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: @@ -236,13 +239,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsftInternalProcessingMode -For Internal use only. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallingPolicy.md index 1f3a0f0fe7..1d0d11adb7 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallingPolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy applicable: Microsoft Teams -title: Set-CsTeamsCallingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars ms.reviewer: alejandramu +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscallingpolicy +schema: 2.0.0 +title: Set-CsTeamsCallingPolicy --- # Set-CsTeamsCallingPolicy @@ -80,22 +81,10 @@ Sets the value of the parameter LiveCaptionsEnabledTypeForCalling to Disabled in ## PARAMETERS -### -Identity -Name of the policy instance being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -110,7 +99,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -120,13 +108,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToPhone + +> Applicable: Microsoft Teams + Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -136,13 +126,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToUser + +> Applicable: Microsoft Teams + Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -152,13 +144,15 @@ Accept wildcard characters: False ``` ### -AllowCallGroups + +> Applicable: Microsoft Teams + Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -168,6 +162,9 @@ Accept wildcard characters: False ``` ### -AllowCallRedirect + +> Applicable: Microsoft Teams + Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway. Valid options are: @@ -180,7 +177,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -190,13 +186,15 @@ Accept wildcard characters: False ``` ### -AllowCloudRecordingForCalls + +> Applicable: Microsoft Teams + Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -206,13 +204,15 @@ Accept wildcard characters: False ``` ### -AllowDelegation + +> Applicable: Microsoft Teams + Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -222,6 +222,9 @@ Accept wildcard characters: False ``` ### -AllowPrivateCalling + +> Applicable: Microsoft Teams + Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. @@ -229,7 +232,6 @@ If you use Skype for Business for calling, this policy will not affect calling f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -239,13 +241,15 @@ Accept wildcard characters: False ``` ### -AllowSIPDevicesCalling + +> Applicable: Microsoft Teams + Determines whether the user is allowed to use a SIP device for calling on behalf of a Teams client. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -255,13 +259,15 @@ Accept wildcard characters: False ``` ### -AllowTranscriptionForCalling + +> Applicable: Microsoft Teams + Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -271,6 +277,9 @@ Accept wildcard characters: False ``` ### -AllowVoicemail + +> Applicable: Microsoft Teams + Enables inbound calls to be routed to voicemail. Valid options are: @@ -283,7 +292,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -293,13 +301,15 @@ Accept wildcard characters: False ``` ### -AllowWebPSTNCalling + +> Applicable: Microsoft Teams + Allows PSTN calling from the Teams web client. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -325,6 +335,9 @@ Accept wildcard characters: False ``` ### -BusyOnBusyEnabledType + +> Applicable: Microsoft Teams + Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. Valid options are: @@ -338,7 +351,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -348,6 +360,9 @@ Accept wildcard characters: False ``` ### -CallingSpendUserLimit + +> Applicable: Microsoft Teams + The maximum amount a user can spend on outgoing PSTN calls, including all calls made through Pay-as-you-go Calling Plans and any overages on plans with bundled minutes. Possible values: any positive integer @@ -356,7 +371,6 @@ Possible values: any positive integer Type: Long Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -366,13 +380,15 @@ Accept wildcard characters: False ``` ### -CallRecordingExpirationDays + +> Applicable: Microsoft Teams + Sets the expiration of the recorded 1:1 calls. Default is 60 days. ```yaml Type: Long Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -382,13 +398,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -398,6 +416,9 @@ Accept wildcard characters: False ``` ### -Copilot + +> Applicable: Microsoft Teams + Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call. Valid options are: @@ -409,7 +430,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -419,13 +439,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users to whom the policy should be assigned. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -435,6 +457,9 @@ Accept wildcard characters: False ``` ### -EnableSpendLimits + +> Applicable: Microsoft Teams + This setting allows an admin to enable or disable spend limits on PSTN calls for their user base. Possible values: @@ -446,7 +471,6 @@ Possible values: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -472,13 +496,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -487,7 +513,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Name of the policy instance being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InboundFederatedCallRoutingTreatment + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound federated calls should be routed. Valid options are: @@ -502,7 +546,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -512,6 +555,9 @@ Accept wildcard characters: False ``` ### -InboundPstnCallRoutingTreatment + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound PSTN calls should be routed. Valid options are: @@ -527,7 +573,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -537,6 +582,9 @@ Accept wildcard characters: False ``` ### -LiveCaptionsEnabledTypeForCalling + +> Applicable: Microsoft Teams + Determines whether real-time captions are available for the user in Teams calls. Valid options are: @@ -548,7 +596,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -558,6 +605,9 @@ Accept wildcard characters: False ``` ### -MusicOnHoldEnabledType + +> Applicable: Microsoft Teams + Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold. Valid options are: @@ -570,7 +620,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -580,13 +629,15 @@ Accept wildcard characters: False ``` ### -PopoutAppPathForIncomingPstnCalls + +> Applicable: Microsoft Teams + Setting this parameter allows you to set the PopoutForIncomingPstnCalls setting's URL path of the website to launch upon receiving incoming PSTN calls. This parameter accepts an HTTPS URL with less than 1024 characters. The URL can contain a `{phone}` placeholder that is replaced with the caller's PSTN number in E.164 format when launched. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: "" @@ -595,13 +646,15 @@ Accept wildcard characters: False ``` ### -PopoutForIncomingPstnCalls + +> Applicable: Microsoft Teams + Setting this parameter allows you to control the tenant users' ability to launch an external website URL automatically in the browser window upon incoming PSTN calls for specific users or user groups. Valid options are Enabled and Disabled. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: Disabled @@ -610,6 +663,9 @@ Accept wildcard characters: False ``` ### -PreventTollBypass + +> Applicable: Microsoft Teams + Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. > [!NOTE] @@ -619,7 +675,6 @@ Setting this parameter to True will send calls through PSTN and incur charges ra Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -628,76 +683,84 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpamFilteringEnabledType -Determines if spam detection is enabled for inbound PSTN calls. +### -RealTimeText -Possible values: +> Applicable: Microsoft Teams -- Enabled: Spam detection is enabled. In case the inbound call is considered spam, the user will get a "Spam Likely" label in Teams. -- Disabled: Spam detection is disabled. +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceSimulationInInterpreter +### -SpamFilteringEnabledType -> [!NOTE] -> This feature has not been released yet and will have no changes if it is enabled or disabled. +> Applicable: Microsoft Teams -Enables the user to use the voice simulation feature while being AI interpreted. +Determines if spam detection is enabled for inbound PSTN calls. -Possible Values: +Possible values: -- Disabled -- Enabled +- Enabled: Spam detection is enabled. In case the inbound call is considered spam, the user will get a "Spam Likely" label in Teams. +- Disabled: Spam detection is disabled. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeText ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. +### -VoiceSimulationInInterpreter -Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. +> Applicable: Microsoft Teams + +> [!NOTE] +> This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the voice simulation feature while being AI interpreted. Possible Values: -- Enabled: User is allowed to turn on real time text. -- Disabled: User is not allowed to turn on real time text. + +- Disabled +- Enabled ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: Enabled +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -705,7 +768,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -729,10 +791,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscallingpolicy) -[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscallingpolicy) -[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscallingpolicy) -[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscallingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsChannelsPolicy.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsChannelsPolicy.md index a6e29ca6ed..a6f1d5b995 100644 --- a/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsChannelsPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamschannelspolicy applicable: Microsoft Teams -title: Set-CsTeamsChannelsPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamschannelspolicy +schema: 2.0.0 +title: Set-CsTeamsChannelsPolicy --- # Set-CsTeamsChannelsPolicy @@ -50,14 +52,13 @@ This example shows updating an existing policy with name "StudentPolicy" and ena ## PARAMETERS -### -EnablePrivateTeamDiscovery -Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. +### -AllowChannelSharingToExternalUser +Owners of a shared channel can invite external users to join the channel if Microsoft Entra external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -65,13 +66,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowOrgWideTeamCreation +Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -80,11 +81,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Bypass all non-fatal errors. +### -AllowPrivateChannelCreation +Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -95,44 +96,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Use this parameter to specify the name of the policy being updated. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Use this parameter to pass the policy object output of Get-CsTeamsChannelsPolicy to update that policy. +### -AllowSharedChannelCreation +Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: Boolean +Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -AllowUserToParticipateInExternalSharedChannel +Users and teams can be invited to external shared channels if Microsoft Entra external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml -Type: System.Guid +Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -140,13 +124,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -155,8 +139,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOrgWideTeamCreation -Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. +### -EnablePrivateTeamDiscovery +Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml Type: Boolean @@ -170,11 +154,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateChannelCreation -Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. +### -Force +Bypass all non-fatal errors. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -185,41 +169,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelSharingToExternalUser -Owners of a shared channel can invite external users to join the channel if Microsoft Entra external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). +### -Identity +Use this parameter to specify the name of the policy being updated. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: + Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedChannelCreation -Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. +### -Instance +Use this parameter to pass the policy object output of Get-CsTeamsChannelsPolicy to update that policy. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: + Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -AllowUserToParticipateInExternalSharedChannel -Users and teams can be invited to external shared channels if Microsoft Entra external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). +### -Tenant +Internal Microsoft use only. ```yaml -Type: Boolean +Type: System.Guid Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -246,6 +233,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -261,10 +263,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamschannelspolicy) +[New-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamschannelspolicy) -[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy) +[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamschannelspolicy) -[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy) +[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamschannelspolicy) -[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy) +[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamschannelspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsClientConfiguration.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsClientConfiguration.md index d2685ba41e..f228bf78c8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsClientConfiguration.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsclientconfiguration applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Set-CsTeamsClientConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsclientconfiguration +schema: 2.0.0 +title: Set-CsTeamsClientConfiguration --- # Set-CsTeamsClientConfiguration ## SYNOPSIS -The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and how Surface Hub devices can interact with Skype for Business meetings. The parameter descriptions below describe what settings are managed by this configuration and how they are enforced. +Changes the Teams client configuration settings for the specified tenant. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication.md index 1e7e7f36f9..4f9489228b 100644 --- a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication applicable: Microsoft Teams -title: Set-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication +schema: 2.0.0 +title: Set-CsTeamsComplianceRecordingApplication --- # Set-CsTeamsComplianceRecordingApplication @@ -115,105 +116,158 @@ Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredD ## PARAMETERS -### -Identity -A name that uniquely identifies the application instance of the policy-based recording application. +### -ComplianceRecordingPairedApplications +Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. -Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -To do this association correctly, the Identity of these application instances must be \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. +In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: ComplianceRecordingPairedApplication[] +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -ConcurrentInvitationCount +Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. + +In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: UInt32 +Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: True (ByValue) +Default value: 1 +Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredBeforeMeetingJoin -Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. +### -Confirm +Prompts you for confirmation before running the cmdlet. -If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. -The meeting will still continue for users who are in the meeting. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredDuringMeeting -Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. - -If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. -The meeting will still continue for users who are in the meeting. +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. -If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +To do this association correctly, the Identity of these application instances must be \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named -Default value: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredBeforeCallEstablishment -Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: -If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Priority +This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet. + +All policy-based recording applications are invited in parallel to ensure low call setup and meeting join latencies. +So this parameter does not affect the order of invitations to the applications, or any other routing. ```yaml -Type: Boolean +Type: Int32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredDuringCall -Indicates whether the policy-based recording application must be in the call while the call is active. +### -RequiredBeforeCallEstablishment +Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. -If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. +If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. -If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. +If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. ```yaml Type: Boolean @@ -227,84 +281,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentInvitationCount -Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. - -In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. +### -RequiredBeforeMeetingJoin +Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. +If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. +The meeting will still continue for users who are in the meeting. -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. +If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 1 +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingPairedApplications -Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. - -In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. +### -RequiredDuringCall +Indicates whether the policy-based recording application must be in the call while the call is active. -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. +If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. +If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. ```yaml -Type: ComplianceRecordingPairedApplication[] +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet. +### -RequiredDuringMeeting +Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. -All policy-based recording applications are invited in parallel to ensure low call setup and meeting join latencies. -So this parameter does not affect the order of invitations to the applications, or any other routing. +If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` @@ -335,36 +366,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -396,20 +397,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy.md index 482a4c801b..51b820b33a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy applicable: Microsoft Teams -title: Set-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: Set-CsTeamsComplianceRecordingPolicy --- # Set-CsTeamsComplianceRecordingPolicy @@ -96,43 +97,44 @@ This effectively stops automatic policy-based recording for all new calls and me ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new Teams recording policy. +### -ComplianceRecordingApplications +A list of application instances of policy-based recording applications to assign to this policy. +The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. -Use the "Global" Identity if you wish to assign this policy to the entire tenant. +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: ComplianceRecordingApplication[] +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### CustomBanner -References the Custom Banner text in the storage. +### -Description +Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: @@ -143,12 +145,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Controls whether this Teams recording policy is active or not. +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording -Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: -Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. ```yaml Type: Boolean @@ -162,8 +175,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WarnUserOnRemoval -This parameter is reserved for future use. +### -Enabled +Controls whether this Teams recording policy is active or not. + +Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. ```yaml Type: Boolean @@ -172,16 +189,16 @@ Aliases: Required: False Position: Named -Default value: True +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -192,50 +209,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingApplications -A list of application instances of policy-based recording applications to assign to this policy. -The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. +### -Identity +Unique identifier to be assigned to the new Teams recording policy. -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +Use the "Global" Identity if you wish to assign this policy to the entire tenant. ```yaml -Type: ComplianceRecordingApplication[] -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableComplianceRecordingAudioNotificationForCalls -Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -DisableComplianceRecordingAudioNotificationForCalls -Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. +### CustomBanner +References the Custom Banner text in the storage. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -281,32 +297,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -WarnUserOnRemoval +This parameter is reserved for future use. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` @@ -342,20 +343,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy) -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy) -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy) -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy) -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication) -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication) -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication) -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication) diff --git a/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCortanaPolicy.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCortanaPolicy.md index 15607b6980..d9e9f930b4 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy applicable: Microsoft Teams -title: Set-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamscortanapolicy +schema: 2.0.0 +title: Set-CsTeamsCortanaPolicy --- # Set-CsTeamsCortanaPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCustomBannerText.md similarity index 86% rename from teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCustomBannerText.md index 131dd52c2a..6fe831060b 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCustomBannerText.md @@ -1,10 +1,11 @@ --- -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText -title: Set-CsTeamsCustomBannerText -schema: 2.0.0 author: saleens7 +Locale: en-US +Module Name: MicrosoftTeams ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsTeamsCustomBannerText +schema: 2.0.0 +title: Set-CsTeamsCustomBannerText --- # Set-CsTeamsCustomBannerText @@ -27,6 +28,8 @@ Updates a single instance of custom banner text. ## EXAMPLES ### Example 1 + +``` PS C:\> Set-CsTeamsCustomBannerText -Id 123e4567-e89b-12d3-a456-426614174000 -Description "Custom Banner Text Example" -Text "Custom Text" ``` @@ -34,14 +37,27 @@ This example sets the properties of the CustomText instance of TeamsCustomBanner ## PARAMETERS +### -Description +The description that you would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id + +> Applicable: Microsoft Teams + The Identity of the CustomBannerText. ```yaml Type: Guid Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -60,17 +76,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -The description that you would like to set to identify what this text represents. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -86,8 +91,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy.md index 3306c4828f..0c5878ad60 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseducationassignmentsapppolicy applicable: Microsoft Teams -title: Set-CsTeamsEducationAssignmentsAppPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamseducationassignmentsapppolicy +schema: 2.0.0 +title: Set-CsTeamsEducationAssignmentsAppPolicy --- # Set-CsTeamsEducationAssignmentsAppPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationConfiguration.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationConfiguration.md index 2574fce8c8..adc1149a78 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationConfiguration.md @@ -1,11 +1,12 @@ --- +author: SaritaBehera external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsEducationConfiguration -author: SaritaBehera ms.author: saritabehera -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamseducationconfiguration schema: 2.0.0 +title: Set-CsTeamsEducationConfiguration --- # Set-CsTeamsEdcuationConfiguration @@ -96,4 +97,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamseducationconfiguration) +[Get-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamseducationconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy.md similarity index 88% rename from teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy.md index f17f6774c5..8e69edbb30 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Set-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Set-CsTeamsEmergencyCallRoutingPolicy --- # Set-CsTeamsEmergencyCallRoutingPolicy @@ -68,6 +70,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Provides a description of the Teams Emergency Call Routing policy to identify the purpose of setting it. @@ -84,7 +101,7 @@ Accept wildcard characters: False ``` ### -EmergencyNumbers -One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) cmdlet. +One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencynumber) cmdlet. ```yaml Type: Object @@ -128,21 +145,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -154,12 +156,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy) -[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy) -[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) +[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencynumber) diff --git a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy.md index b67d6b3cd5..caaff67ff0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Set-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy schema: 2.0.0 +title: Set-CsTeamsEmergencyCallingPolicy --- # Set-CsTeamsEmergencyCallingPolicy @@ -55,6 +57,21 @@ This example first creates two new Teams Emergency Calling Extended Notification ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Provides a description of the Teams Emergency Calling policy to identify the purpose of setting it. @@ -196,21 +213,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -222,12 +224,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy) -[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy) -[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy) -[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification) +[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsemergencycallingextendednotification) diff --git a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEnhancedEncryptionPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEnhancedEncryptionPolicy.md index 33b326f662..2387c68a97 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEnhancedEncryptionPolicy.md @@ -1,209 +1,210 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy -title: Set-CsTeamsEnhancedEncryptionPolicy -author: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Set-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Use this cmdlet to update values in existing Teams enhanced encryption policy. - -## SYNTAX - -``` -Set-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] - [[-Identity] ] [-Force] [-Instance ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Use this cmdlet to update values in existing Teams enhanced encryption policy. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -``` - -The command shown in Example 1 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - -This policy is re-assigned CallingEndtoEndEncryptionEnabledType to be DisabledUserOverride. - -Any Microsoft Teams users who are assigned this policy will have their enhanced encryption policy customized such that the user can use the enhanced encryption setting in Teams. - -### EXAMPLE 2 -```PowerShell -PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -MeetingEndToEndEncryption DisabledUserOverride -``` - -The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - -This policy has re-assigned MeetingEndToEndEncryption to be DisabledUserOverride. - -Any Microsoft Teams users who are assigned this policy and have a Teams Premium license will have the option to create end-to-end encrypted meetings. [Learn more about end-to-end encryption for Teams meetings](https://support.microsoft.com/en-us/office/use-end-to-end-encryption-for-teams-meetings-a8326d15-d187-49c4-ac99-14c17dbd617c). - -### EXAMPLE 3 -```PowerShell -PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" -``` - -The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - -This policy is re-assigned the description from its existing value to "allow useroverride". - -## PARAMETERS - -### -Description -Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. - -For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallingEndtoEndEncryptionEnabledType -Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingEndToEndEncryption -Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -Use the "Global" Identity if you wish modify the policy set for the entire tenant. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses all non-fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Use this to pipe a specific enhanced encryption policy to be set. You can only modify the global policy, so can only pass the global instance of the enhanced encryption policy. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Set-CsTeamsEnhancedEncryptionPolicy +--- + +# Set-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Use this cmdlet to update values in existing Teams enhanced encryption policy. + +## SYNTAX + +``` +Set-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] + [[-Identity] ] [-Force] [-Instance ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Use this cmdlet to update values in existing Teams enhanced encryption policy. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -CallingEndtoEndEncryptionEnabledType DisabledUserOverride +``` + +The command shown in Example 1 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + +This policy is re-assigned CallingEndtoEndEncryptionEnabledType to be DisabledUserOverride. + +Any Microsoft Teams users who are assigned this policy will have their enhanced encryption policy customized such that the user can use the enhanced encryption setting in Teams. + +### EXAMPLE 2 +```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -MeetingEndToEndEncryption DisabledUserOverride +``` + +The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + +This policy has re-assigned MeetingEndToEndEncryption to be DisabledUserOverride. + +Any Microsoft Teams users who are assigned this policy and have a Teams Premium license will have the option to create end-to-end encrypted meetings. [Learn more about end-to-end encryption for Teams meetings](https://support.microsoft.com/en-us/office/use-end-to-end-encryption-for-teams-meetings-a8326d15-d187-49c4-ac99-14c17dbd617c). + +### EXAMPLE 3 +```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" +``` + +The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + +This policy is re-assigned the description from its existing value to "allow useroverride". + +## PARAMETERS + +### -CallingEndtoEndEncryptionEnabledType +Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. + +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +Use the "Global" Identity if you wish modify the policy set for the entire tenant. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Use this to pipe a specific enhanced encryption policy to be set. You can only modify the global policy, so can only pass the global instance of the enhanced encryption policy. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MeetingEndToEndEncryption +Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy) + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEventsPolicy.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEventsPolicy.md index eb143c568f..2d6de4e0a5 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEventsPolicy.md @@ -1,470 +1,471 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseventspolicy -title: Set-CsTeamsEventsPolicy -schema: 2.0.0 -ms.date: 04/23/2025 ---- - -# Set-CsTeamsEventsPolicy - -## SYNOPSIS -This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. - -## SYNTAX - -``` -Set-CsTeamsEventsPolicy [-AllowWebinars ] [-EventAccessType ] [-AllowTownhalls ] [-ImmersiveEvents ] - [-TownhallEventAttendeeAccess ] [-AllowEmailEditing ] [-AllowedQuestionTypesInRegistrationForm ] - [-AllowEventIntegrations ] [-AllowedWebinarTypesForRecordingPublish ] - [-AllowedTownhallTypesForRecordingPublish ] [-TownhallChatExperience ] [-Description ] - [-RecordingForTownhall ] [-RecordingForWebinar ] - [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] - [-UseMicrosoftECDN ] [-BroadcastPremiumApps ] -``` - -## DESCRIPTION -User-level policy for tenant admin to configure options for customizing Teams events experiences. Use this cmdlet to update an existing policy. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled -``` - -The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. - -## PARAMETERS - -### -AllowWebinars -This setting governs if a user can create webinars using Teams Events. -Possible values are: - - **Enabled**: Enables creating webinars. - - **Disabled**: Disables creating webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseMicrosoftECDN -This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTownhalls -This setting governs if a user can create town halls using Teams Events. -Possible values are: - - **Enabled**: Enables creating town halls. - - **Disabled**: Disables creating town halls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmersiveEvents -This setting governs if a user can create Immersive Events using Teams Events. -Possible values are: - - **Enabled**: Enables creating Immersive Events. - - **Disabled**: Disables creating Immersive Events. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TownhallEventAttendeeAccess -This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. -Possible values are: - - **Everyone**: Anyone with the join link may enter the event. - - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Everyone -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEmailEditing -This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. -Possible values are: - - **Enabled**: Enables editing of communication emails. - - **Disabled**: Disables editing of communication emails. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch does not work with this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventAccessType - -> [!NOTE] -> Currently, webinar and town hall event access is managed together via EventAccessType. - -This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. -Possible values are: - - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - - **EveryoneInCompanyExcludingGuests**: Enables creating events to allow only in-tenant users to register and join the event. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedQuestionTypesInRegistrationForm -This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. - -Possible values are: -DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedTownhallTypesForRecordingPublish -This setting describes how IT admins can control which types of Town Hall attendees can have their recordings published. - -Possible values are: -None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedWebinarTypesForRecordingPublish -This setting describes how IT admins can control which types of webinar attendees can have their recordings published. - -Possible values are: -None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEventIntegrations -This setting governs access to the integrations tab in the event creation workflow. - -Possible values -true, false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TownhallChatExperience -This setting governs whether the user can enable the Comment Stream chat experience for Town Halls. - -Possible values are: Optimized, None. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordingForTownhall -Determines whether recording is allowed in a user's townhall. - -Possible values are: - - **Enabled**: Allow recording in user's townhalls. - - **Disabled**: Prohibit recording in user's townhalls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordingForWebinar -Determines whether recording is allowed in a user's webinar. - -Possible values are: - - **Enabled**: Allow recording in user's webinars. - - **Disabled**: Prohibit recording in user's webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TranscriptionForTownhall -Determines whether transcriptions are allowed in a user's townhall. - -Possible values are: - - **Enabled**: Allow transcriptions in user's townhalls. - - **Disabled**: Prohibit transcriptions in user's townhalls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TranscriptionForWebinar -Determines whether transcriptions are allowed in a user's webinar. - -Possible values are: - - **Enabled**: Allow transcriptions in user's webinars. - - **Disabled**: Prohibit transcriptions in user's webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BroadcastPremiumApps -This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. - -Possible values are: -- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall -- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch does not work with this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch does not work with this cmdlet. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.date: 04/23/2025 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamseventspolicy +schema: 2.0.0 +title: Set-CsTeamsEventsPolicy +--- + +# Set-CsTeamsEventsPolicy + +## SYNOPSIS +This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. + +## SYNTAX + +``` +Set-CsTeamsEventsPolicy [-AllowWebinars ] [-EventAccessType ] [-AllowTownhalls ] [-ImmersiveEvents ] + [-TownhallEventAttendeeAccess ] [-AllowEmailEditing ] [-AllowedQuestionTypesInRegistrationForm ] + [-AllowEventIntegrations ] [-AllowedWebinarTypesForRecordingPublish ] + [-AllowedTownhallTypesForRecordingPublish ] [-TownhallChatExperience ] [-Description ] + [-RecordingForTownhall ] [-RecordingForWebinar ] + [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] + [-UseMicrosoftECDN ] [-BroadcastPremiumApps ] +``` + +## DESCRIPTION +User-level policy for tenant admin to configure options for customizing Teams events experiences. Use this cmdlet to update an existing policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled +``` + +The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. + +## PARAMETERS + +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. + +Possible values are: +DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTownhallTypesForRecordingPublish +This setting describes how IT admins can control which types of Town Hall attendees can have their recordings published. + +Possible values are: +None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedWebinarTypesForRecordingPublish +This setting describes how IT admins can control which types of webinar attendees can have their recordings published. + +Possible values are: +None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailEditing +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. +Possible values are: + - **Enabled**: Enables editing of communication emails. + - **Disabled**: Disables editing of communication emails. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEventIntegrations +This setting governs access to the integrations tab in the event creation workflow. + +Possible values +true, false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTownhalls +This setting governs if a user can create town halls using Teams Events. +Possible values are: + - **Enabled**: Enables creating town halls. + - **Disabled**: Disables creating town halls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWebinars +This setting governs if a user can create webinars using Teams Events. +Possible values are: + - **Enabled**: Enables creating webinars. + - **Disabled**: Disables creating webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastPremiumApps +This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. + +Possible values are: +- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall +- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventAccessType + +> [!NOTE] +> Currently, webinar and town hall event access is managed together via EventAccessType. + +This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. +Possible values are: + - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + - **EveryoneInCompanyExcludingGuests**: Enables creating events to allow only in-tenant users to register and join the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmersiveEvents +This setting governs if a user can create Immersive Events using Teams Events. +Possible values are: + - **Enabled**: Enables creating Immersive Events. + - **Disabled**: Disables creating Immersive Events. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForTownhall +Determines whether recording is allowed in a user's townhall. + +Possible values are: + - **Enabled**: Allow recording in user's townhalls. + - **Disabled**: Prohibit recording in user's townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForWebinar +Determines whether recording is allowed in a user's webinar. + +Possible values are: + - **Enabled**: Allow recording in user's webinars. + - **Disabled**: Prohibit recording in user's webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallChatExperience +This setting governs whether the user can enable the Comment Stream chat experience for Town Halls. + +Possible values are: Optimized, None. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallEventAttendeeAccess +This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. +Possible values are: + - **Everyone**: Anyone with the join link may enter the event. + - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranscriptionForTownhall +Determines whether transcriptions are allowed in a user's townhall. + +Possible values are: + - **Enabled**: Allow transcriptions in user's townhalls. + - **Disabled**: Prohibit transcriptions in user's townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranscriptionForWebinar +Determines whether transcriptions are allowed in a user's webinar. + +Possible values are: + - **Enabled**: Allow transcriptions in user's webinars. + - **Disabled**: Prohibit transcriptions in user's webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMicrosoftECDN +This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch does not work with this cmdlet. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsExternalAccessConfiguration.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsExternalAccessConfiguration.md index 3538e2a0af..fefdebfadf 100644 --- a/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsExternalAccessConfiguration.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsexternalaccessconfiguration -title: Set-CsTeamsExternalAccessConfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsexternalaccessconfiguration schema: 2.0.0 +title: Set-CsTeamsExternalAccessConfiguration --- # Set-CsTeamsExternalAccessConfiguration @@ -38,32 +39,32 @@ In this example, the admin has added two malicious users into the blocked list. ## PARAMETERS -### -BlockExternalAccessUserAccess -Designates whether BlockedUsers list is taking effect or not. $true means BlockedUsers are blocked and can't communicate with internal users. +### -BlockedUsers +You can specify blocked users using a List object that contains either the user email or the MRI from the external user you want to block. The user in the list will not able to communicate with the internal users in your organization. ```yaml -Type: Boolean +Type: List Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockedUsers -You can specify blocked users using a List object that contains either the user email or the MRI from the external user you want to block. The user in the list will not able to communicate with the internal users in your organization. +### -BlockExternalAccessUserAccess +Designates whether BlockedUsers list is taking effect or not. $true means BlockedUsers are blocked and can't communicate with internal users. ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFeedbackPolicy.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsFeedbackPolicy.md index c6a1f2b39c..650e304074 100644 --- a/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFeedbackPolicy.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Set-CsTeamsFeedbackPolicy +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsfeedbackpolicy schema: 2.0.0 +title: Set-CsTeamsFeedbackPolicy --- # Set-CsTeamsFeedbackPolicy @@ -44,28 +46,28 @@ In this example, the policy "New Hire Feedback Policy" is modified, sets the use ## PARAMETERS -### -Identity -The unique identifier of the policy. +### -AllowEmailCollection +Set this to TRUE to enable Email collection. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowLogCollection +Set this to TRUE to enable log collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -74,11 +76,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. +### -AllowScreenshotCollection +Set this to TRUE to enable Screenshot collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -89,13 +91,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Internal Microsoft use. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -104,32 +106,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiveSurveysMode -Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. -Set it to EnabledUserOverride to have users receive the survey and allow them to opt out. - -Possible values: - - Enabled - - Disabled - - EnabledUserOverride +### -EnableFeatureSuggestions +This setting will enable Tenant Admins to hide or show the Teams menu item "Help | Suggest a Feature". +Possible Values: True, False ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -140,13 +137,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserInitiatedMode - Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. - Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. - -Possible values: - - Enabled - - Disabled +### -Identity +The unique identifier of the policy. ```yaml Type: String @@ -154,17 +146,17 @@ Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: Enabled +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEmailCollection -Set this to TRUE to enable Email collection. +### -Instance +Internal Microsoft use. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: @@ -175,26 +167,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowLogCollection -Set this to TRUE to enable log collection. +### -ReceiveSurveysMode +Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. +Set it to EnabledUserOverride to have users receive the survey and allow them to opt out. + +Possible values: + - Enabled + - Disabled + - EnabledUserOverride ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowScreenshotCollection -Set this to TRUE to enable Screenshot collection. +### -Tenant +Internal Microsoft use. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: @@ -205,18 +203,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFeatureSuggestions -This setting will enable Tenant Admins to hide or show the Teams menu item "Help | Suggest a Feature". -Possible Values: True, False +### -UserInitiatedMode + Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. + Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. + +Possible values: + - Enabled + - Disabled ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFilesPolicy.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsFilesPolicy.md index 6f9a8796be..0e2848efb2 100644 --- a/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFilesPolicy.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy -title: Set-CsTeamsFilesPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsfilespolicy schema: 2.0.0 +title: Set-CsTeamsFilesPolicy --- # Set-CsTeamsFilesPolicy @@ -44,36 +45,37 @@ The command shown in Example 2 changes the DefaultFileUploadAppId to AppId_GUID ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -AutoShareFilesInExternalChats + +Indicates if file scope will be changed automatically when sharing files and loops in chats with external or guest users. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NativeFileEntryPoints -This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . -Possible values are Enabled or Disabled. +### -Confirm +Prompts you for confirmation before executing the command. + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False - ``` + ### -DefaultFileUploadAppId This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. @@ -89,28 +91,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -119,26 +123,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force - -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -FileSharingInChatswithExternalUsers - -Indicates if file sharing in chats with external users is enabled. - +### -NativeFileEntryPoints +This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . +Possible values are Enabled or Disabled. ```yaml Type: String Parameter Sets: (All) @@ -149,11 +151,11 @@ Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -``` -### -AutoShareFilesInExternalChats +``` +### -SPChannelFilesTab -Indicates if file scope will be changed automatically when sharing files and loops in chats with external or guest users. +Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. ```yaml Type: String @@ -167,18 +169,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPChannelFilesTab - -Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -194,11 +195,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsfilespolicy) -[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration.md index f79231986e..925a28854e 100644 --- a/teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestcallingconfiguration applicable: Microsoft Teams -title: Set-CsTeamsGuestCallingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsguestcallingconfiguration +schema: 2.0.0 +title: Set-CsTeamsGuestCallingConfiguration --- # Set-CsTeamsGuestCallingConfiguration diff --git a/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration.md index 1c4ee27ee2..99ce363e58 100644 --- a/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration.md @@ -1,10 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestmeetingconfiguration -applicable: Microsoft Teams -title: Set-CsTeamsGuestMeetingConfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsguestmeetingconfiguration schema: 2.0.0 +title: Set-CsTeamsGuestMeetingConfiguration --- # Set-CsTeamsGuestMeetingConfiguration @@ -74,6 +75,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowTranscription +Determines whether post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -195,21 +211,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTranscription -Determines whether post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration.md index 41682046d1..bc8e112950 100644 --- a/teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestmessagingconfiguration applicable: Microsoft Teams -title: Set-CsTeamsGuestMessagingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsguestmessagingconfiguration +schema: 2.0.0 +title: Set-CsTeamsGuestMessagingConfiguration --- # Set-CsTeamsGuestMessagingConfiguration @@ -62,6 +64,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowImmersiveReader +Determines if immersive reader for viewing messages is enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowMemes Determines if memes are available for use. @@ -107,8 +124,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserDeleteMessage -Determines if a user is allowed to delete their own messages. +### -AllowUserDeleteChat +Turn this setting on to allow users to permanently delete their one-on-one chat, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. ```yaml Type: Boolean @@ -117,13 +134,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: TRUE Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserEditMessage -Determines if a user is allowed to edit their own messages. +### -AllowUserDeleteMessage +Determines if a user is allowed to delete their own messages. ```yaml Type: Boolean @@ -137,8 +154,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UsersCanDeleteBotMessages -Determines whether a user is allowed to delete messages sent by bots. Set this to TRUE to allow. Set this to FALSE to prohibit. +### -AllowUserEditMessage +Determines if a user is allowed to edit their own messages. ```yaml Type: Boolean @@ -147,7 +164,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -181,21 +198,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserDeleteChat -Turn this setting on to allow users to permanently delete their one-on-one chat, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: TRUE -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -GiphyRatingType Determines Giphy content restrictions. Default value is "Moderate", other options are "NoRestriction" and "Strict" @@ -211,39 +213,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowImmersiveReader -Determines if immersive reader for viewing messages is enabled. +### -Identity ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity +### -Instance ```yaml -Type: XdsIdentity +Type: PSObject Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance +### -Tenant ```yaml -Type: PSObject +Type: Guid Parameter Sets: (All) Aliases: @@ -254,16 +255,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -UsersCanDeleteBotMessages +Determines whether a user is allowed to delete messages sent by bots. Set this to TRUE to allow. Set this to FALSE to prohibit. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsIPPhonePolicy.md similarity index 98% rename from teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsIPPhonePolicy.md index 0f608fbf29..c696b45c13 100644 --- a/teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsipphonepolicy applicable: Microsoft Teams -title: Set-CsTeamsIPPhonePolicy author: tonywoodruff +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsipphonepolicy schema: 2.0.0 +title: Set-CsTeamsIPPhonePolicy --- # Set-CsTeamsIPPhonePolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMediaConnectivityPolicy.md similarity index 83% rename from teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMediaConnectivityPolicy.md index 7bb81a371f..13154e5816 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Set-CsTeamsMediaConnectivityPolicy -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMediaConnectivityPolicy -schema: 2.0.0 author: lirunping-MSFT +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: runli +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +title: Set-CsTeamsMediaConnectivityPolicy --- # Set-CsTeamsMediaConnectivityPolicy @@ -41,32 +42,32 @@ Set Teams media connectivity policy "DirectConnection" value to "Disabled" for i ## PARAMETERS -### -Identity -Identity of the Teams media connectivity policy. +### -DirectConnection +Policy value of the Teams media connectivity DirectConnection policy. ```yaml -Type: String -Parameter Sets: (All) +Type: Boolean +Parameter Sets: ("Enabled","Disabled") Aliases: Required: True Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -DirectConnection -Policy value of the Teams media connectivity DirectConnection policy. +### -Identity +Identity of the Teams media connectivity policy. ```yaml -Type: Boolean -Parameter Sets: ("Enabled","Disabled") +Type: String +Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -82,10 +83,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy) -[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy) -[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy) -[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) \ No newline at end of file +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy.md index 033a024718..644612567a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy.md @@ -1,14 +1,14 @@ --- +applicable: Microsoft Teams +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Set-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas -applicable: Microsoft Teams --- # Set-CsTeamsMeetingBrandingPolicy @@ -45,6 +45,21 @@ In this example, the commands will change the brand accent color of the theme in ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultTheme *This parameter is reserved for Microsoft internal use only.* Identity of default meeting theme. @@ -91,6 +106,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Identity of meeting branding policy that will be updated. To refer to the global policy, use this syntax: `-Identity global`. @@ -139,36 +169,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Describes what would happen if you executed the command without actually executing the command. @@ -197,12 +197,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration.md similarity index 86% rename from teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration.md index a369ef43c1..8971cb0b04 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration.md @@ -1,23 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbroadcastconfiguration applicable: Microsoft Teams -title: Set-CsTeamsMeetingBroadcastConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbroadcastconfiguration +schema: 2.0.0 +title: Set-CsTeamsMeetingBroadcastConfiguration --- # Set-CsTeamsMeetingBroadcastConfiguration ## SYNOPSIS -Set-CsTeamsMeetingBroadcastConfiguration \[\[-Identity\] \\] \[-Tenant \\] \[-SupportURL \\] \[-AllowSdnProviderForBroadcastMeeting \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] - -Set-CsTeamsMeetingBroadcastConfiguration -SdnProviderName \ -SdnApiTemplateUrl \ \[-Tenant \\] \[-SupportURL \\] \[-AllowSdnProviderForBroadcastMeeting \\] \[-SdnLicenseId \\] \[-SdnApiToken \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] - -Set-CsTeamsMeetingBroadcastConfiguration \[-Tenant \\] \[-SupportURL \\] \[-AllowSdnProviderForBroadcastMeeting \\] \[-Instance \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] +Changes the Teams meeting broadcast configuration settings for the specified tenant. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy.md index 5fda5b675c..0aa969b728 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbroadcastpolicy applicable: Microsoft Teams -title: Set-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Set-CsTeamsMeetingBroadcastPolicy --- # Set-CsTeamsMeetingBroadcastPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingConfiguration.md similarity index 98% rename from teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingConfiguration.md index 10cd0d63f9..e3408ef993 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingConfiguration.md @@ -1,10 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingconfiguration -applicable: Microsoft Teams -title: Set-CsTeamsMeetingConfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingconfiguration schema: 2.0.0 +title: Set-CsTeamsMeetingConfiguration --- # Set-CsTeamsMeetingConfiguration @@ -222,9 +223,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableQoS +### -DisableAppInteractionForAnonymousUsers +Determines if anonymous users can interact with apps in meetings. Set to TRUE to disable App interaction. +Possible values: -Determines whether Quality of Service Marking for real-time media (audio, video, screen/app sharing) is enabled in the tenant. Set this to TRUE to enable and FALSE to disable +- True +- False ```yaml Type: Boolean @@ -238,12 +242,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -EnableQoS -{{Fill Force Description}} +Determines whether Quality of Service Marking for real-time media (audio, video, screen/app sharing) is enabled in the tenant. Set this to TRUE to enable and FALSE to disable ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -254,9 +258,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpURL +### -FeedbackSurveyForAnonymousUsers +Determines if anonymous participants receive surveys to provide feedback about their meeting experience. Set to Disabled to disable anonymous meeting participants to receive surveys. Set to Enabled to allow anonymous meeting participants to receive surveys. +Possible values: -URL to a website where users can obtain assistance on joining the meeting.This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries +- Enabled +- Disabled ```yaml Type: String @@ -265,31 +272,33 @@ Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The only valid input is Global +### -Force + +{{Fill Force Description}} ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Use this parameter to update a saved configuration instance +### -HelpURL + +URL to a website where users can obtain assistance on joining the meeting.This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries ```yaml -Type: PSObject +Type: String Parameter Sets: (All) Aliases: @@ -300,27 +309,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegalURL -URL to a website containing legal information and meeting disclaimers. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries +### -Identity +The only valid input is Global ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LogoURL - -URL to a logo image. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries +### -Instance +Use this parameter to update a saved configuration instance ```yaml -Type: String +Type: PSObject Parameter Sets: (All) Aliases: @@ -331,15 +339,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableAppInteractionForAnonymousUsers -Determines if anonymous users can interact with apps in meetings. Set to TRUE to disable App interaction. -Possible values: - -- True -- False +### -LegalURL +URL to a website containing legal information and meeting disclaimers. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -350,12 +354,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant - -Internal Microsoft use +### -LimitPresenterRolePermissions +When set to True, users within the Tenant will have their presenter role capabilities limited. +When set to False, the presenter role capabilities will not be impacted and will remain as is. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: @@ -366,12 +370,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FeedbackSurveyForAnonymousUsers -Determines if anonymous participants receive surveys to provide feedback about their meeting experience. Set to Disabled to disable anonymous meeting participants to receive surveys. Set to Enabled to allow anonymous meeting participants to receive surveys. -Possible values: +### -LogoURL -- Enabled -- Disabled +URL to a logo image. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries ```yaml Type: String @@ -380,17 +381,17 @@ Aliases: Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LimitPresenterRolePermissions -When set to True, users within the Tenant will have their presenter role capabilities limited. -When set to False, the presenter role capabilities will not be impacted and will remain as is. +### -Tenant + +Internal Microsoft use ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingPolicy.md index dc1727f4c4..d250f0f641 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingPolicy.md @@ -1,15 +1,16 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingpolicy -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Set-CsTeamsMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau +ms.date: 02/26/2025 ms.reviewer: alejandramu -ms.date: 2/26/2025 +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmeetingpolicy +schema: 2.0.0 +title: Set-CsTeamsMeetingPolicy --- # Set-CsTeamsMeetingPolicy @@ -168,22 +169,10 @@ This policy will use all the existing values except one: AllowNetworkConfigurati ## PARAMETERS -### -Identity -Specify the name of the policy being created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -198,7 +187,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -287,6 +275,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowBreakoutRooms +Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowCarbonSummary This setting will enable Tenant Admins to enable/disable the sharing of location data necessary to provide the end of meeting carbon summary screen for either the entire tenant or for a particular user. @@ -328,8 +331,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowBreakoutRooms -Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. +### -AllowChannelMeetingScheduling +Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. + +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -338,16 +344,13 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelMeetingScheduling -Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. - -> [!NOTE] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. +### -AllowCloudRecording +Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings. ```yaml Type: Boolean @@ -361,11 +364,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCloudRecording -Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings. +### -AllowDocumentCollaboration + +This setting will allow admins to choose which users will be able to use the Document Collaboration feature. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -376,9 +380,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDocumentCollaboration +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. -This setting will allow admins to choose which users will be able to use the Document Collaboration feature. +Possible values are: + +- \ +- RTMP + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingContext +This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingContext + +This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. ```yaml Type: String @@ -392,6 +431,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowedUsersForMeetingDetails +Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. + +Possible Values: +- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. +- Everyone: All meeting participants can see the meeting info details. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: UsersAllowedToByPassTheLobby +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowEngagementReport Determines whether meeting organizers are allowed to download the attendee engagement report. Possible values are: @@ -429,6 +487,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowExternalNonTrustedMeetingChat +This field controls whether a user is allowed to chat in external meetings with users from non-trusted organizations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowExternalParticipantGiveRequestControl Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting. @@ -572,31 +645,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNetworkConfigurationSettingsLookup -Determines whether network configuration setting lookup can be made for users who are not Enterprise Voice enabled. It is used to enable Network Roaming policy. +### -AllowNDIStreaming +This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. ```yaml Type: Boolean Parameter Sets: (All) Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNDIStreaming -This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. +### -AllowNetworkConfigurationSettingsLookup +Determines whether network configuration setting lookup can be made for users who are not Enterprise Voice enabled. It is used to enable Network Roaming policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -661,8 +734,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetNow -This setting controls whether a user can start an ad hoc private meeting. +### -AllowPrivateMeetingScheduling +Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. + +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -676,11 +752,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetingScheduling -Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. - -> [!NOTE] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. +### -AllowPrivateMeetNow +This setting controls whether a user can start an ad hoc private meeting. ```yaml Type: Boolean @@ -800,22 +873,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedUsersForMeetingContext - -This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowUserToJoinExternalMeeting Currently, this parameter has no effect. @@ -837,23 +894,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedUsersForMeetingContext -This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowExternalNonTrustedMeetingChat -This field controls whether a user is allowed to chat in external meetings with users from non-trusted organizations. +### -AllowWatermarkForCameraVideo +This setting allows scheduling meetings with watermarking for video enabled. ```yaml Type: Boolean @@ -862,7 +904,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -882,21 +924,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForCameraVideo -This setting allows scheduling meetings with watermarking for video enabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowWhiteboard Determines whether whiteboard is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. @@ -912,28 +939,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedStreamingMediaInput -Enables the use of RTMP-In in Teams meetings. - -Possible values are: - -- \ -- RTMP - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AnonymousUserAuthenticationMethod -Determines how anonymous users will be authenticated when joining a meeting. +Determines how anonymous users will be authenticated when joining a meeting. Possible values are: - **OneTimePasscode**, if you would like anonymous users to be sent a one time passcode to their email when joining a meeting @@ -986,22 +993,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoRecording - -This setting allows admins to control the visibility of the auto recording feature in the organizer's **Meeting options**. If the you enable this setting, the **Record and transcribe automatically** setting appears in **Meeting options** with the default value set to **Off** (except for webinars and townhalls). Organizers need to manually toggle this setting to **On** to for their meetings to be automatically recorded. If you disable this setting, **Record and transcribe automatically** is hidden, preventing organizers from setting any meetings to be auto-recorded. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AutoAdmittedUsers Determines what types of participants will automatically be added to meetings organized by this user. Possible values are: @@ -1050,6 +1041,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AutoRecording + +This setting allows admins to control the visibility of the auto recording feature in the organizer's **Meeting options**. If the you enable this setting, the **Record and transcribe automatically** setting appears in **Meeting options** with the default value set to **Off** (except for webinars and townhalls). Organizers need to manually toggle this setting to **On** to for their meetings to be automatically recorded. If you disable this setting, **Record and transcribe automatically** is hidden, preventing organizers from setting any meetings to be auto-recorded. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BlockedAnonymousJoinClientTypes A user can join a Teams meeting anonymously using a [Teams client](https://support.microsoft.com/office/join-a-meeting-without-a-teams-account-c6efc38f-4e03-4e79-b28f-e65a4c039508) or using a [custom application built using Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/join-teams-meeting). When anonymous meeting join is enabled, both types of clients may be used by default. This optional parameter can be used to block one of the client types that can be used. @@ -1266,7 +1273,7 @@ Accept wildcard characters: False ### -ExplicitRecordingConsent Set participant agreement and notification for Recording, Transcript, Copilot in Teams meetings. -Possible Values: +Possible Values: - Enabled: Explicit consent, requires participant agreement. - Disabled: Implicit consent, does not require participant agreement. @@ -1320,6 +1327,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Specify the name of the policy being created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InfoShownInReportMode This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. @@ -1479,6 +1501,9 @@ Accept wildcard characters: False ``` ### -MeetingInviteLanguages + +> Applicable: Microsoft Teams + Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed. > [!NOTE] @@ -1492,7 +1517,6 @@ The preliminary list of available languages is shown below: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1520,6 +1544,8 @@ Accept wildcard characters: False ``` ### -NoiseSuppressionForDialInParticipants +> Applicable: Microsoft Teams + >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1535,7 +1561,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1564,6 +1589,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParticipantSlideControl + +> Applicable: Microsoft Teams + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Determines whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibited from giving control, or being given control, in a meeting. + +Possible Values: +- Everyone: Anyone in the meeting can give or take control +- EveryoneInOrganization: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control +- EveryoneInOrganizationAndGuests: Only those who are Guests to the tenant, MTO users, and internal AAD users can give or take control +- None: No one in the meeting can give or take control + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PreferredMeetingProviderForIslandsMode Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in. @@ -1599,6 +1651,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RealTimeText + +> Applicable: Microsoft Teams + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecordingStorageMode This parameter can take two possible values: @@ -1835,6 +1912,8 @@ Accept wildcard characters: False ### -VoiceSimulationInInterpreter +> Applicable: Microsoft Teams + > [!NOTE] > This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1849,7 +1928,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1938,73 +2016,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedUsersForMeetingDetails -Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. - -Possible Values: -- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. -- Everyone: All meeting participants can see the meeting info details. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: UsersAllowedToByPassTheLobby -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RealTimeText ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. - -Possible Values: -- Enabled: User is allowed to turn on real time text. -- Disabled: User is not allowed to turn on real time text. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParticipantSlideControl ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -Determines whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibited from giving control, or being given control, in a meeting. - -Possible Values: -- Everyone: Anyone in the meeting can give or take control -- EveryoneInOrganization: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control -- EveryoneInOrganizationAndGuests: Only those who are Guests to the tenant, MTO users, and internal AAD users can give or take control -- None: No one in the meeting can give or take control - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 81% rename from teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingTemplatePermissionPolicy.md index e9a319c5d3..57fb8c5872 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMeetingTemplatePermissionPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Set-CsTeamsMeetingTemplatePermissionPolicy --- # Set-CsTeamsMeetingTemplatePermissionPolicy @@ -43,15 +44,16 @@ Updates the hidden meeting templates array. ## PARAMETERS -### -Identity +### -Description -Name of the policy instance to be updated. +> Applicable: Microsoft Teams + +Pass in a new description if that field needs to be updated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -61,14 +63,15 @@ Accept wildcard characters: False ### -HiddenMeetingTemplates +> Applicable: Microsoft Teams + The updated list of meeting template IDs to hide. -The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddenmeetingtemplate). ```yaml Type: HiddenMeetingTemplate[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -76,15 +79,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Pass in a new description if that field needs to be updated. +> Applicable: Microsoft Teams + +Name of the policy instance to be updated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -102,10 +106,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingConfiguration.md similarity index 93% rename from teams/teams-ps/teams/set-csteamsmessagingconfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingConfiguration.md index 79f4c96eb3..5934c368b8 100644 --- a/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingConfiguration.md @@ -1,289 +1,290 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMessagingConfiguration -title: Set-CsTeamsMessagingConfiguration -schema: 2.0.0 ---- - -# Set-CsTeamsMessagingConfiguration - -## SYNOPSIS - -The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. - -## SYNTAX - -```powershell -Set-CsTeamsMessagingConfiguration [-Identity] - [-Confirm] - [-CustomEmojis ] - [-EnableInOrganizationChatControl ] - [-EnableVideoMessageCaptions ] - [-FileTypeCheck ] - [-Force] - [-MessagingNotes ] - [-UrlReputationCheck ] - [-ContentBasedPhishingCheck ] - [-ReportIncorrectSecurityDetections] - [-WhatIf] - [] -``` - -## DESCRIPTION - -TeamsMessagingConfiguration determines the messaging settings for the users in your tenant. This cmdlet lets you update the user messaging options you'd like to enable in your organization. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsMessagingConfiguration -CustomEmojis $False -``` - -The command shown in example 1 disables custom emojis within Teams. - -## PARAMETERS - -### -Identity - -Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomEmojis - -This setting enables/disables the use of custom emojis and reactions across the whole tenant. Upon enablement, admins and/or users can define a user group that is allowed. -Possible Values: True, False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableInOrganizationChatControl - -This setting determines if chat regulation for internal communication in tenant is allowed. -Possible Values: True, False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableVideoMessageCaptions - - This setting determines if closed captions will be displayed, for Teams Video Clips, during playback. - Possible values: True, False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileTypeCheck - ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -This setting determines if FileType check in teams messaging across the whole tenant - -Possible Values: -- Enabled -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessagingNotes - -This setting enables/disables MessagingNotes integration across the whole tenant. Possible Values: Disabled, Enabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlReputationCheck - ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -This setting determines if UrlReputationCheck check in teams messaging across the whole tenant - -Possible Values: -- Enabled -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentBasedPhishingCheck - ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -This setting determines if Content Based Phishing Check in teams messaging across the whole tenant - -Possible Values: -- Enabled -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportIncorrectSecurityDetections - ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -This setting determines if Report Incorrect Security Detections is enabled in teams messaging across the whole tenant - -Possible Values: -- Enabled -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingconfiguration) +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/Set-CsTeamsMessagingConfiguration +schema: 2.0.0 +title: Set-CsTeamsMessagingConfiguration +--- + +# Set-CsTeamsMessagingConfiguration + +## SYNOPSIS + +The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. + +## SYNTAX + +```powershell +Set-CsTeamsMessagingConfiguration [-Identity] + [-Confirm] + [-CustomEmojis ] + [-EnableInOrganizationChatControl ] + [-EnableVideoMessageCaptions ] + [-FileTypeCheck ] + [-Force] + [-MessagingNotes ] + [-UrlReputationCheck ] + [-ContentBasedPhishingCheck ] + [-ReportIncorrectSecurityDetections] + [-WhatIf] + [] +``` + +## DESCRIPTION + +TeamsMessagingConfiguration determines the messaging settings for the users in your tenant. This cmdlet lets you update the user messaging options you'd like to enable in your organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsMessagingConfiguration -CustomEmojis $False +``` + +The command shown in example 1 disables custom emojis within Teams. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentBasedPhishingCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if Content Based Phishing Check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomEmojis + +This setting enables/disables the use of custom emojis and reactions across the whole tenant. Upon enablement, admins and/or users can define a user group that is allowed. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInOrganizationChatControl + +This setting determines if chat regulation for internal communication in tenant is allowed. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableVideoMessageCaptions + + This setting determines if closed captions will be displayed, for Teams Video Clips, during playback. + Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileTypeCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if FileType check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingNotes + +This setting enables/disables MessagingNotes integration across the whole tenant. Possible Values: Disabled, Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportIncorrectSecurityDetections + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if Report Incorrect Security Detections is enabled in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlReputationCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if UrlReputationCheck check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingPolicy.md index d7182ff633..a4472ecb06 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingPolicy.md @@ -1,9 +1,11 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingpolicy applicable: Microsoft Teams -title: Set-CsTeamsMessagingPolicy +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmessagingpolicy schema: 2.0.0 +title: Set-CsTeamsMessagingPolicy --- # Set-CsTeamsMessagingPolicy @@ -131,38 +133,6 @@ All other policy properties will be left as previously assigned. ## PARAMETERS -### -Identity -Identity for the teams messaging policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: `-Identity TeamsMessagingPolicy`. - -If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowChatWithGroup This setting determines if users can chat with groups (Distribution, M365 and Security groups). Possible values: True, False @@ -718,6 +688,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Identity for the teams messaging policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: `-Identity TeamsMessagingPolicy`. + +If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InOrganizationChatControl This setting determines if chat regulation for internal communication in the tenant is allowed. @@ -733,6 +720,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ReadReceiptsEnabledType Use this setting to specify whether read receipts are user controlled, enabled for everyone, or disabled. Set this to UserPreference, Everyone or None. diff --git a/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMobilityPolicy.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMobilityPolicy.md index 483c23e72a..bd60a9f009 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmobilitypolicy applicable: Microsoft Teams -title: Set-CsTeamsMobilityPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmobilitypolicy +schema: 2.0.0 +title: Set-CsTeamsMobilityPolicy --- # Set-CsTeamsMobilityPolicy @@ -87,23 +89,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IPAudioMobileMode -When set to WifiOnly, prohibits the user from making, receiving calls or joining meetings using VoIP calls on the mobile device while on cellular data connection. +### -Identity +Specify the name of the policy that you are creating. ```yaml -Type: String -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IPVideoMobileMode -When set to WifiOnly, prohibits the user from making, receiving video calls or enabling video in meetings using VoIP calls on the mobile device while on cellular data connection. +### -IPAudioMobileMode +When set to WifiOnly, prohibits the user from making, receiving calls or joining meetings using VoIP calls on the mobile device while on cellular data connection. ```yaml Type: String @@ -117,16 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy that you are creating. +### -IPVideoMobileMode +When set to WifiOnly, prohibits the user from making, receiving video calls or enabling video in meetings using VoIP calls on the mobile device while on cellular data connection. ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: String +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMultiTenantOrganizationConfiguration.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMultiTenantOrganizationConfiguration.md index 0e092c6abe..c68af050c0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMultiTenantOrganizationConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Set-CsTeamsMultiTenantOrganizationConfiguration -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmultitenantorganizationconfiguration -schema: 2.0.0 author: samlyu +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: samlyu +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsmultitenantorganizationconfiguration +schema: 2.0.0 +title: Set-CsTeamsMultiTenantOrganizationConfiguration --- # Set-CsTeamsMultiTenantOrganizationConfiguration @@ -45,32 +46,32 @@ Set Teams Multi-tenant Organization Setting "CopilotFromHomeTenant" value to "En ## PARAMETERS -### -Identity -Identity of the Teams Multi-tenant Organization Setting. +### -CopilotFromHomeTenant +Setting value of the Teams Multi-tenant Organization Setting. CopilotFromHomeTenant controls user access to Copilot license in their home tenant during cross-tenant meetings. ```yaml -Type: String -Parameter Sets: (All) +Type: Boolean +Parameter Sets: ("Enabled","Disabled") Aliases: Required: True Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -CopilotFromHomeTenant -Setting value of the Teams Multi-tenant Organization Setting. CopilotFromHomeTenant controls user access to Copilot license in their home tenant during cross-tenant meetings. +### -Identity +Identity of the Teams Multi-tenant Organization Setting. ```yaml -Type: Boolean -Parameter Sets: ("Enabled","Disabled") +Type: String +Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy.md index f7d01f2e45..4d76dd2327 100644 --- a/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnetworkroamingpolicy applicable: Microsoft Teams -title: Set-CsTeamsNetworkRoamingPolicy author: TristanChen-msft -ms.author: jiaych -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsnetworkroamingpolicy schema: 2.0.0 +title: Set-CsTeamsNetworkRoamingPolicy --- # Set-CsTeamsNetworkRoamingPolicy @@ -39,7 +39,7 @@ To enable the network roaming policy for users who are not Enterprise Voice enab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> Set-CsTeamsNetworkRoamingPolicy -Identity "RedmondRoaming" -AllowIPVideo $true -MediaBitRateKb 2000 -Description "Redmond campus roaming policy" ``` @@ -48,63 +48,63 @@ The command shown in Example 1 updates the teams network roaming policy with Id ## PARAMETERS -### -Identity -Unique identifier of the policy to be modified. +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. +Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPVideo -Determines whether video is enabled in a user's meetings or calls. -Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. +### -Description +Description of the policy to be edited. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings. +### -Identity +Unique identifier of the policy to be modified. ```yaml -Type: Integer +Type: XdsIdentity Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 50000 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the policy to be edited. +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. ```yaml -Type: String +Type: Integer Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: 50000 Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNotificationAndFeedsPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsNotificationAndFeedsPolicy.md index b5598c89ee..c4840eb91a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNotificationAndFeedsPolicy.md @@ -1,166 +1,167 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnotificationandfeedspolicy -title: Set-CsTeamsNotificationAndFeedsPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsNotificationAndFeedsPolicy - -## SYNOPSIS - -Modifies an existing Teams Notifications and Feeds Policy - -## SYNTAX - -```powershell -Set-CsTeamsNotificationAndFeedsPolicy [-Description ] [[-Identity] ] - [-SuggestedFeedsEnabledType ] [-TrendingFeedsEnabledType ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsNotificationAndFeedsPolicy Global -SuggestedFeedsEnabledType EnabledUserOverride -``` - -Change settings on an existing Notifications and Feeds Policy. - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Free format text - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier assigned to the policy when it was created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuggestedFeedsEnabledType - -The SuggestedFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about suggested activities and content within their Teams environment. When enabled, this parameter ensures that users are notified about recommended or relevant activities, helping them stay informed and engaged with important updates and interactions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrendingFeedsEnabledType - -The TrendingFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about trending activities within their Teams environment. When enabled, this parameter ensures that users are notified about popular or important activities, helping them stay informed about significant updates and interactions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsnotificationandfeedspolicy +schema: 2.0.0 +title: Set-CsTeamsNotificationAndFeedsPolicy +--- + +# Set-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS + +Modifies an existing Teams Notifications and Feeds Policy + +## SYNTAX + +```powershell +Set-CsTeamsNotificationAndFeedsPolicy [-Description ] [[-Identity] ] + [-SuggestedFeedsEnabledType ] [-TrendingFeedsEnabledType ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsNotificationAndFeedsPolicy Global -SuggestedFeedsEnabledType EnabledUserOverride +``` + +Change settings on an existing Notifications and Feeds Policy. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Free format text + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuggestedFeedsEnabledType + +The SuggestedFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about suggested activities and content within their Teams environment. When enabled, this parameter ensures that users are notified about recommended or relevant activities, helping them stay informed and engaged with important updates and interactions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrendingFeedsEnabledType + +The TrendingFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about trending activities within their Teams environment. When enabled, this parameter ensures that users are notified about popular or important activities, helping them stay informed about significant updates and interactions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRecordingRollOutPolicy.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsRecordingRollOutPolicy.md index f41ad5f975..657068267a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsrecordingrolloutpolicy -schema: 2.0.0 applicable: Microsoft Teams -title: Set-CsTeamsRecordingRollOutPolicy -manager: yujin1 author: ronwa +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams ms.author: ronwa +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsrecordingrolloutpolicy +schema: 2.0.0 +title: Set-CsTeamsRecordingRollOutPolicy --- # Set-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md index 171a3e9cd7..822eb17ae8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,225 +1,228 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsroomvideoteleconferencingpolicy -title: Set-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. - -## SYNTAX - -```powershell -Set-CsTeamsRoomVideoTeleConferencingPolicy [-AreaCode ] [-Description ] [-Enabled ] - [[-Identity] ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] - [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -AreaCode - -GUID provided by the CVI partner that the customer signed the agreement with - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled - -The policy can exist for the tenant but it can be enabled or disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the policy to be modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceExternalCalls - -The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceInternalCalls - -The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveExternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveInternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Set-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Set-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +``` +Set-CsTeamsRoomVideoTeleConferencingPolicy [-AreaCode ] [-Description ] [-Enabled ] + [[-Identity] ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] + [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## EXAMPLES + +## PARAMETERS + +### -AreaCode + +GUID provided by the CVI partner that the customer signed the agreement with + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + +The policy can exist for the tenant but it can be enabled or disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceExternalCalls + +The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceInternalCalls + +The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveExternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveInternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSettingsCustomApp.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSettingsCustomApp.md index 455aab2ff0..0cdb3de4bc 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSettingsCustomApp.md @@ -1,95 +1,96 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp -title: Set-CsTeamsSettingsCustomApp -schema: 2.0.0 ---- - -# Set-CsTeamsSettingsCustomApp - -## SYNOPSIS -Set the Custom Apps Setting's value of Teams Admin Center. - -## SYNTAX - -``` -Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -There is a switch for managing Custom Apps in the Org-wide App Settings page of Teams Admin Center. The command can set the value of this switch. If the isSideloadedAppsInteractionEnabled is set to true, the switch is enabled. So that the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled $True -``` - -Set the value of Custom Apps Setting to true. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -isSideloadedAppsInteractionEnabled -The value to Custom Apps Setting. If the value is true, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[Get-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssettingscustomapp +schema: 2.0.0 +title: Set-CsTeamsSettingsCustomApp +--- + +# Set-CsTeamsSettingsCustomApp + +## SYNOPSIS +Set the Custom Apps Setting's value of Teams Admin Center. + +## SYNTAX + +``` +Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +There is a switch for managing Custom Apps in the Org-wide App Settings page of Teams Admin Center. The command can set the value of this switch. If the isSideloadedAppsInteractionEnabled is set to true, the switch is enabled. So that the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled $True +``` + +Set the value of Custom Apps Setting to true. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -isSideloadedAppsInteractionEnabled +The value to Custom Apps Setting. If the value is true, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Get-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSharedCallingRoutingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSharedCallingRoutingPolicy.md index 31c805cfbb..d31630e75b 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSharedCallingRoutingPolicy.md @@ -1,15 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -title: Set-CsTeamsSharedCallingRoutingPolicy -schema: 2.0.0 author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: - +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy +schema: 2.0.0 +title: Set-CsTeamsSharedCallingRoutingPolicy --- # Set-CsTeamsSharedCallingRoutingPolicy @@ -45,17 +43,20 @@ The command shown in Example 1 removes the emergency callback number +1425555667 ## PARAMETERS -### -Identity -Unique identifier of the Teams shared calling routing policy to be created. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -98,69 +99,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceAccount -The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. +### -Force -The phone number assigned to the resource account must: -- Have the same phone number type and country as the emergency numbers configured in this policy instance. -- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. -- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. +> Applicable: Microsoft Teams -The same resource account can be used in multiple shared calling policy instances. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity +Unique identifier of the Teams shared calling routing policy to be created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -ResourceAccount +The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. + +The phone number assigned to the resource account must: +- Have the same phone number type and country as the emergency numbers configured in this policy instance. +- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) and the -LocationId parameter to set the location. +- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. + +The same resource account can be used in multiple shared calling policy instances. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -186,12 +190,12 @@ Shared Calling is not supported for Calling Plan service phone numbers in Romani This cmdlet was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS -[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy) -[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy) -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsAppPolicy.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsAppPolicy.md index abbbb97e70..e7b4818e46 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsAppPolicy.md @@ -1,133 +1,134 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsapppolicy -title: Set-CsTeamsShiftsAppPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsShiftsAppPolicy - -## SYNOPSIS - -Allows you to set or update properties of a Teams Shifts App Policy instance. - -## SYNTAX - -```powershell -Set-CsTeamsShiftsAppPolicy [-AllowTimeClockLocationDetection ] [[-Identity] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsShiftsAppPolicy 'Default' -AllowTimeClockLocationDetection $False -``` - -Change Settings on a Teams Shift App Policy (only works on Global policy) - -## PARAMETERS - -### -AllowTimeClockLocationDetection - -Turns on the location detection. The time report will indicate whether workers are "on location" when they clocked in and out. Workers are considered as "on location" if they clock in or out within a 200-meter radius of the set location. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Policy instance name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsapppolicy +schema: 2.0.0 +title: Set-CsTeamsShiftsAppPolicy +--- + +# Set-CsTeamsShiftsAppPolicy + +## SYNOPSIS + +Allows you to set or update properties of a Teams Shifts App Policy instance. + +## SYNTAX + +```powershell +Set-CsTeamsShiftsAppPolicy [-AllowTimeClockLocationDetection ] [[-Identity] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsShiftsAppPolicy 'Default' -AllowTimeClockLocationDetection $False +``` + +Change Settings on a Teams Shift App Policy (only works on Global policy) + +## PARAMETERS + +### -AllowTimeClockLocationDetection + +Turns on the location detection. The time report will indicate whether workers are "on location" when they clocked in and out. Workers are considered as "on location" if they clock in or out within a 200-meter radius of the set location. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Policy instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnection.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnection.md index dd1eca6bb1..af400016d9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Set-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnection schema: 2.0.0 +title: Set-CsTeamsShiftsConnection --- # Set-CsTeamsShiftsConnection @@ -168,6 +169,21 @@ In case of an error, you can capture the error response as follows: ## PARAMETERS +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Body The request body. @@ -214,7 +230,7 @@ Accept wildcard characters: False ``` ### -ConnectionId -The WFM connection ID for the instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +The WFM connection ID for the instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). ```yaml Type: String @@ -228,6 +244,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectorId +Used to specify the unique identifier of the connector being used for the connection. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +The connector-specific settings. + +```yaml +Type: IUpdateWfmConnectionRequestConnectorSpecificSettings +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HttpPipelineAppend SendAsync Pipeline Steps to be appended to the front of the pipeline. @@ -303,21 +364,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector-specific settings. - -```yaml -Type: IUpdateWfmConnectionRequestConnectorSpecificSettings -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Proxy The URI for the proxy server to use. @@ -394,51 +440,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorId -Used to specify the unique identifier of the connector being used for the connection. - -```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. - -```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -458,10 +459,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection) -[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection) -[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnection) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnectionInstance.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnectionInstance.md index eb62460fc0..45259a9d6d 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: leonardospina external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Set-CsTeamsShiftsConnectionInstance -author: leonardospina ms.author: lespina -manager: valk -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Set-CsTeamsShiftsConnectionInstance --- # Set-CsTeamsShiftsConnectionInstance @@ -165,6 +166,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectionId +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ConnectorAdminEmail Gets or sets the list of connector admin email addresses. @@ -193,8 +208,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId -Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -DesignatedActorId +Gets or sets the designated actor ID that App acts as for Shifts Graph API calls. ```yaml Type: String @@ -207,54 +222,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -Gets or sets the designated actor ID that App acts as for Shifts Graph API calls. +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -IfMatch +The value of the etag field as returned by the cmdlets. ```yaml Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Parameter Sets: (All) Aliases: Required: True Position: Named @@ -263,22 +279,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -InputObject +Identity Parameter. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: SetViaIdentityExpanded, SetViaIdentity Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SyncScenarioSwapRequest -The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Name +The connector instance name. ```yaml Type: String @@ -291,50 +307,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: Uri +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String @@ -347,40 +363,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -SyncFrequencyInMin +The sync frequency in minutes. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: Int32 +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The value of the etag field as returned by the cmdlets. +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: Required: True Position: Named @@ -389,22 +405,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: SetViaIdentityExpanded, SetViaIdentity +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connector instance name. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -417,50 +433,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Uri -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: PSCredential -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -473,11 +489,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin -The sync frequency in minutes. +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Int32 +Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: Required: True @@ -502,21 +518,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Etag -Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. - -```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -536,12 +537,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance) -[Update-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance) +[Update-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsPolicy.md index 6835a0dfa9..a87af15d4c 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsPolicy.md @@ -1,220 +1,235 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-teamsshiftspolicy -title: Set-CsTeamsShiftsPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. - -## SYNTAX - -```powershell -Set-CsTeamsShiftsPolicy [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] - [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] - [-EnableScheduleOwnerPermissions ] [-Identity] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance. Use this to set the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 -``` -In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", a warning message (Message 1) will always be displayed to the user on opening Teams during off shift hours. - -## PARAMETERS - -### -Identity -Policy instance name. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessType -Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. -Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. -For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: UnrestrictedAccess_TeamsApp -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageType -The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. -'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. -'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. -'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. -'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. -'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. -'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. -'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. -'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. -'CustomMessage' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: DefaultMessage -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageCustom -Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeFrequency -Frequency of warning dialog displayed when user opens Teams. Set one of Always, ShowOnceOnChange, Never. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: Always -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessGracePeriodMinutes -Indicates the grace period time in minutes between when the first shift starts, or last shift ends and when access is blocked. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableScheduleOwnerPermissions -Indicates whether a user can manage a Shifts schedule as a team member. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teamsshiftspolicy +schema: 2.0.0 +title: Set-CsTeamsShiftsPolicy +--- + +# Set-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. + +## SYNTAX + +```powershell +Set-CsTeamsShiftsPolicy [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] + [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] + [-EnableScheduleOwnerPermissions ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance. Use this to set the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 +``` +In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", a warning message (Message 1) will always be displayed to the user on opening Teams during off shift hours. + +## PARAMETERS + +### -AccessGracePeriodMinutes + +> Applicable: Microsoft Teams + +Indicates the grace period time in minutes between when the first shift starts, or last shift ends and when access is blocked. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessType + +> Applicable: Microsoft Teams + +Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. +Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. +For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: UnrestrictedAccess_TeamsApp +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableScheduleOwnerPermissions + +> Applicable: Microsoft Teams + +Indicates whether a user can manage a Shifts schedule as a team member. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Microsoft Teams + +Policy instance name. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeFrequency + +> Applicable: Microsoft Teams + +Frequency of warning dialog displayed when user opens Teams. Set one of Always, ShowOnceOnChange, Never. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: Always +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageCustom + +> Applicable: Microsoft Teams + +Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageType + +> Applicable: Microsoft Teams + +The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. +'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. +'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. +'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. +'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. +'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. +'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. +'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. +'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. +'CustomMessage' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: DefaultMessage +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSipDevicesConfiguration.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSipDevicesConfiguration.md index 2163f1d2f1..2c1924c3f9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSipDevicesConfiguration.md @@ -1,11 +1,12 @@ --- +author: anmandav external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsSipDevicesConfiguration -author: anmandav ms.author: anmandav -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssipdevicesconfiguration +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssipdevicesconfiguration schema: 2.0.0 +title: Set-CsTeamsSipDevicesConfiguration --- # Set-CsTeamsSipDevicesConfiguration @@ -102,4 +103,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamssipdevicesconfiguration) +[Get-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamssipdevicesconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliance.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliance.md index 49fabb2ff1..fbba72c88f 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliance.md @@ -1,135 +1,140 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliance -title: Set-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# Set-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Set-CsTeamsSurvivableBranchAppliance [-Description ] [[-Identity] ] [-Site ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Description of the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -The TenantNetworkSite where the SBA is located. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssurvivablebranchappliance +schema: 2.0.0 +title: Set-CsTeamsSurvivableBranchAppliance +--- + +# Set-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Changes the Survivable Branch Appliance (SBA) configuration settings for the specified tenant. + +## SYNTAX + +``` +Set-CsTeamsSurvivableBranchAppliance [-Description ] [[-Identity] ] [-Site ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site + +The TenantNetworkSite where the SBA is located. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliancePolicy.md index fe8cc3c54b..1e1e1de51b 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,119 +1,124 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliancepolicy -title: Set-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Set-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Set-CsTeamsSurvivableBranchAppliancePolicy [-BranchApplianceFqdns ] [[-Identity] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -BranchApplianceFqdns - -The FQDN of the SBA(s) in the site. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Set-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Set-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Changes the Survivable Branch Appliance (SBA) Policy configuration settings for the specified tenant. + +## SYNTAX + +``` +Set-CsTeamsSurvivableBranchAppliancePolicy [-BranchApplianceFqdns ] [[-Identity] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -BranchApplianceFqdns + +The FQDN of the SBA(s) in the site. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTargetingPolicy.md similarity index 89% rename from teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsTargetingPolicy.md index f1e5d3000d..ccb2bcac75 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTargetingPolicy.md @@ -1,204 +1,202 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy -title: Set-CsTeamsTargetingPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsTargetingPolicy - -## SYNOPSIS - -The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. - -## SYNTAX - -```powershell -Set-CsTeamsTargetingPolicy [-CustomTagsMode ] [-Description ] [[-Identity] ] - [-ManageTagsPermissionMode ] [-ShiftBackedTagsMode ] [-SuggestedPresetTags ] - [-TeamOwnersEditWhoCanManageTagsMode ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. - -The Set-CsTeamsTargetingPolicy cmdlet allows administrators to update existing Tenant tag settings that can be assigned to particular teams to control Team features related to tags. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsTargetingPolicy -Identity NewTagPolicy -CustomTagsMode Enabled -``` - -The command shown in Example 1 uses the Set-CsTeamsTargetingPolicy cmdlet to update an existing Tenant tag setting with the CustomTagsMode Enabled. This flag will enable Teams users to create tags. - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomTagsMode - -Determine whether Teams users can create tags in team. Set this to Enabled to allow users to create new tags. Set this to Disabled to prohibit them from creating new tags. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Pass in a new description if that field needs to be updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Name of the policy instance to be updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManageTagsPermissionMode - -Determine whether team users can manage tag settings in Teams. Set this to EnabledTeamOwner to only allow Teams owners to manage tag settings in current Teams. Set this to EnabledTeamOwnerMember to allow Teams owners and Teams members to manage tag settings in current Teams. Set this to EnabledTeamOwnerMemberGuest to allow Teams owners, Teams members and guest users to manage tag settings in current Teams. Set this to MicrosoftDefault to user default setting in current Teams, which will be the same as EnabledTeamOwner. Set this to Disabled to prohibit all users from managing tag settings in current Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftBackedTagsMode - -Determine whether Teams can have tags created by Shift App. Set this to Enabled to allow tags created by Shift App. Set this to Disabled to prohibit tags from Shift App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamOwnersEditWhoCanManageTagsMode - -Determine whether Teams owners can change Tenant tag settings. Set this to Enabled to allow Teams owners to change Tenant tag settings for current Teams. Set this to Disabled to prohibit them from changing Tenant tag settings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) -[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstargetingpolicy +schema: 2.0.0 +title: Set-CsTeamsTargetingPolicy +--- + +# Set-CsTeamsTargetingPolicy + +## SYNOPSIS +The Set-CsTeamsTargetingPolicy cmdlet allows administrators to update existing Tenant tag settings that can be assigned to particular teams to control Team features related to tags. + +## SYNTAX + +```powershell +Set-CsTeamsTargetingPolicy [-CustomTagsMode ] [-Description ] [[-Identity] ] + [-ManageTagsPermissionMode ] [-ShiftBackedTagsMode ] [-SuggestedPresetTags ] + [-TeamOwnersEditWhoCanManageTagsMode ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsTargetingPolicy -Identity NewTagPolicy -CustomTagsMode Enabled +``` + +The command shown in Example 1 uses the Set-CsTeamsTargetingPolicy cmdlet to update an existing Tenant tag setting with the CustomTagsMode Enabled. This flag will enable Teams users to create tags. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomTagsMode + +Determine whether Teams users can create tags in team. Set this to Enabled to allow users to create new tags. Set this to Disabled to prohibit them from creating new tags. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Pass in a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageTagsPermissionMode + +Determine whether team users can manage tag settings in Teams. Set this to EnabledTeamOwner to only allow Teams owners to manage tag settings in current Teams. Set this to EnabledTeamOwnerMember to allow Teams owners and Teams members to manage tag settings in current Teams. Set this to EnabledTeamOwnerMemberGuest to allow Teams owners, Teams members and guest users to manage tag settings in current Teams. Set this to MicrosoftDefault to user default setting in current Teams, which will be the same as EnabledTeamOwner. Set this to Disabled to prohibit all users from managing tag settings in current Teams. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftBackedTagsMode + +Determine whether Teams can have tags created by Shift App. Set this to Enabled to allow tags created by Shift App. Set this to Disabled to prohibit tags from Shift App. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamOwnersEditWhoCanManageTagsMode + +Determine whether Teams owners can change Tenant tag settings. Set this to Enabled to allow Teams owners to change Tenant tag settings for current Teams. Set this to Disabled to prohibit them from changing Tenant tag settings. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTemplatePermissionPolicy.md similarity index 85% rename from teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsTemplatePermissionPolicy.md index 8aa49764df..7f08503422 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTemplatePermissionPolicy.md @@ -1,155 +1,155 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy -title: Set-CsTeamsTemplatePermissionPolicy -author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: -manager: weiliu2 -schema: 2.0.0 ---- - -# Set-CsTeamsTemplatePermissionPolicy - -## SYNOPSIS -This cmdlet updates an existing TeamsTemplatePermissionPolicy. - -## SYNTAX - -``` -Set-CsTeamsTemplatePermissionPolicy - [-HiddenTemplates ] - [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Updates any of the properties of an existing instance of the TeamsTemplatePermissionPolicy. - -## EXAMPLES - -### Example 1 -```powershell -PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent -PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject -PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) -PS >Set-CsTeamsTemplatePermissionPolicy -Identity Global -HiddenTemplates $HiddenList -``` - -Updates the hidden templates array. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Adds a new description if that field needs to be updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. - -You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenTemplates -The updated list of Teams template IDs to hide. -The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). - -```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Name of the policy instance to be updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) - -[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) - -[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) +--- +author: yishuaihuang4 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy +schema: 2.0.0 +title: Set-CsTeamsTemplatePermissionPolicy +--- + +# Set-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +This cmdlet updates an existing TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +Set-CsTeamsTemplatePermissionPolicy + [-HiddenTemplates ] + [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Updates any of the properties of an existing instance of the TeamsTemplatePermissionPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) +PS >Set-CsTeamsTemplatePermissionPolicy -Identity Global -HiddenTemplates $HiddenList +``` + +Updates the hidden templates array. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Adds a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenTemplates +The updated list of Teams template IDs to hide. +The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamshiddentemplate). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy) + +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTranslationRule.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsTranslationRule.md index 64bcdc16c5..dc6fa66265 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule applicable: Microsoft Teams -title: Set-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstranslationrule +schema: 2.0.0 +title: Set-CsTeamsTranslationRule --- # Set-CsTeamsTranslationRule @@ -36,16 +37,16 @@ This example modifies the rule that initially configured to strip +1206555 from ## PARAMETERS -### -Identity -Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -66,8 +67,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Pattern -A regular expression that caller or callee number must match in order for this rule to be applied. +### -Identity +Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. ```yaml Type: String @@ -75,14 +76,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Translation -The regular expression pattern that will be applied to the number to convert it. +### -Pattern +A regular expression that caller or callee number must match in order for this rule to be applied. ```yaml Type: String @@ -96,13 +97,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. +### -Translation +The regular expression pattern that will be applied to the number to convert it. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -111,13 +112,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -136,10 +137,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstranslationrule) -[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstranslationrule) -[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamstranslationrule) -[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUnassignedNumberTreatment.md similarity index 72% rename from teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsUnassignedNumberTreatment.md index 75ea8483a8..78d34f0671 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUnassignedNumberTreatment.md @@ -1,166 +1,217 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment -applicable: Microsoft Teams -title: Set-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsTeamsUnassignedNumberTreatment - -## SYNOPSIS -Changes a treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. - -## SYNTAX - -``` -Set-CsTeamsUnassignedNumberTreatment [[-Identity] ] [-Description ] [-Pattern ] [-Target ] [-TargetType ] - [-TreatmentPriority ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet changes a treatment for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa2@contoso.com).ObjectId -Set-CsTeamsUnassignedNumberTreatment -Identity MainAA -Target $RAObjectId -``` -This example changes the treatment MainAA to route the calls to the resource account aa2@contoso.com. - -### Example 2 -```powershell -$UserObjectId = (Get-CsOnlineUser -Identity user2@contoso.com).Identity -Set-CsTeamsUnassignedNumberTreatment -Identity User2PSTN -TargetType User -Target $UserObjectId -``` -This example changes the treatment User2PSTN to route the calls to the user user2@contoso.com. - -## PARAMETERS - -### -Description -Free format description of this treatment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Id of the specific treatment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern -A regular expression that the called number must match in order for the treatment to take effect. It is best practice to start the regular expression with the hat character and end it with the dollar character. -You can use various regular expression test sites on the Internet to validate the expression. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetType -The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatmentPriority -The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - -```yaml -Type: System.Integer -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.5.1 or later. - -Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. - -To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. - -To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. - -If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to -the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains -a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. - -## RELATED LINKS -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) - -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) - -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) - -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) - -[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment +schema: 2.0.0 +title: Set-CsTeamsUnassignedNumberTreatment +--- + +# Set-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +Changes a treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. + +## SYNTAX + +``` +Set-CsTeamsUnassignedNumberTreatment [-Description ] [[-Identity] ] [-Pattern ] + [-Target ] [-TargetType ] [-TreatmentPriority ] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet changes a treatment for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa2@contoso.com).ObjectId +Set-CsTeamsUnassignedNumberTreatment -Identity MainAA -Target $RAObjectId +``` +This example changes the treatment MainAA to route the calls to the resource account aa2@contoso.com. + +### Example 2 +```powershell +$UserObjectId = (Get-CsOnlineUser -Identity user2@contoso.com).Identity +Set-CsTeamsUnassignedNumberTreatment -Identity User2PSTN -TargetType User -Target $UserObjectId +``` +This example changes the treatment User2PSTN to route the calls to the user user2@contoso.com. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free format description of this treatment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the specific treatment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that the called number must match in order for the treatment to take effect. It is best practice to start the regular expression with the hat character and end it with the dollar character. +You can use various regular expression test sites on the Internet to validate the expression. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetType +The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatmentPriority +The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. + +To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. + +To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. + +If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to +the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains +a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. + +## RELATED LINKS +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/microsoftteams/import-csonlineaudiofile) + +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment) + +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment) + +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment) + +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpdateManagementPolicy.md similarity index 98% rename from teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpdateManagementPolicy.md index 5d5806b15b..0adf083515 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsupdatemanagementpolicy applicable: Microsoft Teams -title: Set-CsTeamsUpdateManagementPolicy -schema: 2.0.0 author: vargasj-ms -ms.author: vargasj +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: gnamun +Module Name: MicrosoftTeams +ms.author: vargasj +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsupdatemanagementpolicy +schema: 2.0.0 +title: Set-CsTeamsUpdateManagementPolicy --- # Set-CsTeamsUpdateManagementPolicy @@ -41,41 +42,6 @@ In this example, the policy "Campaign Policy" is modified, disabling the in-prod ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledInProductMessages -List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: - -| ID | Campaign Category | -| -- | -- | -| 91382d07-8b89-444c-bbcb-cfe43133af33 | What's New | -| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | - -```yaml -Type: System.Management.Automation.PSListModifier`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowManagedUpdates Enables/Disables managed updates for the user. @@ -165,6 +131,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. @@ -181,12 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateDayOfWeek +### -DisabledInProductMessages +List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: - Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. +| ID | Campaign Category | +| -- | -- | +| 91382d07-8b89-444c-bbcb-cfe43133af33 | What's New | +| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | ```yaml -Type: Int64 +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) Aliases: @@ -197,12 +182,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTime - -Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -213,12 +197,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTimeOfDay +### -Identity +The unique identifier of the policy. -Machine local time. Can be set only when AllowManagedUpdates is set to True +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OCDIRedirect +This setting controls whether users are redirected from teams.microsoft.com to the unified domain teams.cloud.microsoft. Possible values are: +- **Microsoft Default**, Microsoft will manage redirection behavior. If no explicit admin configuration is set, users may be redirected automatically. +- **Disabled**, Users will remain on teams.microsoft.com. Use this if your organization's apps are incompatible with the unified domain. +- **Enabled**, Users will be redirected to teams.cloud.microsoft. Use this only if your organization had previously opted out of redirection and now wants to opt back in. ```yaml -Type: DateTime +Type: String Parameter Sets: (All) Aliases: @@ -229,17 +229,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNewTeamsClient +### -UpdateDayOfWeek -This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. - If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. - If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. - If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. - If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. - If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. + Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. ```yaml -Type: String +Type: Int64 Parameter Sets: (All) Aliases: @@ -250,11 +245,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OCDIRedirect -This setting controls whether users are redirected from teams.microsoft.com to the unified domain teams.cloud.microsoft. Possible values are: -- **Microsoft Default**, Microsoft will manage redirection behavior. If no explicit admin configuration is set, users may be redirected automatically. -- **Disabled**, Users will remain on teams.microsoft.com. Use this if your organization's apps are incompatible with the unified domain. -- **Enabled**, Users will be redirected to teams.cloud.microsoft. Use this only if your organization had previously opted out of redirection and now wants to opt back in. +### -UpdateTime + +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. + ```yaml Type: String Parameter Sets: (All) @@ -267,11 +261,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) Aliases: @@ -282,16 +277,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The unique identifier of the policy. +### -UseNewTeamsClient + +This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. + If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. + If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. + If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. + If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. + If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpgradeConfiguration.md similarity index 86% rename from teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpgradeConfiguration.md index 001f0dbe19..26d730b4a6 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpgradeConfiguration.md @@ -1,15 +1,17 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration applicable: Microsoft Teams -title: Set-CsTeamsUpgradeConfiguration +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsupgradeconfiguration schema: 2.0.0 +title: Set-CsTeamsUpgradeConfiguration --- # Set-CsTeamsUpgradeConfiguration ## SYNOPSIS -Administrators can use Set-CsTeamsUpgradeConfiguration to manage certain aspects of client behavior for users being upgraded from Skype for Business to Teams. TeamsUpgradeConfiguration should be used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. It allows administrators to determine which application end users should use to join Skype for Business meetings. +Manage certain aspects of client behavior for users being upgraded from Skype for Business to Teams. ## SYNTAX @@ -43,14 +45,15 @@ The above cmdlet specifies that users subject to upgrade should download Teams i ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -BlockLegacyAuthorization +This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. +If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. +If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -59,44 +62,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DownloadTeams -The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This Boolean setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SfBMeetingJoinUx -The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: "SkypeMeetingsApp" and "NativeLimitedClient". "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. + +### -DownloadTeams + +> Applicable: Microsoft Teams + +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This Boolean setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. ```yaml -Type: string +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: NativeLimitedClient +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -106,13 +116,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + For internal use only. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 1 @@ -121,31 +133,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal use only. +### -SfBMeetingJoinUx + +> Applicable: Microsoft Teams + +The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: "SkypeMeetingsApp" and "NativeLimitedClient". "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. ```yaml -Type: Guid +Type: string Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: NativeLimitedClient Accept pipeline input: False Accept wildcard characters: False ``` +### -Tenant -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +> Applicable: Microsoft Teams + +For internal use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -154,15 +168,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockLegacyAuthorization -This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. -If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. -If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users - +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -187,10 +203,10 @@ These settings are only honored by newer versions of Skype for Business clients. ## RELATED LINKS -[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradeconfiguration) +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradeconfiguration) -[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsupgradepolicy) -[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsupgradepolicy) [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVdiPolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsVdiPolicy.md index 5c21d8c52c..d853f4cc48 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVdiPolicy.md @@ -1,165 +1,164 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-cteamsvdipolicy -title: Set-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsVdiPolicy - -## SYNOPSIS -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -```powershell -Set-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] - [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" -``` - -The command shown in Example 1 uses the Set-CsTeamsVdiPolicy cmdlet to update an existing vdi policy with the Identity RestrictedUserPolicy. This policy will use all the existing values except one: VDI2Optimization; in this example, users with this policy can not be in VDI 2.0 optimized. - -### Example 2 -```powershell -PS C:\> Set-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True -``` - -In Example 2, the Set-CsTeamsVdiPolicy cmdlet is used to update a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the existing values. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAudioVideoInCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VDI2Optimization -Determines whether a user can be VDI 2.0 optimized. -* Enabled - allow a user to be VDI 2.0 optimized. -* Disabled - disallow a user to be VDI 2.0 optimized. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cteamsvdipolicy +schema: 2.0.0 +title: Set-CsTeamsVdiPolicy +--- + +# Set-CsTeamsVdiPolicy + +## SYNOPSIS +The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. + +## SYNTAX + +```powershell +Set-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] + [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" +``` + +The command shown in Example 1 uses the Set-CsTeamsVdiPolicy cmdlet to update an existing vdi policy with the Identity RestrictedUserPolicy. This policy will use all the existing values except one: VDI2Optimization; in this example, users with this policy can not be in VDI 2.0 optimized. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True +``` + +In Example 2, the Set-CsTeamsVdiPolicy cmdlet is used to update a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the existing values. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAudioVideoInCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VDI2Optimization +Determines whether a user can be VDI 2.0 optimized. +* Enabled - allow a user to be VDI 2.0 optimized. +* Disabled - disallow a user to be VDI 2.0 optimized. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVirtualAppointmentsPolicy.md similarity index 86% rename from teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsVirtualAppointmentsPolicy.md index 363ba6ac2f..920e382332 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy -title: Set-CsTeamsVirtualAppointmentsPolicy -schema: 2.0.0 -author: emmanuelrocha001 ms.author: erocha -manager: sonaggarwal +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy +schema: 2.0.0 +title: Set-CsTeamsVirtualAppointmentsPolicy --- # Set-CsTeamsVirtualAppointmentsPolicy @@ -52,13 +53,15 @@ Accept wildcard characters: False ``` ### -EnableSmsNotifications + +> Applicable: Microsoft Teams + This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment template meeting. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -126,10 +129,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy) -[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVoiceApplicationsPolicy.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsVoiceApplicationsPolicy.md index e39d07bd9a..00e6906d85 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy -title: Set-CsTeamsVoiceApplicationsPolicy +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy schema: 2.0.0 +title: Set-CsTeamsVoiceApplicationsPolicy --- # Set-CsTeamsVoiceApplicationsPolicy @@ -74,9 +75,9 @@ The command shown in Example 1 sets allowing CQ overflow shared voicemail greeti ## PARAMETERS -### -AllowAutoAttendantBusinessHoursGreetingChange +### -AllowAutoAttendantAfterHoursGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. ```yaml Type: Boolean @@ -90,9 +91,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursGreetingChange +### -AllowAutoAttendantAfterHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. ```yaml Type: Boolean @@ -106,9 +107,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayGreetingChange +### -AllowAutoAttendantBusinessHoursChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. ```yaml Type: Boolean @@ -122,9 +123,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursChange +### -AllowAutoAttendantBusinessHoursGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -138,9 +139,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidaysChange +### -AllowAutoAttendantBusinessHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. ```yaml Type: Boolean @@ -154,11 +155,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantTimeZoneChange - -_This feature is not currently available to authorized users._ +### -AllowAutoAttendantHolidayGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. ```yaml Type: Boolean @@ -172,11 +171,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantLanguageChange - -_This feature is not currently available to authorized users._ +### -AllowAutoAttendantHolidayRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. ```yaml Type: Boolean @@ -190,9 +187,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursRoutingChange +### -AllowAutoAttendantHolidaysChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. ```yaml Type: Boolean @@ -206,9 +203,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursRoutingChange +### -AllowAutoAttendantLanguageChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. ```yaml Type: Boolean @@ -222,9 +221,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayRoutingChange +### -AllowAutoAttendantTimeZoneChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. ```yaml Type: Boolean @@ -238,9 +239,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange +### -AllowCallQueueAgentOptChange -When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. ```yaml Type: Boolean @@ -254,9 +255,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMusicOnHoldChange +### -AllowCallQueueConferenceModeChange -When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. ```yaml Type: Boolean @@ -270,9 +271,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowSharedVoicemailGreetingChange +### -AllowCallQueueLanguageChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. ```yaml Type: Boolean @@ -286,9 +289,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutSharedVoicemailGreetingChange +### -AllowCallQueueMembershipChange -When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. ```yaml Type: Boolean @@ -302,11 +305,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentSharedVoicemailGreetingChange - -_This feature is not currently available to authorized users._ +### -AllowCallQueueMusicOnHoldChange -When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -320,11 +321,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange _This feature is not currently available to authorized users._ -When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. +When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. ```yaml Type: Boolean @@ -338,9 +339,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMembershipChange +### -AllowCallQueueNoAgentsRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -354,9 +355,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +### -AllowCallQueueOptOutChange -When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. ```yaml Type: Boolean @@ -370,9 +371,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueRoutingMethodChange +### -AllowCallQueueOverflowRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. ```yaml Type: Boolean @@ -386,9 +387,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueuePresenceBasedRoutingChange +### -AllowCallQueueOverflowSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -402,9 +403,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOptOutChange +### -AllowCallQueuePresenceBasedRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. +When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. ```yaml Type: Boolean @@ -418,9 +419,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowRoutingChange +### -AllowCallQueueRoutingMethodChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. ```yaml Type: Boolean @@ -450,9 +451,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentsRoutingChange +### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -466,9 +467,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueAgentOptChange +### -AllowCallQueueWelcomeGreetingChange -When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -484,6 +485,8 @@ Accept wildcard characters: False ### -CallQueueAgentMonitorMode +> Applicable: Microsoft Teams + PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor call sessions. @@ -500,7 +503,6 @@ When set to `Takeover`, users affected by the policy will be allowed to monitor Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -511,6 +513,8 @@ Accept wildcard characters: False ### -CallQueueAgentMonitorNotificationMode +> Applicable: Microsoft Teams + PARAMVALUE: Disabled | Agent When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor agents during call sessions. @@ -521,7 +525,6 @@ When set to `Agent`, users affected by the policy will be allowed to monitor age Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -530,22 +533,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAutoAttendantMetricsPermission - -PARAMVALUE: Disabled | AuthorizedOnly | All - -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. - -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. +### -Confirm -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` will not be able to access real-time metrics. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Object -Parameter Sets: Dual -Aliases: -applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -554,22 +549,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeCallQueueMetricsPermission +### -HistoricalAgentMetricsPermission + +> Applicable: Microsoft Teams PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` will not be able to access real-time metrics. +When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -578,22 +573,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAgentMetricsPermission +### -HistoricalAutoAttendantMetricsPermission + +> Applicable: Microsoft Teams PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` will not be able to access real-time metrics. +When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -602,21 +597,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalAutoAttendantMetricsPermission +### -HistoricalCallQueueMetricsPermission + +> Applicable: Microsoft Teams PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. -When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. -When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. +When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -625,44 +621,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalCallQueueMetricsPermission +### -Identity -PARAMVALUE: Disabled | AuthorizedOnly | All +Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: -When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. +-Identity global -When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. +To refer to a per-user policy, use syntax similar to this: -When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. +-Identity "SDA-Allow-All" + +If you do not specify an Identity, then the `Set-CsTeamsVoiceApplicationsPolicy` cmdlet will modify the global policy. ```yaml -Type: Object -Parameter Sets: Dual +Type: String +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalAgentMetricsPermission +### -RealTimeAgentMetricsPermission + +> Applicable: Microsoft Teams PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. -When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. -When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` will not be able to access real-time metrics. ```yaml Type: Object Parameter Sets: Dual Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -671,39 +670,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity +### -RealTimeAutoAttendantMetricsPermission -Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: +> Applicable: Microsoft Teams --Identity global +PARAMVALUE: Disabled | AuthorizedOnly | All -To refer to a per-user policy, use syntax similar to this: +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. --Identity "SDA-Allow-All" +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. -If you do not specify an Identity, then the `Set-CsTeamsVoiceApplicationsPolicy` cmdlet will modify the global policy. +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` will not be able to access real-time metrics. ```yaml -Type: String -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -RealTimeCallQueueMetricsPermission -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +> Applicable: Microsoft Teams + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` will not be able to access real-time metrics. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: Object +Parameter Sets: Dual +Aliases: Required: False Position: Named @@ -712,14 +720,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -WhatIf -Prompts you for confirmation before running the cmdlet. +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -742,10 +751,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy) -[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy) -[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLoadPolicy.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLoadPolicy.md index 1db49482a3..74dcf437f0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLoadPolicy.md @@ -1,239 +1,240 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy -title: Set-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet sets the Teams Workload Policy value for current tenant. - -## SYNTAX - -```powershell -Set-CsTeamsWorkLoadPolicy [-AllowCalling ] [-AllowCallingPinned ] [-AllowMeeting ] - [-AllowMeetingPinned ] [-AllowMessaging ] [-AllowMessagingPinned ] - [-Description ] [[-Identity] ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsWorkLoadPolicy -Identity Global -AllowCalling Disabled -``` - -This sets the Teams Workload Policy Global value of AllowCalling to disabled. - -## PARAMETERS - -### -AllowCalling - -Determines if calling workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallingPinned - -Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeeting - -Determines if meetings workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetingPinned - -Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessaging - -Determines if messaging workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessagingPinned - -Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -The description of the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the Teams Work Load Policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworkloadpolicy +schema: 2.0.0 +title: Set-CsTeamsWorkLoadPolicy +--- + +# Set-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet sets the Teams Workload Policy value for current tenant. + +## SYNTAX + +```powershell +Set-CsTeamsWorkLoadPolicy [-AllowCalling ] [-AllowCallingPinned ] [-AllowMeeting ] + [-AllowMeetingPinned ] [-AllowMessaging ] [-AllowMessagingPinned ] + [-Description ] [[-Identity] ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsWorkLoadPolicy -Identity Global -AllowCalling Disabled +``` + +This sets the Teams Workload Policy Global value of AllowCalling to disabled. + +## PARAMETERS + +### -AllowCalling + +Determines if calling workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallingPinned + +Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeeting + +Determines if meetings workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingPinned + +Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessaging + +Determines if messaging workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessagingPinned + +Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +The description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Teams Work Load Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLocationDetectionPolicy.md similarity index 88% rename from teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLocationDetectionPolicy.md index 176485db17..a00018cf97 100644 --- a/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy -title: Set-CsTeamsWorkLocationDetectionPolicy -schema: 2.0.0 -author: artemiykozlov ms.author: arkozlov -manager: prashibadkur +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy +schema: 2.0.0 +title: Set-CsTeamsWorkLocationDetectionPolicy --- # Set-CsTeamsWorkLocationDetectionPolicy @@ -127,10 +128,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy) -[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy) -[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy) -[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers.md similarity index 93% rename from teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers.md index 616604a4f9..05aba88905 100644 --- a/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantblockedcallingnumbers applicable: Microsoft Teams -title: Set-CsTenantBlockedCallingNumbers -schema: 2.0.0 author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantblockedcallingnumbers +schema: 2.0.0 +title: Set-CsTenantBlockedCallingNumbers --- # Set-CsTenantBlockedCallingNumbers @@ -45,28 +47,28 @@ To get the current tenant blocked calling numbers setting, use Get-CsTenantBlock ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTenantBlockedCallingNumbers -Enabled $false ``` This example turns off the tenant blocked calling numbers setting. No inbound number will be blocked from this feature. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsTenantBlockedCallingNumbers -Enabled $true ``` This example turns on the tenant blocked calling numbers setting. Inbound calls will be blocked based on the list of blocked number patterns. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsTenantBlockedCallingNumbers -Name "MyCustomBlockedCallingNumbersName" ``` This example renames the current blocked calling numbers with "MyCustomBlockedCallingNumbersName". No change is made besides the Name field change. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsTenantBlockedCallingNumbers -InboundBlockedNumberPatterns @((New-CsInboundBlockedNumberPattern -Name "AnonymousBlockedPattern" -Enabled $true -Pattern "^(?!)Anonymous")) ``` @@ -77,21 +79,6 @@ Note that if the current InboundBlockedNumberPatterns already contains a list of ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier which identifies the TenantBlockedCallingNumbers to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -137,6 +124,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +The Identity parameter is a unique identifier which identifies the TenantBlockedCallingNumbers to set. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InboundBlockedNumberPatterns The InboundBlockedNumberPatterns parameter contains the list of InboundBlockedNumberPatterns. @@ -242,6 +244,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers) -[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Set-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantDialPlan.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantDialPlan.md index 1df48b83dc..0a54df8656 100644 --- a/teams/teams-ps/teams/Set-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan applicable: Microsoft Teams -title: Set-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantdialplan +schema: 2.0.0 +title: Set-CsTenantDialPlan --- # Set-CsTenantDialPlan @@ -67,13 +68,15 @@ Finally, we pass the variable back to the NormalizationRules parameter of the `S ## PARAMETERS ### -Confirm + +> Applicable: Microsoft Teams + The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. Maximum characters is 1040. @@ -90,7 +96,6 @@ Maximum characters is 1040. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -116,8 +123,11 @@ Accept wildcard characters: False ``` ### -NormalizationRules + +> Applicable: Microsoft Teams + The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. -Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet, which creates the rule and assigns it to the specified tenant dial plan. +Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csvoicenormalizationrule) cmdlet, which creates the rule and assigns it to the specified tenant dial plan. The number of normalization rules cannot exceed 50 per TenantDialPlan. @@ -125,7 +135,6 @@ The number of normalization rules cannot exceed 50 per TenantDialPlan. Type: List Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -SimpleName + +> Applicable: Microsoft Teams + The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. This string can be up to 49 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), and parentheses (()). @@ -143,7 +155,6 @@ This string can be up to 49 characters long. Valid characters are alphabetic or Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -153,13 +164,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -181,10 +194,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/grant-cstenantdialplan) -[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantdialplan) -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan) -[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantdialplan) diff --git a/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantFederationConfiguration.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantFederationConfiguration.md index c881b93707..cdc8e8077b 100644 --- a/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantFederationConfiguration.md @@ -1,24 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration applicable: Microsoft Teams -title: Set-CsTenantFederationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: williamlooney ms.date: 12/11/2024 +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantfederationconfiguration +schema: 2.0.0 +title: Set-CsTenantFederationConfiguration --- # Set-CsTenantFederationConfiguration ## SYNOPSIS -> [!NOTE] -> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter AllowPublicUsers can no longer be used. - Manages federation configuration settings for your Skype for Business Online tenants. -These settings are used to determine which domains (if any) your users are allowed to communicate with. ## SYNTAX @@ -43,6 +41,9 @@ Set-CsTenantFederationConfiguration [-Tenant ] [-AllowedDomains [!NOTE] +> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter AllowPublicUsers can no longer be used. + Federation is a service that enables users to exchange IM and presence information with users from other domains. With Skype for Business Online, administrators can use the federation configuration settings to govern: @@ -56,7 +57,7 @@ However, administrators must use the `Set-CsTenantPublicProvider` cmdlet in orde ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -70,7 +71,7 @@ This domain object is stored in a variable named $x. The second command in the example then uses the `Set-CsTenantFederationConfiguration` cmdlet to update the blocked domains list. Using the Replace method ensures that the existing blocked domains list will be replaced by the new list: a list that contains only the domain fabrikam.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -83,7 +84,7 @@ The resulting domain object is then stored in a variable named $x. The second command in the example then uses the `Set-CsTenantFederationConfiguration` cmdlet and the Remove method to remove fabrikam.com from the blocked domains list for the specified tenant. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -96,7 +97,7 @@ This object is stored in a variable named $x. After the domain object has been created, the second command then uses the `Set-CsTenantFederationConfiguration` cmdlet and the Add method to add fabrikam.com to any domains already on the blocked domains list. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Set-CsTenantFederationConfiguration -BlockedDomains $Null ``` @@ -105,7 +106,7 @@ Example 5 shows how you can remove all the domains assigned to the blocked domai To do this, simply include the BlockedDomains parameter and set the parameter value to null ($Null). When this command completes, the blocked domain list will be cleared. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -117,7 +118,7 @@ Example 6 shows how you can replace domains in the Allowed Domains using a List First, a List collection is created and domains are added to it, then, simply include the AllowedDomainsAsAList parameter and set the parameter value to the List object. When this command completes, the allowed domains list will be replaced with those domains. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -128,7 +129,7 @@ Set-CsTenantFederationConfiguration -AllowedDomainsAsAList @{Add=$list} Example 7 shows how you can add domains to the existing Allowed Domains using a List object. First, a List is created and domains are added to it, then use the Add method in the AllowedDomainsAsAList parameter to add the domains to the existing allowed domains list. When this command completes, the domains in the list will be added to any domains already on the AllowedDomains list. -### -------------------------- Example 8 -------------------------- +### Example 8 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -139,14 +140,14 @@ Set-CsTenantFederationConfiguration -AllowedDomainsAsAList @{Remove=$list} Example 8 shows how you can remove domains from the existing Allowed Domains using a List object. First, a List is created and domains are added to it, then use the Remove method in the AllowedDomainsAsAList parameter to remove the domains from the existing allowed domains list. When this command completes, the domains in the list will be removed from the AllowedDomains list. -### -------------------------- Example 9 -------------------------- +### Example 9 ``` Set-CsTenantFederationConfiguration -AllowTeamsConsumer $True -AllowTeamsConsumerInbound $False ``` The command shown in Example 9 enables communication with people using Teams with an account that's not managed by an organization, to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people in your organization. -### -------------------------- Example 10 ------------------------- +### Example 10 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -162,14 +163,14 @@ When the BlockAllSubdomains is enabled, all users from all subdomains of all dom So, users from subdomain.contoso.com and subdomain.fabrikam.com will be blocked. Note: Users from subcontoso.com will not be blocked because it's a completely different domain rather than a subdomain of contoso.com. -### -------------------------- Example 11 ------------------------- +### Example 11 ``` Set-CsTenantFederationConfiguration -ExternalAccessWithTrialTenants "Allowed" ``` Example 11 shows how you can allow users to communicate with users in tenants that contain only trial licenses (default value is Blocked). -### -------------------------- Example 12 -------------------------- +### Example 12 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -182,7 +183,7 @@ Using the `AllowedTrialTenantDomains` parameter, you can whitelist specific "tri First, a List collection is created and domains are added to it, then, simply include the `AllowedTrialTenantDomains` parameter and set the parameter value to the List object. When this command completes, the Allowed Trial Tenant Domains list will be replaced with those domains. -### -------------------------- Example 13 -------------------------- +### Example 13 ``` Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @("contoso.com", "fabrikam.com") ``` @@ -191,7 +192,7 @@ Example 13 shows another way to set a value of `AllowedTrialTenantDomains`. It u The array of `AllowedTrialTenantDomains` can be emptied by running the following command: `Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @()`. -### -------------------------- Example 14 -------------------------- +### Example 14 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -203,7 +204,7 @@ Example 14 shows how you can add domains to the existing Allowed Trial Tenant Do First, a List is created and domains are added to it, then, use the Add method in the `AllowedTrialTenantDomains` parameter to add the domains to the existing allowed domains list. When this command completes, the domains in the list will be added to any domains already on the Allowed Trial Tenant Domains list. -### -------------------------- Example 15 -------------------------- +### Example 15 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -215,7 +216,7 @@ Example 15 shows how you can remove domains from the existing Allowed Trial Tena First, a List is created and domains are added to it, then use the Remove method in the `AllowedTrialTenantDomains` parameter to remove the domains from the existing allowed domains list. When this command completes, the domains in the list will be removed from the Allowed Trial Tenant Domains list. -### -------------------------- Example 16 ------------------------- +### Example 16 ``` Set-CsTenantFederationConfiguration -DomainBlockingForMDOAdminsInTeams "Enabled" ``` @@ -223,6 +224,9 @@ Set-CsTenantFederationConfiguration -DomainBlockingForMDOAdminsInTeams "Enabled" ## PARAMETERS ### -AllowedDomains + +> Applicable: Microsoft Teams + Domain objects (created by using the `New-CsEdgeAllowList` cmdlet or the `New-CsEdgeAllowAllKnownDomains` cmdlet) that represent the domains that users are allowed to communicate with. If the `New-CsEdgeAllowAllKnownDomains` cmdlet is used then users can communicate with any domain that does not appear on the blocked domains list. If the `New-CsEdgeAllowList` cmdlet is used then users can only communicate with domains that have been added to the allowed domains list. @@ -236,7 +240,6 @@ The AllowedDomains parameter can support up to 4,000 domains. Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -245,15 +248,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowFederatedUsers -When set to True (the default value) users will be potentially allowed to communicate with users from other domains. -If this property is set to False then users cannot communicate with users from other domains regardless of the values assigned to the AllowedDomains and BlockedDomains properties. +### -AllowedDomainsAsAList + +> Applicable: Microsoft Teams + +You can specify allowed domains using a List object that contains the domains that users are allowed to communicate with. See Examples section. ```yaml -Type: Boolean +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -262,8 +266,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTeamsConsumer -Allows federation with people using Teams with an account that's not managed by an organization. +### -AllowedTrialTenantDomains + +> Applicable: Microsoft Teams + +You can whitelist specific "trial-only" tenant domains, while keeping the `ExternalAccessWithTrialTenants` set to `Blocked`. This will allow you to protect your organization against majority of tenants that don't have any paid subscriptions, while still being able to collaborate externally with those trusted trial-tenants in the list. + +Note: +- The list supports up to maximum 4k domains. +- If `ExternalAccessWithTrialTenants` is set to `Allowed`, then the `AllowedTrialTenantDomains` list will not be checked. +- Any domain in this list that belongs to a tenant with paid subscriptions will be ignored. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFederatedUsers + +> Applicable: Microsoft Teams + +When set to True (the default value) users will be potentially allowed to communicate with users from other domains. +If this property is set to False then users cannot communicate with users from other domains regardless of the values assigned to the AllowedDomains and BlockedDomains properties. ```yaml Type: Boolean @@ -272,13 +303,13 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTeamsConsumerInbound -Allows people using Teams with an account that's not managed by an organization, to discover and start communication with users in your organization. When -AllowTeamsConsumer is enabled and this parameter is disabled, only the users in your organization will be able to discover and start communication with people using Teams with an account that's not managed by an organization, but they will not discover and start communications with users in your organization. +### -AllowTeamsConsumer +Allows federation with people using Teams with an account that's not managed by an organization. ```yaml Type: Boolean @@ -292,25 +323,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockedDomains -If the AllowedDomains property has been set to AllowAllKnownDomains, then users will be allowed to communicate with users from any domain except domains that appear in the blocked domains list. -If the AllowedDomains property has not been set to AllowAllKnownDomains, then the blocked list is ignored, and users can only communicate with domains that have been expressly added to the allowed domains list. -The BlockedDomains parameter can support up to 4,000 domains. +### -AllowTeamsConsumerInbound +Allows people using Teams with an account that's not managed by an organization, to discover and start communication with users in your organization. When -AllowTeamsConsumer is enabled and this parameter is disabled, only the users in your organization will be able to discover and start communication with people using Teams with an account that's not managed by an organization, but they will not discover and start communications with users in your organization. ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### -BlockAllSubdomains + +> Applicable: Skype for Business Online + If the BlockedDomains parameter is used, then BlockAllSubdomains can be used to activate all subdomains blocking. If the BlockedDomains parameter is ignored, then BlockAllSubdomains is also ignored. Just like for BlockedDomains, users will be disallowed from communicating with users from blocked domains. @@ -320,7 +351,6 @@ But all subdomains for domains in this list will also be blocked. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -329,14 +359,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -BlockedDomains + +> Applicable: Microsoft Teams + +If the AllowedDomains property has been set to AllowAllKnownDomains, then users will be allowed to communicate with users from any domain except domains that appear in the blocked domains list. +If the AllowedDomains property has not been set to AllowAllKnownDomains, then the blocked list is ignored, and users can only communicate with domains that have been expressly added to the allowed domains list. +The BlockedDomains parameter can support up to 4,000 domains. ```yaml -Type: SwitchParameter +Type: List Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -345,14 +379,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -361,35 +397,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the collection of tenant federation configuration settings to be modified. -Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the `Set-CsTenantFederationConfiguration` cmdlet. -If you do choose to use the Identity parameter you must also include the Tenant parameter. -For example: +### -DomainBlockingForMDOAdminsInTeams -`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` +> Applicable: Microsoft Teams + +When set to 'Enabled', security operations team will be able to add domains to the blocklist on security portal. +When set to 'Disabled', security operations team will not have permissions to update the domains blocklist. ```yaml -Type: XdsIdentity +Type: DomainBlockingForMDOAdminsInTeamsType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -ExternalAccessWithTrialTenants + +> Applicable: Microsoft Teams + +When set to 'Blocked', all external access with users from Teams subscriptions that contain only trial licenses will be blocked. This means users from these trial-only tenants will not be able to reach to your users via chats, Teams calls, and meetings (using the users authenticated identity) and your users will not be able to reach users in these trial-only tenants. If this setting is set to "Blocked", users from the trial-only tenant will also be removed from existing chats. + +Allowed - Communication with other tenants is allowed based on other settings. + +Blocked - Communication with users in tenants that contain only trial licenses will be blocked. ```yaml -Type: PSObject +Type: ExternalAccessWithTrialTenantsType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -398,15 +438,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharedSipAddressSpace -When set to True, indicates that the users homed on Skype for Business Online use the same SIP domain as users homed on the on-premises version of Skype for Business Server. -The default value is False, meaning that the two sets of users have different SIP domains. +### -Force + +> Applicable: Microsoft Teams + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -415,43 +456,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose federation settings are being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -Identity -You can return your tenant ID by running this command: +> Applicable: Microsoft Teams -`Get-CsTenant | Select-Object DisplayName, TenantID` +Specifies the collection of tenant federation configuration settings to be modified. +Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the `Set-CsTenantFederationConfiguration` cmdlet. +If you do choose to use the Identity parameter you must also include the Tenant parameter. +For example: -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. +`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` ```yaml -Type: Guid +Type: XdsIdentity Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TreatDiscoveredPartnersAsUnverified -When set to True, messages sent from discovered partners are considered unverified. -That means that those messages will be delivered only if they were sent from a person who is on the recipient's Contacts list. -The default value is False ($False). +### -Instance + +> Applicable: Microsoft Teams + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean +Type: PSObject Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -460,14 +497,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedDomainsAsAList -You can specify allowed domains using a List object that contains the domains that users are allowed to communicate with. See Examples section. +### -RestrictTeamsConsumerToExternalUserProfiles +Defines if a user is restricted to collaboration with Teams Consumer (TFL) user only in Extended Directory. +Possible values: True, False ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -476,18 +513,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalAccessWithTrialTenants -When set to 'Blocked', all external access with users from Teams subscriptions that contain only trial licenses will be blocked. This means users from these trial-only tenants will not be able to reach to your users via chats, Teams calls, and meetings (using the users authenticated identity) and your users will not be able to reach users in these trial-only tenants. If this setting is set to "Blocked", users from the trial-only tenant will also be removed from existing chats. +### -SharedSipAddressSpace -Allowed - Communication with other tenants is allowed based on other settings. +> Applicable: Microsoft Teams -Blocked - Communication with users in tenants that contain only trial licenses will be blocked. +When set to True, indicates that the users homed on Skype for Business Online use the same SIP domain as users homed on the on-premises version of Skype for Business Server. +The default value is False, meaning that the two sets of users have different SIP domains. ```yaml -Type: ExternalAccessWithTrialTenantsType +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -496,36 +532,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainBlockingForMDOAdminsInTeams -When set to 'Enabled', security operations team will be able to add domains to the blocklist on security portal. -When set to 'Disabled', security operations team will not have permissions to update the domains blocklist. +### -Tenant -```yaml -Type: DomainBlockingForMDOAdminsInTeamsType -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the tenant account whose federation settings are being modified. +For example: -### -AllowedTrialTenantDomains -You can whitelist specific "trial-only" tenant domains, while keeping the `ExternalAccessWithTrialTenants` set to `Blocked`. This will allow you to protect your organization against majority of tenants that don't have any paid subscriptions, while still being able to collaborate externally with those trusted trial-tenants in the list. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -Note: -- The list supports up to maximum 4k domains. -- If `ExternalAccessWithTrialTenants` is set to `Allowed`, then the `AllowedTrialTenantDomains` list will not be checked. -- Any domain in this list that belongs to a tenant with paid subscriptions will be ignored. +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: List +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -534,9 +561,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RestrictTeamsConsumerToExternalUserProfiles -Defines if a user is restricted to collaboration with Teams Consumer (TFL) user only in Extended Directory. -Possible values: True, False +### -TreatDiscoveredPartnersAsUnverified + +> Applicable: Microsoft Teams + +When set to True, messages sent from discovered partners are considered unverified. +That means that those messages will be delivered only if they were sent from a person who is on the recipient's Contacts list. +The default value is False ($False). ```yaml Type: Boolean @@ -551,13 +582,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named @@ -584,4 +617,4 @@ Instead, the `Set-CsTenantFederationConfiguration` cmdlet modifies existing inst ## RELATED LINKS -[Get-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantfederationconfiguration) +[Get-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantMigrationConfiguration.md similarity index 90% rename from teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantMigrationConfiguration.md index 9008b4da94..9a171130ab 100644 --- a/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantMigrationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration applicable: Microsoft Teams -title: Set-CsTenantMigrationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantmigrationconfiguration +schema: 2.0.0 +title: Set-CsTenantMigrationConfiguration --- # Set-CsTenantMigrationConfiguration @@ -45,7 +47,7 @@ For more information, see [Using the Meeting Migration Service (MMS)](https://le ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTenantMigrationConfiguration -MeetingMigrationEnabled $false ``` @@ -54,31 +56,34 @@ This example disables MMS in the organization. ## PARAMETERS -### -Identity -Unique identifier for the Migration Configuration. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: -applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. -You can retrieve this object reference by calling the `Get-CsTenantMigrationConfiguration` cmdlet. +### -Force + +> Applicable: Microsoft Teams + +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: SwitchParameter +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -87,30 +92,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity + +> Applicable: Microsoft Teams + +Unique identifier for the Migration Configuration. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Type: String +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Instance + +> Applicable: Microsoft Teams + +The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. +You can retrieve this object reference by calling the `Get-CsTenantMigrationConfiguration` cmdlet. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -120,13 +130,15 @@ Accept wildcard characters: False ``` ### -MeetingMigrationEnabled + +> Applicable: Microsoft Teams + Set this to false to disable the Meeting Migration Service. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -136,6 +148,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + Globally unique identifier (GUID) of the tenant account whose Migration Configurations are being created. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" @@ -148,7 +163,6 @@ Get-CsTenant | Select-Object DisplayName, TenantID Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -158,13 +172,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkRegion.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkRegion.md index 7ec40da511..d15b9c716d 100644 --- a/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkRegion.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion applicable: Microsoft Teams -title: Set-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworkregion +schema: 2.0.0 +title: Set-CsTenantNetworkRegion --- # Set-CsTenantNetworkRegion ## SYNOPSIS -As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. +Changes the definintion of network regions. ## SYNTAX @@ -24,6 +25,8 @@ Set-CsTenantNetworkRegion [[-Identity] ] [-CentralSite ] [-Descr ``` ## DESCRIPTION +As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. + Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. ## EXAMPLES @@ -37,12 +40,12 @@ The command shown in Example 1 sets the network region 'RegionA' with the descri ## PARAMETERS -### -Identity -Unique identifier for the network region to be set. +### -CentralSite +This parameter is not used. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: (All) Aliases: Required: False @@ -52,13 +55,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CentralSite -This parameter is not used. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -82,12 +85,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -The name of the network region. Not required in this PowerShell command. +### -Identity +Unique identifier for the network region to be set. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Required: False @@ -97,13 +100,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkRegionID +The name of the network region. Not required in this PowerShell command. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -142,8 +145,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworkregion) -[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworkregion) -[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworkregion) diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSite.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSite.md index 9f97f7495e..97f473ae54 100644 --- a/teams/teams-ps/teams/Set-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSite.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite applicable: Microsoft Teams -title: Set-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksite +schema: 2.0.0 +title: Set-CsTenantNetworkSite --- # Set-CsTenantNetworkSite ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, Set-CsTenantNetworkSite to define network sites. Network sites are defined as a collection of IP subnets. Each network site must be associated with a network region. Tenant network site is used for Location Based Routing. +Changes the definition of network sites. ## SYNTAX @@ -56,13 +57,13 @@ The command shown in Example 3 sets the network site 'site3' with description 's ## PARAMETERS -### -Identity -Unique identifier for the network site to be set. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -131,8 +132,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationPolicy -This parameter is reserved for internal Microsoft use. +### -Identity +Unique identifier for the network site to be set. ```yaml Type: String @@ -146,8 +147,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -NetworkRegionID is the identifier for the network region which the current network site is associating to. +### -LocationPolicy +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -161,8 +162,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRoamingPolicy -NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. +### -NetworkRegionID +NetworkRegionID is the identifier for the network region which the current network site is associating to. ```yaml Type: String @@ -176,13 +177,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkRoamingPolicy +NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -220,8 +221,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksite) -[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksite) -[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksite) diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSubnet.md similarity index 89% rename from teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSubnet.md index 52e3aea595..68cfec5f4c 100644 --- a/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSubnet.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet applicable: Microsoft Teams -title: Set-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantnetworksubnet +schema: 2.0.0 +title: Set-CsTenantNetworkSubnet --- # Set-CsTenantNetworkSubnet ## SYNOPSIS -As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkSubnet to define network subnets and assign them to network sites. Each internal subnet may only be associated with one site. The organization's network subnet is used for Location-Based Routing. +Changes the definition of network subnets. ## SYNTAX @@ -48,16 +49,16 @@ IPv6 format subnet accepts maskbits from 0 to 128 inclusive. ## PARAMETERS -### -Identity -Unique identifier for the network subnet to be set. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -78,28 +79,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaskBits -This parameter determines the length of bits to mask to the subnet. - -IPv4 format subnet accepts maskbits from 0 to 32 inclusive. IPv6 format subnet accepts maskbits from 0 to 128 inclusive. +### -Identity +Unique identifier for the network subnet to be set. ```yaml -Type: Int32 -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID -NetworkSiteID is the identifier for the network site which the current network subnet is associating to. +### -MaskBits +This parameter determines the length of bits to mask to the subnet. + +IPv4 format subnet accepts maskbits from 0 to 32 inclusive. IPv6 format subnet accepts maskbits from 0 to 128 inclusive. ```yaml -Type: String +Type: Int32 Parameter Sets: (All) Aliases: @@ -110,13 +111,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkSiteID +NetworkSiteID is the identifier for the network site which the current network subnet is associating to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -150,8 +151,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/new-cstenantnetworksubnet) -[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cstenantnetworksubnet) -[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantnetworksubnet) diff --git a/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantTrustedIPAddress.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantTrustedIPAddress.md index 8e93bf341c..fe867e81e1 100644 --- a/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantTrustedIPAddress.md @@ -1,19 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenanttrustedipaddress applicable: Microsoft Teams -title: Set-CsTenantTrustedIPAddress -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenanttrustedipaddress +schema: 2.0.0 +title: Set-CsTenantTrustedIPAddress --- # Set-CsTenantTrustedIPAddress ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, Set-CsTenantTrustedIPAddress to define external subnets and assign them to the tenant. You can define an unlimited number of external subnets for a tenant. +Changes the definition of network IP addresses. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsUser.md b/teams/teams-ps/MicrosoftTeams/Set-CsUser.md similarity index 87% rename from teams/teams-ps/teams/Set-CsUser.md rename to teams/teams-ps/MicrosoftTeams/Set-CsUser.md index 97f1298690..8bf3dfd394 100644 --- a/teams/teams-ps/teams/Set-CsUser.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsUser.md @@ -1,23 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csuser applicable: Microsoft Teams -title: Set-CsUser -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csuser +schema: 2.0.0 +title: Set-CsUser --- # Set-CsUser ## SYNOPSIS Modifies Skype for Business properties for an existing user account. -Properties can be modified only for accounts that have been enabled for use with Skype for Business. -This cmdlet was introduced in Lync Server 2010. - -**Note**: Using this cmdlet for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. ## SYNTAX @@ -31,6 +29,11 @@ Set-CsUser [-DomainController ] [-Identity] [-PassThru] ``` ## DESCRIPTION +Properties can be modified only for accounts that have been enabled for use with Skype for Business. +This cmdlet was introduced in Lync Server 2010. + +**Note**: Using this cmdlet for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignment) cmdlets instead. + The `Set-CsUser` cmdlet enables you to modify the Skype for Business related user account attributes that are stored in Active Directory Domain Services or modify a subset of Skype for Business online user attributes that are stored in Microsoft Entra ID. For example, you can disable or re-enable a user for Skype for Business Server; enable or disable a user for audio/video (A/V) communications; or modify a user's private line and line URI numbers. For Skype for Business online enable or disable a user for enterprise voice, hosted voicemail, or modify the user's on premise line uri. The `Set-CsUser` cmdlet can be used only for users who have been enabled for Skype for Business. @@ -42,7 +45,7 @@ You should not attempt to manually configure these attributes. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Set-CsUser -Identity "Pilar Ackerman" -EnterpriseVoiceEnabled $True ``` @@ -51,7 +54,7 @@ In Example 1, the `Set-CsUser` cmdlet is used to modify the user account with th In this case, the account is modified to enable Enterprise Voice, the Microsoft implementation of VoIP. This task is carried out by adding the EnterpriseVoiceEnabled parameter, and then setting the parameter value to $True. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsUser -LdapFilter "Department=Finance" | Set-CsUser -EnterpriseVoiceEnabled $True ``` @@ -60,7 +63,7 @@ In Example 2, all the users in the Finance department have their accounts enable In this command, the `Get-CsUser` cmdlet and the LdapFilter parameter are first used to return a collection of all the users who work in the Finance department. That information is then piped to the `Set-CsUser` cmdlet, which enables Enterprise Voice for each account in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell Set-CsUser -Identity "Pilar Ackerman" -LineUri "tel:+123456789" ``` @@ -70,28 +73,29 @@ In this case, the account is modified to set the phone number assigned to the us ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be modified. -User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). -User Identities can also be referenced by using the user's Active Directory distinguished name. +### -AcpInfo -You can use the asterisk (*) wildcard character when using the display name as the user Identity. -For example, the Identity "Smith" returns all the users who have a display name that ends with the string value " Smith". +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to assign one or more third-party audio conferencing providers to a user. +However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. ```yaml -Type: UserIdParameter +Type: AcpInfo Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -AudioVideoDisabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to make audio/visual (A/V) calls by using Skype for Business. If set to True, the user will largely be restricted to sending and receiving instant messages. @@ -103,7 +107,43 @@ You cannot disable A/V communications if a user is currently enabled for remote Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a domain controller to connect to when modifying a user account. +If this parameter is not included then the cmdlet will use the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -113,6 +153,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the user has been enabled for Skype for Business Server. If you set this value to False, the user will no longer be able to log on to Skype for Business Server; setting this value to True re-enables the user's logon privileges. @@ -125,7 +168,6 @@ When you run the `Disable-CsUser` cmdlet, all the Skype for Business Server data Type: Boolean Parameter Sets: (All) Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -134,15 +176,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to specify a domain controller to connect to when modifying a user account. -If this parameter is not included then the cmdlet will use the first available domain controller. +### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). +With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. + +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) cmdlet instead. ```yaml -Type: Fqdn +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -151,17 +197,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnterpriseVoiceEnabled -Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). -With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. +### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the user's instant messaging sessions are archived. +Allowed values are: -**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving ```yaml -Type: Boolean +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -171,6 +225,9 @@ Accept wildcard characters: False ``` ### -HostedVoiceMail + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, enables a user's voice mail calls to be routed to a hosted version of Microsoft Exchange Server. In addition, setting this option to True enables Skype for Business users to directly place a call to another user's voice mail. @@ -180,7 +237,6 @@ In addition, setting this option to True enables Skype for Business users to dir Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -189,36 +245,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. - -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and the "tel:" prefix, for example: tel:+14255551297. -Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. +### -Identity -It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not -be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 -routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call -directly to the user. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -For Direct Routing phone numbers in GCC High and DoD cloud instances, assigning a base phone number to a user or resource account is not supported if you already have other users or resource accounts assigned phone numbers with the same base phone number and extensions or vice versa. For instance, if you have a user with the assigned phone number +14255551200;ext=123 you can't assign the phone number +14255551200 to another user or resource account or if you have a user or resource account with the assigned phone number +14255551200 you can't assign the phone number +14255551200;ext=123 to another user or resource account. Assigning phone numbers with the same base number but different extensions to users and resource accounts is supported. For instance, you can have a user with +14255551200;ext=123 and another user with +14255551200;ext=124. +Indicates the Identity of the user account to be modified. +User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. -Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 +You can use the asterisk (*) wildcard character when using the display name as the user Identity. +For example, the Identity "Smith" returns all the users who have a display name that ends with the string value " Smith". ```yaml -Type: String +Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -LineServerURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The URI of the remote call control telephone gateway assigned to the user. The LineServerUri is the gateway URI, prefaced by "sip:". For example: sip:rccgateway@litwareinc.com @@ -227,7 +280,6 @@ For example: sip:rccgateway@litwareinc.com Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -236,20 +288,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrivateLine -Phone number for the user's private telephone line. -A private line is a phone number that is not published in Active Directory Domain Services and, as a result, is not readily available to other people. -In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. -Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. +### -LineURI -The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. -For example: tel:+14255551297. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. + +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and the "tel:" prefix, for example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. + +It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not +be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 +routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call +directly to the user. + +For Direct Routing phone numbers in GCC High and DoD cloud instances, assigning a base phone number to a user or resource account is not supported if you already have other users or resource accounts assigned phone numbers with the same base phone number and extensions or vice versa. For instance, if you have a user with the assigned phone number +14255551200;ext=123 you can't assign the phone number +14255551200 to another user or resource account or if you have a user or resource account with the assigned phone number +14255551200 you can't assign the phone number +14255551200;ext=123 to another user or resource account. Assigning phone numbers with the same base number but different extensions to users and resource accounts is supported. For instance, you can have a user with +14255551200;ext=123 and another user with +14255551200;ext=124. + +Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -258,38 +319,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoteCallControlTelephonyEnabled -Indicates whether the user has been enabled for remote call control telephony. -When enabled for remote call control, a user can employ Skype for Business to answer phone calls made to his or her desk phone. -Phone calls can also be made using Skype for Business. -These calls all rely on the standard telephone network, also known as the public switched telephone network (PSTN). -To make and receive phone calls over the Internet, the user must be enabled for Enterprise Voice. -For details, see the parameter EnterpriseVoiceEnabled. +### -OnPremLineURI -To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. +> Applicable: Microsoft Teams -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. +For example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. +Depending on your setup, those two numbers could actually be different. +For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. +Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. -### -SipAddress -Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Skype for Business. -The SIP address must use the sip: prefix as well as a valid SIP domain; for example: `-SipAddress sip:kenmyer@litwareinc.com`. +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csphonenumberassignment) cmdlet instead. + +**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -299,6 +351,9 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user whose account is being modified. By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. @@ -308,7 +363,6 @@ By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -317,30 +371,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PrivateLine -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Phone number for the user's private telephone line. +A private line is a phone number that is not published in Active Directory Domain Services and, as a result, is not readily available to other people. +In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. +Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. -### -Confirm -Prompts you for confirmation before executing the command. +The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. +For example: tel:+14255551297. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -349,15 +395,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcpInfo -Enables you to assign one or more third-party audio conferencing providers to a user. -However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. +### -RemoteCallControlTelephonyEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the user has been enabled for remote call control telephony. +When enabled for remote call control, a user can employ Skype for Business to answer phone calls made to his or her desk phone. +Phone calls can also be made using Skype for Business. +These calls all rely on the standard telephone network, also known as the public switched telephone network (PSTN). +To make and receive phone calls over the Internet, the user must be enabled for Enterprise Voice. +For details, see the parameter EnterpriseVoiceEnabled. + +To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. ```yaml -Type: AcpInfo +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -366,23 +420,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the user's instant messaging sessions are archived. -Allowed values are: - -Uninitialized - -UseLyncArchivingPolicy +### -SipAddress -ArchivingToExchange +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -NoArchiving +Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Skype for Business. +The SIP address must use the sip: prefix as well as a valid SIP domain; for example: `-SipAddress sip:kenmyer@litwareinc.com`. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -391,27 +439,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnPremLineURI -Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. -For example: tel:+14255551297. -Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. - -Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. -Depending on your setup, those two numbers could actually be different. -For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. -Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. +### -WhatIf -**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named @@ -439,4 +476,4 @@ The `Set-CsUser` cmdlet does not return any objects. ## RELATED LINKS -[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineuser) diff --git a/teams/teams-ps/teams/Set-CsUserCallingDelegate.md b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingDelegate.md similarity index 73% rename from teams/teams-ps/teams/Set-CsUserCallingDelegate.md rename to teams/teams-ps/MicrosoftTeams/Set-CsUserCallingDelegate.md index ac17aa7a8a..57879dac3b 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingDelegate.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingDelegate.md @@ -1,144 +1,164 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate -applicable: Microsoft Teams -title: Set-CsUserCallingDelegate -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsUserCallingDelegate - -## SYNOPSIS -This cmdlet will change permissions for a delegate for calling in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -```powershell -Set-CsUserCallingDelegate -Identity -Delegate [-MakeCalls ] [-ReceiveCalls ] [-ManageSettings ] [] -``` - -## DESCRIPTION -This cmdlet can change the permissions assigned to a delegate for the specified user. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $false -ReceiveCalls $true -ManageSettings $false -``` -This example shows setting the permissions for user1@contoso.com's delegate user2@contoso.com. - -### Example 2 -```powershell -Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -``` -This example shows setting the MakeCalls permissions to True for user1@contoso.com's delegate user2@contoso.com. - -## PARAMETERS - -### -Delegate -The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. - -A user can have up to 25 delegates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeCalls - -Specifies whether delegate is allowed to make calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: False -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManageSettings - -Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: False -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveCalls - -Specifies whether delegate is allowed to receive calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: False -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, -and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -The specified user need to have the Microsoft Phone System license assigned. - -You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. - -## RELATED LINKS -[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingdelegate +schema: 2.0.0 +title: Set-CsUserCallingDelegate +--- + +# Set-CsUserCallingDelegate + +## SYNOPSIS +This cmdlet will change permissions for a delegate for calling in Microsoft Teams. + +## SYNTAX + +``` +Set-CsUserCallingDelegate -Identity -Delegate [-MakeCalls ] + [-ManageSettings ] [-ReceiveCalls ] [-HttpPipelinePrepend ] + [] +``` + +## DESCRIPTION +This cmdlet can change the permissions assigned to a delegate for the specified user. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $false -ReceiveCalls $true -ManageSettings $false +``` +This example shows setting the permissions for user1@contoso.com's delegate user2@contoso.com. + +### Example 2 +```powershell +Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true +``` +This example shows setting the MakeCalls permissions to True for user1@contoso.com's delegate user2@contoso.com. + +## PARAMETERS + +### -Delegate +The Identity of the delegate to add. +Can be specified using the ObjectId or the SIP address. + +A user can have up to 25 delegates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeCalls + +Specifies whether delegate is allowed to make calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageSettings + +Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveCalls + +Specifies whether delegate is allowed to receive calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +The specified user need to have the Microsoft Phone System license assigned. + +You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. + +## RELATED LINKS +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Set-CsUserCallingSettings.md b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingSettings.md similarity index 82% rename from teams/teams-ps/teams/Set-CsUserCallingSettings.md rename to teams/teams-ps/MicrosoftTeams/Set-CsUserCallingSettings.md index 4b590f4ab2..e66b399f80 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingSettings.md @@ -1,414 +1,450 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings -applicable: Microsoft Teams -title: Set-CsUserCallingSettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsUserCallingSettings - -## SYNOPSIS -This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. - -## SYNTAX - -### Identity (Default) -```powershell -Set-CsUserCallingSettings -Identity [] -``` - -### ForwardingOnOff -```powershell -Set-CsUserCallingSettings -Identity -IsForwardingEnabled [] -``` - -### Forwarding -```powershell -Set-CsUserCallingSettings -Identity -IsForwardingEnabled -ForwardingType [-ForwardingTarget ] -ForwardingTargetType [] -``` - -### UnansweredOnOff -```powershell -Set-CsUserCallingSettings -Identity -IsUnansweredEnabled [] -``` - -### Unanswered -```powershell -Set-CsUserCallingSettings -Identity -IsUnansweredEnabled [-UnansweredTarget ] -UnansweredTargetType -UnansweredDelay [] -``` - -### CallGroup -```powershell -Set-CsUserCallingSettings -Identity -CallGroupOrder -CallGroupTargets [] -``` - -### CallGroupMembership -```powershell -Set-CsUserCallingSettings -Identity -GroupMembershipDetails [] -``` - -### CallGroupNotification -```powershell -Set-CsUserCallingSettings -Identity -GroupNotificationOverride [] -``` - -## DESCRIPTION -This cmdlet sets the call forwarding, simultaneous ringing and call group settings for the specified user. - -When specifying settings you need to specify all settings with a settings grouping, for instance, you can't just change a forwarding target. Instead, you need to -start by getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Voicemail -``` -This example shows setting immediate call forwarding to voicemail for user1@contoso.com. - -### Example 2 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $false -``` -This example shows removing call forwarding for user1@contoso.com. - -### Example 3 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Simultaneous -ForwardingTargetType SingleTarget -ForwardingTarget "+12065551234" -``` -This example shows setting simultaneous ringing to +12065551234 for user1@contoso.com. - -### Example 4 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType MyDelegates -UnansweredDelay 00:00:30 -``` -This example shows setting unanswered call forward to the delegates after 30 seconds for user1@contoso.com. - -### Example 5 -```powershell -$cgm = @("sip:user2@contoso.com","sip:user3@contoso.com") -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder InOrder -CallGroupTargets $cgm -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Group -``` -This example shows creating a call group for user1@contoso.com with 2 members and setting immediate call forward to the call group for user1@contoso.com. - -### Example 6 -```powershell -$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com -$cgt = {$ucs.CallGroupTargets}.Invoke() -$cgt.Add("sip:user5@contoso.com") -$cgt.Remove("sip:user6@contoso.com") -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets $cgt - -$gmd = (Get-CsUserCallingSettings -Identity user5@contoso.com).GroupMembershipDetails -$gmd[[array]::IndexOf($gmd.CallGroupOwnerId,'sip:user1@contoso.com')].NotificationSetting = 'Banner' -Set-CsUserCallingSettings -Identity user5@contoso.com -GroupMembershipDetails $gmd -``` - -This example shows how to update the call group of user1@contoso.com to add user5@contoso.com and remove user6@contoso.com. In addition the notification setting for -user5@contoso.com for user1@contoso.com's call group is set to Banner. - -The key to note here is the call group membership is defined on the object of the owner of the call group, in the above case this is user1@contoso.com. However, -the notification setting for a member for a particular call group is defined on the member. In this case user5@contoso.com. - -### Example 7 -```powershell -$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets @() -``` - -This example shows how to remove all members of the call group. - -### Example 8 -```powershell -[Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[]]$gmd = @( - [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user20@contoso.com';NotificationSetting='Banner'} - [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user30@contoso.com';NotificationSetting='Mute'} -) -Set-CsUserCallingSettings -Identity user10@contoso.com -GroupMembershipDetails $gmd -``` - -In this example user10@contoso.com is a member of two call groups: user20@contoso.com and user30@contoso.com. User10@contoso.com would like to have Banner -notification for the first call group and Mute notification for the last one. - -### Example 9 -```powershell -Set-CsUserCallingSettings -Identity user2@contoso.com -GroupNotificationOverride 'Mute' -``` - -This example shows how to set the group notification override for user2@contoso.com. This setting overrides any specific notification setting set for the user -on any call group the user is a member of. - -### Example 10 -```powershell -Set-CsUserCallingSettings -Identity user6@contoso.com -IsForwardingEnabled $false -Set-CsUserCallingSettings -Identity user6@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType Voicemail -UnansweredDelay 00:00:20 -``` - -This example shows how to set the default call forwarding settings for a user. - -### Example 11 -```powershell -Set-CsUserCallingSettings -Identity user7@contoso.com -IsUnansweredEnabled $false -``` - -This example shows turning off unanswered call forwarding for a user. The Microsoft Teams client will show this as _If unanswered Do nothing_. - -## PARAMETERS - -### -CallGroupOrder - -The order in which to call members of the Call Group. The supported values are Simultaneous and InOrder. - -You can only use InOrder, if the call group has 5 or less members. - -```yaml -Type: System.String -Parameter Sets: (CallGroup) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallGroupTargets -The members of the Call Group. You need to always specify the full set of members as the parameter value. What you set here will overwrite the current call group membership. - -A call group can have up to 25 members. - -```yaml -Type: System.Array of System.String -Parameter Sets: (CallGroup) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingTarget - -The forwarding target. Supported types of values are ObjectId's, SIP addresses and phone numbers. -For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. - -Only used when ForwardingTargetType is SingleTarget. - -```yaml -Type: System.String -Parameter Sets: (Forwarding) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingTargetType - -The forwarding target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. Voicemail is only supported for Immediate forwarding. - -SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1 -delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). - -```yaml -Type: System.String -Parameter Sets: (Forwarding) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingType - -The type of forwarding to set. Supported values are Immediate and Simultaneous - -```yaml -Type: System.String -Parameter Sets: (Forwarding) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupMembershipDetails - -The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a -call group and the notification setting for the specified user for that call group. - -This parameter only exists if the specified user is a member of a call group. You can't create it, you can only change it. - -You need to always specify the full group membership details as the parameter value. What you set here will over-write the current group membership details. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] -Parameter Sets: (GroupMembershipDetails) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -GroupNotificationOverride - -The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. - -The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. - -```yaml -Type: System.String -Parameter Sets: (GroupNotificationOverride) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsForwardingEnabled - -This parameter controls whether forwarding is enabled or not. - -```yaml -Type: System.Boolean -Parameter Sets: (ForwardingOnOff,Forwarding) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsUnansweredEnabled - -This parameter controls whether forwarding for unanswered calls is enabled or not. - -```yaml -Type: System.Boolean -Parameter Sets: (UnansweredOnOff,Unanswered) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnansweredDelay - -The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and -60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds. - -```yaml -Type: System.String -Parameter Sets: (Unanswered) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnansweredTarget - -The unanswered target. Supported type of values are ObjectId, SIP address and phone number. -For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. - -Only used when UnansweredTargetType is SingleTarget. - -```yaml -Type: System.String -Parameter Sets: (Unanswered) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnansweredTargetType - -The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. - -SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's -delegates. Group is used when forwarding the unanswered call to the specified user's call group. - -```yaml -Type: System.String -Parameter Sets: (Unanswered) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -The specified user need to have the Microsoft Phone System license assigned. - -When forwarding to MyDelegates, the specified user needs to have one or more delegates defined that are allowed to receive calls. When forwarding to Group, the -specified user needs to have one or more members of the user's call group. - -The cmdlet is validating the different settings and is always writing all the parameters in a settings group. You might see validation errors from the cmdlet due to -this behavior. As an example, if you have ForwardingTargetType set to Group and you want to remove all members of the call group, you will get a validation error. - -You can specify a SIP URI without 'sip:' on input, but the output from Get-CsUserCallingSettings will show the full SIP URI. - -You are not able to configure delegates via this cmdlet. Please use New-CsUserCallingDelegate, Set-CsUserCallingDelegate cmdlets and Remove-CsUserCallingDelegate. - -## RELATED LINKS -[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingsettings +schema: 2.0.0 +title: Set-CsUserCallingSettings +--- + +# Set-CsUserCallingSettings + +## SYNOPSIS +This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. + +## SYNTAX + +### Identity (Default) +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] [] +``` + +### CallGroupNotification +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -GroupNotificationOverride [] +``` + +### CallGroupMembership +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -GroupMembershipDetails [] +``` + +### CallGroup +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] -CallGroupOrder + -CallGroupTargets [] +``` + +### Unanswered +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -IsUnansweredEnabled -UnansweredDelay [-UnansweredTarget ] + [-UnansweredTargetType ] [] +``` + +### UnansweredOnOff +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -IsUnansweredEnabled [] +``` + +### Forwarding +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -IsForwardingEnabled -ForwardingType -ForwardingTargetType + [-ForwardingTarget ] [] +``` + +### ForwardingOnOff +``` +Set-CsUserCallingSettings -Identity [-HttpPipelinePrepend ] + -IsForwardingEnabled [] +``` + +## DESCRIPTION +This cmdlet sets the call forwarding, simultaneous ringing and call group settings for the specified user. + +When specifying settings you need to specify all settings with a settings grouping, for instance, you can't just change a forwarding target. Instead, you need to +start by getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Voicemail +``` +This example shows setting immediate call forwarding to voicemail for user1@contoso.com. + +### Example 2 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $false +``` +This example shows removing call forwarding for user1@contoso.com. + +### Example 3 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Simultaneous -ForwardingTargetType SingleTarget -ForwardingTarget "+12065551234" +``` +This example shows setting simultaneous ringing to +12065551234 for user1@contoso.com. + +### Example 4 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType MyDelegates -UnansweredDelay 00:00:30 +``` +This example shows setting unanswered call forward to the delegates after 30 seconds for user1@contoso.com. + +### Example 5 +```powershell +$cgm = @("sip:user2@contoso.com","sip:user3@contoso.com") +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder InOrder -CallGroupTargets $cgm +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Group +``` +This example shows creating a call group for user1@contoso.com with 2 members and setting immediate call forward to the call group for user1@contoso.com. + +### Example 6 +```powershell +$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com +$cgt = {$ucs.CallGroupTargets}.Invoke() +$cgt.Add("sip:user5@contoso.com") +$cgt.Remove("sip:user6@contoso.com") +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets $cgt + +$gmd = (Get-CsUserCallingSettings -Identity user5@contoso.com).GroupMembershipDetails +$gmd[[array]::IndexOf($gmd.CallGroupOwnerId,'sip:user1@contoso.com')].NotificationSetting = 'Banner' +Set-CsUserCallingSettings -Identity user5@contoso.com -GroupMembershipDetails $gmd +``` + +This example shows how to update the call group of user1@contoso.com to add user5@contoso.com and remove user6@contoso.com. In addition the notification setting for +user5@contoso.com for user1@contoso.com's call group is set to Banner. + +The key to note here is the call group membership is defined on the object of the owner of the call group, in the above case this is user1@contoso.com. However, +the notification setting for a member for a particular call group is defined on the member. In this case user5@contoso.com. + +### Example 7 +```powershell +$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets @() +``` + +This example shows how to remove all members of the call group. + +### Example 8 +```powershell +[Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[]]$gmd = @( + [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user20@contoso.com';NotificationSetting='Banner'} + [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user30@contoso.com';NotificationSetting='Mute'} +) +Set-CsUserCallingSettings -Identity user10@contoso.com -GroupMembershipDetails $gmd +``` + +In this example user10@contoso.com is a member of two call groups: user20@contoso.com and user30@contoso.com. User10@contoso.com would like to have Banner +notification for the first call group and Mute notification for the last one. + +### Example 9 +```powershell +Set-CsUserCallingSettings -Identity user2@contoso.com -GroupNotificationOverride 'Mute' +``` + +This example shows how to set the group notification override for user2@contoso.com. This setting overrides any specific notification setting set for the user +on any call group the user is a member of. + +### Example 10 +```powershell +Set-CsUserCallingSettings -Identity user6@contoso.com -IsForwardingEnabled $false +Set-CsUserCallingSettings -Identity user6@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType Voicemail -UnansweredDelay 00:00:20 +``` + +This example shows how to set the default call forwarding settings for a user. + +### Example 11 +```powershell +Set-CsUserCallingSettings -Identity user7@contoso.com -IsUnansweredEnabled $false +``` + +This example shows turning off unanswered call forwarding for a user. The Microsoft Teams client will show this as _If unanswered Do nothing_. + +## PARAMETERS + +### -CallGroupOrder + +The order in which to call members of the Call Group. The supported values are Simultaneous and InOrder. + +You can only use InOrder, if the call group has 5 or less members. + +```yaml +Type: System.String +Parameter Sets: CallGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallGroupTargets +The members of the Call Group. You need to always specify the full set of members as the parameter value. What you set here will overwrite the current call group membership. + +A call group can have up to 25 members. + +```yaml +Type: System.Array +Parameter Sets: CallGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingTarget + +The forwarding target. Supported types of values are ObjectId's, SIP addresses and phone numbers. +For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. + +Only used when ForwardingTargetType is SingleTarget. + +```yaml +Type: System.String +Parameter Sets: Forwarding +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingTargetType + +The forwarding target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. Voicemail is only supported for Immediate forwarding. + +SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1 +delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). + +```yaml +Type: System.String +Parameter Sets: Forwarding +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingType + +The type of forwarding to set. Supported values are Immediate and Simultaneous + +```yaml +Type: System.String +Parameter Sets: Forwarding +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMembershipDetails + +The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a +call group and the notification setting for the specified user for that call group. + +This parameter only exists if the specified user is a member of a call group. You can't create it, you can only change it. + +You need to always specify the full group membership details as the parameter value. What you set here will over-write the current group membership details. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] +Parameter Sets: CallGroupMembership +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -GroupNotificationOverride + +The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. + +The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. + +```yaml +Type: System.String +Parameter Sets: CallGroupNotification +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsForwardingEnabled + +This parameter controls whether forwarding is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: Forwarding, ForwardingOnOff +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUnansweredEnabled + +This parameter controls whether forwarding for unanswered calls is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: Unanswered, UnansweredOnOff +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredDelay + +The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and +60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds. + +```yaml +Type: System.String +Parameter Sets: Unanswered +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredTarget + +The unanswered target. Supported type of values are ObjectId, SIP address and phone number. +For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. + +Only used when UnansweredTargetType is SingleTarget. + +```yaml +Type: System.String +Parameter Sets: Unanswered +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredTargetType + +The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. + +SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's +delegates. Group is used when forwarding the unanswered call to the specified user's call group. + +```yaml +Type: System.String +Parameter Sets: Unanswered +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +The specified user need to have the Microsoft Phone System license assigned. + +When forwarding to MyDelegates, the specified user needs to have one or more delegates defined that are allowed to receive calls. When forwarding to Group, the +specified user needs to have one or more members of the user's call group. + +The cmdlet is validating the different settings and is always writing all the parameters in a settings group. You might see validation errors from the cmdlet due to +this behavior. As an example, if you have ForwardingTargetType set to Group and you want to remove all members of the call group, you will get a validation error. + +You can specify a SIP URI without 'sip:' on input, but the output from Get-CsUserCallingSettings will show the full SIP URI. + +You are not able to configure delegates via this cmdlet. Please use New-CsUserCallingDelegate, Set-CsUserCallingDelegate cmdlets and Remove-CsUserCallingDelegate. + +## RELATED LINKS +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/microsoftteams/get-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/new-csusercallingdelegate) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/set-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/Set-CsVideoInteropServiceProvider.md similarity index 97% rename from teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/Set-CsVideoInteropServiceProvider.md index 87c3b8383b..a8280cd247 100644 --- a/teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsVideoInteropServiceProvider.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csvideointeropserviceprovider applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Set-CsVideoInteropServiceProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-csvideointeropserviceprovider +schema: 2.0.0 +title: Set-CsVideoInteropServiceProvider --- # Set-CsVideoInteropServiceProvider diff --git a/teams/teams-ps/teams/Set-Team.md b/teams/teams-ps/MicrosoftTeams/Set-Team.md similarity index 97% rename from teams/teams-ps/teams/Set-Team.md rename to teams/teams-ps/MicrosoftTeams/Set-Team.md index ec7260f07c..e5bdc94f92 100644 --- a/teams/teams-ps/teams/Set-Team.md +++ b/teams/teams-ps/MicrosoftTeams/Set-Team.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-team -title: Set-Team -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-team +schema: 2.0.0 +title: Set-Team --- # Set-Team @@ -40,27 +40,26 @@ Set-Team -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Updated Tea ## PARAMETERS -### -GroupId -GroupId of the team +### -AllowAddRemoveApps +Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Team display name. -Team Name Characters Limit - 256. +### -AllowChannelMentions +Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -71,13 +70,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Team description. -Team Description Characters Limit - 1024. +### -AllowCreatePrivateChannels +Determines whether private channel creation is allowed for the team. ```yaml -Type: String -Parameter Sets: (All) +Type: Boolean +Parameter Sets: CreateTeam Aliases: Required: False @@ -87,13 +85,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MailNickName -The MailNickName parameter specifies the alias for the associated Office 365 Group. -This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. -The value of the MailNickName parameter has to be unique across your tenant. +### -AllowCreateUpdateChannels +Setting that determines whether or not members (and not just owners) are allowed to create channels. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -104,11 +100,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Classification -This parameter is reserved for internal Microsoft use. +### -AllowCreateUpdateRemoveConnectors +Setting that determines whether or not members (and not only owners) can manage connectors in the team. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -119,12 +115,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Visibility -Team visibility. -Valid values are "Private" and "Public" +### -AllowCreateUpdateRemoveTabs +Setting that determines whether or not members (and not only owners) can manage tabs in channels. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -135,8 +130,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAddRemoveApps -Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. +### -AllowCustomMemes +Setting that determines whether or not members can use the custom memes functionality in teams. ```yaml Type: Boolean @@ -150,8 +145,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelMentions -Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. +### -AllowDeleteChannels +Setting that determines whether or not members (and not only owners) can delete channels in the team. ```yaml Type: Boolean @@ -165,8 +160,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreateUpdateChannels -Setting that determines whether or not members (and not just owners) are allowed to create channels. +### -AllowGiphy +Setting that determines whether or not giphy can be used in the team. ```yaml Type: Boolean @@ -180,8 +175,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreateUpdateRemoveConnectors -Setting that determines whether or not members (and not only owners) can manage connectors in the team. +### -AllowGuestCreateUpdateChannels +Setting that determines whether or not guests can create channels in the team. ```yaml Type: Boolean @@ -195,8 +190,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreateUpdateRemoveTabs -Setting that determines whether or not members (and not only owners) can manage tabs in channels. +### -AllowGuestDeleteChannels +Setting that determines whether or not guests can delete in the team. ```yaml Type: Boolean @@ -210,8 +205,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCustomMemes -Setting that determines whether or not members can use the custom memes functionality in teams. +### -AllowOwnerDeleteMessages +Setting that determines whether or not owners can delete messages that they or other members of the team have posted. ```yaml Type: Boolean @@ -225,8 +220,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDeleteChannels -Setting that determines whether or not members (and not only owners) can delete channels in the team. +### -AllowStickersAndMemes +Setting that determines whether stickers and memes usage is allowed in the team. ```yaml Type: Boolean @@ -240,8 +235,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowGiphy -Setting that determines whether or not giphy can be used in the team. +### -AllowTeamMentions +Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) ```yaml Type: Boolean @@ -255,8 +250,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowGuestCreateUpdateChannels -Setting that determines whether or not guests can create channels in the team. +### -AllowUserDeleteMessages +Setting that determines whether or not members can delete messages that they have posted. ```yaml Type: Boolean @@ -270,8 +265,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowGuestDeleteChannels -Setting that determines whether or not guests can delete in the team. +### -AllowUserEditMessages +Setting that determines whether or not users can edit messages that they have posted. ```yaml Type: Boolean @@ -285,11 +280,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOwnerDeleteMessages -Setting that determines whether or not owners can delete messages that they or other members of the team have posted. +### -Classification +This parameter is reserved for internal Microsoft use. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -300,11 +295,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowStickersAndMemes -Setting that determines whether stickers and memes usage is allowed in the team. +### -Description +Team description. +Team Description Characters Limit - 1024. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -315,11 +311,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTeamMentions -Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) +### -DisplayName +Team display name. +Team Name Characters Limit - 256. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -330,11 +327,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserDeleteMessages -Setting that determines whether or not members can delete messages that they have posted. +### -GiphyContentRating +Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -345,23 +342,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserEditMessages -Setting that determines whether or not users can edit messages that they have posted. +### -GroupId +GroupId of the team ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -GiphyContentRating -Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" +### -MailNickName +The MailNickName parameter specifies the alias for the associated Office 365 Group. +This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. +The value of the MailNickName parameter has to be unique across your tenant. ```yaml Type: String @@ -389,12 +388,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreatePrivateChannels -Determines whether private channel creation is allowed for the team. +### -Visibility +Team visibility. +Valid values are "Private" and "Public" ```yaml -Type: Boolean -Parameter Sets: CreateTeam +Type: String +Parameter Sets: (All) Aliases: Required: False @@ -415,6 +415,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-Team](https://learn.microsoft.com/powershell/module/microsoftteams/get-team) -[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) +[New-Team](https://learn.microsoft.com/powershell/module/microsoftteams/new-team) diff --git a/teams/teams-ps/teams/Set-TeamArchivedState.md b/teams/teams-ps/MicrosoftTeams/Set-TeamArchivedState.md similarity index 96% rename from teams/teams-ps/teams/Set-TeamArchivedState.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamArchivedState.md index 5b3b53ee89..c9e850cd7e 100644 --- a/teams/teams-ps/teams/Set-TeamArchivedState.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamArchivedState.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-teamarchivedstate -title: Set-TeamArchivedState -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teamarchivedstate +schema: 2.0.0 +title: Set-TeamArchivedState --- # Set-TeamArchivedState diff --git a/teams/teams-ps/teams/Set-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/Set-TeamChannel.md similarity index 95% rename from teams/teams-ps/teams/Set-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamChannel.md index 14b6fa83e6..d740d5726e 100644 --- a/teams/teams-ps/teams/Set-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamChannel.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-teamchannel -title: Set-TeamChannel -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teamchannel +schema: 2.0.0 +title: Set-TeamChannel --- # Set-TeamChannel @@ -36,8 +36,8 @@ Set-TeamChannel -GroupId c58566a6-4bb4-4221-98d4-47677dbdbef6 -CurrentDisplayNam ## PARAMETERS -### -GroupId -GroupId of the team +### -CurrentDisplayName +Current channel name ```yaml Type: String @@ -51,41 +51,41 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -CurrentDisplayName -Current channel name +### -Description +Updated Channel description. +Channel Description Characters Limit - 1024. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -NewDisplayName -New Channel display name. -Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : \< \> ? -+ | ' " +### -GroupId +GroupId of the team ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Description -Updated Channel description. -Channel Description Characters Limit - 1024. +### -NewDisplayName +New Channel display name. +Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : \< \> ? ++ | ' " ```yaml Type: String diff --git a/teams/teams-ps/teams/Set-TeamPicture.md b/teams/teams-ps/MicrosoftTeams/Set-TeamPicture.md similarity index 94% rename from teams/teams-ps/teams/Set-TeamPicture.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamPicture.md index eeb537153b..2f1a701a64 100644 --- a/teams/teams-ps/teams/Set-TeamPicture.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamPicture.md @@ -1,25 +1,19 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-teampicture -title: Set-TeamPicture -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teampicture +schema: 2.0.0 +title: Set-TeamPicture --- # Set-TeamPicture ## SYNOPSIS - Update the team picture. -Note: the command will return immediately, but the Teams application will not reflect the update immediately. -The Teams application may need to be open for up to an hour before changes are reflected. - -Note: this cmdlet is not support in special government environments (TeamsGCCH and TeamsDoD) and is currently only supported in our beta release. - ## SYNTAX ``` @@ -27,6 +21,10 @@ Set-TeamPicture -GroupId -ImagePath [] ``` ## DESCRIPTION +Note: the command will return immediately, but the Teams application will not reflect the update immediately. +The Teams application may need to be open for up to an hour before changes are reflected. + +Note: this cmdlet is not support in special government environments (TeamsGCCH and TeamsDoD) and is currently only supported in our beta release. ## EXAMPLES diff --git a/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md b/teams/teams-ps/MicrosoftTeams/Set-TeamTargetingHierarchy.md similarity index 94% rename from teams/teams-ps/teams/Set-TeamTargetingHierarchy.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamTargetingHierarchy.md index 4f8a952534..1aa85c5f33 100644 --- a/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamTargetingHierarchy.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams -title: Set-TeamTargetingHierarchy -schema: 2.0.0 -author: serdarsoysal ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/microsoftteams/connect-microsoftteams +schema: 2.0.0 +title: Set-TeamTargetingHierarchy --- # Set-TeamTargetingHierarchy @@ -47,35 +47,35 @@ requestId c67e86109d88479e9708c3b7e8ff7217 ## PARAMETERS -### -FilePath -Specifies the path to a CSV file that defines the hierarchy. +### -ApiVersion +The version of the Hierarchy APIs to use. Valid values are: 1 or 2. + +Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None -Accept pipeline input: False +Default value: 1 +Accept pipeline input: false Accept wildcard characters: False ``` -### -ApiVersion -The version of the Hierarchy APIs to use. Valid values are: 1 or 2. - -Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. +### -FilePath +Specifies the path to a CSV file that defines the hierarchy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 1 -Accept pipeline input: false +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` @@ -90,4 +90,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-TeamTargetingHierarchyStatus](https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus) +[Get-TeamTargetingHierarchyStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-teamtargetinghierarchystatus) diff --git a/teams/teams-ps/teams/Set-TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Set-TeamsApp.md similarity index 93% rename from teams/teams-ps/teams/Set-TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamsApp.md index 3f493249cb..bdaa599aa2 100644 --- a/teams/teams-ps/teams/Set-TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamsApp.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-teamsapp -title: Set-TeamsApp +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teamsapp schema: 2.0.0 +title: Set-TeamsApp --- # Set-TeamsApp diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/MicrosoftTeams/Set-TeamsEnvironmentConfig.md similarity index 97% rename from teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamsEnvironmentConfig.md index 81c1a3382e..e522775a6f 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamsEnvironmentConfig.md @@ -1,13 +1,14 @@ --- +author: VikneshMSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Locale: en-US +manager: vinelap Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-teamsenvironmentconfig -title: Set-TeamsEnvironmentConfig -schema: 2.0.0 -author: VikneshMSFT ms.author: vimohan ms.reviewer: pbafna -manager: vinelap +online version: https://learn.microsoft.com/powershell/module/microsoftteams/set-teamsenvironmentconfig +schema: 2.0.0 +title: Set-TeamsEnvironmentConfig --- # Set-TeamsEnvironmentConfig diff --git a/teams/teams-ps/teams/Start-CsExMeetingMigration.md b/teams/teams-ps/MicrosoftTeams/Start-CsExMeetingMigration.md similarity index 90% rename from teams/teams-ps/teams/Start-CsExMeetingMigration.md rename to teams/teams-ps/MicrosoftTeams/Start-CsExMeetingMigration.md index 411d082929..8c5c9bf9f3 100644 --- a/teams/teams-ps/teams/Start-CsExMeetingMigration.md +++ b/teams/teams-ps/MicrosoftTeams/Start-CsExMeetingMigration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/start-csexmeetingmigration applicable: Microsoft Teams -title: Start-CsExMeetingMigration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/start-csexmeetingmigration +schema: 2.0.0 +title: Start-CsExMeetingMigration --- # Start-CsExMeetingMigration @@ -29,7 +31,7 @@ Also, with `Start-CsExMeetingMigration` cmdlet, you can start a meeting migratio ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Start-CsExMeetingMigration -Identity ashaw@contoso.com -TargetMeetingType Teams ``` @@ -39,6 +41,9 @@ This example below shows how to initiate meeting migration for user ashaw@contos ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + Specifies the Identity of the user account to be modified. A user identity can be specified by using one of four formats: 1. The user's SIP address 2. The user's user principal name (UPN) @@ -49,7 +54,6 @@ Specifies the Identity of the user account to be modified. A user identity can b Type: UserIdParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: 2 @@ -59,6 +63,9 @@ Accept wildcard characters: False ``` ### -SourceMeetingType + +> Applicable: Microsoft Teams + The possible values are: * **All:** indicates that both Skype for Business meetings and Teams meetings should be updated. This is the **default value**. * **SfB:** indicates that only Skype for Business meetings (whether on-premises or online) should be updated. @@ -68,7 +75,6 @@ The possible values are: Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -78,6 +84,9 @@ Accept wildcard characters: False ``` ### -TargetMeetingType + +> Applicable: Microsoft Teams + The possible values are: * **Current:** specifies that Skype for Business meetings remain Skype for Business meetings and Teams meetings remain Teams meetings. However audio conferencing coordinates might be changed, and any on-premises Skype for Business meetings would be migrated to Skype for Business Online. This is the **default value**. * **Teams:** specifies that any existing meeting must be migrated to Teams, regardless of whether the meeting is hosted in Skype for Business online or on-premises, and regardless of whether any audio conferencing updates are required. @@ -86,7 +95,6 @@ The possible values are: Type: Object Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -107,8 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/SkypeForBusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) -[Get-CsMeetingMigrationStatus](https://learn.microsoft.com/powershell/module/teams/get-csmeetingmigrationstatus) +[Get-CsMeetingMigrationStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csmeetingmigrationstatus) -[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration) +[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/set-cstenantmigrationconfiguration) -[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration) +[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantmigrationconfiguration) diff --git a/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Sync-CsOnlineApplicationInstance.md similarity index 88% rename from teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Sync-CsOnlineApplicationInstance.md index 8076e411c3..a77d6ed724 100644 --- a/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Sync-CsOnlineApplicationInstance.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance applicable: Microsoft Teams -title: Sync-CsOnlineApplicationInstance -schema: 2.0.0 author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: naveenv -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/sync-csonlineapplicationinstance +schema: 2.0.0 +title: Sync-CsOnlineApplicationInstance --- # Sync-CsOnlineApplicationInstance ## SYNOPSIS -Use the Sync-CsOnlineApplicationInstance cmdlet to sync the application instance from Microsoft Entra ID into Agent Provisioning Service. This is needed because the mapping between application instance and application needs to be stored in Agent Provisioning Service. If an application ID was provided at the creation of the application instance, you need not run this cmdlet. +Sync the application instance from Microsoft Entra ID into Agent Provisioning Service. ## SYNTAX @@ -22,18 +23,18 @@ Sync-CsOnlineApplicationInstance -ObjectId [-CallbackUri ] [-Forc ``` ## DESCRIPTION -Use the Sync-CsOnlineApplicationInstance cmdlet to sync application instances from Microsoft Entra ID into Agent Provisioning Service. +Use the Sync-CsOnlineApplicationInstance cmdlet to sync the application instance from Microsoft Entra ID into Agent Provisioning Service. This is needed because the mapping between application instance and application needs to be stored in Agent Provisioning Service. If an application ID was provided at the creation of the application instance, you need not run this cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Sync-CsOnlineApplicationInstance -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationId yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy ``` This example sync application instance with object ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" and application ID "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy" into Agent Provisioning Service. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Sync-CsOnlineApplicationInstance -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationId 00000000-0000-0000-0000-000000000000 ``` @@ -43,11 +44,11 @@ The command removes the mapping for application instance with object ID "xxxxxxx ## PARAMETERS -### -CallbackUri -This parameter is reserved for internal Microsoft use. +### -AcsResourceId +The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: @@ -58,8 +59,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ObjectId -The application instance ID. +### -ApplicationId +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid @@ -73,11 +74,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. +### -CallbackUri +This parameter is reserved for internal Microsoft use. ```yaml -Type: System.Guid +Type: String Parameter Sets: (All) Aliases: @@ -88,13 +89,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcsResourceId -The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -118,14 +119,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -ObjectId +The application instance ID. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -134,13 +134,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -160,10 +161,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/find-csonlineapplicationinstance) -[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Test-CsEffectiveTenantDialPlan.md similarity index 90% rename from teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Test-CsEffectiveTenantDialPlan.md index 1402626383..7f9be8612c 100644 --- a/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsEffectiveTenantDialPlan.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-cseffectivetenantdialplan applicable: Microsoft Teams -title: Test-CsEffectiveTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-cseffectivetenantdialplan +schema: 2.0.0 +title: Test-CsEffectiveTenantDialPlan --- # Test-CsEffectiveTenantDialPlan @@ -34,14 +36,14 @@ The `Test-CsEffectiveTenantDialPlan` cmdlet normalizes the dialed number by appl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsEffectiveTenantDialPlan -Identity adelev | Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 ``` This example gets the Identity of a dial plan that is associated with the identity of a user, and applies the retrieved tenant dial plan to normalize the dialed number. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 -Identity adelev@contoso.onmicrosoft.com ``` @@ -50,14 +52,16 @@ This example tests the given dialed number against a specific identity. ## PARAMETERS -### -DialedNumber -The DialedNumber parameter is the phone number to be normalized with the effective tenant dial plan. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: PhoneNumber +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -66,14 +70,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Indicates the identity of the user account to be tested against. The user's SIP address, the user's user principal name (UPN) or the user's display name can be specified. +### -DialedNumber + +> Applicable: Microsoft Teams + +The DialedNumber parameter is the phone number to be normalized with the effective tenant dial plan. ```yaml -Type: UserIdParameter +Type: PhoneNumber Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -82,14 +88,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -EffectiveTenantDialPlanName + +> Applicable: Microsoft Teams + +The EffectiveTenantDialPlanName parameter is the effective tenant dial plan name in the form of TenantId_TenantDialPlan_GlobalVoiceDialPlan. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -99,6 +107,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -107,7 +118,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -116,15 +126,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. +### -Identity + +> Applicable: Microsoft Teams + +Indicates the identity of the user account to be tested against. The user's SIP address, the user's user principal name (UPN) or the user's display name can be specified. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -133,14 +144,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EffectiveTenantDialPlanName -The EffectiveTenantDialPlanName parameter is the effective tenant dial plan name in the form of TenantId_TenantDialPlan_GlobalVoiceDialPlan. +### -TenantScopeOnly + +> Applicable: Microsoft Teams + +Runs the test only against Tenant-level dial plans (does not take into account Service Level Dial Plans). ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -149,14 +162,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantScopeOnly -Runs the test only against Tenant-level dial plans (does not take into account Service Level Dial Plans). +### -WhatIf + +> Applicable: Microsoft Teams + +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Test-CsInboundBlockedNumberPattern.md similarity index 93% rename from teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Test-CsInboundBlockedNumberPattern.md index 56da11fbfd..166872828e 100644 --- a/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsInboundBlockedNumberPattern.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern applicable: Microsoft Teams -title: Test-CsInboundBlockedNumberPattern author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-csinboundblockednumberpattern +title: Test-CsInboundBlockedNumberPattern --- # Test-CsInboundBlockedNumberPattern diff --git a/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsShiftsConnectionValidate.md similarity index 91% rename from teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md rename to teams/teams-ps/MicrosoftTeams/Test-CsTeamsShiftsConnectionValidate.md index 7d7fd3966d..2295e94b39 100644 --- a/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsShiftsConnectionValidate.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Test-CsTeamsShiftsConnectionValidate -author: gucsun ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate schema: 2.0.0 +title: Test-CsTeamsShiftsConnectionValidate --- # Test-CsTeamsShiftsConnectionValidate @@ -51,13 +52,14 @@ Returns the list of conflicts if there are any. Empty result means there's no co ### -ConnectorId +> Applicable: Microsoft Teams + The ID of the shifts connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -65,15 +67,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name - -The connector's instance name. +### -ConnectorSpecificSettings +The connector specific settings. ```yaml -Type: String -Parameter Sets: (All) +Type: IConnectorInstanceRequestConnectorSpecificSettings +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None @@ -81,14 +82,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector specific settings. +### -Name + +> Applicable: Microsoft Teams + +The connector's instance name. ```yaml -Type: IConnectorInstanceRequestConnectorSpecificSettings -Parameter Sets: NewExpanded +Type: String +Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -107,6 +110,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/MicrosoftTeams/Test-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsTranslationRule.md new file mode 100644 index 0000000000..c575afd2dc --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsTranslationRule.md @@ -0,0 +1,176 @@ +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamstranslationrule +schema: 2.0.0 +title: Test-CsTeamsTranslationRule +--- + +# Test-CsTeamsTranslationRule + +## SYNOPSIS +This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. + +## SYNTAX + +``` +Test-CsTeamsTranslationRule -PhoneNumber [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION +This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. + +## EXAMPLES + +### Example 1 +```powershell +Test-CsTeamsTranslationRule -PhoneNumber 1234 +``` +```output +Identity Pattern PhoneNumberTranslated Translation +-------- ------- --------------------- ----------- +rule1 ^1234$ 4321 4321 +``` +This example displays information about the manipulation rule matching the phone number 1234. + +## PARAMETERS + +### -Break +{{ Fill Break Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +{{ Fill HttpPipelineAppend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +{{ Fill HttpPipelinePrepend Description }} + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumber +The phone number to test. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +{{ Fill Proxy Description }} + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +{{ Fill ProxyCredential Description }} + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +{{ Fill ProxyUseDefaultCredentials Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES +The cmdlet is available in Teams PowerShell Module 4.5.0 or later. + +The matching logic used in the cmdlet is the same as when the manipulation rule has been associated with an SBC and a call is being routed. + +If a match is found in two or more manipulation rules, the first one is returned. + +There is a short delay before newly created manipulation rules are added to the evaluation. + +## RELATED LINKS +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamstranslationrule) + +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamstranslationrule) + +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamstranslationrule) + +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsUnassignedNumberTreatment.md similarity index 80% rename from teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Test-CsTeamsUnassignedNumberTreatment.md index 1682ef0ba6..fa15e7ceae 100644 --- a/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsUnassignedNumberTreatment.md @@ -1,11 +1,12 @@ --- -external help file: Microsoft.TeamsCmdlets.Powershell.Custom.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment -Module Name: Microsoft Teams -title: Test-CsTeamsUnassignedNumberTreatment author: firatakandere +external help file: Microsoft.TeamsCmdlets.Powershell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: osakande +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment schema: 2.0.0 +title: Test-CsTeamsUnassignedNumberTreatment --- # Test-CsTeamsUnassignedNumberTreatment @@ -64,10 +65,10 @@ The cmdlet is available in Teams PS module 3.2.0-preview or later. ## RELATED LINKS -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment) -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment) -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment) -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md b/teams/teams-ps/MicrosoftTeams/Test-CsVoiceNormalizationRule.md similarity index 80% rename from teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md rename to teams/teams-ps/MicrosoftTeams/Test-CsVoiceNormalizationRule.md index 43647176a6..4de8034499 100644 --- a/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsVoiceNormalizationRule.md @@ -1,21 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-csvoicenormalizationrule applicable: Microsoft Teams -title: Test-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/test-csvoicenormalizationrule +schema: 2.0.0 +title: Test-CsVoiceNormalizationRule --- # Test-CsVoiceNormalizationRule ## SYNOPSIS Tests a telephone number against a voice normalization rule and returns the number after the normalization rule has been applied. -Voice normalization rules are typically used to convert a telephone dialing requirement (for example, you must dial 9 to access an outside line) to the E.164 phone -number format. -This cmdlet was introduced in Lync Server 2010. ## SYNTAX @@ -25,14 +24,17 @@ Test-CsVoiceNormalizationRule -DialedNumber -NormalizationRule Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + The phone number against which you want to test the normalization rule specified in the NormalizationRule parameter. Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber @@ -100,7 +105,6 @@ Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber Type: PhoneNumber Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: True Position: Named @@ -110,6 +114,9 @@ Accept wildcard characters: False ``` ### -NormalizationRule + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + An object containing a reference to the normalization rule against which you want to test the number specified in the DialedNumber parameter. For Lync and Skype for Business Server, you can retrieve voice normalization rules by calling the `Get-CsVoiceNormalizationRule` cmdlet. @@ -119,7 +126,6 @@ For Microsoft Teams, you can retrieve voice normalization rules by calling the ` Type: NormalizationRule Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: True Position: Named @@ -146,6 +152,6 @@ Returns an object of type Microsoft.Rtc.Management.Voice.NormalizationRuleTestRe ## RELATED LINKS -[New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) +[New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/microsoftteams/new-csvoicenormalizationrule) -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/microsoftteams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber.md similarity index 87% rename from teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber.md index a2f7712c39..34b3532993 100644 --- a/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/unregister-csonlinedialinconferencingservicenumber applicable: Microsoft Teams -title: Unregister-CsOnlineDialInConferencingServiceNumber -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/unregister-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Unregister-CsOnlineDialInConferencingServiceNumber --- # Unregister-CsOnlineDialInConferencingServiceNumber @@ -28,7 +30,7 @@ Unassigns the previously assigned service number as default Conference Bridge nu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Unregister-CsOnlineDialInConferencingServiceNumber -BridgeName "Conference Bridge" -RemoveDefaultServiceNumber 1234 ``` @@ -37,46 +39,52 @@ Unassigns the 1234 Service Number to the given Conference Bridge. ## PARAMETERS -### -Identity -PARAMVALUE: String +### -BridgeId + +> Applicable: Microsoft Teams + +PARAMVALUE: Guid ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: ConferencingServiceNumber +### -BridgeName + +> Applicable: Microsoft Teams + +PARAMVALUE: String ```yaml -Type: ConferencingServiceNumber +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeId -PARAMVALUE: Guid +### -DomainController + +> Applicable: Microsoft Teams + +PARAMVALUE: Fqdn ```yaml -Type: Guid +Type: Fqdn Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: DC Required: False Position: Named @@ -85,14 +93,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeName -PARAMVALUE: String +### -Force + +> Applicable: Microsoft Teams + +PARAMVALUE: SwitchParameter ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -101,46 +111,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -PARAMVALUE: Fqdn +### -Identity + +> Applicable: Microsoft Teams + +PARAMVALUE: String ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: DC -applicable: Microsoft Teams +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Instance + +> Applicable: Microsoft Teams + +PARAMVALUE: ConferencingServiceNumber ```yaml -Type: SwitchParameter +Type: ConferencingServiceNumber Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -RemoveDefaultServiceNumber + +> Applicable: Microsoft Teams + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -150,13 +166,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Microsoft Teams + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -166,13 +184,15 @@ Accept wildcard characters: False ``` ### -TenantDomain + +> Applicable: Microsoft Teams + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Update-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Update-CsAutoAttendant.md similarity index 83% rename from teams/teams-ps/teams/Update-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Update-CsAutoAttendant.md index e904781ef4..e33cbb4737 100644 --- a/teams/teams-ps/teams/Update-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/update-csautoattendant applicable: Microsoft Teams -title: Update-CsAutoAttendant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/microsoftteams/update-csautoattendant +schema: 2.0.0 +title: Update-CsAutoAttendant --- # Update-CsAutoAttendant @@ -24,11 +26,11 @@ Update-CsAutoAttendant -Identity [-Tenant ] [] ## DESCRIPTION This cmdlet provides a way to update the resources associated with an auto attendant configured for use in your organization. Currently, it repairs the Dial-by-Name recognition status of an auto attendant. -Note: This cmdlet only triggers the refresh of auto attendant resources. It does not wait until all the resources have been refreshed. The last completed status of auto attendant can be retrieved using [`Get-CsAutoAttendantStatus`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) cmdlet. +Note: This cmdlet only triggers the refresh of auto attendant resources. It does not wait until all the resources have been refreshed. The last completed status of auto attendant can be retrieved using [`Get-CsAutoAttendantStatus`](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus) cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Update-CsAutoAttendant -Identity "6abea1cd-904b-520b-be96-1092cc096432" ``` @@ -38,13 +40,15 @@ In Example 1, the Update-CsAutoAttendant cmdlet is used to update all resources ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The identity for the AA whose resources are to be updated. ```yaml Type: System.String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: True Position: 0 @@ -55,11 +59,12 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Microsoft Teams + ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -84,10 +89,10 @@ The Update-CsAutoAttendant cmdlet accepts a string as the Identity parameter. ## RELATED LINKS -[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendant) -[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/microsoftteams/get-csautoattendantstatus) -[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/set-csautoattendant) -[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csautoattendant) diff --git a/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Update-CsCustomPolicyPackage.md similarity index 85% rename from teams/teams-ps/teams/Update-CsCustomPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Update-CsCustomPolicyPackage.md index b993377f9a..430d0913ab 100644 --- a/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsCustomPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: sunguchuan external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: Update-CsCustomPolicyPackage -author: sunguchuan ms.author: gucsun -manager: dasosby -online version: https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage +online version: https://learn.microsoft.com/powershell/module/microsoftteams/update-cscustompolicypackage schema: 2.0.0 +title: Update-CsCustomPolicyPackage --- # Update-CsCustomPolicyPackage @@ -44,49 +45,52 @@ Updates the custom package named "MyPackage" to have a description of "My packag ## PARAMETERS -### -Identity +### -Description -The name of the custom package. +> Applicable: Microsoft Teams + +The description of the custom package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True -Position: 0 +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyList +### -Identity -A list of one or more policies to be included in the updated package. To specify the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy). +> Applicable: Microsoft Teams + +The name of the custom package. ```yaml -Type: String[] +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -PolicyList -The description of the custom package. +> Applicable: Microsoft Teams + +A list of one or more policies to be included in the updated package. To specify the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsmessagingpolicy). ```yaml -Type: String +Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -104,8 +108,8 @@ The resulting custom package's contents will be replaced by the new one instead ## RELATED LINKS -[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/get-cspolicypackage) -[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage) +[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/new-cscustompolicypackage) -[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage) +[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/microsoftteams/remove-cscustompolicypackage) diff --git a/teams/teams-ps/teams/Update-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Update-CsPhoneNumberTag.md similarity index 85% rename from teams/teams-ps/teams/Update-CsPhoneNumberTag.md rename to teams/teams-ps/MicrosoftTeams/Update-CsPhoneNumberTag.md index 31d633d8dd..7f751afe00 100644 --- a/teams/teams-ps/teams/Update-CsPhoneNumberTag.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsPhoneNumberTag.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/update-csphonenumbertag applicable: Microsoft Teams -title: Update-CsPhoneNumberTag author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/microsoftteams/update-csphonenumbertag schema: 2.0.0 +title: Update-CsPhoneNumberTag --- # Update-CsPhoneNumberTag ## SYNOPSIS -This cmdlet allows admin to update existing telephone number tags. +This cmdlet allows admin to update existing telephone number tags. ## SYNTAX @@ -23,7 +24,7 @@ Update-CsPhoneNumberTag -NewTag -Tag [] ``` ## DESCRIPTION -This cmdlet can be used to update existing tags for telephone numbers. Tags can be up to 50 characters long, including spaces, and can contain multiple words. They are not case-sensitive. An admin can get a list of all existing tags using [Get-CsPhoneNumberTag](https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag). +This cmdlet can be used to update existing tags for telephone numbers. Tags can be up to 50 characters long, including spaces, and can contain multiple words. They are not case-sensitive. An admin can get a list of all existing tags using [Get-CsPhoneNumberTag](https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumbertag). ## EXAMPLES @@ -52,7 +53,7 @@ Accept wildcard characters: False ``` ### -Tag -This is the old tag which the admin wants to update. +This is the old tag which the admin wants to update. ```yaml Type: String diff --git a/teams/teams-ps/teams/Update-CsTeamTemplate.md b/teams/teams-ps/MicrosoftTeams/Update-CsTeamTemplate.md similarity index 96% rename from teams/teams-ps/teams/Update-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/Update-CsTeamTemplate.md index 67710e31ba..70800546a1 100644 --- a/teams/teams-ps/teams/Update-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsTeamTemplate.md @@ -1,809 +1,809 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate -title: Update-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# Update-CsTeamTemplate - -## SYNOPSIS - -This cmdlet submits an operation that updates a custom team template with new team template settings. - -NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. - -## SYNTAX - -### UpdateExpanded (Default) - -```powershell -Update-CsTeamTemplate -OdataId -DisplayName -ShortDescription - [-App ] [-Category ] [-Channel ] - [-Classification ] [-Description ] [-DiscoverySetting ] - [-FunSetting ] [-GuestSetting ] [-Icon ] - [-IsMembershipLimitedToOwner] [-MemberSetting ] - [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] - [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-Confirm] [-WhatIf] - [] -``` - -### Update - -```powershell -Update-CsTeamTemplate -OdataId -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### UpdateViaIdentity - -```powershell -Update-CsTeamTemplate -InputObject -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### UpdateViaIdentityExpanded - -```powershell -Update-CsTeamTemplate -InputObject -DisplayName - -ShortDescription [-App ] [-Category ] - [-Channel ] [-Classification ] [-Description ] - [-DiscoverySetting ] [-FunSetting ] - [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] - [-MemberSetting ] [-MessagingSetting ] - [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] - [-Uri ] [-Visibility ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR') > input.json -# open json in your favorite editor, make changes - -Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body (Get-Content '.\input.json' | Out-String) -``` - -Step 1: Creates a JSON file of the template you have specified. -Step 2: Updates the template with JSON file you have edited. - -### EXAMPLE 2 - -```powershell -PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` -DisplayName='New Template';` -ShortDescription='Short Definition';` -Description='New Description';` -App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` -Channel=@{` - displayName = "General";` - id= "General";` - isFavoriteByDefault= $true` - },` - @{` - displayName= "test";` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` - isFavoriteByDefault= $false` - }` -} - -PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body $template -``` - -Update to a new object - -### EXAMPLE 3 - -```powershell -PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' ` --Locale en-US -DisplayName 'New Template' ` --ShortDescription 'New Description' ` --App @{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'} ` --Channel @{ ` -displayName = "General"; ` -id= "General"; ` -isFavoriteByDefault= $true ` -}, ` -@{ ` - displayName= "test"; ` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` - isFavoriteByDefault= $false ` -} -``` -> [!Note] -> It can take up to 24 hours for Teams users to see a custom template change in the gallery. - -## PARAMETERS - -### -App - -Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. -To construct, see NOTES section for APP properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body - -The client input for a request to create a template. -Only admins from Config Api can perform this request. -To construct, see NOTES section for BODY properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate -Parameter Sets: Update, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category - -Gets or sets list of categories. - -```yaml -Type: System.String[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Channel - -Gets or sets the set of channel templates included in the team template. -To construct, see NOTES section for CHANNEL properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Classification - -Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Gets or sets the team's Description. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoverySetting - -Governs discoverability of a team. -To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName - -Gets or sets the team's DisplayName. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunSetting - -Governs use of fun media like giphy and stickers in the team. -To construct, see NOTES section for FUNSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestSetting - -Guest role settings for the team. -To construct, see NOTES section for GUESTSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Icon - -Gets or sets template icon. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsMembershipLimitedToOwner - -Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberSetting - -Member role settings for the team. -To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessagingSetting - -Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. -To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OdataId - -A composite URI of a template. - -```yaml -Type: System.String -Parameter Sets: Update, UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerUserObjectId - -Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishedBy - -Gets or sets published name. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShortDescription - -Gets or sets template short description. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Specialization - -The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateId - -Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri - -Gets or sets uri to be used for GetTemplate api call. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Visibility - -Used to control the scope of users who can view a group/team and its members, and ability to join. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -APP \: Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. - -- `[Id ]`: Gets or sets the app's ID in the global apps catalog. - -BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. - -- `DisplayName `: Gets or sets the team's DisplayName. -- `ShortDescription `: Gets or sets template short description. -- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. - - `[Id ]`: Gets or sets the app's ID in the global apps catalog. -- `[Category ]`: Gets or sets list of categories. -- `[Channel ]`: Gets or sets the set of channel templates included in the team template. - - `[Description ]`: Gets or sets channel description as displayed to users. - - `[DisplayName ]`: Gets or sets channel name as displayed to users. - - `[Id ]`: Gets or sets identifier for the channel template. - - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - - `[Configuration ]`: Represents the configuration of a tab. - - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. -- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. -- `[Description ]`: Gets or sets the team's Description. -- `[DiscoverySetting ]`: Governs discoverability of a team. - - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. -- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. - - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. - - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - - `GiphyContentRating `: Gets or sets the rating filter on giphy content. -- `[GuestSetting ]`: Guest role settings for the team. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. -- `[Icon ]`: Gets or sets template icon. -- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. -- `[MemberSetting ]`: Member role settings for the team. - - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. - - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. - - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. - - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. -- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. - - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. -- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. -- `[PublishedBy ]`: Gets or sets published name. -- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. -- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. -- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. -- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. - -CHANNEL : Gets or sets the set of channel templates included in the team template. - -- `[Description ]`: Gets or sets channel description as displayed to users. -- `[DisplayName ]`: Gets or sets channel name as displayed to users. -- `[Id ]`: Gets or sets identifier for the channel template. -- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. -- `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - - `[Configuration ]`: Represents the configuration of a tab. - - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. - -DISCOVERYSETTING \: Governs discoverability of a team. - -- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - -FUNSETTING \: Governs use of fun media like giphy and stickers in the team. - -- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. -- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. -- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. -- `GiphyContentRating `: Gets or sets the rating filter on giphy content. - -GUESTSETTING \: Guest role settings for the team. - -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. - -INPUTOBJECT \: Identity Parameter - -- `[Bssid ]`: -- `[ChassisId ]`: -- `[CivicAddressId ]`: Civic address id. -- `[Country ]`: -- `[GroupId ]`: The ID of a group whose policy assignments will be returned. -- `[Id ]`: -- `[Identity ]`: -- `[Locale ]`: -- `[LocationId ]`: Location id. -- `[OdataId ]`: A composite URI of a template. -- `[OperationId ]`: The ID of a batch policy assignment operation. -- `[OrderId ]`: -- `[PackageName ]`: The name of a specific policy package -- `[PolicyType ]`: The policy type for which group policy assignments will be returned. -- `[Port ]`: -- `[PortInOrderId ]`: -- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. -- `[SubnetId ]`: -- `[TenantId ]`: -- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -MEMBERSETTING \: Member role settings for the team. - -- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. -- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. -- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. -- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. -- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. - -MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. - -- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. -- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. -- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. -- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. -- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - -## RELATED LINKS - -- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/microsoftteams/update-csteamtemplate +schema: 2.0.0 +title: Update-CsTeamTemplate +--- + +# Update-CsTeamTemplate + +## SYNOPSIS + +This cmdlet submits an operation that updates a custom team template with new team template settings. + +## SYNTAX + +### UpdateExpanded (Default) + +```powershell +Update-CsTeamTemplate -OdataId -DisplayName -ShortDescription + [-App ] [-Category ] [-Channel ] + [-Classification ] [-Description ] [-DiscoverySetting ] + [-FunSetting ] [-GuestSetting ] [-Icon ] + [-IsMembershipLimitedToOwner] [-MemberSetting ] + [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] + [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-Confirm] [-WhatIf] + [] +``` + +### Update + +```powershell +Update-CsTeamTemplate -OdataId -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentity + +``` +Update-CsTeamTemplate -InputObject -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded + +``` +Update-CsTeamTemplate -InputObject -DisplayName + -ShortDescription [-App ] [-Category ] + [-Channel ] [-Classification ] [-Description ] + [-DiscoverySetting ] [-FunSetting ] + [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] + [-MemberSetting ] [-MessagingSetting ] + [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] + [-Uri ] [-Visibility ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR') > input.json +# open json in your favorite editor, make changes + +Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body (Get-Content '.\input.json' | Out-String) +``` + +Step 1: Creates a JSON file of the template you have specified. +Step 2: Updates the template with JSON file you have edited. + +### EXAMPLE 2 + +```powershell +PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` +DisplayName='New Template';` +ShortDescription='Short Definition';` +Description='New Description';` +App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` +Channel=@{` + displayName = "General";` + id= "General";` + isFavoriteByDefault= $true` + },` + @{` + displayName= "test";` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` + isFavoriteByDefault= $false` + }` +} + +PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body $template +``` + +Update to a new object + +### EXAMPLE 3 + +```powershell +PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' ` +-Locale en-US -DisplayName 'New Template' ` +-ShortDescription 'New Description' ` +-App @{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'} ` +-Channel @{ ` +displayName = "General"; ` +id= "General"; ` +isFavoriteByDefault= $true ` +}, ` +@{ ` + displayName= "test"; ` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` + isFavoriteByDefault= $false ` +} +``` +> [!Note] +> It can take up to 24 hours for Teams users to see a custom template change in the gallery. + +## PARAMETERS + +### -App + +Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. +To construct, see NOTES section for APP properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body + +The client input for a request to create a template. +Only admins from Config Api can perform this request. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break + +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category + +Gets or sets list of categories. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Channel + +Gets or sets the set of channel templates included in the team template. +To construct, see NOTES section for CHANNEL properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Classification + +Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Gets or sets the team's Description. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoverySetting + +Governs discoverability of a team. +To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName + +Gets or sets the team's DisplayName. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunSetting + +Governs use of fun media like giphy and stickers in the team. +To construct, see NOTES section for FUNSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestSetting + +Guest role settings for the team. +To construct, see NOTES section for GUESTSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend + +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend + +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Icon + +Gets or sets template icon. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsMembershipLimitedToOwner + +Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberSetting + +Member role settings for the team. +To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingSetting + +Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. +To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OdataId + +A composite URI of a template. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerUserObjectId + +Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy + +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential + +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials + +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishedBy + +Gets or sets published name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShortDescription + +Gets or sets template short description. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Specialization + +The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateId + +Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri + +Gets or sets uri to be used for GetTemplate api call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Visibility + +Used to control the scope of users who can view a group/team and its members, and ability to join. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +APP \: Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. + +- `[Id ]`: Gets or sets the app's ID in the global apps catalog. + +BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. + +- `DisplayName `: Gets or sets the team's DisplayName. +- `ShortDescription `: Gets or sets template short description. +- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. + - `[Id ]`: Gets or sets the app's ID in the global apps catalog. +- `[Category ]`: Gets or sets list of categories. +- `[Channel ]`: Gets or sets the set of channel templates included in the team template. + - `[Description ]`: Gets or sets channel description as displayed to users. + - `[DisplayName ]`: Gets or sets channel name as displayed to users. + - `[Id ]`: Gets or sets identifier for the channel template. + - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. + - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration ]`: Represents the configuration of a tab. + - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. +- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. +- `[Description ]`: Gets or sets the team's Description. +- `[DiscoverySetting ]`: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. +- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. + - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. + - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. + - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. + - `GiphyContentRating `: Gets or sets the rating filter on giphy content. +- `[GuestSetting ]`: Guest role settings for the team. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. +- `[Icon ]`: Gets or sets template icon. +- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. +- `[MemberSetting ]`: Member role settings for the team. + - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. + - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. + - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. + - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. + - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. +- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. + - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. + - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. + - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. + - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. + - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. +- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. +- `[PublishedBy ]`: Gets or sets published name. +- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. +- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. +- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. +- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. + +CHANNEL : Gets or sets the set of channel templates included in the team template. + +- `[Description ]`: Gets or sets channel description as displayed to users. +- `[DisplayName ]`: Gets or sets channel name as displayed to users. +- `[Id ]`: Gets or sets identifier for the channel template. +- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. +- `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration ]`: Represents the configuration of a tab. + - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. + +DISCOVERYSETTING \: Governs discoverability of a team. + +- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. + +FUNSETTING \: Governs use of fun media like giphy and stickers in the team. + +- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. +- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. +- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. +- `GiphyContentRating `: Gets or sets the rating filter on giphy content. + +GUESTSETTING \: Guest role settings for the team. + +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. + +INPUTOBJECT \: Identity Parameter + +- `[Bssid ]`: +- `[ChassisId ]`: +- `[CivicAddressId ]`: Civic address id. +- `[Country ]`: +- `[GroupId ]`: The ID of a group whose policy assignments will be returned. +- `[Id ]`: +- `[Identity ]`: +- `[Locale ]`: +- `[LocationId ]`: Location id. +- `[OdataId ]`: A composite URI of a template. +- `[OperationId ]`: The ID of a batch policy assignment operation. +- `[OrderId ]`: +- `[PackageName ]`: The name of a specific policy package +- `[PolicyType ]`: The policy type for which group policy assignments will be returned. +- `[Port ]`: +- `[PortInOrderId ]`: +- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. +- `[SubnetId ]`: +- `[TenantId ]`: +- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +MEMBERSETTING \: Member role settings for the team. + +- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. +- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. +- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. +- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. +- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. + +MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. + +- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. +- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. +- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. +- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. +- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. + +## RELATED LINKS + +- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) +- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamtemplatelist) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnection.md similarity index 96% rename from teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnection.md index 776c82c956..52f196b47d 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnection.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Update-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: -online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection +online version: https://docs.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnection schema: 2.0.0 +title: Update-CsTeamsShiftsConnection --- # Update-CsTeamsShiftsConnection @@ -133,6 +133,21 @@ Updates the connection with the specified -ConnectionId with the given settings. ## PARAMETERS +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Body The request body. @@ -178,27 +193,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -ConnectionId +The WFM connection ID for the instance. +This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, Update Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -ConnectorId +Used to specify the unique identifier of the connector being used for the connection. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -208,38 +224,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The value of the ETag field as returned by the cmdlets. +### -ConnectorSpecificSettings +Used to specify settings that are unique to the connector being used. This parameter allows administrators to configure various properties specific to the workforce management (WFM) system they are integrating with Teams Shifts. ```yaml -Type: String -Parameter Sets: (All) +Type: IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The connector instance name. +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. ```yaml Type: String @@ -253,11 +254,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: Uri +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -268,11 +269,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: PSCredential +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -283,44 +284,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -IfMatch +The value of the ETag field as returned by the cmdlets. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. +### -InputObject +Identity Parameter ```yaml -Type: String +Type: IConfigApiBasedCmdletsIdentity Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Name +The connector instance name. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: Required: False Position: Named @@ -329,11 +329,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String +Type: Uri Parameter Sets: (All) Aliases: @@ -344,28 +344,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId -The WFM connection ID for the instance. -This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: UpdateExpanded, Update +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId -Used to specify the unique identifier of the connector being used for the connection. +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: Required: False @@ -375,28 +374,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -Used to specify settings that are unique to the connector being used. This parameter allows administrators to configure various properties specific to the workforce management (WFM) system they are integrating with Teams Shifts. +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. ```yaml -Type: IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Etag -Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -424,10 +424,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection) -[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnection) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnectionInstance.md similarity index 96% rename from teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnectionInstance.md index 466a0bf1c7..a397729b44 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,12 @@ --- +author: nunocorreia-ms external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Update-CsTeamsShiftsConnectionInstance -author: nunocorreia-ms ms.author: nunocorreia -manager: -online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance +online version: https://docs.microsoft.com/powershell/module/microsoftteams/update-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Update-CsTeamsShiftsConnectionInstance --- # Update-CsTeamsShiftsConnectionInstance @@ -145,6 +145,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectionId +The WFM connection ID for the instance. +This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ConnectorAdminEmail Gets or sets the list of connector admin email addresses. @@ -187,54 +203,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -IfMatch +The value of the ETag field as returned by the cmdlets. ```yaml Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: (All) Aliases: Required: True Position: Named @@ -243,96 +260,96 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioSwapRequest -The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -InputObject +Identity Parameter ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Name +The connector instance name. ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: Uri +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -SyncFrequencyInMin +The sync frequency in minutes. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: Int32 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False Position: Named @@ -341,12 +358,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The value of the ETag field as returned by the cmdlets. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True Position: Named @@ -355,82 +372,82 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connector instance name. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Uri -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call. +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: PSCredential -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True Position: Named @@ -439,59 +456,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin -The sync frequency in minutes. +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Int32 +Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId -The WFM connection ID for the instance. -This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Etag -Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named Default value: None @@ -518,12 +518,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance) -[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance) -[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Update-M365TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Update-M365TeamsApp.md similarity index 96% rename from teams/teams-ps/teams/Update-M365TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Update-M365TeamsApp.md index 7fccff1744..168d4ef992 100644 --- a/teams/teams-ps/teams/Update-M365TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Update-M365TeamsApp.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Update-M365TeamsApp applicable: Microsoft Teams -title: Update-M365TeamsApp author: lkueter -ms.author: sribagchi +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 04/24/2024 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Update-M365TeamsApp schema: 2.0.0 +title: Update-M365TeamsApp --- # Update-M365TeamsApp @@ -76,6 +77,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AppInstallType + +App installation type. + +```yaml +Type: String +Parameter Sets: (Everyone, UsersandGroups, Noone) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Groups List of all the groups for whom the app is enabled or disabled. @@ -108,13 +125,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsBlocked +### -InstallForGroups -The state of the app in the tenant. +List of all the groups for whom the app is installed. ```yaml -Type: Boolean -Parameter Sets: (true, false) +Type: String[] +Parameter Sets: (All) Aliases: Required: False @@ -124,9 +141,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OperationType +### -InstallForOperationType -Operation performed on the app assigment. +Operation performed on the app installation. ```yaml Type: String @@ -140,9 +157,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Users +### -InstallForUsers -List of all the users for whom the app is enabled or disabled. +List of all the users for whom the app is installed. ```yaml Type: String[] @@ -156,13 +173,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppInstallType +### -InstallVersion -App installation type. +App version to be installed. ```yaml Type: String -Parameter Sets: (Everyone, UsersandGroups, Noone) Aliases: Required: True @@ -172,41 +188,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallForOperationType +### -IsBlocked -Operation performed on the app installation. +The state of the app in the tenant. ```yaml -Type: String -Parameter Sets: (Add, Remove) +Type: Boolean +Parameter Sets: (true, false) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallForUsers +### -OperationType -List of all the users for whom the app is installed. +Operation performed on the app assigment. ```yaml -Type: String[] -Parameter Sets: (All) +Type: String +Parameter Sets: (Add, Remove) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallForGroups +### -Users -List of all the groups for whom the app is installed. +List of all the users for whom the app is enabled or disabled. ```yaml Type: String[] @@ -220,21 +236,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallVersion - -App version to be installed. - -```yaml -Type: String -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -251,5 +252,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) -[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) +[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/microsoftteams/get-allm365teamsapps) +[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/microsoftteams/get-allm365teamsapps) diff --git a/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedCustomPendingApp.md similarity index 92% rename from teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md rename to teams/teams-ps/MicrosoftTeams/Update-M365UnifiedCustomPendingApp.md index f2292aee01..af52986bbf 100644 --- a/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md +++ b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedCustomPendingApp.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Update-M365UnifiedCustomPendingApp applicable: Microsoft Teams -title: Update-M365UnifiedCustomPendingApp author: michelle-paradis -ms.author: mparadis +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: swmerchant +Module Name: MicrosoftTeams +ms.author: mparadis ms.date: 01/20/2025 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Update-M365UnifiedCustomPendingApp schema: 2.0.0 +title: Update-M365UnifiedCustomPendingApp --- # Update-M365UnifiedCustomPendingApp @@ -19,7 +20,7 @@ This cmdlet updates the review status for a custom Microsoft Teams app that is p ## SYNTAX -```powershell +``` Update-M365UnifiedCustomPendingApp -Id -ReviewStatus ``` @@ -34,6 +35,7 @@ This cmdlet allows administrators to reject or publish custom Microsoft Teams ap ```powershell PS C:\> Update-M365UnifiedCustomPendingApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -ReviewStatus Published ``` + Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b to Published. ### Example 2 @@ -41,11 +43,12 @@ Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4 ```powershell PS C:\> Update-M365UnifiedCustomPendingApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -ReviewStatus Rejected ``` + Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b to Rejected. ## PARAMETERS -### Id +### -Id Application ID of the Teams app. @@ -61,7 +64,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### ReviewStatus +### -ReviewStatus The review status of the Teams app. @@ -90,3 +93,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object ## NOTES + +## RELATED LINKS \ No newline at end of file diff --git a/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedTenantSettings.md similarity index 95% rename from teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Update-M365UnifiedTenantSettings.md index ed119948d2..01caa21b7a 100644 --- a/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedTenantSettings.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Update-M365UnifiedTenantSettings applicable: Microsoft Teams -title: Update-M365UnifiedTenantSettings author: lkueter -ms.author: sribagchi +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 10/22/2024 +online version: https://docs.microsoft.com/powershell/module/microsoftteams/Update-M365UnifiedTenantSettings schema: 2.0.0 +title: Update-M365UnifiedTenantSettings --- # Update-M365UnifiedTenantSettings @@ -45,28 +46,29 @@ Updates the tenant setting for GlobalApp to None ## PARAMETERS -### -SettingName +### -Groups -Setting Name to be changed. +List of all the groups for whom the app is enabled or disabled. ```yaml -Type: String -Parameter Sets: (DefaultApp, GlobalApp, PrivateApp, EnableCopilotExtensibility) +Type: String[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SettingValue -Setting Value to be changed. +### -Operation + +Operation performed (whether we are adding or removing users/groups). ```yaml Type: String -Parameter Sets: (All, None, Some) +Parameter Sets: (add, remove) Aliases: Required: True @@ -76,13 +78,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Operation +### -SettingName -Operation performed (whether we are adding or removing users/groups). +Setting Name to be changed. ```yaml Type: String -Parameter Sets: (add, remove) +Parameter Sets: (DefaultApp, GlobalApp, PrivateApp, EnableCopilotExtensibility) Aliases: Required: True @@ -92,25 +94,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Users - -List of all the users for whom the app is enabled or disabled. +### -SettingValue +Setting Value to be changed. ```yaml -Type: String[] -Parameter Sets: (All) +Type: String +Parameter Sets: (All, None, Some) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Groups +### -Users -List of all the groups for whom the app is enabled or disabled. +List of all the users for whom the app is enabled or disabled. ```yaml Type: String[] diff --git a/teams/teams-ps/teams/Add-TeamsAppInstallation.md b/teams/teams-ps/teams/Add-TeamsAppInstallation.md deleted file mode 100644 index 031a1aa094..0000000000 --- a/teams/teams-ps/teams/Add-TeamsAppInstallation.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/add-teamsappinstallation -title: Add-TeamsAppInstallation -schema: 2.0.0 ---- - -# Add-TeamsAppInstallation - -## SYNOPSIS -Add a Teams App to Microsoft Teams. - -## SYNTAX - -### TeamScope -``` -Add-TeamsAppInstallation -AppId -TeamId [-Permissions ] [] -``` - -### UserScope -``` -Add-TeamsAppInstallation -AppId -UserId [-Permissions ] [] -``` - -## DESCRIPTION -Add a Teams App to Microsoft Teams. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example adds a Teams App to Microsoft Teams. - -### Example 2 -```powershell -PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -Permissions "TeamSettings.Read.Group ChannelMessage.Read.Group" -``` - -This example adds a Teams App to Microsoft Teams with RSC Permissions. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Permissions -RSC permissions for the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md deleted file mode 100644 index 84d184eb9d..0000000000 --- a/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -title: Disable-CsTeamsShiftsConnectionErrorReport -author: gucsun -ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport -schema: 2.0.0 ---- - -# Disable-CsTeamsShiftsConnectionErrorReport - -## SYNOPSIS - -**Note:** This cmdlet is currently in public preview. - -This cmdlet disables an error report. - -## SYNTAX - -``` -Disable-CsTeamsShiftsConnectionErrorReport -ErrorReportId [] -``` - -## DESCRIPTION - -This cmdlet disables an error report. All available instances can be found by running [Get-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Disable-CsTeamsShiftsConnectionErrorReport -ErrorReportId 18b3e490-e6ed-4c2e-9925-47e36609dff3 -``` - -Disables the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. - -## PARAMETERS - -### -ErrorReportId - -The ID of the error report that you want to disable. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport) diff --git a/teams/teams-ps/teams/Get-CsDialPlan.md b/teams/teams-ps/teams/Get-CsDialPlan.md deleted file mode 100644 index f7d347abb0..0000000000 --- a/teams/teams-ps/teams/Get-CsDialPlan.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csdialplan -applicable: Microsoft Teams -title: Get-CsDialPlan -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: rogupta ---- - -# Get-CsDialPlan - -## SYNOPSIS -Returns information about the dial plans used in your organization. -This cmdlet was introduced in Lync Server 2010. - -## SYNTAX - -### Identity (Default) -``` -Get-CsDialPlan [-Tenant ] [[-Identity] ] [-LocalStore] [] -``` - -### Filter -``` -Get-CsDialPlan [-Tenant ] [-Filter ] [-LocalStore] [] -``` - -## DESCRIPTION -This cmdlet returns information about one or more dial plans (also known as a location profiles) in an organization. -Dial plans provide information required to enable Enterprise Voice users to make telephone calls. -Dial plans are also used by the Conferencing Attendant application for dial-in conferencing. -A dial plan determines such things as which normalization rules are applied and whether a prefix must be dialed for external calls. - -Note: You can use the Get-CsDialPlan cmdlet to retrieve specific information about the normalization rules of a dial plan, but if that's the only dial plan information you need, you can also use the Get-CsVoiceNormalizationRule cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsDialPlan -``` - -Example 1 returns a collection of all the dial plans configured for use in your organization; this is done by calling the Get-CsDialPlan cmdlet without any additional parameters. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsDialPlan -Identity RedmondDialPlan -``` - -In Example 2, the Identity parameter is used to limit the retrieved data to dial plans that have a per-user dial plan with the Identity RedmondDialPlan. -Because identities must be unique, this command will return only the specified dial plan. - -### -------------------------- Example 3 -------------------------- -``` -Get-CsDialPlan -Identity site:Redmond -``` - -Example 3 is identical to Example 2 except that instead of retrieving a per-user dial plan, we're retrieving a dial plan assigned to a site. -We do that by specifying the value site: followed by the site name (in this case Redmond) of the site we want to retrieve. - -### -------------------------- Example 4 -------------------------- -``` -Get-CsDialPlan -Filter tag:* -``` - -This example uses the Filter parameter to return a collection of all the dial plans that have been configured at the per-user scope. -(Settings configured at the per-user, or tag, scope can be directly assigned to users and groups.) The wildcard string tag:* instructs the cmdlet to return only those dial plans that have an identity beginning with the string value tag:, which identifies a dial plan as a per-user dial plan. - -### -------------------------- Example 5 -------------------------- -``` -Get-CsDialPlan | Select-Object -ExpandProperty NormalizationRules -``` - -This example displays the normalization rules used by the dial plans configured for use in your organization. -Because the NormalizationRules property consists of an array of objects, the complete set of normalization rules is typically not displayed on screen. -To see all of these rules, this sample command first uses the Get-CsDialPlan cmdlet to retrieve a collection of all the dial plans. -That collection is then piped to the Select-Object cmdlet; in turn, the ExpandProperty parameter of the Select-Object cmdlet is used to "expand" the values found in the NormalizationRules property. -Expanding the values simply means that all the normalization rules will be listed out individually on the screen, the same output that would be seen if the Get-CsVoiceNormalizationRule cmdlet had been called. - -### -------------------------- Example 6 -------------------------- -``` -Get-CsDialPlan | Where-Object {$_.Description -match "Redmond"} -``` - -In Example 6, the Get-CsDialPlan cmdlet and the Where-Object cmdlet are used to retrieve a collection of all the dial plans that include the word Redmond in their description. -To do this, the command first uses the Get-CsDialPlan cmdlet to retrieve all the dial plans. -That collection is then piped to the Where-Object cmdlet, which applies a filter that limits the returned data to profiles that have the word Redmond somewhere in their Description. - -## PARAMETERS - -### -Identity -The unique identifier designating the scope, and for per-user scope a name, to identify the dial plan you want to retrieve. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Performs a wildcard search that allows you to narrow down your results to only dial plans with identities that match the given wildcard string. - -```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -Retrieves the dial plan information from the local replica of the Central Management store, rather than the Central Management store itself. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -{{Fill Tenant Description}} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile - -## NOTES - -## RELATED LINKS - -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md deleted file mode 100644 index 15b1d9e69b..0000000000 --- a/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber -applicable: Microsoft Teams -title: Get-CsHybridTelephoneNumber -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: - ---- - -# Get-CsHybridTelephoneNumber - -## SYNOPSIS -This cmdlet displays information about one or more hybrid telephone numbers. - -> [!IMPORTANT] -> This cmdlet is being deprecated. Use the **Get-CsPhoneNumberAssignment** cmdlet to display information about one or more phone numbers. Detailed instructions on how to use the new cmdlet can be found at [Get-CsPhoneNumberAssignment](/powershell/module/teams/get-csphonenumberassignment?view=teams-ps) - -## SYNTAX - -### Assignment (Default) -```powershell -Get-CsHybridTelephoneNumber [-TelephoneNumber ] -InputObject [] -``` - -## DESCRIPTION -This cmdlet displays information about one or more hybrid telephone numbers used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - -Returned results are sorted by telephone number in ascending order. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsHybridTelephoneNumber -TelephoneNumber 14025551234 -``` -```output -Id O365Region SourceType TargetType TelephoneNumber UserId --- ---------- ---------- ---------- --------------- ------ -14025551234 NOAM Hybrid 14025551234 00000000-0000-0000-0000-000000000000 -``` -This example displays information about the phone number +1 (402) 555-1234. - -### Example 2 -```powershell -Get-CsHybridTelephoneNumber -``` -```output -Id O365Region SourceType TargetType TelephoneNumber UserId --- ---------- ---------- ---------- --------------- ------ -14025551234 Hybrid 14025551234 -14025551235 Hybrid 14025551235 -``` -This example displays information about all hybrid telephone numbers in the tenant. Note that O365Region, TargetType, and UserId will not be populated. - -## PARAMETERS - -### -TelephoneNumber -Filters the returned results to a specific phone number. The number should be specified without a prefixed "+". The phone number can't have "tel:" prefixed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The identity parameter. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -The cmdlet is available in Teams PowerShell module 4.5.0 or later. - -The cmdlet is only available in GCC High and DoD cloud instances. - -## RELATED LINKS -[New-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber) - -[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md deleted file mode 100644 index f5161eb3d9..0000000000 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsMainlineAttendantAppointmentBookingFlow -applicable: Microsoft Teams -title: Get-CsMainlineAttendantAppointmentBookingFlow -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Get-CsMainlineAttendantAppointmentBookingFlow - -## SYNOPSIS -The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet returns the identified Mainline attendant appointment booking flow. - -## SYNTAX - -``` -Get-CsMainlineAttendantAppointmentBookingFlow [-Identity ] [-Tenant ] [-First ] [-Skip ] [-ExcludeContent ] [-Sort ] [-Descending ] [-NameFilter ] [] -``` - -## DESCRIPTION -The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet lets you retrieve information about the Mainline attendant appointment booking flows n your organization. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsMainlineAttendantAppointmentBookingFlow -``` - -This example gets the first 100 Mainline attendant appointment booking flows in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsMainlineAttendantAppointmentBookingFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 -``` - -This example gets the Mainline attendant appointment booking flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no appointment booking flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. - -## PARAMETERS - -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -The First parameter gets the first N appointment flows, up to a maximum of 100 at a time. -When not specified, the default behavior is to return the first 100 appointment flows. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. -If a number greater than 100 is supplied, the request will fail. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: 100 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -The Skip parameter skips the first N appointment flows. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeContent -The ExcludeContent parameter only displays the Name and Id of the appointment flow. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The Sort parameter specifies the property used to sort. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: Name -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Descending -The Descending parameter sorts appointment booking flows in descending order - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NameFilter -The NameFilter parameter returns appointment booking flows where the name contains specified string - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Identity -Represents the unique identifier of an appointment booking flow. - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md deleted file mode 100644 index 3b01b0dd8f..0000000000 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csmainlineattendantflow -applicable: Microsoft Teams -title: Get-CsMainlineAttendantFlow -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# Get-CsMainlineAttendantFlow - -## SYNOPSIS -Creates new Call Queue in your Skype for Business Online organization. - -## SYNTAX - -``` -Get-CsMainlineAttendantFlow [-MaConfigId ] [-Type ] [-FlowId ] [-Tenant ] [] -``` - -## DESCRIPTION -The Get-CsMainlineAttendantFlow cmdlet returns information about the Mainline Attendant flows configured in your organization. - -> [!CAUTION] -> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. - -## EXAMPLES - -### Example 1 -``` -Get-CsMainlineAttendantFlow -``` - -This example will list all the Mainline Attendant flows in the tenant. - -### Example 2 -``` -Get-CsMainlineAttendantFlow -MaConfig 0b31bbe5-e2a0-4117-9b6f-956bca6023f8 -``` - -This example will list all the Mainline Attendant flows associated with the specific configuration id. - -### Example 3 -``` -Get-CsMainlineAttendantFlow -Type Type 1 | Type 2 -``` - -This example will list all the Mainline Attendant flows with the specified type. - -### Example 4 -``` -Get-CsMainlineAttendantFlow -FlowId 956bca6-e2a0-4117-9b6f-023f80b31bbe5 -``` - -This example will list the Mainline Attendant flow with the specified flow id. - -## PARAMETERS - -### -MaConfigId -The Mainline Attendant configuration Id - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Mainline Attendant flow type - -PARAMVALUE: Appointment | QuestionAndAnswer - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FlowId -The Mainline Attendant flow id - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md deleted file mode 100644 index fcaf4470cd..0000000000 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsMainlineAttendantQuestionAnswerFlow -applicable: Microsoft Teams -title: Get-CsMainlineAttendantQuestionAnswerFlow -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Get-CsMainlineAttendantQuestionAnswerFlow - -## SYNOPSIS -The Get-CsMainlineAttendantQuestionAnswerFlow cmdlet returns the identified Mainline attendant question and answer flow. - -## SYNTAX - -``` -Get-CsMainlineAttendantQuestionAnswerFlow [-Identity ] [-Tenant ] [-First ] [-Skip ] [-ExcludeContent ] [-Sort ] [-Descending ] [-NameFilter ] [] -``` - -## DESCRIPTION -The Get-CsMainlineAttendantQuestionAnswerFlow cmdlet lets you retrieve information about the Mainline attendant question and answer flows n your organization. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsMainlineAttendantQuestionAnswerFlow -``` - -This example gets the first 100 Mainline attendant question and answer flows in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsMainlineAttendantQuestionAnswerFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 -``` - -This example gets the Mainline attendant question and answer flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no question and answer flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. - -## PARAMETERS - -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -The First parameter gets the first N appointment flows, up to a maximum of 100 at a time. -When not specified, the default behavior is to return the first 100 question and answer flows. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. -If a number greater than 100 is supplied, the request will fail. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: 100 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -The Skip parameter skips the first N appointment flows. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeContent -The ExcludeContent parameter only displays the Name and Id of the question and answer flow. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The Sort parameter specifies the property used to sort. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: Name -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Descending -The Descending parameter sorts appointment booking flows in descending order - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NameFilter -The NameFilter parameter returns question and answer booking flows where the name contains specified string - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Identity -Represents the unique identifier of a question and answer booking flow. - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md b/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md deleted file mode 100644 index 445cec3c6a..0000000000 --- a/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -title: Get-LicenseReportForChangeNotificationSubscription -author: serdarsoysal -ms.author: serdars -manager: alagra -online version: https://learn.microsoft.com/powershell/module/teams/get-licensereportforchangenotificationsubscription -schema: 2.0.0 ---- - -# Get-LicenseReportForChangeNotificationSubscription - -## SYNOPSIS - -This cmdlet tells whether a user has the required license to export their messages via [change notification subscription](https://learn.microsoft.com/graph/teams-licenses). - -## SYNTAX - -``` -Get-LicenseReportForChangeNotificationSubscription [-Period] [] -``` - -## DESCRIPTION - -This cmdlet supports retrieving the total number of messages sent by a user in chat/channel and whether a user has the required license(s) to send change notification events when subscribed for chat or channel messages. For more details, please review [Licenses for subscribing to chat messages](https://learn.microsoft.com/graph/teams-licenses). -This cmdlet is currently supported in preview version only. - -## EXAMPLES - -### Example -```powershell -PS C:\> Get-LicenseReportForChangeNotificationSubscription -Period 7 -``` - -Returns license info and total messages sent by users in the last 7 days. - -## PARAMETERS - -### -Period - -Number of days prior to today. Acceptable values are 7, 30, 90 and 180. - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamFunSettings.md b/teams/teams-ps/teams/Get-TeamFunSettings.md deleted file mode 100644 index 00fb19db53..0000000000 --- a/teams/teams-ps/teams/Get-TeamFunSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamFunSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teamfunsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamFunSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's fun settings, run Get-Team. - -Gets a team's fun settings. - -## SYNTAX - -``` -Get-TeamFunSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamFunSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamGuestSettings.md b/teams/teams-ps/teams/Get-TeamGuestSettings.md deleted file mode 100644 index 91b260b35c..0000000000 --- a/teams/teams-ps/teams/Get-TeamGuestSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamGuestSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teamguestsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamGuestSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's guest settings, run Get-Team. - -Gets Team guest settings. - -## SYNTAX - -``` -Get-TeamGuestSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamGuestSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamMemberSettings.md b/teams/teams-ps/teams/Get-TeamMemberSettings.md deleted file mode 100644 index f2b4df4491..0000000000 --- a/teams/teams-ps/teams/Get-TeamMemberSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamMemberSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teammembersettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamMemberSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's member settings, run Get-Team. - -Gets team member settings. - -## SYNTAX - -``` -Get-TeamMemberSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamMemberSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamMessagingSettings.md b/teams/teams-ps/teams/Get-TeamMessagingSettings.md deleted file mode 100644 index 75cbd47356..0000000000 --- a/teams/teams-ps/teams/Get-TeamMessagingSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamMessagingSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teammessagingsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamMessagingSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's messaging settings, run Get-Team. - -Gets team messaging settings. - -## SYNTAX - -``` -Get-TeamMessagingSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamMessagingSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamsAppInstallation.md b/teams/teams-ps/teams/Get-TeamsAppInstallation.md deleted file mode 100644 index 39ef59a41c..0000000000 --- a/teams/teams-ps/teams/Get-TeamsAppInstallation.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamsappinstallation -title: Get-TeamsAppInstallation -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamsAppInstallation - -## SYNOPSIS -Get a Teams App installed in Microsoft Teams. - -## SYNTAX - -### TeamScope (Default) -``` -Get-TeamsAppInstallation -TeamId [-AppInstallationId ] [-AppId ] [] -``` - -### UserScope -``` -Get-TeamsAppInstallation -UserId [-AppInstallationId ] [-AppId ] [] -``` - -## DESCRIPTION -Get a Teams App installed in Microsoft Teams. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example gets a Teams App specifying its AppId and the TeamId. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AppInstallationId -Installation identifier of the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md b/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md deleted file mode 100644 index e85a10218d..0000000000 --- a/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-cscloudmeetingpolicy -applicable: Microsoft Teams -title: Grant-CsCloudMeetingPolicy -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Grant-CsCloudMeetingPolicy - -## SYNOPSIS -Grants Skype Meetings polices for a user. - -## SYNTAX - -``` -Grant-CsCloudMeetingPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-Identity] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Grant-CsCloudMeetingPolicy cmdlet enables or disables automatic scheduling of Skype Meetings features for a specified user. -The default is disabled. - -To enable automatic scheduling for all users in a tenant, use the Set-CsCloudMeetingPolicy cmdlet. - -Note that the policies to use this cmdlet are not available unless the Set-CsCloudMeetingConfiguration cmdlet has been run to enable Skype Meetings polices for a tenant. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -Grant-CsCloudMeetingPolicy -PolicyName AutoScheduleEnabled -Identity "JaneC" -``` - -This example enables Skype Meetings automatic scheduling for a user. - -## PARAMETERS - -### -Identity -Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: `-Identity "SeattlePSTN".` - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the policy for all users automatic Skype Meeting Ready scheduling. -Can be either AutoScheduleEnabled or AutoScheduleDisabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -@{Text=} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308".` -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online, you do not have to include the Tenant parameter. -The tenant ID will be determined by your connection and credentials. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md b/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md deleted file mode 100644 index d587ae4503..0000000000 --- a/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csexternalusercommunicationpolicy -applicable: Microsoft Teams -title: Grant-CsExternalUserCommunicationPolicy -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Grant-CsExternalUserCommunicationPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsExternalUserCommunicationPolicy [[-Identity] ] [-PolicyName] - [-Tenant ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsExternalUserCommunicationPolicy [-PolicyName] [-Tenant ] - [-DomainController ] [-PassThru] [-Global] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - -## PARAMETERS - -### -PolicyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md deleted file mode 100644 index 80fbe8f586..0000000000 --- a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber -applicable: Microsoft Teams -title: New-CsHybridTelephoneNumber -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# New-CsHybridTelephoneNumber - -## SYNOPSIS -This cmdlet adds a hybrid telephone number to the tenant. - -> [!IMPORTANT] -> This cmdlet is being deprecated. Use the **New-CsOnlineDirectRoutingTelephoneNumberUploadOrder** cmdlet to add a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder?view=teams-ps) - -## SYNTAX - -### Identity (Default) -```powershell -New-CsHybridTelephoneNumber -TelephoneNumber [-Force] -InputObject [] -``` - -## DESCRIPTION -This cmdlet adds a hybrid telephone number to the tenant that can be used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - -## EXAMPLES - -### Example 1 -```powershell -New-CsHybridTelephoneNumber -TelephoneNumber +14025551234 -``` -This example adds the hybrid phone number +1 (402) 555-1234. - -## PARAMETERS - -### -TelephoneNumber -The telephone number to add. The number should be specified with a prefixed "+". The phone number can't have "tel:" prefixed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The identity parameter. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: NewViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -The cmdlet is only available in GCC High and DoD cloud instances. - -## RELATED LINKS -[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber) - -[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md deleted file mode 100644 index f55a7ea3db..0000000000 --- a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantappointmentbookingflow -applicable: Microsoft Teams -title: New-CsMainlineAttendantAppointmentBookingFlow -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# New-CsMainlineAttendantAppointmentBookingFlow - -## SYNOPSIS -Creates new Mainline Attendant appointment booking flow - -## SYNTAX - -``` -New-CsMainlineAttendantAppointmentBookingFlow -Name -Description -CallerAuthenticationMethod -ApiAuthenticationType -ApiDefinitions [-Tenant ] [] -``` - -## DESCRIPTION -The New-CsMainlineAttendantAppointmentBookingFlow cmdlet creates a new appointment booking connection that can be used with Mainline Attendant - -> [!CAUTION] -> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. - -## EXAMPLES - - -## PARAMETERS - -### -Name -The name of the appointment booking flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for the appointment booking flow - -Limit: 500 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallerAuthenticationMethod -The method by which the caller is authenticated - -PARAVALUES: sms | email | verification_link | voiceprint | user_details - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiAuthenticationType -The method of authentication used by the API - -PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiDefinitions -The parameters used by the API - -For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md deleted file mode 100644 index 6403f8f04b..0000000000 --- a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantappointmentbookingflowapidefinitionsJSON -applicable: Microsoft Teams -title: New-CsMainLineAttendantAppointmentBookingFlowApiDefinitionsJSON -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# New-CsMainlineAttendantAppointmentBookingFlow -ApiDefinition JSON Example - -## SYNOPSIS -The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantAppointmentBookingFlow.md) -ApiDefinitions requires a JSON formatted response. - -## SYNTAX - -``` -{ - "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { // Description of the query string parameters in the endpoint - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer ", // replace with an expected value - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - - "response" : { // Response to 200 range of codes - "token" : "" // this token will be used for APIs with "bearer_token_dynamic" auth type - } - }, - - "getCallerDetails" : [ // Can specify multiple endpoints below to get caller details by phone number, ID, email, etc. - { - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { // Definition of the query string parameters in the endpoint - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", // replace with an expected value. will be replaced by the response to generateAuthToken() - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - - "body" : { // Sent as JSON payload - "in_parameter1" : "", - "in_parameter2" : "" - }, - - "response" : { // Response to 200 range of codes - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" - } - }, - - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" - }, - - "body" : { - "in_parameter1" : "", - "in_parameter2" : "" - }, - - "response" : { - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" - } - } - ], - - "initiateCallerAuthentication" : [ // for SMS/email code, verification link - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - - "body" : { - "in_parameter1" : "", // phone number, user ID, etc - "in_parameter2" : "" // session ID - }, - - "response" : { - "out_parameter1" : "", // success/failure - } - } - ], - - "authenticateCaller" : [ // for SMS/email code, voiceprint, verification link, caller details - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - - "body" : { - "in_parameter1" : "", // phone number, user ID, etc - "in_parameter2" : "", // session ID - "in_parameter3" : "", // VoicePrint payload or code - }, - - "response" : { - "out_parameter1" : "", // success/failure - } - } - ], - - "getAvailableAppointmentTimeslots" : [ - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" - }, - - "body" : { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "in_parameter3" : "", // optional parameters like appointment type, doctor name, etc - "in_parameter4" : "", // number of results - }, - - "response" : { - "time_slots" : [ - { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "opt_parameter1" : "", // optional parameters like appointment type, doctor name, etc - }, - - { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "opt_parameter1" : "", // optional parameters like appointment type, doctor name, etc - } - ], - - "out_parameter3" : "", - "out_parameter4" : "", - } - } - ], - - "bookAppointment" : [ - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" - }, - - "body" : { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "in_parameter3" : "", // optional parameters like appointment type, doctor name, etc - "in_parameter4" : "", // patient id - }, - - "response" : { - "out_parameter1" : "", // success/failure - "out_parameter2" : "", - } - } - ], - - "getUpcomingAppointments" : [ - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" - }, - - "body" : { - "in_parameter1" : "", // phone number, user ID, etc - "in_parameter2" : "" - }, - - "response" : { - "time_slots" : [ - { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "opt_parameter1" : "" // optional parameters like appointment type, doctor name, etc - }, - - { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "opt_parameter1" : "" // optional parameters like appointment type, doctor name, etc - } - ], - - "out_parameter3" : "", - "out_parameter4" : "" - } - } - ] -} -``` - -## PARAMETERS - -### -ApiDefinitions -The parameters used by the API - see the JSON example above. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: Yes -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - - - diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md deleted file mode 100644 index 6b178a7e40..0000000000 --- a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/New-CsMainlineAttendantQuestionAnswerFlow -applicable: Microsoft Teams -title: New-CsMainlineAttendantQuestionAnswerFlow -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# New-CsMainlineAttendantQuestionAnswerFlow - -## SYNOPSIS -Creates new Mainline Attendant question and answer (FAQ) flow - -## SYNTAX - -``` -New-CsMainlineAttendantQuestionAnswerFlow -Name -Description -ApiAuthenticationType -KnowledgeBase [-Tenant ] [] -``` - -## DESCRIPTION -The New-CsMainlineAttendantQuestionAnswerFlow cmdlet creates a question and answer connection that can be used with Mainline Attendant - -> [!CAUTION] -> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. - -## EXAMPLES - - -## PARAMETERS - -### -Name -The name of the question and answer flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for the question and answer flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiAuthenticationType -The method of authentication used by the API - -PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KnowledgeBase -The knowledge base definition - -The parameters used by the API - -For an example, see [New-CsMainlineAttendantQuestionAnswerFlow -KnowledgeBase](./New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md deleted file mode 100644 index 94939608d0..0000000000 --- a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantquestionanswerflowknowledgebaseJSON -applicable: Microsoft Teams -title: New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# New-CsMainlineAttendantQuestionAnswerFlow -KnowledgeBase JSON Example - -## SYNOPSIS -The [New-CsMainlineAttendantQuestionAnswerFlow](./New-CsMainlineAttendantQuestionAnswerFlow.md) -Knowledge requires a path to a JSON formatted response. - -## SYNTAX - -``` -[ - { - "address_type" : "local_file", - "document_address" : "", // provide full path to the local address - "description" : "" - - }, - { - "address_type" : "webpage", - "document_address" : "", // provide full path to the webpage - "description" : "" - - }, - { - "address_type" : "api_endpoint", - "description" : "", - "api_specification" : { - "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= - "method_type": "GET" or "PUT" or "POST", - "description" : "", - "query_strings" : { // Description of the query string parameters in the endpoint - "parameter1" : "", - "parameter2" : "" - }, - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer ", // replace with an expected value - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - "response" : { // Response to 200 range of codes - "token" : "" // this token will be used for APIs with "bearer_token_dynamic" auth type - } - }, - "getResults1" : { - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= - "method_type": "GET" or "PUT" or "POST", - "description" : "", - "query_strings" : { // Definition of the query string parameters in the endpoint - "parameter1" : "", - "parameter2" : "" - }, - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", // replace with an expected value. will be replaced by the response to generateAuthToken() - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - "body" : { // Sent as JSON payload - "in_parameter1" : "", - "in_parameter2" : "" - }, - "response" : { // Response to 200 range of codes - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" - } - }, - "getResults2" : { - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= - "method_type": "GET" or "PUT" or "POST" - "description" : "", - "query_strings" : { // Definition of the query string parameters in the endpoint - "parameter1" : "", - "parameter2" : "" - }, - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", // replace with an expected value. will be replaced by the response to generateAuthToken() - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - "body" : { // Sent as JSON payload - "in_parameter1" : "", - "in_parameter2" : "" - }, - "response" : { // Response to 200 range of codes - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" - } - } - } - } -] -``` - -## PARAMETERS - -### -Knowledgebase -The parameters used by the Knowledgebase - see the JSON example above. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: Yes -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - - - diff --git a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md deleted file mode 100644 index a1cde5d5cf..0000000000 --- a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version:online version: https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder -applicable: Microsoft Teams -title: New-CsOnlineTelephoneNumberReleaseOrder -author: pavellatif -ms.author: pavellatif -ms.reviewer: pavellatif -manager: roykuntz -schema: 2.0.0 ---- - -# New-CsOnlineTelephoneNumberReleaseOrder - -## SYNOPSIS -This cmdlet creates a request to release telephone numbers from Microsoft Teams telephone number management inventory. - -## SYNTAX - -``` -New-CsOnlineTelephoneNumberReleaseOrder [-TelephoneNumber ] [-StartingNumber ] [-EndingNumber ] [-FileContent ] [] -``` - -## DESCRIPTION -This cmdlet releases existing telephone numbers from Microsoft Teams telephone number management inventory. Once released the phone numbers will not be visible in Teams PowerShell as acquired telephone numbers. A maximum of 1,000 phone numbers can be released at a time. If more than 1,000 numbers need to be released, the requests should be divided into multiple increments of up to 1,000 numbers. - -The cmdlet is an asynchronous operation and will return an OrderId as output. You can use the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to check the status of the OrderId, including any error or warning messages that might result from the operation: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789" -cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 -``` - -In this example, a telephone number "+123456789" is being released from Microsoft Teams telephone number management inventory. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. - -### Example 2 -```powershell -PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789,+134567890,+145678901" -cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 -``` - -In this example, a list of telephone numbers are being released from Microsoft Teams telephone number management. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. - -### Example 3 -```powershell -PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -StartingNumber "+12000000" -EndingNumber "+12000009" -cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 -``` - -In this example, a range of telephone numbers from "+12000000" to "+12000009" are being released from Microsoft Teams telephone number management. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. - -### Example 4 -```powershell -PS C:\> $drlist = [System.IO.File]::ReadAllBytes("C:\Users\testuser\DrNumber.csv") -PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -FileContent $drlist -cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 -``` - -In this example, the content of a file with a list of telephone numbers are being released via file upload. The file should be in Comma Separated Values (CSV) file format and should only contain the list of telephone numbers to be released. The New-CsOnlineTelephoneNumberReleaseOrder cmdlet is only used to pass the content. To read the output of this cmdlet and retrieve the status of your order, you can use OrderId with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet : `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. - -## PARAMETERS - -### -TelephoneNumber -This is the telephone number you wish to release from your tenant in Microsoft Teams telephone number management inventory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartingNumber -This is the starting number of a range of telephone number you wish to release from your tenant in Microsoft Teams telephone number management inventory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndingNumber -This is the ending number of a range of telephone number you wish to release from your tenant in Microsoft Teams telephone number management inventory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileContent -This is the content of a .csv file that includes the telephone numbers to be released from the Microsoft Teams telephone number management inventory. This parameter can be used to release up to 1,000 numbers at a time. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.String - -## NOTES -The cmdlet is available in Teams PowerShell module 6.7.1 or later. - -The cmdlet is only available in commercial and GCC cloud instances. - -## RELATED LINKS -[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) -[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder) \ No newline at end of file diff --git a/teams/teams-ps/teams/New-CsTeamsCustomBannerText b/teams/teams-ps/teams/New-CsTeamsCustomBannerText deleted file mode 100644 index af23fbf760..0000000000 --- a/teams/teams-ps/teams/New-CsTeamsCustomBannerText +++ /dev/null @@ -1,95 +0,0 @@ ---- -Module Name: MicrosoftTeams -title: New-CsTeamsCustomBannerText -author: saleens7 -ms.author: wblocker -online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsCustomBannerText -schema: 2.0.0 ---- - -# New-CsTeamsCustomBannerText - -## SYNOPSIS - -Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. - -## SYNTAX - -### Identity (Default) -``` -New-CsTeamsCustomBannerText [[-Id] ] [] -``` - -## DESCRIPTION - -Creates a single instance of a custom banner text. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-CsTeamsCustomBannerText -Identity CustomText -``` - -Creates an instance of TeamsCustomBannerText with the name CustomText. - -## PARAMETERS - -### -Id -The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. - -```yaml -Type: Guid -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Text -The text that the tenant admin would like to set in the policy. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description that the tenant admin would like to set to identify what this text represents. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) - -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) - -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/New-CsTeamsPinnedApp.md b/teams/teams-ps/teams/New-CsTeamsPinnedApp.md deleted file mode 100644 index 6c96bf3b11..0000000000 --- a/teams/teams-ps/teams/New-CsTeamsPinnedApp.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -Module Name: tmp_1cmcv0jw.3l2 -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamspinnedapp -title: New-CsTeamsPinnedApp -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# New-CsTeamsPinnedApp - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -### Identity (Default) -``` -New-CsTeamsPinnedApp [-Tenant ] -Order [-Priority ] [-Identity] - [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey -``` -New-CsTeamsPinnedApp [-Tenant ] -Parent -Id -Order [-Priority ] - [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally not provided - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Do not use. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do not use. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Order -Do not use. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parent -Do not use. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Do not use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Do not use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md deleted file mode 100644 index d08b9fba67..0000000000 --- a/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber -applicable: Microsoft Teams -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: -title: Remove-CsHybridTelephoneNumber -schema: 2.0.0 ---- - -# Remove-CsHybridTelephoneNumber - -## SYNOPSIS -This cmdlet removes a hybrid telephone number. - -> [!IMPORTANT] -> This cmdlet is being deprecated. Use the new **New-CsOnlineTelephoneNumberReleaseOrder** cmdlet to remove a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineTelephoneNumberReleaseOrder](/powershell/module/teams/new-csonlinetelephonenumberreleaseorder?view=teams-ps). - -## SYNTAX - -### Identity (Default) -```powershell -Remove-CsHybridTelephoneNumber -TelephoneNumber [-Force] [-WhatIf] [-Confirm][] -``` - -## DESCRIPTION -This cmdlet removes a hybrid telephone number used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsHybridTelephoneNumber -TelephoneNumber 14025551234 -``` -This example removes the hybrid phone number +1 (402) 555-1234. - -## PARAMETERS - -### -TelephoneNumber -The telephone number to remove. The number should be specified without a prefixed "+". The phone number can't have "tel:" prefixed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -The cmdlet is only available in GCC High and DoD cloud instances. - -## RELATED LINKS - -[New-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber) - -[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md deleted file mode 100644 index e38af8fd7a..0000000000 --- a/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsMainlineAttendantAppointmentBookingFlow -applicable: Microsoft Teams -title: Remove-CsMainlineAttendantAppointmentBookingFlow -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Remove-CsMainlineAttendantAppointmentBookingFlow - -## SYNOPSIS -The Remove-CsMainlineAttendantAppointmentBookingFlow cmdlet deletes an existing Mainline attendant appointment booking flow. - -## SYNTAX - -``` -Remove-CsMainlineAttendantAppointmentBookingFlow -Identity [-Tenant ] [] -``` - -## DESCRIPTION -The Remove-CsMainlineAttendantAppointmentBookingFlow cmdlet deletes an existing Mainline attendant appointment booking flow. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsMainlineAttendantAppointmentBookingFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 -``` - -This example removes the Mainline attendant appointment booking flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no appointment booking flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. - -## PARAMETERS - -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Identity -Represents the unique identifier of a Mainline attendant appointment booking flow. - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md deleted file mode 100644 index d57095be09..0000000000 --- a/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsMainlineAttendantQuestionAnswerFlow -applicable: Microsoft Teams -title: Remove-CsMainlineAttendantQuestionAnswerFlow -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Remove-CsMainlineAttendantQuestionAnswerFlow - -## SYNOPSIS -The Remove-CsMainlineAttendantQuestionAnswerFlow cmdlet deletes an existing Mainline attendant question and answer flow. - -## SYNTAX - -``` -Remove-CsMainlineAttendantQuestionAnswerFlow -Identity [-Tenant ] [] -``` - -## DESCRIPTION -The Remove-CsMainlineAttendantQuestionAnswerFlow cmdlet deletes an existing Mainline attendant question and answer flow. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsMainlineAttendantQuestionAnswerFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 -``` - -This example removes the Mainline attendant question and answer flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no question and answer flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. - -## PARAMETERS - -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Identity -Represents the unique identifier of a Mainline attendant question and answer flow. - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText deleted file mode 100644 index 9e9dcd1434..0000000000 --- a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText +++ /dev/null @@ -1,71 +0,0 @@ ---- -Module Name: MicrosoftTeams -title: Remove-CsTeamsCustomBannerText -author: saleens7 -ms.author: wblocker -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText -schema: 2.0.0 ---- - -# Remove-CsTeamsCustomBannerText - -## SYNOPSIS - -Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. - -## SYNTAX - -### Identity (Default) -``` -Remove-CsTeamsCustomBannerText [[-Identity] ] [] -``` - -## DESCRIPTION - -Removes a single instance of custom banner text. - -## EXAMPLES - -### Example 1 -PS C:\> Remove-CsTeamsCustomBannerText -Identity CustomText -``` - -Removes a TeamsCustomBannerText instance with the name "CustomText". - -## PARAMETERS - -### -Identity -Policy instance name (optional). - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) - -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) - -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md b/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md deleted file mode 100644 index 669b830d56..0000000000 --- a/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csteamspinnedapp -applicable: Microsoft Teams -title: Remove-CsTeamsPinnedApp -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Remove-CsTeamsPinnedApp - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -``` -Remove-CsTeamsPinnedApp [[-Identity] ] - [-Confirm] - [-Force] - [-Tenant ] - [-WhatIf] - [] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally not provided - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-TeamsAppInstallation.md b/teams/teams-ps/teams/Remove-TeamsAppInstallation.md deleted file mode 100644 index 36234579ef..0000000000 --- a/teams/teams-ps/teams/Remove-TeamsAppInstallation.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsappinstallation -title: Remove-TeamsAppInstallation -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Remove-TeamsAppInstallation - -## SYNOPSIS -Removes a Teams App installed in Microsoft Teams. - -## SYNTAX - -### TeamScope -``` -Remove-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -TeamId - [] -``` - -### UserScope -``` -Remove-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -UserId - [] -``` - -## DESCRIPTION -Removes a Teams App installed in Microsoft Teams. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example removes a Teams App in Microsoft Teams specifying its AppId and TeamId. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AppInstallationId -Installation identifier of the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md deleted file mode 100644 index c74a4f85ba..0000000000 --- a/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment -title: Set-CsGroupPolicyAssignment -schema: 2.0.0 -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Set-CsGroupPolicyAssignment - -## SYNOPSIS - -> [!NOTE] -> The cmdlet Set-CsGroupPolicyAssignment is not yet available. In the meantime, to change a group policy assignment you can first remove the current policy assignment from the group and then add a new policy assignment. - -## RELATED LINKS - -[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) - -[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) - -[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md deleted file mode 100644 index bef2833cb8..0000000000 --- a/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsMainlineAttendantAppointmentBookingFlow -applicable: Microsoft Teams -title: Set-CsMainlineAttendantAppointmentBookingFlow -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# Set-CsMainlineAttendantAppointmentBookingFlow - -## SYNOPSIS -Changes an existing Mainline Attendant appointment booking flow - -## SYNTAX - -``` -Set-CsMainlineAttendantAppointmentBookingFlow -Identity [-Name ] [-Description ] [-CallerAuthenticationMethod ] [-ApiAuthenticationType ] [-ApiDefinitions ] [-Tenant ] [] -``` - -## DESCRIPTION -The Set-CsMainlineAttendantAppointmentBookingFlow cmdlet changes an existing appointment booking flow that is used with Mainline Attendant - -> [!CAUTION] -> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. - -## EXAMPLES - - -## PARAMETERS - -### -Identity -The unique Id of the appointment booking flow to change - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the appointment booking flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for the appointment booking flow - -Limit: 500 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallerAuthenticationMethod -The method by which the caller is authenticated - -PARAVALUES: sms | email | verification_link | voiceprint | user_details - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiAuthenticationType -The method of authentication used by the API - -PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiDefinitions -The parameters used by the API - -For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - - diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md deleted file mode 100644 index 68cb82c876..0000000000 --- a/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsMainlineAttendantQuestionAnswerFlow -applicable: Microsoft Teams -title: Set-CsMainlineAttendantQuestionAnswerFlow -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# Set-CsMainlineAttendantQuestionAnswerFlow - -## SYNOPSIS -Changes an existing Mainline Attendant question and answer (FAQ) flow - -## SYNTAX - -``` -Set-CsMainlineAttendantQuestionAnswerFlow -Identity [-Name ] [-Description ] [-ApiAuthenticationType ] [-KnowledgeBase ] [-Tenant ] [] -``` - -## DESCRIPTION -The Set-CsMainlineAttendantQuestionAnswerFlow cmdlet changes an existing question and answer connection that can be used with Mainline Attendant - -> [!CAUTION] -> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. - -## EXAMPLES - - -## PARAMETERS - -### -Identity -The unique identifier for the question and answer flow. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the question and answer flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for the question and answer flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiAuthenticationType -The method of authentication used by the API - -PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KnowledgeBase -The knowledge base definition - -The parameters used by the API - -For an example, see [New-CsMainlineAttendantQuestionAnswerFlow -KnowledgeBase](./New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - - diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md deleted file mode 100644 index 9b13013f9e..0000000000 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csonlinedialinconferencinguserdefaultnumber -applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingUserDefaultNumber -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Set-CsOnlineDialInConferencingUserDefaultNumber - -## SYNOPSIS -Replace the default toll or toll-free number for all users. - -> [!IMPORTANT] ->This command is being deprecated and will not be available after July 7, 2024. If you are using this command to bulk update Audio conferencing Toll or Toll free phone numbers for users in your organization you can do that using the following alternative methods. -> 1. Use a custom Teams audio conferencing policy - [Audio Conferencing toll-free number policies - Microsoft Teams | Microsoft Learn](https://learn.microsoft.com/en-us/microsoftteams/audio-conferencing-toll-free-numbers-policy) -> 2. Use Set-CsOnlineDialinConferencingUser - [Set-CsOnlineDialInConferencingUser (MicrosoftTeamsPowerShell) | Microsoft Learn](https://learn.microsoft.com/en-us/powershell/module/teams/set-csonlinedialinconferencinguser?view=teams-ps) -> ->If you need assistance in using any of the above methods to achieve what you previously did with the Set-CsOnlineDialInConferencingUserDefaultNumber command, please open a support case with our customer support team. - -## SYNTAX - -### BridgeNameParams -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain ] [-Tenant ] - -BridgeName [-FromNumber ] -ToNumber -NumberType - [-CountryOrRegion ] [-AreaOrState ] [-CapitalOrMajorCity ] [-RescheduleMeetings] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### FilterByUsageLocation -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain ] [-Tenant ] - [-BridgeName ] -BridgeId -ToNumber -NumberType - -CountryOrRegion [-AreaOrState ] [-CapitalOrMajorCity ] [-RescheduleMeetings] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### UniqueBridgeParams -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain ] [-Tenant ] - -BridgeId -FromNumber -ToNumber -NumberType [-RescheduleMeetings] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineDialInConferencingUserDefaultNumber -FromNumber 14255550100 -ToNumber 14255550101 -NumberType Toll -RescheduleMeetings -BridgeId 9884626f-dcfb-49f4-8025-912f5bc68fdc -``` - -This example replaces the default toll or toll-free number for all users who have the number 14255550100 as a default number to the number 14255550101 and starts the process of rescheduling their meetings. - -## PARAMETERS - -### -BridgeId -The Bridge Id results from running [Get-CsOnlineDialInConferencingBridge](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge) -For example "9884626f-dcfb-49f4-8025-912f5bc68fdc". You can either specify BridgeName or BridgeId. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BridgeName -The Bridge Name results from running [Get-CsOnlineDialInConferencingBridge](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge) -For example "Conference Bridge". You can either specify BridgeName or BridgeId. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -A String representing the Country or Region this Dial In Conferencing Default number belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromNumber -The current default number defined. -$null if no number defined. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberType -The type of number this Dial In Conferencing Default number has. -Valid values are - -- Toll -- TollFree - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToNumber -The new number to assign, without the + sign, for example 14255550101. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AreaOrState -A String representing the Area or State this Dial In Conferencing Default number belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapitalOrMajorCity -A String representing the Capital or Major City this Dial In Conferencing Default number belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RescheduleMeetings -Sends e-mail notifications to Meeting attendees with the updated settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText deleted file mode 100644 index e13c9bf900..0000000000 --- a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText +++ /dev/null @@ -1,93 +0,0 @@ ---- -Module Name: MicrosoftTeams -title: Set-CsTeamsCustomBannerText -author: saleens7 -ms.author: wblocker -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText -schema: 2.0.0 ---- - -# Set-CsTeamsCustomBannerText - -## SYNOPSIS - -Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsCustomBannerText [[-Id] ] [] -``` - -## DESCRIPTION - -Updates a single instance of a custom banner text. - -## EXAMPLES - -### Example 1 -PS C:\> Set-CsTeamsCustomBannerText -Identity CustomText -``` - -Sets the properties of the CustomText instance of TeamsCustomBannerText. - -## PARAMETERS - -### -Id -The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. - -```yaml -Type: Guid -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Text -The text that the tenant admin would like to set in the policy. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description that the tenant admin would like to set to identify what this text represents. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) - -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) - -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md b/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md deleted file mode 100644 index fac26286e2..0000000000 --- a/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csteamspinnedapp -applicable: Microsoft Teams -title: Set-CsTeamsPinnedApp -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Set-CsTeamsPinnedApp - -## SYNOPSIS -**NOTE**: This cmdlet has been deprecated. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsPinnedApp [-Tenant ] [-Order ] [-Priority ] [[-Identity] ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTeamsPinnedApp [-Tenant ] [-Order ] [-Priority ] [-Instance ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**NOTE**: This cmdlet has been deprecated. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally not provided. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do not use. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Do not use. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Order -Do not use. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Do not use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Do not use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamFunSettings.md b/teams/teams-ps/teams/Set-TeamFunSettings.md deleted file mode 100644 index b0c4f9d5ab..0000000000 --- a/teams/teams-ps/teams/Set-TeamFunSettings.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamFunSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teamfunsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamFunSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Update Giphy, Stickers and Memes settings. - -## SYNTAX - -``` -Set-TeamFunSettings -GroupId [-AllowGiphy ] [-GiphyContentRating ] - [-AllowStickersAndMemes ] [-AllowCustomMemes ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamFunSettings -GroupId 0ebb500c-f5f3-44dd-b155-cc8c4f383e2d -AllowGiphy true -GiphyContentRating Strict -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowGiphy -Setting to enable giphy for team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GiphyContentRating -Settings to set content rating for giphy. -Can be "Strict" or "Moderate" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowStickersAndMemes -Enable Stickers and memes - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCustomMemes -Allow custom memes to be uploaded - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### GroupId, AllowGiphy, GiphyContentRating, AllowStickersAndMemes, AllowCustomMemes - - -## OUTPUTS - - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamGuestSettings.md b/teams/teams-ps/teams/Set-TeamGuestSettings.md deleted file mode 100644 index 97674abb46..0000000000 --- a/teams/teams-ps/teams/Set-TeamGuestSettings.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamGuestSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teamguestsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamGuestSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Updates team guest settings. - -## SYNTAX - -``` -Set-TeamGuestSettings -GroupId [-AllowCreateUpdateChannels ] [-AllowDeleteChannels ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamGuestSettings -GroupId a61f5a96-a0cf-43db-a7c8-cec05f8a8fc4 -AllowCreateUpdateChannels true -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowCreateUpdateChannels -Settings to create and update channels - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDeleteChannels -Settings to Delete channels - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### GroupId - -### AllowCreateUpdateChannels - -### AllowDeleteChannels - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamMemberSettings.md b/teams/teams-ps/teams/Set-TeamMemberSettings.md deleted file mode 100644 index 0e21dfe1c8..0000000000 --- a/teams/teams-ps/teams/Set-TeamMemberSettings.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamMemberSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teammembersettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamMemberSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Updates team member settings. - -## SYNTAX - -``` -Set-TeamMemberSettings -GroupId [-AllowCreateUpdateChannels ] [-AllowDeleteChannels ] - [-AllowAddRemoveApps ] [-AllowCreateUpdateRemoveTabs ] - [-AllowCreateUpdateRemoveConnectors ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamMemberSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowCreateUpdateChannels false -``` - -### -------------------------- Example 2 -------------------------- -``` -Set-TeamMemberSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowDeleteChannels true -AllowAddRemoveApps false -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowCreateUpdateChannels -Setting to create and update channels - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDeleteChannels -Setting to Delete channels - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAddRemoveApps -Setting to add and remove apps to teams - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCreateUpdateRemoveTabs -Setting to create, update and remove tabs - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCreateUpdateRemoveConnectors -Setting to create, update and remove connectors - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### GroupId - -### AllowCreateUpdateChannels - -### AllowDeleteChannels - -### AllowAddRemoveApps - -### AllowCreateUpdateRemoveTabs - -### AllowCreateUpdateRemoveConnectors - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamMessagingSettings.md b/teams/teams-ps/teams/Set-TeamMessagingSettings.md deleted file mode 100644 index eebbf86afa..0000000000 --- a/teams/teams-ps/teams/Set-TeamMessagingSettings.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamMessagingSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teammessagingsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamMessagingSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Updates team messaging settings. - -## SYNTAX - -``` -Set-TeamMessagingSettings -GroupId [-AllowUserEditMessages ] - [-AllowUserDeleteMessages ] [-AllowOwnerDeleteMessages ] [-AllowTeamMentions ] - [-AllowChannelMentions ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamMessagingSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowUserEditMessages true -``` - -### -------------------------- Example 2 -------------------------- -``` -Set-TeamMessagingSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowUserDeleteMessages false -AllowChannelMentions true -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUserEditMessages -Setting to allow user to edit messages - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserDeleteMessages -Setting to allow user to delete messages - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOwnerDeleteMessages -Setting to allow owner to Delete messages - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTeamMentions -Allow @team or @\[team name\] mentions. -This will notify everyone in the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowChannelMentions -Allow @channel or @\[channel name\] mentions. -This wil notify members who've favorited that channel - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### GroupId - -### AllowUserEditMessages - -### AllowUserDeleteMessages - -### AllowOwnerDeleteMessages - -### AllowTeamMentions - -### AllowChannelMentions - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md b/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md deleted file mode 100644 index 42891b66a8..0000000000 --- a/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule -applicable: Microsoft Teams -title: Test-CsTeamsTranslationRule -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Test-CsTeamsTranslationRule - -## SYNOPSIS -This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. - -## SYNTAX - -### Test (Default) -```powershell -Test-CsTeamsTranslationRule [-PhoneNumber ] [] -``` - -## DESCRIPTION -This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. - -## EXAMPLES - -### Example 1 -```powershell -Test-CsTeamsTranslationRule -PhoneNumber 1234 -``` -```output -Identity Pattern PhoneNumberTranslated Translation --------- ------- --------------------- ----------- -rule1 ^1234$ 4321 4321 -``` -This example displays information about the manipulation rule matching the phone number 1234. - -## PARAMETERS - -### -PhoneNumber -The phone number to test. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -The cmdlet is available in Teams PowerShell Module 4.5.0 or later. - -The matching logic used in the cmdlet is the same as when the manipulation rule has been associated with an SBC and a call is being routed. - -If a match is found in two or more manipulation rules, the first one is returned. - -There is a short delay before newly created manipulation rules are added to the evaluation. - -## RELATED LINKS -[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) - -[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) - -[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) - -[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Update-TeamsAppInstallation.md b/teams/teams-ps/teams/Update-TeamsAppInstallation.md deleted file mode 100644 index d7ce547680..0000000000 --- a/teams/teams-ps/teams/Update-TeamsAppInstallation.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/update-teamsappinstallation -title: Update-TeamsAppInstallation -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Update-TeamsAppInstallation - -## SYNOPSIS -Update a Teams App in Microsoft Teams. - -## SYNTAX - -### TeamScope -``` -Update-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -TeamId - [-Permissions ] [] -``` - -### UserScope -``` -Update-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -UserId - [-Permissions ] [] -``` - -## DESCRIPTION -Update a Teams App in Microsoft Teams. -This won't update teams client; this will update an application installed on the user/team. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Update-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example updates a Teams App in Microsoft Teams specifying its AppId and TeamId. - -### Example 2 -```powershell -PS C:\> Update-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -Permissions "TeamSettings.Read.Group ChannelMessage.Read.Group" -``` - -This example updates a Teams App in Microsoft Teams specifying its AppId and TeamId and RSC Permissions. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AppInstallationId -Installation identifier of the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Permissions -RSC permissions for the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/teams.md b/teams/teams-ps/teams/teams.md deleted file mode 100644 index 058504f325..0000000000 --- a/teams/teams-ps/teams/teams.md +++ /dev/null @@ -1,548 +0,0 @@ ---- -Module Name: Microsoft Teams PowerShell -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -title: teams ---- - -# Microsoft Teams PowerShell - -## Description -The following cmdlet references are for Microsoft Teams. - -## Microsoft Teams Cmdlets - -### [Add-TeamChannelUser](Add-TeamChannelUser.md) -### [Add-TeamsAppInstallation](Add-TeamsAppInstallation.md) -### [Add-TeamUser](Add-TeamUser.md) -### [Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) -### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md) -### [Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) -### [Connect-MicrosoftTeams](Connect-MicrosoftTeams.md) -### [Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) -### [Disable-CsTeamsShiftsConnectionErrorReport](Disable-CsTeamsShiftsConnectionErrorReport.md) -### [Disconnect-MicrosoftTeams](Disconnect-MicrosoftTeams.md) -### [Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) -### [Export-CsAcquiredPhoneNumber](Export-CsAcquiredPhoneNumber.md) -### [Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) -### [export-csonlineaudiofile](export-csonlineaudiofile.md) -### [Find-CsGroup](Find-CsGroup.md) -### [Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) -### [Get-AssociatedTeam](Get-AssociatedTeam.md) -### [Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) -### [Get-CsApplicationMeetingConfiguration](Get-CsApplicationMeetingConfiguration.md) -### [Get-CsAutoAttendant](Get-CsAutoAttendant.md) -### [Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) -### [Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) -### [Get-CsAutoAttendantSupportedLanguage](Get-CsAutoAttendantSupportedLanguage.md) -### [Get-CsAutoAttendantSupportedTimeZone](Get-CsAutoAttendantSupportedTimeZone.md) -### [Get-CsAutoAttendantTenantInformation](Get-CsAutoAttendantTenantInformation.md) -### [Get-CsBatchPolicyAssignmentOperation](Get-CsBatchPolicyAssignmentOperation.md) -### [Get-CsBatchTeamsDeploymentStatus](Get-CsBatchTeamsDeploymentStatus.md) -### [Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) -### [Get-CsCallQueue](Get-CsCallQueue.md) -### [Get-CsCloudCallDataConnection](Get-CsCloudCallDataConnection.md) -### [Get-CsDialPlan](Get-CsDialPlan.md) -### [Get-CsEffectiveTenantDialPlan](Get-CsEffectiveTenantDialPlan.md) -### [Get-CsExportAcquiredPhoneNumberStatus](Get-CsExportAcquiredPhoneNumberStatus.md) -### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) -### [Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) -### [Get-CsHybridTelephoneNumber](Get-CsHybridTelephoneNumber.md) -### [Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) -### [Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) -### [Get-CsMeetingMigrationStatus](Get-CsMeetingMigrationStatus.md) -### [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) -### [Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) -### [Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) -### [Get-CsCsOnlineAudioConferencingRoutingPolicy][Get-CsOnlineAudioConferencingRoutingPolicy.md] -### [Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) -### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) -### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) -### [Get-CsOnlineDialinConferencingTenantConfiguration](Get-CsOnlineDialinConferencingTenantConfiguration.md) -### [Get-CsOnlineDialInConferencingTenantSettings](Get-CsOnlineDialInConferencingTenantSettings.md) -### [Get-CsOnlineDialInConferencingUser](Get-CsOnlineDialInConferencingUser.md) -### [Get-CsOnlineDialOutPolicy](Get-CsOnlineDialOutPolicy.md) -### [Get-CsOnlineDirectoryTenant](Get-CsOnlineDirectoryTenant.md) -### [Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) -### [Get-CsOnlineLisCivicAddress](Get-CsOnlineLisCivicAddress.md) -### [Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) -### [Get-CsOnlineLisPort](Get-CsOnlineLisPort.md) -### [Get-CsOnlineLisSubnet](Get-CsOnlineLisSubnet.md) -### [Get-CsOnlineLisSwitch](Get-CsOnlineLisSwitch.md) -### [Get-CsOnlineLisWirelessAccessPoint](Get-CsOnlineLisWirelessAccessPoint.md) -### [Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) -### [Get-CsOnlinePstnUsage](Get-CsOnlinePstnUsage.md) -### [Get-CsOnlineSchedule](Get-CsOnlineSchedule.md) -### [Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) -### [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) -### [Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) -### [Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) -### [Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) -### [Get-CsOnlineUser](Get-CsOnlineUser.md) -### [Get-CsOnlineVoicemailPolicy](Get-CsOnlineVoicemailPolicy.md) -### [Get-CsOnlineVoicemailUserSettings](Get-CsOnlineVoicemailUserSettings.md) -### [Get-CsOnlineVoiceRoute](Get-CsOnlineVoiceRoute.md) -### [Get-CsOnlineVoiceRoutingPolicy](Get-CsOnlineVoiceRoutingPolicy.md) -### [Get-CsOnlineVoiceUser](Get-CsOnlineVoiceUser.md) -### [Get-CsPhoneNumberAssignment](Get-CsPhoneNumberAssignment.md) -### [Get-CsPolicyPackage](Get-CsPolicyPackage.md) -### [Get-CsTeamsAcsFederationConfiguration](Get-CsTeamsAcsFederationConfiguration.md) -### [Get-CsTeamsAppPermissionPolicy](Get-CsTeamsAppPermissionPolicy.md) -### [Get-CsTeamsAppSetupPolicy](Get-CsTeamsAppSetupPolicy.md) -### [Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) -### [Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) -### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) -### [Get-CsTeamsCallParkPolicy](Get-CsTeamsCallParkPolicy.md) -### [Get-CsTeamsChannelsPolicy](Get-CsTeamsChannelsPolicy.md) -### [Get-CsTeamsClientConfiguration](Get-CsTeamsClientConfiguration.md) -### [Get-CsTeamsComplianceRecordingApplication](Get-CsTeamsComplianceRecordingApplication.md) -### [Get-CsTeamsComplianceRecordingPolicy](Get-CsTeamsComplianceRecordingPolicy.md) -### [Get-CsTeamsCortanaPolicy](Get-CsTeamsCortanaPolicy.md) -### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) -### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) -### [Get-CsTeamsEducationAssignmentsAppPolicy](Get-CsTeamsEducationAssignmentsAppPolicy.md) -### [Get-CsTeamsEducationConfiguration](Get-CsTeamsEducationConfiguration.md) -### [Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) -### [Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) -### [Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) -### [Get-CsTeamsEventsPolicy](Get-CsTeamsEventsPolicy.md) -### [Get-CsTeamsFeedbackPolicy](Get-CsTeamsFeedbackPolicy.md) -### [Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) -### [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) -### [Get-CsTeamsGuestCallingConfiguration](Get-CsTeamsGuestCallingConfiguration.md) -### [Get-CsTeamsGuestMeetingConfiguration](Get-CsTeamsGuestMeetingConfiguration.md) -### [Get-CsTeamsGuestMessagingConfiguration](Get-CsTeamsGuestMessagingConfiguration.md) -### [Get-CsTeamsIPPhonePolicy](Get-CsTeamsIPPhonePolicy.md) -### [Get-CsTeamsMediaLoggingPolicy](Get-CsTeamsMediaLoggingPolicy.md) -### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) -### [Get-CsTeamsMeetingBroadcastConfiguration](Get-CsTeamsMeetingBroadcastConfiguration.md) -### [Get-CsTeamsMeetingBroadcastPolicy](Get-CsTeamsMeetingBroadcastPolicy.md) -### [Get-CsTeamsMeetingConfiguration](Get-CsTeamsMeetingConfiguration.md) -### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) -### [Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) -### [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Get-CsTeamsMessagingConfiguration](Get-CsTeamsMessagingConfiguration.md) -### [Get-CsTeamsMessagingPolicy](Get-CsTeamsMessagingPolicy.md) -### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) -### [Get-CsTeamsNetworkRoamingPolicy](Get-CsTeamsNetworkRoamingPolicy.md) -### [Get-CsTeamsRecordingRollOutPolicy](Get-CsTeamsRecordingRollOutPolicy.md) -### [Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) -### [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) -### [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) -### [Get-CsTeamsShiftsConnectionErrorReport](Get-CsTeamsShiftsConnectionErrorReport.md) -### [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) -### [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md) -### [Get-CsTeamsShiftsConnectionSyncResult](Get-CsTeamsShiftsConnectionSyncResult.md) -### [Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) -### [Get-CsTeamsShiftsConnectionWfmTeam](Get-CsTeamsShiftsConnectionWfmTeam.md) -### [Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) -### [Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) -### [Get-CsTeamsSipDevicesConfiguration](Get-CsTeamsSipDevicesConfiguration.md) -### [Get-CsTeamsSurvivableBranchAppliance](Get-CsTeamsSurvivableBranchAppliance.md) -### [Get-CsTeamsSurvivableBranchAppliancePolicy](Get-CsTeamsSurvivableBranchAppliancePolicy.md) -### [Get-CsTeamsTargetingPolicy](Get-CsTeamsTargetingPolicy.md) -### [Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) -### [Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) -### [Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) -### [Get-CsTeamsUpdateManagementPolicy](Get-CsTeamsUpdateManagementPolicy.md) -### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) -### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) -### [Get-CsTeamsVdiPolicy](Get-CsTeamsVdiPolicy.md) -### [Get-CsTeamsVideoInteropServicePolicy](Get-CsTeamsVideoInteropServicePolicy.md) -### [Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) -### [Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) -### [Get-CsTeamsWorkLoadPolicy](Get-CsTeamsWorkLoadPolicy.md) -### [Get-CsTeamsWorkLocationDetectionPolicy](Get-CsTeamsWorkLocationDetectionPolicy.md) -### [Get-CsTeamTemplate](Get-CsTeamTemplate.md) -### [Get-CsTeamTemplateList](Get-CsTeamTemplateList.md) -### [Get-CsTenant](Get-CsTenant.md) -### [Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) -### [Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) -### [Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) -### [Get-CsTenantLicensingConfiguration](Get-CsTenantLicensingConfiguration.md) -### [Get-CsTenantMigrationConfiguration](Get-CsTenantMigrationConfiguration.md) -### [Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) -### [Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) -### [Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) -### [Get-CsTenantTrustedIPAddress](Get-CsTenantTrustedIPAddress.md) -### [Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) -### [Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md) -### [Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) -### [Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) -### [Get-CsVideoInteropServiceProvider](Get-CsVideoInteropServiceProvider.md) -### [Get-LicenseReportForChangeNotificationSubscription](Get-LicenseReportForChangeNotificationSubscription.md) -### [Get-M365UnifiedCustomPendingApps](Get-M365UnifiedCustomPendingApps.md) -### [Get-SharedWithTeam](Get-SharedWithTeam.md) -### [Get-SharedWithTeamUser](Get-SharedWithTeamUser.md) -### [Get-Team](Get-Team.md) -### [Get-TeamAllChannel](Get-TeamAllChannel.md) -### [Get-TeamChannel](Get-TeamChannel.md) -### [Get-TeamChannelUser](Get-TeamChannelUser.md) -### [Get-TeamFunSettings](Get-TeamFunSettings.md) -### [Get-TeamGuestSettings](Get-TeamGuestSettings.md) -### [Get-TeamIncomingChannel](Get-TeamIncomingChannel.md) -### [Get-TeamMemberSettings](Get-TeamMemberSettings.md) -### [Get-TeamMessagingSettings](Get-TeamMessagingSettings.md) -### [Get-TeamsApp](Get-TeamsApp.md) -### [Get-TeamsAppInstallation](Get-TeamsAppInstallation.md) -### [Get-TeamTargetingHierarchyStatus](Get-TeamTargetingHierarchyStatus.md) -### [Get-TeamUser](Get-TeamUser.md) -### [Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) -### [Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) -### [Grant-CsCloudMeetingPolicy](Grant-CsCloudMeetingPolicy.md) -### [Grant-CsDialoutPolicy](Grant-CsDialoutPolicy.md) -### [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) -### [Grant-CsExternalUserCommunicationPolicy](Grant-CsExternalUserCommunicationPolicy.md) -### [Grant-CsGroupPolicyPackageAssignment](Grant-CsGroupPolicyPackageAssignment.md) -### [Grant-CsOnlineVoicemailPolicy](Grant-CsOnlineVoicemailPolicy.md) -### [Grant-CsOnlineVoiceRoutingPolicy](Grant-CsOnlineVoiceRoutingPolicy.md) -### [Grant-CsTeamsAppPermissionPolicy](Grant-CsTeamsAppPermissionPolicy.md) -### [Grant-CsTeamsAppSetupPolicy](Grant-CsTeamsAppSetupPolicy.md) -### [Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) -### [Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) -### [Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) -### [Grant-CsTeamsCallParkPolicy](Grant-CsTeamsCallParkPolicy.md) -### [Grant-CsTeamsChannelsPolicy](Grant-CsTeamsChannelsPolicy.md) -### [Grant-CsTeamsComplianceRecordingPolicy](Grant-CsTeamsComplianceRecordingPolicy.md) -### [Grant-CsTeamsCortanaPolicy](Grant-CsTeamsCortanaPolicy.md) -### [Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) -### [Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) -### [Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) -### [Grant-CsTeamsEventsPolicy](Grant-CsTeamsEventsPolicy.md) -### [Grant-CsTeamsFeedbackPolicy](Grant-CsTeamsFeedbackPolicy.md) -### [Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) -### [Grant-CsTeamsIPPhonePolicy](Grant-CsTeamsIPPhonePolicy.md) -### [Grant-CsTeamsMediaLoggingPolicy](Grant-CsTeamsMediaLoggingPolicy.md) -### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) -### [Grant-CsTeamsMeetingBroadcastPolicy](Grant-CsTeamsMeetingBroadcastPolicy.md) -### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) -### [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Grant-CsTeamsMessagingPolicy](Grant-CsTeamsMessagingPolicy.md) -### [Grant-CsTeamsMobilityPolicy](Grant-CsTeamsMobilityPolicy.md) -### [Grant-CsTeamsRecordingRollOutPolicy](Grant-CsTeamsRecordingRollOutPolicy.md) -### [Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) -### [Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) -### [Grant-CsTeamsUpdateManagementPolicy](Grant-CsTeamsUpdateManagementPolicy.md) -### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -### [Grant-CsTeamsVdiPolicy](Grant-CsTeamsVdiPolicy.md) -### [Grant-CsTeamsVideoInteropServicePolicy](Grant-CsTeamsVideoInteropServicePolicy.md) -### [Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) -### [Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) -### [Grant-CsTeamsWorkLoadPolicy](Grant-CsTeamsWorkLoadPolicy.md) -### [Grant-CsTeamsWorkLocationDetectionPolicy](Grant-CsTeamsWorkLocationDetectionPolicy.md) -### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) -### [Grant-CsUserPolicyPackage](Grant-CsUserPolicyPackage.md) -### [Import-CsAutoAttendantHolidays](Import-CsAutoAttendantHolidays.md) -### [Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) -### [New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) -### [New-CsAutoAttendant](New-CsAutoAttendant.md) -### [New-CsAutoAttendantCallableEntity](New-CsAutoAttendantCallableEntity.md) -### [New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) -### [New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md) -### [New-CsAutoAttendantDialScope](New-CsAutoAttendantDialScope.md) -### [New-CsAutoAttendantMenu](New-CsAutoAttendantMenu.md) -### [New-CsAutoAttendantMenuOption](New-CsAutoAttendantMenuOption.md) -### [New-CsAutoAttendantPrompt](New-CsAutoAttendantPrompt.md) -### [New-CsBatchPolicyAssignmentOperation](New-CsBatchPolicyAssignmentOperation.md) -### [New-CsBatchPolicyPackageAssignmentOperation](New-CsBatchPolicyPackageAssignmentOperation.md) -### [New-CsBatchTeamsDeployment](New-CsBatchTeamsDeployment.md) -### [New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) -### [New-CsCallQueue](New-CsCallQueue.md) -### [New-CsCloudCallDataConnection](New-CsCloudCallDataConnection.md) -### [New-CsCustomPolicyPackage](New-CsCustomPolicyPackage.md) -### [New-CsEdgeAllowAllKnownDomains](New-CsEdgeAllowAllKnownDomains.md) -### [New-CsEdgeAllowList](New-CsEdgeAllowList.md) -### [New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) -### [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) -### [New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md) -### [New-CsHybridTelephoneNumber](New-CsHybridTelephoneNumber.md) -### [New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) -### [New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) -### [New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) -### [New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) -### [New-CsCsOnlineAudioConferencingRoutingPolicy][New-CsOnlineAudioConferencingRoutingPolicy.md] -### [New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) -### [New-CsOnlineLisCivicAddress](New-CsOnlineLisCivicAddress.md) -### [New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) -### [New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) -### [New-CsOnlineSchedule](New-CsOnlineSchedule.md) -### [New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) -### [New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) -### [New-CsOnlineVoicemailPolicy](New-CsOnlineVoicemailPolicy.md) -### [New-CsOnlineVoiceRoute](New-CsOnlineVoiceRoute.md) -### [New-CsOnlineVoiceRoutingPolicy](New-CsOnlineVoiceRoutingPolicy.md) -### [New-CsTeamsAppPermissionPolicy](New-CsTeamsAppPermissionPolicy.md) -### [New-CsTeamsAppSetupPolicy](New-CsTeamsAppSetupPolicy.md) -### [New-CsTeamsAudioConferencingPolicy](New-CsTeamsAudioConferencingPolicy.md) -### [New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) -### [New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) -### [New-CsTeamsCallParkPolicy](New-CsTeamsCallParkPolicy.md) -### [New-CsTeamsChannelsPolicy](New-CsTeamsChannelsPolicy.md) -### [New-CsTeamsComplianceRecordingApplication](New-CsTeamsComplianceRecordingApplication.md) -### [New-CsTeamsComplianceRecordingPairedApplication](New-CsTeamsComplianceRecordingPairedApplication.md) -### [New-CsTeamsComplianceRecordingPolicy](New-CsTeamsComplianceRecordingPolicy.md) -### [New-CsTeamsCortanaPolicy](New-CsTeamsCortanaPolicy.md) -### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) -### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) -### [New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) -### [New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) -### [New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) -### [New-CsTeamsEmergencyNumber](New-CsTeamsEmergencyNumber.md) -### [New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) -### [New-CsTeamsEventsPolicy](New-CsTeamsEventsPolicy.md) -### [New-CsTeamsFeedbackPolicy](New-CsTeamsFeedbackPolicy.md) -### [New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) -### [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md) -### [New-CsTeamsHiddenTemplate](New-CsTeamsHiddenTemplate.md) -### [New-CsTeamsIPPhonePolicy](New-CsTeamsIPPhonePolicy.md) -### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) -### [New-CsTeamsMeetingBroadcastPolicy](New-CsTeamsMeetingBroadcastPolicy.md) -### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) -### [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) -### [New-CsTeamsMessagingPolicy](New-CsTeamsMessagingPolicy.md) -### [New-CsTeamsMobilityPolicy](New-CsTeamsMobilityPolicy.md) -### [New-CsTeamsNetworkRoamingPolicy](New-CsTeamsNetworkRoamingPolicy.md) -### [New-CsTeamsPinnedApp](New-CsTeamsPinnedApp.md) -### [New-CsTeamsRecordingRollOutPolicy](New-CsTeamsRecordingRollOutPolicy.md) -### [New-CsTeamsSharedCallingRoutingPolicy](New-CsTeamsSharedCallingRoutingPolicy.md) -### [New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) -### [New-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.md) -### [New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) -### [New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) -### [New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) -### [New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) -### [New-CsTeamsUnassignedNumberTreatment](New-CsTeamsUnassignedNumberTreatment.md) -### [New-CsTeamsUpdateManagementPolicy](New-CsTeamsUpdateManagementPolicy.md) -### [New-CsTeamsVdiPolicy](New-CsTeamsVdiPolicy.md) -### [New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) -### [New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) -### [New-CsTeamsWorkLoadPolicy](New-CsTeamsWorkLoadPolicy.md) -### [New-CsTeamsWorkLocationDetectionPolicy](New-CsTeamsWorkLocationDetectionPolicy.md) -### [New-CsTeamTemplate](New-CsTeamTemplate.md) -### [New-CsTenantDialPlan](New-CsTenantDialPlan.md) -### [New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) -### [New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) -### [New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) -### [New-CsTenantTrustedIPAddress](New-CsTenantTrustedIPAddress.md) -### [New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) -### [New-CsVideoInteropServiceProvider](New-CsVideoInteropServiceProvider.md) -### [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) -### [New-Team](New-Team.md) -### [New-TeamChannel](New-TeamChannel.md) -### [New-TeamsApp](New-TeamsApp.md) -### [Register-CsOnlineDialInConferencingServiceNumber](Register-CsOnlineDialInConferencingServiceNumber.md) -### [Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) -### [Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) -### [Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) -### [Remove-CsCallQueue](Remove-CsCallQueue.md) -### [Remove-CsCustomPolicyPackage](Remove-CsCustomPolicyPackage.md) -### [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) -### [Remove-CsGroupPolicyAssignment](Remove-CsGroupPolicyAssignment.md) -### [Remove-CsHybridTelephoneNumber](Remove-CsHybridTelephoneNumber.md) -### [Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) -### [Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) -### [Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) -### [Remove-CsCsOnlineAudioConferencingRoutingPolicy][Remove-CsOnlineAudioConferencingRoutingPolicy.md] -### [Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) -### [Remove-CsOnlineDialInConferencingTenantSettings](Remove-CsOnlineDialInConferencingTenantSettings.md) -### [Remove-CsOnlineLisCivicAddress](Remove-CsOnlineLisCivicAddress.md) -### [Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) -### [Remove-CsOnlineLisPort](Remove-CsOnlineLisPort.md) -### [Remove-CsOnlineLisSubnet](Remove-CsOnlineLisSubnet.md) -### [Remove-CsOnlineLisSwitch](Remove-CsOnlineLisSwitch.md) -### [Remove-CsOnlineLisWirelessAccessPoint](Remove-CsOnlineLisWirelessAccessPoint.md) -### [Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) -### [Remove-CsOnlineSchedule](Remove-CsOnlineSchedule.md) -### [Remove-CsOnlineTelephoneNumber](Remove-CsOnlineTelephoneNumber.md) -### [Remove-CsOnlineVoicemailPolicy](Remove-CsOnlineVoicemailPolicy.md) -### [Remove-CsOnlineVoiceRoute](Remove-CsOnlineVoiceRoute.md) -### [Remove-CsOnlineVoiceRoutingPolicy](Remove-CsOnlineVoiceRoutingPolicy.md) -### [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) -### [Remove-CsTeamsAppPermissionPolicy](Remove-CsTeamsAppPermissionPolicy.md) -### [Remove-CsTeamsAppSetupPolicy](Remove-CsTeamsAppSetupPolicy.md) -### [Remove-CsTeamsAudioConferencingPolicy](Remove-CsTeamsAudioConferencingPolicy.md) -### [Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) -### [Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) -### [Remove-CsTeamsCallParkPolicy](Remove-CsTeamsCallParkPolicy.md) -### [Remove-CsTeamsChannelsPolicy](Remove-CsTeamsChannelsPolicy.md) -### [Remove-CsTeamsComplianceRecordingApplication](Remove-CsTeamsComplianceRecordingApplication.md) -### [Remove-CsTeamsComplianceRecordingPolicy](Remove-CsTeamsComplianceRecordingPolicy.md) -### [Remove-CsTeamsCortanaPolicy](Remove-CsTeamsCortanaPolicy.md) -### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) -### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) -### [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) -### [Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) -### [Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) -### [Remove-CsTeamsEventsPolicy](Remove-CsTeamsEventsPolicy.md) -### [Remove-CsTeamsFeedbackPolicy](Remove-CsTeamsFeedbackPolicy.md) -### [Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) -### [Remove-CsTeamsIPPhonePolicy](Remove-CsTeamsIPPhonePolicy.md) -### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) -### [Remove-CsTeamsMeetingBroadcastPolicy](Remove-CsTeamsMeetingBroadcastPolicy.md) -### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) -### [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Remove-CsTeamsMessagingPolicy](Remove-CsTeamsMessagingPolicy.md) -### [Remove-CsTeamsMobilityPolicy](Remove-CsTeamsMobilityPolicy.md) -### [Remove-CsTeamsNetworkRoamingPolicy](Remove-CsTeamsNetworkRoamingPolicy.md) -### [Remove-CsTeamsPinnedApp](Remove-CsTeamsPinnedApp.md) -### [Remove-CsTeamsRecordingRollOutPolicy](Remove-CsTeamsRecordingRollOutPolicy.md) -### [Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) -### [Remove-CsTeamsShiftsConnection](Remove-CsTeamsShiftsConnection.md) -### [Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) -### [Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) -### [Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) -### [Remove-CsTeamsShiftsScheduleRecord](Remove-CsTeamsShiftsScheduleRecord.md) -### [Remove-CsTeamsSurvivableBranchAppliance](Remove-CsTeamsSurvivableBranchAppliance.md) -### [Remove-CsTeamsSurvivableBranchAppliancePolicy](Remove-CsTeamsSurvivableBranchAppliancePolicy.md) -### [Remove-CsTeamsTargetingPolicy](Remove-CsTeamsTargetingPolicy.md) -### [Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) -### [Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) -### [Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) -### [Remove-CsTeamsUpdateManagementPolicy](Remove-CsTeamsUpdateManagementPolicy.md) -### [Remove-CsTeamsVdiPolicy](Remove-CsTeamsVdiPolicy.md) -### [Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) -### [Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) -### [Remove-CsTeamsWorkLoadPolicy](Remove-CsTeamsWorkLoadPolicy.md) -### [Remove-CsTeamsWorkLocationDetectionPolicy](Remove-CsTeamsWorkLocationDetectionPolicy.md) -### [Remove-CsTeamTemplate](Remove-CsTeamTemplate.md) -### [Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) -### [Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) -### [Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) -### [Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) -### [Remove-CsTenantTrustedIPAddress](Remove-CsTenantTrustedIPAddress.md) -### [Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) -### [Remove-CsVideoInteropServiceProvider](Remove-CsVideoInteropServiceProvider.md) -### [Remove-SharedWithTeam](Remove-SharedWithTeam.md) -### [Remove-Team](Remove-Team.md) -### [Remove-TeamChannel](Remove-TeamChannel.md) -### [Remove-TeamChannelUser](Remove-TeamChannelUser.md) -### [Remove-TeamsApp](Remove-TeamsApp.md) -### [Remove-TeamsAppInstallation](Remove-TeamsAppInstallation.md) -### [Remove-TeamTargetingHierarchy](Remove-TeamTargetingHierarchy.md) -### [Remove-TeamUser](Remove-TeamUser.md) -### [Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) -### [Set-CsApplicationMeetingConfiguration](Set-CsApplicationMeetingConfiguration.md) -### [Set-CsAutoAttendant](Set-CsAutoAttendant.md) -### [Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) -### [Set-CsCallQueue](Set-CsCallQueue.md) -### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) -### [Set-CsGroupPolicyAssignment](Set-CsGroupPolicyAssignment.md) -### [Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) -### [Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) -### [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) -### [Set-CsCsOnlineAudioConferencingRoutingPolicy][Set-CsOnlineAudioConferencingRoutingPolicy.md] -### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) -### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) -### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md) -### [Set-CsOnlineDialInConferencingUser](Set-CsOnlineDialInConferencingUser.md) -### [Set-CsOnlineEnhancedEmergencyServiceDisclaimer](Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md) -### [Set-CsOnlineLisCivicAddress](Set-CsOnlineLisCivicAddress.md) -### [Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) -### [Set-CsOnlineLisPort](Set-CsOnlineLisPort.md) -### [Set-CsOnlineLisSubnet](Set-CsOnlineLisSubnet.md) -### [Set-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) -### [Set-CsOnlineLisWirelessAccessPoint](Set-CsOnlineLisWirelessAccessPoint.md) -### [Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) -### [Set-CsOnlinePstnUsage](Set-CsOnlinePstnUsage.md) -### [Set-CsOnlineSchedule](Set-CsOnlineSchedule.md) -### [Set-CsOnlineVoiceApplicationInstance](Set-CsOnlineVoiceApplicationInstance.md) -### [Set-CsOnlineVoicemailPolicy](Set-CsOnlineVoicemailPolicy.md) -### [Set-CsOnlineVoicemailUserSettings](Set-CsOnlineVoicemailUserSettings.md) -### [Set-CsOnlineVoiceRoute](Set-CsOnlineVoiceRoute.md) -### [Set-CsOnlineVoiceRoutingPolicy](Set-CsOnlineVoiceRoutingPolicy.md) -### [Set-CsOnlineVoiceUser](Set-CsOnlineVoiceUser.md) -### [Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) -### [Set-CsTeamsAcsFederationConfiguration](Set-CsTeamsAcsFederationConfiguration.md) -### [Set-CsTeamsAppPermissionPolicy](Set-CsTeamsAppPermissionPolicy.md) -### [Set-CsTeamsAppSetupPolicy](Set-CsTeamsAppSetupPolicy.md) -### [Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) -### [Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) -### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) -### [Set-CsTeamsCallParkPolicy](Set-CsTeamsCallParkPolicy.md) -### [Set-CsTeamsChannelsPolicy](Set-CsTeamsChannelsPolicy.md) -### [Set-CsTeamsClientConfiguration](Set-CsTeamsClientConfiguration.md) -### [Set-CsTeamsComplianceRecordingApplication](Set-CsTeamsComplianceRecordingApplication.md) -### [Set-CsTeamsComplianceRecordingPolicy](Set-CsTeamsComplianceRecordingPolicy.md) -### [Set-CsTeamsCortanaPolicy](Set-CsTeamsCortanaPolicy.md) -### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) -### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) -### [Set-CsTeamsEducationAssignmentsAppPolicy](Set-CsTeamsEducationAssignmentsAppPolicy.md) -### [Set-CsTeamsEducationConfiguration](Set-CsTeamsEducationConfiguration.md) -### [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) -### [Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) -### [Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) -### [Set-CsTeamsEventsPolicy](Set-CsTeamsEventsPolicy.md) -### [Set-CsTeamsFeedbackPolicy](Set-CsTeamsFeedbackPolicy.md) -### [Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) -### [Set-CsTeamsGuestCallingConfiguration](Set-CsTeamsGuestCallingConfiguration.md) -### [Set-CsTeamsGuestMeetingConfiguration](Set-CsTeamsGuestMeetingConfiguration.md) -### [Set-CsTeamsGuestMessagingConfiguration](Set-CsTeamsGuestMessagingConfiguration.md) -### [Set-CsTeamsIPPhonePolicy](Set-CsTeamsIPPhonePolicy.md) -### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) -### [Set-CsTeamsMeetingBroadcastConfiguration](Set-CsTeamsMeetingBroadcastConfiguration.md) -### [Set-CsTeamsMeetingBroadcastPolicy](Set-CsTeamsMeetingBroadcastPolicy.md) -### [Set-CsTeamsMeetingConfiguration](Set-CsTeamsMeetingConfiguration.md) -### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) -### [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Set-CsTeamsMessagingConfiguration](Set-CsTeamsMessagingConfiguration.md) -### [Set-CsTeamsMessagingPolicy](Set-CsTeamsMessagingPolicy.md) -### [Set-CsTeamsMobilityPolicy](Set-CsTeamsMobilityPolicy.md) -### [Set-CsTeamsNetworkRoamingPolicy](Set-CsTeamsNetworkRoamingPolicy.md) -### [Set-CsTeamsPinnedApp](Set-CsTeamsPinnedApp.md) -### [Set-CsTeamsRecordingRollOutPolicy](Set-CsTeamsRecordingRollOutPolicy.md) -### [Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) -### [Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) -### [Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) -### [Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) -### [Set-CsTeamsSipDevicesConfiguration](Set-CsTeamsSipDevicesConfiguration.md) -### [Set-CsTeamsSurvivableBranchAppliance](Set-CsTeamsSurvivableBranchAppliance.md) -### [Set-CsTeamsSurvivableBranchAppliancePolicy](Set-CsTeamsSurvivableBranchAppliancePolicy.md) -### [Set-CsTeamsTargetingPolicy](Set-CsTeamsTargetingPolicy.md) -### [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) -### [Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) -### [Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) -### [Set-CsTeamsUpdateManagementPolicy](Set-CsTeamsUpdateManagementPolicy.md) -### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) -### [Set-CsTeamsVdiPolicy](Set-CsTeamsVdiPolicy.md) -### [Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) -### [Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) -### [Set-CsTeamsWorkLoadPolicy](Set-CsTeamsWorkLoadPolicy.md) -### [Set-CsTeamsWorkLocationDetectionPolicy](Set-CsTeamsWorkLocationDetectionPolicy.md) -### [Set-CsTenantBlockedCallingNumbers](Set-CsTenantBlockedCallingNumbers.md) -### [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) -### [Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) -### [Set-CsTenantMigrationConfiguration](Set-CsTenantMigrationConfiguration.md) -### [Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) -### [Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) -### [Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) -### [Set-CsTenantTrustedIPAddress](Set-CsTenantTrustedIPAddress.md) -### [Set-CsUser](Set-CsUser.md) -### [Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) -### [Set-CsUserCallingSettings](Set-CsUserCallingSettings.md) -### [Set-CsVideoInteropServiceProvider](Set-CsVideoInteropServiceProvider.md) -### [Set-Team](Set-Team.md) -### [Set-TeamArchivedState](Set-TeamArchivedState.md) -### [Set-TeamChannel](Set-TeamChannel.md) -### [Set-TeamFunSettings](Set-TeamFunSettings.md) -### [Set-TeamGuestSettings](Set-TeamGuestSettings.md) -### [Set-TeamMemberSettings](Set-TeamMemberSettings.md) -### [Set-TeamMessagingSettings](Set-TeamMessagingSettings.md) -### [Set-TeamPicture](Set-TeamPicture.md) -### [Set-TeamsApp](Set-TeamsApp.md) -### [Set-TeamsEnvironmentConfig](Set-TeamsEnvironmentConfig.md) -### [Set-TeamTargetingHierarchy](Set-TeamTargetingHierarchy.md) -### [Start-CsExMeetingMigration](Start-CsExMeetingMigration.md) -### [Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) -### [Test-CsEffectiveTenantDialPlan](Test-CsEffectiveTenantDialPlan.md) -### [Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) -### [Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) -### [Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) -### [Test-CsTeamsUnassignedNumberTreatment](Test-CsTeamsUnassignedNumberTreatment.md) -### [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) -### [Unregister-CsOnlineDialInConferencingServiceNumber](Unregister-CsOnlineDialInConferencingServiceNumber.md) -### [Update-CsAutoAttendant](Update-CsAutoAttendant.md) -### [Update-CsCustomPolicyPackage](Update-CsCustomPolicyPackage.md) -### [Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) -### [Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) -### [Update-CsTeamTemplate](Update-CsTeamTemplate.md) -### [Update-M365UnifiedCustomPendingApp](Update-M365UnifiedCustomPendingApp.md) -### [Update-TeamsAppInstallation](Update-TeamsAppInstallation.md)